Skip to content

bpmnServer docs

Execution

bpmn-server / Execution

Class: Execution#

is accessed two ways: execute - start process signal - invoke a node (userTask, event, etc.)

Hierarchy#

ServerComponent

↳ Execution

Implements#

IExecution

Table of contents#

Constructors#

constructor

Properties#

Accessors#

Methods#

Constructors#

constructor#

• new Execution(server, name, source, state?): Execution

Parameters#

Name	Type	Default value	Description
`server`	`any`	`undefined`	-
`name`	`string`	`undefined`	process name
`source`	`any`	`undefined`	bpmn source
`state`	`any`	`null`	-

Returns#

Overrides#

ServerComponent.constructor

Defined in#

packages/bpmn-server/src/engine/Execution.ts:62

Properties#

instance#

• instance: InstanceObject

Implementation of#

IExecution.instance

Defined in#

packages/bpmn-server/src/engine/Execution.ts:23

tokens#

• tokens: Map\<any, any>

Implementation of#

IExecution.tokens

Defined in#

packages/bpmn-server/src/engine/Execution.ts:24

definition#

• definition: IDefinition

Implementation of#

IExecution.definition

Defined in#

packages/bpmn-server/src/engine/Execution.ts:25

process#

• process: Process

Implementation of#

IExecution.process

Defined in#

packages/bpmn-server/src/engine/Execution.ts:26

errors#

• errors: any

Implementation of#

IExecution.errors

Defined in#

packages/bpmn-server/src/engine/Execution.ts:27

item#

• item: any

Implementation of#

IExecution.item

Defined in#

packages/bpmn-server/src/engine/Execution.ts:28

messageMatchingKey#

• messageMatchingKey: any

Implementation of#

IExecution.messageMatchingKey

Defined in#

packages/bpmn-server/src/engine/Execution.ts:29

worker#

• worker: any

Implementation of#

IExecution.worker

Defined in#

packages/bpmn-server/src/engine/Execution.ts:30

userName#

• userName: any

Implementation of#

IExecution.userName

Defined in#

packages/bpmn-server/src/engine/Execution.ts:31

promises#

• promises: any[] = []

Implementation of#

IExecution.promises

Defined in#

packages/bpmn-server/src/engine/Execution.ts:32

servicesProvider#

• servicesProvider: any

Defined in#

packages/bpmn-server/src/engine/Execution.ts:33

isLocked#

• isLocked: boolean = false

Implementation of#

IExecution.isLocked

Defined in#

packages/bpmn-server/src/engine/Execution.ts:34

options#

• options: any

Implementation of#

IExecution.options

Defined in#

packages/bpmn-server/src/engine/Execution.ts:35

operation#

• operation: any

What the call running it does: start, signal, assign, cancel, …

Implementation of#

IExecution.operation

Defined in#

packages/bpmn-server/src/engine/Execution.ts:36

svg#

• svg: string

Defined in#

packages/bpmn-server/src/engine/Execution.ts:37

action#

• action: NODE_ACTION = NODE_ACTION.stop

Implementation of#

IExecution.action

Defined in#

packages/bpmn-server/src/engine/Execution.ts:44

uids#

• uids: Object = {}

Implementation of#

IExecution.uids

Defined in#

packages/bpmn-server/src/engine/Execution.ts:748

server#

• server: any

Implementation of#

IExecution.server

Inherited from#

ServerComponent.server

Defined in#

packages/bpmn-server/src/server/ServerComponent.ts:10

Accessors#

id#

• get id(): any

Returns#

any

Implementation of#

Defined in#

packages/bpmn-server/src/engine/Execution.ts:39

name#

• get name(): any

Returns#

any

Implementation of#

IExecution.name

Defined in#

packages/bpmn-server/src/engine/Execution.ts:40

status#

• get status(): EXECUTION_STATUS

Returns#

EXECUTION_STATUS

Implementation of#

IExecution.status

Defined in#

packages/bpmn-server/src/engine/Execution.ts:41

execution#

• get execution(): this

Returns#

this

Defined in#

packages/bpmn-server/src/engine/Execution.ts:42

listener#

• get listener(): any

Returns#

any

Implementation of#

IExecution.listener

Overrides#

ServerComponent.listener

Defined in#

packages/bpmn-server/src/engine/Execution.ts:52

