bpmn-server / IAPIEngine
Interface: IAPIEngine#
Implemented by#
Table of contents#
Methods#
Methods#
start#
▸ start(modelName, data, user, options?): Promise\<IExecution>
start a new Instance of specified model
Parameters#
| Name | Type | Description |
|---|---|---|
modelName |
any |
name of the model to start. |
data |
Object |
- |
user |
ISecureUser |
user object {} |
options? |
IEngineOptions |
- |
Returns#
Promise\<IExecution>
Defined in#
packages/bpmn-server/src/API/API.ts:105
invoke#
▸ invoke(query, data, user, options?): Promise\<IExecution>
continue with the execution of a particular item that is in a wait state, typically a user task
Parameters#
| Name | Type |
|---|---|
query |
any |
data |
Object |
user |
ISecureUser |
options? |
IEngineOptions |
Returns#
Promise\<IExecution>
Defined in#
packages/bpmn-server/src/API/API.ts:112
assign#
▸ assign(query, data, assignment, user, options?): Promise\<IExecution>
provide assignment data to a user task Also, updates item data
Parameters#
| Name | Type |
|---|---|
query |
any |
data |
any |
assignment |
any |
user |
ISecureUser |
options? |
IEngineOptions |
Returns#
Promise\<IExecution>
Defined in#
packages/bpmn-server/src/API/API.ts:117
throwMessage#
▸ throwMessage(messageId, data, messageMatchingKey, user, options?): Promise\<IExecution>
throw a message with an id, system will identify receiving item
Parameters#
| Name | Type |
|---|---|
messageId |
any |
data |
any |
messageMatchingKey |
any |
user |
ISecureUser |
options? |
IEngineOptions |
Returns#
Promise\<IExecution>
Defined in#
packages/bpmn-server/src/API/API.ts:121
throwSignal#
▸ throwSignal(signalId, data, messageMatchingKey, user, options?): Promise\<IExecution>
throw a signal with an id, system will identify receiving item(s)
Parameters#
| Name | Type |
|---|---|
signalId |
any |
data |
any |
messageMatchingKey |
any |
user |
ISecureUser |
options? |
IEngineOptions |
Returns#
Promise\<IExecution>
Defined in#
packages/bpmn-server/src/API/API.ts:125
startEvent#
▸ startEvent(query, elementId, data, user, options?): Promise\<IExecution>
start a second event node (in a subprocess) for a running instance
Parameters#
| Name | Type |
|---|---|
query |
any |
elementId |
any |
data |
Object |
user |
ISecureUser |
options? |
IEngineOptions |
Returns#
Promise\<IExecution>
Defined in#
packages/bpmn-server/src/API/API.ts:129
restart#
▸ restart(itemQuery, data, userName, options?): Promise\<IExecution>
restarting an already completed instance at a particular node
this function requires dataStore.enableSavePoints to be true in configuration.ts
this add a savePoint for each item, allowing you to select that item to restore it
Parameters#
| Name | Type | Description |
|---|---|---|
itemQuery |
any |
Query to find a single item |
data |
any |
- |
userName |
any |
- |
options? |
any |
- |
Returns#
Promise\<IExecution>
Defined in#
packages/bpmn-server/src/API/API.ts:143
upgrade#
▸ upgrade(model, afterNodeIds, user): Promise\<string[] | { errors: any }>
upgrade running instances with the latest revised bpmn model default behaviour is that running instances will retain the model at start However, this routine will upgrade already started instances with the revised model
Parameters#
| Name | Type | Description |
|---|---|---|
model |
string |
Model Name |
afterNodeIds |
string[] |
list of nodeIds, to check if already started, don't apply the upgrade |
user |
ISecureUser |
- |
Returns#
Promise\<string[] | { errors: any }>
Defined in#
packages/bpmn-server/src/API/API.ts:154