bpmn-server / Transaction

Class: Transaction

Hierarchy

• SubProcess

↳ Transaction

Table of contents

Constructors

• constructor

Properties

• id
• type
• subType
• behaviours
• isFlow
• lane
• name
• process
• def
• outbounds
• inbounds
• attachments
• attachedTo
• messageId
• signalId
• initiator
• assignee
• candidateGroups
• candidateUsers
• scripts
• childProcess

Accessors

• processId
• loopDefinition
• isCatching
• canBeInvoked
• requiresWait
• isTransaction

Methods

• restored
• hasBehaviour
• getBehaviour
• addBehaviour
• validate
• doEvent
• setInput
• getInput
• getOutput
• enter
• execute
• continue
• run
• cancelEBG
• cancelBoundaryEvents
• resume
• init
• getOutbounds
• startBoundaryEvents
• describe
• end
• Cancel
• Compensate
• getNodes
• getItemsForToken
• getItems
• start

Constructors

constructor

• new Transaction(id, process, type, def): Transaction

Parameters

Name	Type
id	any
process	any
type	any
def	any

Returns

Transaction

Inherited from

SubProcess.constructor

Defined in

elements/Node.ts:32

Properties

id

• id: any

Inherited from

SubProcess.id

Defined in

elements/Element.ts:13

---

type

• type: any

Inherited from

SubProcess.type

Defined in

elements/Element.ts:14

---

subType

• subType: any

Inherited from

SubProcess.subType

Defined in

elements/Element.ts:15

---

behaviours

• behaviours: Map\<any, any>

Inherited from

SubProcess.behaviours

Defined in

elements/Element.ts:17

---

isFlow

• isFlow: boolean = false

Inherited from

SubProcess.isFlow

Defined in

elements/Element.ts:18

---

lane

• lane: any

Inherited from

SubProcess.lane

Defined in

elements/Element.ts:19

---

name

• name: any

Inherited from

SubProcess.name

Defined in

elements/Node.ts:13

---

process

• process: any

Inherited from

SubProcess.process

Defined in

elements/Node.ts:14

---

def

• def: any

Inherited from

SubProcess.def

Defined in

elements/Node.ts:15

---

outbounds

• outbounds: Flow[]

Inherited from

SubProcess.outbounds

Defined in

elements/Node.ts:16

---

inbounds

• inbounds: Flow[]

Inherited from

SubProcess.inbounds

Defined in

elements/Node.ts:17

---

attachments

• attachments: Node[]

Inherited from

SubProcess.attachments

Defined in

elements/Node.ts:18

---

attachedTo

• attachedTo: Node

Inherited from

SubProcess.attachedTo

Defined in

elements/Node.ts:19

---

messageId

• messageId: any

Inherited from

SubProcess.messageId

Defined in

elements/Node.ts:20

---

signalId

• signalId: any

Inherited from

SubProcess.signalId

Defined in

elements/Node.ts:21

---

initiator

• initiator: any

Inherited from

SubProcess.initiator

Defined in

elements/Node.ts:22

---

assignee

• assignee: any

Inherited from

SubProcess.assignee

Defined in

elements/Node.ts:23

---

candidateGroups

• candidateGroups: any

Inherited from

SubProcess.candidateGroups

Defined in

elements/Node.ts:24

---

candidateUsers

• candidateUsers: any

Inherited from

SubProcess.candidateUsers

Defined in

elements/Node.ts:25

---

scripts

• scripts: Map\<any, any>

Inherited from

SubProcess.scripts

Defined in

elements/Node.ts:26

---

childProcess

• childProcess: Process

Inherited from

SubProcess.childProcess

Defined in

elements/Tasks.ts:238

Accessors

processId

• get processId(): any

Returns

any

Inherited from

SubProcess.processId

Defined in

elements/Node.ts:27

---

loopDefinition

• get loopDefinition(): any

Returns

any

Inherited from

SubProcess.loopDefinition

Defined in

elements/Node.ts:138

---

isCatching

• get isCatching(): boolean

Returns

boolean

Inherited from

SubProcess.isCatching

Defined in

elements/Node.ts:142

---

canBeInvoked

• get canBeInvoked(): boolean

Returns

boolean

Inherited from

SubProcess.canBeInvoked

Defined in

elements/Tasks.ts:240

---

requiresWait

• get requiresWait(): boolean

Returns

boolean

Overrides

SubProcess.requiresWait

Defined in

elements/Transaction.ts:15

---

isTransaction

• get isTransaction(): boolean

Returns

boolean

Defined in

elements/Transaction.ts:22

Methods

restored

▸ restored(item): void

Parameters

Name	Type
item	Item

Returns

void

Inherited from

SubProcess.restored

Defined in

elements/Element.ts:24

---

hasBehaviour

▸ hasBehaviour(name): boolean

respond by providing behaviour attributes beyond item and node information ex: timer due , input/outupt , fields

Parameters

Name	Type
name	any

Returns

boolean

Inherited from

SubProcess.hasBehaviour

Defined in

elements/Element.ts:34

---

getBehaviour

▸ getBehaviour(name): any

Parameters

Name	Type
name	any

Returns

any

Inherited from

SubProcess.getBehaviour

Defined in

elements/Element.ts:38

---

addBehaviour

▸ addBehaviour(nane, behavriour): void

Parameters

Name	Type
nane	any
behavriour	any

Returns

void

Inherited from

SubProcess.addBehaviour

Defined in

elements/Element.ts:41