keepLogs#

• get keepLogs(): boolean

The instance keeps its log lines only when they are saved (its flags.saveLogs, else dataStore.saveLogs, the default).

Returns#

boolean

Defined in#

packages/bpmn-server/src/engine/Execution.ts:780

configuration#

• get configuration(): any

Returns#

any

Implementation of#

IExecution.configuration

Inherited from#

ServerComponent.configuration

Defined in#

packages/bpmn-server/src/server/ServerComponent.ts:15

logger#

• get logger(): any

Returns#

any

Implementation of#

IExecution.logger

Inherited from#

ServerComponent.logger

Defined in#

packages/bpmn-server/src/server/ServerComponent.ts:16

cron#

• get cron(): Cron

Returns#

Implementation of#

IExecution.cron

Inherited from#

ServerComponent.cron

Defined in#

packages/bpmn-server/src/server/ServerComponent.ts:17

cache#

• get cache(): ICacheManager

Returns#

ICacheManager

Implementation of#

IExecution.cache

Inherited from#

ServerComponent.cache

Defined in#

packages/bpmn-server/src/server/ServerComponent.ts:18

appDelegate#

• get appDelegate(): any

Returns#

any

Implementation of#

IExecution.appDelegate

Inherited from#

ServerComponent.appDelegate

Defined in#

packages/bpmn-server/src/server/ServerComponent.ts:19

engine#

• get engine(): IEngine

Returns#

Implementation of#

IExecution.engine

Inherited from#

ServerComponent.engine

Defined in#

packages/bpmn-server/src/server/ServerComponent.ts:20

dataStore#

• get dataStore(): any

Returns#

any

Implementation of#

IExecution.dataStore

Inherited from#

ServerComponent.dataStore

Defined in#

packages/bpmn-server/src/server/ServerComponent.ts:21

lockManager#

• get lockManager(): any

The lock port: the configuration's, else the data store's.

Returns#

any

Inherited from#

ServerComponent.lockManager

Defined in#

packages/bpmn-server/src/server/ServerComponent.ts:23

definitions#

• get definitions(): any

Returns#

any

Implementation of#

IExecution.definitions

Inherited from#

ServerComponent.definitions

Defined in#

packages/bpmn-server/src/server/ServerComponent.ts:24

scriptHandler#

• get scriptHandler(): any

Returns#

any

Implementation of#

IExecution.scriptHandler

Inherited from#

ServerComponent.scriptHandler

Defined in#

packages/bpmn-server/src/server/ServerComponent.ts:26

Methods#

tillDone#

▸ tillDone(): Promise\<Execution>

Returns#

Promise\<Execution>

Defined in#

packages/bpmn-server/src/engine/Execution.ts:46

getNodeById#

▸ getNodeById(id): Node

Parameters#

Name	Type
`id`	`any`

Returns#

Implementation of#

IExecution.getNodeById

Defined in#

packages/bpmn-server/src/engine/Execution.ts:76

getToken#

▸ getToken(id): Token

Parameters#

Name	Type
`id`	`number`

Returns#

Implementation of#

IExecution.getToken

Defined in#

packages/bpmn-server/src/engine/Execution.ts:79

checkEnd#

▸ checkEnd(): Promise\<void>

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/engine/Execution.ts:82

end#

▸ end(): Promise\<void>

Returns#

Promise\<void>

Implementation of#

Defined in#

packages/bpmn-server/src/engine/Execution.ts:95

terminate#

▸ terminate(): void

causes the execution to stop from running any further

Returns#

void

Implementation of#

IExecution.terminate

Defined in#

packages/bpmn-server/src/engine/Execution.ts:109

stop#

▸ stop(): void

causes the execution to stop from running any further

Returns#

void

Implementation of#

IExecution.stop

Defined in#

packages/bpmn-server/src/engine/Execution.ts:119

execute#

▸ execute(startNodeId?, inputData?, options?, userName?): Promise\<void>

Parameters#

Name	Type	Default value
`startNodeId`	`any`	`null`
`inputData`	`Object`	`{}`
`options`	`Object`	`{}`
`userName`	`any`	`null`

Returns#

Promise\<void>

Implementation of#

IExecution.execute

Defined in#

packages/bpmn-server/src/engine/Execution.ts:126

assign#

