8.3.7. Multi-instance sub-process

MultipleInstances
Figure 21. Multi-instance sub-process

A Multiple Instance sub-process is a special kind of sub-process that allows you to execute the contained process segment multiple times, once for each element in a collection. A multiple instance sub-process should have one incoming connection and one outgoing connection. It waits until the embedded process fragment is completed for each of the elements in the given collection before continuing. It contains the following properties:

Id: The id of the node (which is unique within one node container).

Name: The display name of the node.

CollectionExpression: The name of a variable that represents the collection of elements that should be iterated over. The collection variable should be an array or of type java.util.Collection. If the collection expression evaluates to null or an empty collection, the multiple instances sub-process will be completed immediately and follow its outgoing connection.

VariableName: The name of the variable to contain the current element from the collection. This gives nodes within the composite node access to the selected element.

CollectionOutput: The name of a variable that represents collection of elements that will gather all output of the multi instance sub process

OutputVariableName: The name of the variable to contain the currentl output from the multi instance activitiy

CompletionCondition: MVEL expression that will be evaluated on each instance completion to check if given multi instance activity can already be completed. In case it evaluates to true all other remaining instances within multi instance activity will be canceled.