Skip to content

Latest commit

 

History

History
201 lines (125 loc) · 4.65 KB

IAPIEngine.md

File metadata and controls

201 lines (125 loc) · 4.65 KB

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

API/API.ts:89

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

API/API.ts:96

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

API/API.ts:101

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

API/API.ts:105

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

API/API.ts:109

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

API/API.ts:113

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

API/API.ts:127