▸ assign(executionId, inputData, assignment?, userName, options?): Promise\<void>

Parameters#

Name	Type
`executionId`	`any`
`inputData`	`any`
`assignment`	`Object`
`userName`	`any`
`options`	`Object`

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/engine/Execution.ts:198

signalItem#

▸ signalItem(itemId, inputData, userName, options?): Promise\<IExecution>

invoke scenarios: itemId elementId - but only one is active elementId - for a startEvent in a secondary process

Parameters#

Name	Type
`itemId`	`any`
`inputData`	`any`
`userName`	`any`
`options`	`Object`

Returns#

Promise\<IExecution>

Implementation of#

IExecution.signalItem

Defined in#

packages/bpmn-server/src/engine/Execution.ts:235

signalItem2#

▸ signalItem2(itemId): Promise\<IExecution>

Parameters#

Name	Type
`itemId`	`any`

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/engine/Execution.ts:299

retry#

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

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

Parameters#

Name	Type
`itemId`	`any`
`userName?`	`string`

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/engine/Execution.ts:348

restart#

▸ restart(itemId, inputData, userName, options?): Promise\<IExecution>

Parameters#

Name	Type
`itemId`	`any`
`inputData`	`any`
`userName`	`any`
`options`	`Object`

Returns#

Promise\<IExecution>

Defined in#

packages/bpmn-server/src/engine/Execution.ts:370

signalEvent#

▸ signalEvent(executionId, inputData, userName, options?): Promise\<IExecution>

Parameters#

Name	Type
`executionId`	`any`
`inputData`	`any`
`userName`	`any`
`options`	`Object`

Returns#

Promise\<IExecution>

Implementation of#

IExecution.signalEvent

Defined in#

packages/bpmn-server/src/engine/Execution.ts:395

signalRepeatTimerEvent#

▸ signalRepeatTimerEvent(executionId, prevItem, inputData, options?): Promise\<IExecution>

Parameters#

Name	Type
`executionId`	`any`
`prevItem`	`any`
`inputData`	`any`
`options`	`Object`

Returns#

Promise\<IExecution>

Implementation of#

IExecution.signalRepeatTimerEvent

Defined in#

packages/bpmn-server/src/engine/Execution.ts:487

save#

▸ save(): Promise\<void>

Returns#

Promise\<void>

Implementation of#

IExecution.save

Defined in#

packages/bpmn-server/src/engine/Execution.ts:520

getItems#

▸ getItems(): Item[]

Returns#

Implementation of#

IExecution.getItems

Defined in#

packages/bpmn-server/src/engine/Execution.ts:536

getItemsData#

▸ getItemsData(): any[]

Returns#

any[]

Implementation of#

IExecution.getItemsData

Defined in#

packages/bpmn-server/src/engine/Execution.ts:547

getState#

▸ getState(): IInstanceData

Returns#

IInstanceData

Implementation of#

IExecution.getState

Defined in#

packages/bpmn-server/src/engine/Execution.ts:557

findSavePoint#

▸ findSavePoint(state, itemId): any

Parameters#

Name	Type
`state`	`any`
`itemId`	`any`

Returns#

any

Defined in#

packages/bpmn-server/src/engine/Execution.ts:581

restore#

▸ restore(server, state, itemId?): Promise\<Execution>

re-enstate the execution from db

Parameters#

Name	Type	Default value
`server`	`any`	`undefined`
`state`	`IInstanceData`	`undefined`
`itemId`	`any`	`null`

Returns#

Promise\<Execution>

Defined in#

packages/bpmn-server/src/engine/Execution.ts:601

restored#

▸ restored(): Promise\<void>

Returns#

Promise\<void>

Implementation of#

IExecution.restored

Defined in#

packages/bpmn-server/src/engine/Execution.ts:686

resume#

▸ resume(): Promise\<void>

Returns#

Promise\<void>

Implementation of#

IExecution.resume

Defined in#

packages/bpmn-server/src/engine/Execution.ts:693

reportToken#

▸ reportToken(token, level): void

Parameters#

Name	Type
`token`	`Token`
`level`	`any`

Returns#

void

Defined in#

packages/bpmn-server/src/engine/Execution.ts:698

report#

▸ report(): void

Returns#

void

Implementation of#

IExecution.report

Defined in#

