Skip to content

Activity.md

Latest commit

 

History

History
222 lines (156 loc) · 8.24 KB

Activity.md

File metadata and controls

222 lines (156 loc) · 8.24 KB
Raw

Activity

Shared activity behaviour.

Activity lifecycle

All activities except EventBasedGateway share this lifecycle. The EventBasedGateway takes care of it's own outbound in the Behaviour.

Activity lifecycle

new Activity(Behaviour, activityDefinition, context)

Arguments:

  • Behaviour: activity Behaviour function, called with new
  • activityDefinition: activity definition object from serializable context
  • context: shared context

Activity properties:

  • id: activity id
  • type: activity type
  • name: activity name
  • attachedTo: if this is a BoundaryEvent, the activity instance it is attached to; otherwise null
  • Behaviour: passed activity Behaviour function, invoked with new
  • behaviour: activity behaviour from serializable context
  • bpmnIo: BpmnIO extension if present
  • broker: activity broker
  • counters: counters for completed runs etc
  • environment: shared environment
  • eventDefinitions: list of event definition instances
  • execution: getter for current execution instance
  • executionId: current unique execution id
  • extensions: object with extensions
  • formatter: per-activity formatter that resolves pending format messages
  • inbound: list of inbound sequence flows
  • initialized: boolean indicating that the activity has been initialized (init called)
  • isCatching: boolean indicating that the activity is a catching event
  • isConvergingGateway: boolean indicating that the activity is a parallel or inclusive gateway with more than one incoming sequence flow, converging by monitoring its upstream peers
  • isEnd: boolean indicating that the activity has no outbound sequence flows
  • isForCompensation: boolean indicating that the activity is for compensation
  • isMultiInstance: boolean indicating that the activity has loop characteristics
  • isParallelGateway: boolean indicating if the activity is a parallel gateway
  • isParallelJoin: deprecated, use isConvergingGateway combined with isParallelGateway. Boolean indicating if the activity is a parallel gateway with inbound flows from more than one source activity
  • isRunning: boolean indicating if the activity is running
  • isStart: boolean indicating if the activity a start activity
  • isSubProcess: boolean indicating if the activity is a sub process
  • isThrowing: boolean indicating that the activity is a throwing event
  • isTransaction: boolean indicating that the activity is a transaction
  • logger: activity logger instance
  • outbound: list of outbound sequence flows
  • parent: activity parent
    • id: id of parent
    • type: parent type
  • parentElement: activity parent process or sub process reference
  • lane: activity lane reference if any
  • status: current run status
    • entered: Run entered, triggered by taken inbound flow
    • started: Run started
    • executing: Executing activity behaviour
    • executed: Activity behaviour execution completed successfully
    • end: Run end, take outbound flows
    • discard: Entering discard run, triggered by discarded inbound flow
    • discarded: Run was discarded, discard outbound flows
    • error: Activity behaviour execution failed, discard run
    • formatting: Formatting next run message
  • stopped: boolean indicating if the activity is in a stopped state
  • triggeredByEvent: boolean indicating that the activity (sub process) is triggered by an event

activate()

Start listening on inbound sequence flow(s) events.

deactivate()

Stop listening for inbound sequence flow(s) events.

discard()

Discard activity. If the activity is running - discard run.

getApi(message)

Get activity api.

Arguments:

  • message: activity broker message

Returns activity api

getActivityById(id)

Get activity by id from context.

getState()

Get activity state. If environment.settings.disableTrackState === true the state may be undefined if the task is not running.

init([initContent])

Initialize the activity without running. Publishes an activity.init event with an execution id reserved for the next run, and queues a non-persistent activity.init message on the activity's inbound queue. When the inbound queue is consumed the activity runs with that reserved id. This is how start activities and link catch events are armed.

Arguments:

  • initContent: optional object merged into the init message content
  • properties: optional message properties merged into the queued inbound message

addInboundListeners()

Subscribe to inbound sequence flow events. Called internally from activate() and rarely needs to be called directly.

removeInboundListeners()

Unsubscribe from inbound sequence flow events. Counterpart to addInboundListeners().

shake()

Walk outbound sequence flows for shake analysis. Used to discover reachable flows from this activity.

next()

Take next message in run-queue. Only appears if environment settings have step: true.

on(eventName, handler[, eventOptions])

Listen for events.

Arguments:

  • eventName: name of event
  • handler: required function called when events occur
  • eventOptions: passed to underlying broker as consume options

once(eventName, handler[, eventOptions])

Listen for event.

Arguments:

  • eventName: name of event
  • handler: required function called when event occur
  • eventOptions: passed to underlying broker as consume options

recover(state)

Recover activity from state.

resume()

Resume recovered or stopped activity.

run([runContent])

Run activity.

Arguments:

  • runContent: optional object containing extra content for the broker run messages.

stop()

Stop activity run.

waitFor(eventName[, onMessage])

Wait for event to occur as promised.

Arguments:

  • eventName: name of event
  • onMessage: optional message callback for event filtering purposes. Return false if the promise should not resolve. Called with the following arguments:
    • routingKey: broker message routing key
    • message: actual message that match event name
    • owner: message owner, in this case probably the actual activity instance

Returns Promise that will resolve with activity api on event name or reject on error.

evaluateOutbound(brokerMessage, discardRestAtTake, callback)

Evaluate all outbound sequence flows.

Arguments:

  • brokerMessage: broker message that will be passed to condition
  • discardRestAtTake: boolean, discard all other outbound flows if one flow is taken
  • callback: function with signature, (err, outbound)
    • err: occasional error
    • outbound: list with flow actions, i.e. discard or take
      • id: outbound flow id
      • action: discard or take as string
      • isDefault: boolean indicating if flow is default flow
      • result: result of condition
      • message: optional message passed from argument brokerMessage.content.message