---

validate

▸ validate(item): Promise\<void>

Parameters

Name	Type
item	Item

Returns

Promise\<void>

Inherited from

SubProcess.validate

Defined in

elements/Node.ts:45

---

doEvent

▸ doEvent(item, event, newStatus?, eventDetails?): Promise\<any[]>

Parameters

Name	Type	Default value
item	Item	undefined
event	EXECUTION_EVENT	undefined
newStatus	ITEM_STATUS	null
eventDetails	Object	{}

Returns

Promise\<any[]>

Inherited from

SubProcess.doEvent

Defined in

elements/Node.ts:58

---

setInput

▸ setInput(item, input): Promise\<void>

is Called after execution transform data using input rules todo

Parameters

Name	Type
item	Item
input	any

Returns

Promise\<void>

Inherited from

SubProcess.setInput

Defined in

elements/Node.ts:94

---

getInput

▸ getInput(item, input): Promise\<{}>

Parameters

Name	Type
item	Item
input	any

Returns

Promise\<{}>

Inherited from

SubProcess.getInput

Defined in

elements/Node.ts:104

---

getOutput

▸ getOutput(item): Promise\<{}>

transform data using output rules todo

Parameters

Name	Type
item	Item

Returns

Promise\<{}>

Inherited from

SubProcess.getOutput

Defined in

elements/Node.ts:118

---

enter

▸ enter(item): void

Parameters

Name	Type
item	Item

Returns

void

Inherited from

SubProcess.enter

Defined in

elements/Node.ts:122

---

execute

▸ execute(item): Promise\<void | wait | end | error | abort>

this is the primary exectuion method for a node

considerations: the following are handled by Token 1. Loops we are inside a loop already (if any) 2. Gatways 3. Subprocess the parent node is fired as normal run method will fire the subprocess invoking a new token and will go into wait

Parameters

Name	Type
item	Item

Returns

Promise\<void | wait | end | error | abort>

Inherited from

SubProcess.execute

Defined in

elements/Node.ts:152

---

continue

▸ continue(item): Promise\<void>

Parameters

Name	Type
item	Item

Returns

Promise\<void>

Inherited from

SubProcess.continue

Defined in

elements/Node.ts:232

---

run

▸ run(item): Promise\<NODE_ACTION>

Parameters

Name	Type
item	Item

Returns

Promise\<NODE_ACTION>

Inherited from

SubProcess.run

Defined in

elements/Node.ts:247

---

cancelEBG

▸ cancelEBG(item): Promise\<void>

Parameters

Name	Type
item	any

Returns

Promise\<void>

Inherited from

SubProcess.cancelEBG

Defined in

elements/Node.ts:251

---

cancelBoundaryEvents

▸ cancelBoundaryEvents(item): Promise\<void>

Parameters

Name	Type
item	any

Returns

Promise\<void>

Inherited from

SubProcess.cancelBoundaryEvents

Defined in

elements/Node.ts:259

---

resume

▸ resume(item): void

is called by the token after an execution resume for every active (in wait) item different than init, which is called for all items

Parameters

Name	Type
item	Item

Returns

void

Inherited from

SubProcess.resume

Defined in

elements/Node.ts:336

---

init

▸ init(item): void

Parameters

Name	Type
item	Item

Returns

void

Inherited from

SubProcess.init

Defined in

elements/Node.ts:339

---

getOutbounds

▸ getOutbounds(item): Item[]

Parameters

Name	Type
item	Item

Returns

Item[]

Inherited from

SubProcess.getOutbounds

Defined in

elements/Node.ts:344

---

startBoundaryEvents

▸ startBoundaryEvents(item, token): Promise\<void>

Parameters

Name	Type
item	any
token	any

Returns

Promise\<void>

Inherited from

SubProcess.startBoundaryEvents

Defined in

elements/Node.ts:363

---

describe

▸ describe(): any[]

Returns

any[]

Inherited from

SubProcess.describe

Defined in

elements/Node.ts:374

---

end

▸ end(item, cancel?): Promise\<void>

Parameters

Name	Type	Default value
item	any	undefined
cancel	Boolean	false

Returns

Promise\<void>

Overrides

SubProcess.end

Defined in

elements/Transaction.ts:17

---

Cancel

▸ Cancel(transaction): Promise\<void>

Cancel Transaction is called by Throw Cancel Event

1. Aborts any started items in the transaction
2. Compensate any completed items

Parameters

Name	Type
transaction	any

Returns

Promise\<void>

Defined in

elements/Transaction.ts:32

---

Compensate

▸ Compensate(transItem): Promise\<void>

Compensate Transaction is called by Throw Compensate Event this is called outside of the transaction

1. Compensate any completed items

Parameters

Name	Type
transItem	any

Returns

Promise\<void>

Defined in

elements/Transaction.ts:45

---

getNodes

▸ getNodes(): Node[]

Returns

Node[]

Defined in

elements/Transaction.ts:87

---

getItemsForToken

▸ getItemsForToken(token): any[]

Parameters

Name	Type
token	any

Returns

any[]

Defined in

elements/Transaction.ts:91

---

getItems

▸ getItems(item): any[]

Parameters

Name	Type
item	any

Returns

any[]

Defined in

elements/Transaction.ts:105

---

start

▸ start(item): Promise\<NODE_ACTION>

Parameters

Name	Type
item	any

Returns

Promise\<NODE_ACTION>

Overrides

SubProcess.start

Defined in

elements/Transaction.ts:110