bpmn-server / IExecution

Interface: IExecution

Hierarchy

• IServerComponent

↳ IExecution

Implemented by

• Execution

Table of contents

Properties

• instance
• operation
• server
• tokens
• definition
• appDelegate
• logger
• process
• promises
• listener
• isLocked
• errors
• item
• messageMatchingKey
• worker
• userName
• id
• status
• action
• options
• name
• uids
• configuration
• cron
• cache
• engine
• dataStore
• scriptHandler
• definitions

Methods

• getNodeById
• getToken
• getItemsData
• save
• end
• stop
• terminate
• execute
• signalItem
• signalEvent
• signalRepeatTimerEvent
• getItems
• getState
• restored
• resume
• report
• getNewId
• getUUID
• doExecutionEvent
• doItemEvent
• log
• logS
• logE
• info
• decision
• error
• appendData
• getData
• processQueue

Properties

instance

• instance: IInstanceData

Defined in

packages/bpmn-server/src/interfaces/engine.ts:101

---

operation

• Optional operation: string

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

Defined in

packages/bpmn-server/src/interfaces/engine.ts:103

---

server

• server: IBPMNServer

Overrides

IServerComponent.server

Defined in

packages/bpmn-server/src/interfaces/engine.ts:104

---

tokens

• tokens: Map\<any, IToken>

Defined in

packages/bpmn-server/src/interfaces/engine.ts:105

---

definition

• definition: IDefinition

Defined in

packages/bpmn-server/src/interfaces/engine.ts:106

---

appDelegate

• appDelegate: IAppDelegate

Overrides

IServerComponent.appDelegate

Defined in

packages/bpmn-server/src/interfaces/engine.ts:107

---

logger

• logger: ILogger

Overrides

IServerComponent.logger

Defined in

packages/bpmn-server/src/interfaces/engine.ts:108

---

process

• process: any

Defined in

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

---

promises

• promises: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:110

---

listener

• listener: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:111

---

isLocked

• isLocked: boolean

Defined in

packages/bpmn-server/src/interfaces/engine.ts:112

---

errors

• errors: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:114

---

item

• item: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:115

---

messageMatchingKey

• messageMatchingKey: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:116

---

worker

• worker: any

Defined in

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

---

userName

• userName: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:118

---

id

• id: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:120

---

status

• status: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:121

---

action

• action: NODE_ACTION

Defined in

packages/bpmn-server/src/interfaces/engine.ts:122

---

options

• options: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:123

---

name

• name: any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:124

---

uids

• uids: Object

Defined in

packages/bpmn-server/src/interfaces/engine.ts:157

---

configuration

• configuration: IConfiguration

Inherited from

IServerComponent.configuration

Defined in

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

---

cron

• cron: any

Inherited from

IServerComponent.cron

Defined in

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

---

cache

• cache: any

Inherited from

IServerComponent.cache

Defined in

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

---

engine

• engine: any

Inherited from

IServerComponent.engine

Defined in

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

---

dataStore

• dataStore: IDataStore

Inherited from

IServerComponent.dataStore

Defined in

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

---

scriptHandler

• scriptHandler: IScriptHandler

Inherited from

IServerComponent.scriptHandler

Defined in

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

---

definitions

• definitions: any

Inherited from

IServerComponent.definitions

Defined in

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

Methods

getNodeById

▸ getNodeById(id): Node

Parameters

Name	Type
id	any

Returns

Node

Defined in

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

---

getToken

▸ getToken(id): IToken

Parameters

Name	Type
id	number

Returns

IToken

Defined in

packages/bpmn-server/src/interfaces/engine.ts:127

---

getItemsData

▸ getItemsData(): IItemData[]

Returns

IItemData[]

Defined in

packages/bpmn-server/src/interfaces/engine.ts:128

---

save

▸ save(): Promise\<void>

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/interfaces/engine.ts:129

---

end

▸ end(): Promise\<void>

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/interfaces/engine.ts:130

---

stop

▸ stop(): void

causes the execution to stop from running any further

Returns

void

Defined in

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

---

terminate

▸ terminate(): void

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:136

---

execute

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

Parameters

Name	Type
startNodeId?	any
inputData?	Object

Returns

Promise\<void>

Defined in

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

---

signalItem

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

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

Parameters

Name	Type
executionId	any
inputData	any
options?	Object

Returns

Promise\<IExecution>

Defined in

packages/bpmn-server/src/interfaces/engine.ts:148

---

signalEvent

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

Parameters

Name	Type
executionId	any
inputData	any
options?	Object

Returns

Promise\<IExecution>

Defined in

packages/bpmn-server/src/interfaces/engine.ts:149

---

signalRepeatTimerEvent

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

Parameters

Name	Type
executionId	any
prevItem	any
inputData	any
options?	Object

Returns

Promise\<IExecution>

Defined in

packages/bpmn-server/src/interfaces/engine.ts:150

---

getItems

▸ getItems(query?): IItem[]

Parameters

Name	Type
query?	any

Returns

IItem[]

Defined in

packages/bpmn-server/src/interfaces/engine.ts:152

---

getState

▸ getState(): IInstanceData

Returns

IInstanceData

Defined in

packages/bpmn-server/src/interfaces/engine.ts:153

---

restored

▸ restored(): void

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:154

---

resume

▸ resume(): void

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:155

---

report

▸ report(): void

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:156

---

getNewId

▸ getNewId(scope): number

Parameters

Name	Type
scope	string

Returns

number

Defined in

packages/bpmn-server/src/interfaces/engine.ts:158

---

getUUID

▸ getUUID(): any

Returns

any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:159

---

doExecutionEvent

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

Parameters

Name	Type
process	any
event	any
eventDetails?	any

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/interfaces/engine.ts:160

---

doItemEvent

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

Parameters

Name	Type
item	any
event	any
eventDetails?	any

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/interfaces/engine.ts:161

---

log

▸ log(...msg): void

Parameters

Name	Type
...msg	any

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:162

---

logS

▸ logS(...msg): void

Parameters

Name	Type
...msg	any

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:163

---

logE

▸ logE(...msg): void

Parameters

Name	Type
...msg	any

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:164

---

info

▸ info(...msg): void

Parameters

Name	Type
...msg	any

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:165

---

decision

▸ decision(...msg): void

Why the engine took a path, kept in the instance log as a decision entry.

Parameters

Name	Type
...msg	any

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:167

---

error

▸ error(msg): void

Parameters

Name	Type
msg	any

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:168

---

appendData

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

Parameters

Name	Type
inputData	any
item	IItem
dataPath?	any
assignment?	any

Returns

void

Defined in

packages/bpmn-server/src/interfaces/engine.ts:169

---

getData

▸ getData(dataPath): any

Parameters

Name	Type
dataPath	any

Returns

any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:170

---

processQueue

▸ processQueue(): any

Returns

any

Defined in

packages/bpmn-server/src/interfaces/engine.ts:171

Comments