Packages
bpe
11.4.13
13.5.22-aleph
11.4.16
11.4.15
11.4.14
11.4.13
9.9.7
9.9.6
8.12.4
8.12.3
8.12.1
8.12.0
retired
8.2.1
8.2.0
8.1.0
7.11.0
7.10.4
7.10.3
7.10.2
7.10.1
7.9.1
7.9.0
7.8.2
7.8.1
7.8.0
7.6.4
7.6.3
7.6.2
7.6.1
7.6.0
7.5.15
7.5.14
7.5.13
7.5.12
7.5.11
7.5.10
7.5.9
7.5.8
7.5.7
7.5.6
7.5.5
7.5.3
7.5.2
7.5.1
7.5.0
7.4.11
7.4.10
7.4.9
7.4.8
7.4.7
7.4.6
7.4.5
7.4.4
7.4.3
7.4.2
7.4.1
7.4.0
7.3.0
7.2.8
7.2.7
7.2.6
7.1.6
7.1.5
7.1.4
7.1.3
7.1.2
6.12.7
6.12.6
6.12.5
6.12.3
6.12.2
6.12.1
6.12.0
6.11.0
6.10.0
6.5.3
6.5.2
6.5.1
6.5.0
6.4.0
6.3.0
5.12.0
5.11.4
5.11.3
5.11.2
5.11.1
5.11.0
5.8.7
5.8.6
5.8.5
5.8.4
5.8.3
5.8.2
5.8.1
5.8.0
5.7.0
5.6.0
5.5.2
5.5.1
5.4.0
5.2.0
5.1.3
5.1.2
5.1.1
4.12.4
4.12.3
4.12.2
4.12.1
4.12.0
4.11.8
4.11.7
4.11.6
4.11.5
4.11.4
4.11.3
4.11.2
4.11.1
4.11.0
4.10.24
4.10.23
4.10.22
4.10.21
4.10.20
4.10.19
4.10.18
4.10.17
4.10.16
4.10.15
4.10.14
4.10.13
4.10.12
4.10.11
4.10.10
4.10.9
4.10.8
4.10.7
4.10.6
4.10.5
4.10.4
4.10.3
4.10.2
4.10.1
4.10.0
4.9.18
4.9.17
4.9.16
4.9.15
4.9.14
4.9.13
4.9.12
4.9.11
4.9.10
4.9.9
4.9.8
4.9.7
4.9.6
4.9.5
4.9.4
4.9.3
4.9.2
4.9.1
4.9.0
4.8.1
4.8.0
4.7.5
4.7.3
4.7.2
4.7.1
4.7.0
4.6.0
2.4.0
0.7.16
ERP/1: RTP GST WebRTC ICE SDP H.264 H.265 MP4 MPEG-2 HLS HEVC
Current section
Files
Jump to
Current section
Files
man/bpe.htm
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="" />
<meta name="author" content="Maxim Sokhatsky" />
<title>BPE</title>
<link rel="stylesheet" href="https://n2o.dev/blank.css"/>
<link rel="stylesheet" href="https://n2o.dev/zima.css"/>
<link rel="shortcut icon" type="image/x-icon" href="https://n2o.dev/img/favicon.ico"/>
<link rel="apple-touch-icon" sizes="180x180" href="https://n2o.dev/img/apple-touch-icon.png"/>
<link rel="icon" type="image/png" sizes="32x32" href="https://n2o.dev/img/favicon-32x32.png"/>
<link rel="icon" type="image/png" sizes="16x16" href="https://n2o.dev/img/favicon-16x16.png"/>
<link rel="manifest" href="https://n2o.dev/img/site.webmanifest"/>
</head>
<body>
<nav>
<a href="https://n2o.dev">DEV</a>
<a href="https://bpe.n2o.dev">BPE</a>
<a href="#" style="background:#ededed;">API</a>
<div class="dropdown">
<a onclick="drop()" class="dropbtn">EN</a>
<div id="dropdown" class="dropdown-content">
<a href="https://n2o.dev/deps/bpe/man/ua/bpe.htm">UA</a>
<a href="#">EN</a>
</div>
</div>
</nav>
<header>
<a href="../index.html"><img src="https://openmoji.org/data/color/svg/1F4A0.svg"/></a>
<h1>BPE</h1>
</header><main>
<section>
<h3>INTRO</h3>
<p>The <b>bpe</b> module contains a subset of BPMN 2.0 API for
controlling processes with parallel gateways, hierarchical
traces and scheduler. Also BPE supports XML BPMN format out
of the box. Can be used with Camunda BPMN modeler.</p>
</section>
<section>
<h3>SERVICE</h3>
<h4 id="load">load(string()) -> #process{}</h4>
<p>Loads the process from the database.
This function should be protected against admin authorization.</p>
<h4 id="start/3">start(#process{}, list(), #procMonitor{}) -> {ok,pid()} | {error,any()}.</h4>
<p>Starts the process in the context of process monitor — a supervised process group.
This function is matching against current user tasks and roles.</p>
<h4 id="start/2">start(#process{}, list()) -> {ok, pid()} | {error, any()}.</h4>
<p>Starts the process in the runtime with no process group.
This function is matching against current user tasks and roles.</p>
</section>
<section>
<h3>CONTEXT</h3>
<h4 id="proc">proc(pid()) -> #process{}.</h4>
<p>Retrieves current process state (if running) from the runtime.
This function should be protected against admin authorization.</p>
<h4 id="next/1">next(pid()) -> {complete, any()}.</h4>
<p>Invokes BPMN 2.0 process scheduler tick.</p>
<h4 id="next/2">next(any(), pid()) -> {complete, any()}.</h4>
<p>Invokes BPMN 2.0 process scheduler tick on particular flow (if allowed).</p>
<h4 id="complete/1">complete(pid()) -> {complete, any()}.</h4>
<p>Invokes BPMN 1.0 process scheduler tick.</p>
<h4 id="complete/2">complete(any(), pid()) -> {complete, any()}.</h4>
<p>Invokes BPMN 1.0 process scheduler tick on particular flow (if allowed).</p>
<h4 id="amend">amend(pid(), any()) -> {complete, any()}.</h4>
<p>Invokes BPMN 2.0 process scheduler tick with additional document in the state as an argument.</p>
<h4 id="discard">discard(pid(), any()) -> {complete, any()}.</h4>
<p>Invokes BPMN 2.0 process scheduler tick with additional document removal from the the state.</p>
<h4 id="append">append(pid(), any()) -> {complete, any()}.</h4>
<p>Modifies current state of the process with additional document.</p>
<h4 id="remove">remove(pid(), any()) -> {complete, any()}.</h4>
<p>Modifies current state of the process with document removal.</p>
<h4 id="event">event(pid(), any()) -> {complete, any()}.</h4>
<p>Sends the sync event to the runtime process.</p>
<h4 id="hist">hist(pid()) -> list(#hist{}).</h4>
<p>Retrieves the process history.</p>
</section>
<section>
<h3>ENV</h3>
<h4 id="task">task(Name::list(), #process{}) -> [tuple()] | tuple().</h4>
<p>Retrieves the task from process definition.</p>
<h4 id="doc">doc(Record::tuple(), #process{}) -> [tuple()] | tuple().</h4>
<p>Searches for the documents in the process environment.</p>
</section>
<section>
<h3></h3>
<h4 id="tasks">tasks(#process{}) -> list().</h4>
<p>Retrieves the tasks from process definition.</p>
<h4 id="flows">flows(#process{}) -> list().</h4>
<p>Retrieves the flows from process definition.</p>
<h4 id="docs">docs(#process{}) -> list().</h4>
<p>Retrieves the documents from process definition.</p>
<h4 id="events">events(#process{}) -> list().</h4>
<p>Retrieves the events from process definition.</p>
</section>
<section>
<p>This module may refer to:
<b><a href="task.htm">TASK</a></b>
</p>
</section>
</main><footer>
Made with <span class="heart">❤</span> to N2O
</footer></body>
<script>function drop(){document.getElementById("dropdown").classList.toggle("show");}</script>
</html>