Skip to content

bpmn-server / IEngine

Interface: IEngine#

Implemented by#

Table of contents#

Methods#

Methods#

start#

▸ start(name, data?, startNodeId?, userName?, options?): Promise\<IExecution>

loads a definitions and start execution

Parameters#

Name Type Description
name any name of the process to start
data? any input data
startNodeId? string in process has multiple start node; you need to specify which one
userName? string -
options? any -

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:54

get#

▸ get(instanceQuery): Promise\<IExecution>

restores an instance into memeory or provides you access to a running instance

this will also resume execution

Parameters#

Name Type Description
instanceQuery any criteria to fetch the instance query example: jsonl { id: instanceId} { data: {caseId: 1005}} { items.id : 'abcc111322'} { items.itemKey : 'businesskey here'}

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:72

invoke#

▸ invoke(itemQuery, data, userName?, options?): Promise\<IExecution>

Continue an existing item that is in a wait state

scenario:

itemId  {itemId: value }
itemKey     {itemKey: value}
instance,task   {instanceId: instanceId, elementId: value }

Parameters#

Name Type Description
itemQuery any criteria to retrieve the item
data Object
userName? string -
options? Object -

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:89

assign#

▸ assign(itemQuery, data, assignment, userName, options?): Promise\<IExecution>

Parameters#

Name Type
itemQuery any
data Object
assignment Object
userName string
options? Object

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:91

startRepeatTimerEvent#

▸ startRepeatTimerEvent(instanceId, prevItem, data, options?): Promise\<IExecution>

Parameters#

Name Type
instanceId any
prevItem IItem
data Object
options? Object

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:94

deleteInstances#

▸ deleteInstances(query): Promise\<{ deletedCount: number }>

Removes the instances a query matches, each under its lock and with its timers.

Parameters#

Name Type
query any

Returns#

Promise\<{ deletedCount: number }>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:97

tagInstance#

▸ tagInstance(instanceId, tag): Promise\<void>

Marks a saved instance with a tag of the caller's.

Parameters#

Name Type
instanceId string
tag any

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:99

startEvent#

▸ startEvent(instanceId, elementId, data?, userName?, options?): Promise\<IExecution>

Invoking an event (usually start event of a secondary process) against an existing instance or Invoking a start event (of a secondary process) against an existing instance

 instance,task

{instanceId: instanceId, elementId: value }

Parameters#

Name Type
instanceId any
elementId any
data? Object
userName? string
options? Object

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:117

throwMessage#

▸ throwMessage(messageId, data, matchingQuery): Promise\<IExecution>

signal/message raise a signal or throw a message

will seach for a matching event/task given the signalId/messageId

that can be againt a running instance or it may start a new instance#

Parameters#

Name Type Description
messageId any the id of the message or signal as per bpmn definition
data Object message data
matchingQuery Object -

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:131

throwSignal#

▸ throwSignal(signalId, data, matchingQuery, from?): any

Parameters#

Name Type
signalId any
data Object
matchingQuery Object
from? IItem

Returns#

any

Defined in#

packages/bpmn-server/src/interfaces/server.ts:132

retry#

▸ retry(itemQuery, userName?): Promise\<IExecution>

Runs a failed item's work again (an item whose status is error), and the instance on from it.

Parameters#

Name Type
itemQuery any
userName? string

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:134

restart#

▸ restart(itemQuery, data, userName, options): Promise\<IExecution>

Parameters#

Name Type
itemQuery any
data any
userName any
options any

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:135

cancel#

▸ cancel(instanceQuery, userName?, options?): Promise\<IExecution>

Cancels a running instance: terminated and saved, never deleted.

Parameters#

Name Type
instanceQuery any
userName? string
options? Object

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:137

upgrade#

▸ upgrade(model, afterNodeIds): Promise\<string[] | { errors: any }>

Parameters#

Name Type
model string
afterNodeIds string[]

Returns#

Promise\<string[] | { errors: any }>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:139

upgradeRunning#

▸ upgradeRunning(models?, options?): Promise\<IUpgradeReport[]>

Moves the instances that have not ended onto their model's current saved source (see Engine.upgradeRunning).

Parameters#

Name Type
models? string[]
options? Object
options.dryRun? boolean

Returns#

Promise\<IUpgradeReport[]>

Defined in#

packages/bpmn-server/src/interfaces/server.ts:141

Comments