packages/bpmn-server/src/engine/Execution.ts:716

formatDate#

▸ formatDate(date): string

Parameters#

Name	Type
`date`	`any`

Returns#

string

Defined in#

packages/bpmn-server/src/engine/Execution.ts:740

getNewId#

▸ getNewId(scope): number

The next id of a scope; items are numbered from 1 (their seq), tokens and loops from 0.

Parameters#

Name	Type
`scope`	`string`

Returns#

number

Implementation of#

IExecution.getNewId

Defined in#

packages/bpmn-server/src/engine/Execution.ts:751

getUUID#

▸ getUUID(): string

Returns#

string

Implementation of#

IExecution.getUUID

Defined in#

packages/bpmn-server/src/engine/Execution.ts:758

doExecutionEvent#

▸ doExecutionEvent(process, event, eventDetails?): Promise\<void>

Parameters#

Name	Type
`process`	`any`
`event`	`any`
`eventDetails`	`Object`

Returns#

Promise\<void>

Implementation of#

IExecution.doExecutionEvent

Defined in#

packages/bpmn-server/src/engine/Execution.ts:763

doItemEvent#

▸ doItemEvent(item, event, eventDetails?): Promise\<void>

Parameters#

Name	Type
`item`	`any`
`event`	`any`
`eventDetails`	`Object`

Returns#

Promise\<void>

Implementation of#

IExecution.doItemEvent

Defined in#

packages/bpmn-server/src/engine/Execution.ts:768

dispatch#

▸ dispatch(event, eventDetails): Promise\<any>

The server's listeners, then its lifecycle subscribers (server/Listener.ts); a plain emitter only emits.

Parameters#

Name	Type
`event`	`any`
`eventDetails`	`any`

Returns#

Promise\<any>

Defined in#

packages/bpmn-server/src/engine/Execution.ts:773

record#

▸ record(entry): void

Parameters#

Name	Type
`entry`	`any`

Returns#

void

Defined in#

packages/bpmn-server/src/engine/Execution.ts:783

log#

▸ log(...msg): void

Parameters#

Name	Type
`...msg`	`any`[]

Returns#

void

Implementation of#

Defined in#

packages/bpmn-server/src/engine/Execution.ts:786

logS#

▸ logS(...msg): void

Parameters#

Name	Type
`...msg`	`any`[]

Returns#

void

Implementation of#

IExecution.logS

Defined in#

packages/bpmn-server/src/engine/Execution.ts:789

logE#

▸ logE(...msg): void

Parameters#

Name	Type
`...msg`	`any`[]

Returns#

void

Implementation of#

IExecution.logE

Defined in#

packages/bpmn-server/src/engine/Execution.ts:792

info#

▸ info(...msg): void

Parameters#

Name	Type
`...msg`	`any`[]

Returns#

void

Implementation of#

IExecution.info

Defined in#

packages/bpmn-server/src/engine/Execution.ts:795

decision#

▸ decision(...msg): void

Why the engine took a path: kept in the instance's log, as a 'decision' entry. A decision object is written as a block (seq and element, action, why); the entry also keeps its seq, element and action.

Parameters#

Name	Type
`...msg`	`any`[]

Returns#

void

Implementation of#

IExecution.decision

Defined in#

packages/bpmn-server/src/engine/Execution.ts:802

error#

▸ error(msg): void

Parameters#

Name	Type
`msg`	`any`

Returns#

void

Implementation of#

IExecution.error

Defined in#

packages/bpmn-server/src/engine/Execution.ts:810

appendData#

▸ appendData(inputData, item, dataPath?, assignment?): void

Parameters#

Name	Type
`inputData`	`any`
`item`	`Item`
`dataPath?`	`any`
`assignment?`	`any`

Returns#

void

Implementation of#

IExecution.appendData

Defined in#

packages/bpmn-server/src/engine/Execution.ts:815

getData#

▸ getData(dataPath): any

Parameters#

Name	Type
`dataPath`	`any`

Returns#

any

Implementation of#

IExecution.getData

Defined in#

packages/bpmn-server/src/engine/Execution.ts:820

processQueue#

▸ processQueue(): Promise\<void>

Returns#

Promise\<void>

Implementation of#

IExecution.processQueue

Defined in#

packages/bpmn-server/src/engine/Execution.ts:825

Comments