A Receive Task waits for the arrival of an external trigger. This trigger is sent programmatically (via Java or REST API). For process to process triggering, use the signal events.
A receive task is visualized as a rounded rectangle with an envelope icon in the top-left corner.
| Property | Description |
|---|---|
|
Id |
A unique identifier for this element. |
|
Name |
A name for this element. |
|
Documentation |
A description of this element. |
|
Variables |
When the API is used to trigger the continuation of the process instance, a set of variables can be passed. However, these won’t appear automatically in drop-down lists later (like the sequence flow condition builder, forms, and so on.). To make them appear, this property needs to be configured with those variables that are set or exported by the script task. |
|
Asynchronous |
(Advanced) Define this task as asynchronous. This means the task will not be executed as part of the current action of the user, but later. This can be useful if it’s not important to have the task immediately ready. |
|
Exclusive |
(Advanced) Define this task as exclusive. This means that, when there are multiple asynchronous elements of the same process instance, none will be executed at the same time. This is useful to solve race conditions. |
|
Execution listeners |
Execution listeners configured for this instance. An execution listeners is a piece of logic that is not shown in the diagram and can be used for technical purposes. |
|
Multi-Instance type |
Determines if this task is performed multiple times and how. For more information on multi-instance, see the Developer Guide. The possible values are:
|
|
Cardinality (Multi-instance) |
The number of times the task is to be performed. |
|
Collection (Multi-instance) |
The name of a process variable which is a collection. For each item in the collection, an instance of this task will be created. |
|
Element variable (Multi-instance) |
A process variable name which will contain the current value of the collection in each task instance. |
|
Completion condition (Multi-instance) |
A multi-instance activity normally ends when all instances end. You can specify an expression here to be evaluated each time an instance ends. If the expression evaluates to true, all remaining instances are destroyed and the multi-instance activity ends. |
|
Is for compensation |
If this activity is used for compensating the effects of another activity, you can declare it to be a compensation handler. For more information on compensation handlers see the Developer Guide. |