Skip to content

Sub Process Activity

The Sub Process activity defines a graphical object within a larger process. It encapsulates a collection of activities, gateways, events, and sequence flows, and can also contain nested sub processes.

Field Description Requirement
Exclusive When enabled, this sub process ensures jobs run in sequential order upon receiving a specific process example. Optional
Data objects Defines the data objects for the process or sub process. Each data object is initialized as a process variable under its defined name. Optional
Execution listeners Configures listeners that trigger at the start and end of the activity's execution lifecycle. Optional
Multi-instance type Determines if multiple instances of this activity are created. Options include None, Parallel, or Sequential. Optional
Cardinality (Multi-instance) An expression or numeric integer value that specifies the exact number of instances to create when Multi-instance type is configured. Optional
Collection (Multi-instance) Defines a collection whose elements determine the number of instances. A new instance is created for each element in the collection. Optional
Element Variable (Multi-instance) The variable name under which each element from the Collection is made available to its newly created instance. Optional
Completion Condition (Multi-instance) An expression that, when evaluated to true, stops the creation of new instances for a multi-instance configuration. Optional
Is a transaction sub process Identifies whether this sub process functions as a transaction. A BPMN transaction groups activities logically and can be canceled via a Cancel End Event or handled by a Cancel Intermediate Boundary Event. Optional
Element index variable The variable name used as a counter for multi-instance characteristics. Optional

Action Types & Examples

Start

  • Format: Event Trigger
  • Example Result: Start

End

  • Format: Event Trigger
  • Example Result: End

Take

  • Format: Event Trigger
  • Example Result: Take

None

  • Format: Multi-instance Type (Enum)
  • Example Result: None

Parallel

  • Format: Multi-instance Type (Enum)
  • Example Result: Parallel

Sequential

  • Format: Multi-instance Type (Enum)
  • Example Result: Sequential

Implementation Examples

Field Setup - Cardinality (Multi-instance): ${number} - Cardinality (Multi-instance): 2 - Collection (Multi-instance): 2 - Element Variable (Multi-instance): elementvar - Completion Condition (Multi-instance): true - Completion Condition (Multi-instance): ${variable==True} - Completion Condition (Multi-instance): ${dataCount==0} - Completion Condition (Multi-instance): ${dataExists=="true"} - Element index variable: Counter1

Execution Parameters - Execution Listener selection: Start - Execution Listener selection: End - Execution Listener selection: Take - Multi-instance Type selection: None - Multi-instance Type selection: Parallel - Multi-instance Type selection: Sequential

Technical Notes

A Sub-Process can only have one none start event; no other start event types are allowed. A Sub-Process must at least have one end event.