Call Activity

Call Activity
A Call Activity identifies a point in the Process where a global Process or a Global Task is used. The Call Activity acts as a 'wrapper' for the invocation of a global Process or Global Task within the execution. The activation of a call Activity results in the transfer of control to the called global Process or Global Task.
— BPMN 2.0.2 Standard, 10.3.6, Call Activity

BPMN 2.0 makes a distinction between a regular sub-process, often also called embedded sub-process, and the call activity, which looks very similar. From a conceptual point of view, both call a sub-process when the process execution arrives at the activity.

The difference is that the call activity references a process that is external to the process definition, whereas the sub-process is embedded within the original process definition. The main use case for the call activity is to have a reusable process definition that can be called from multiple other process definitions.

Attributes

Group Attribute Description

General

ID

The unique identifier of the element within the process model.

Name

The name of the element. This is the name displayed in the diagram.

Documentation

A description and additional information about this element.

Details

In same deployment

Set it to true if the referenced process should be referenced from within the same app deployment. Set it to false to always use the newest process definition.

Subprocess ref.

Reference of an existing process that is started globally when executing the activity.

Instance name

Name of the newly created process instance.

In

An optional input parameter map. Allows the mapping of parameters and variables which are then available in the newly created process.

Out

An optional output parameter map. Allows the mapping of parameters and variables onto the original Case Work Item as the Human task’s Work Item completes.

Inherit variables

Inherit parent process variables in the newly created process.

Business key

Business key of the newly created process instance. Can be an expression.

Inherit business key

Inherit the business key from the parent process.

Use local scope

Use local variable scope for out parameters.

Complete asynchronously

Executes the completion of the call activity in an exclusive asynchronous job. This is for example useful in combination with parallel multi-instance.

Fallback to default tenant

Indicates that the process instance is created with the default tenant if it is not available on the current tenant. if the application is running in a multi-tenant setup.

Is transaction

A BPMN transaction is a set of activities that logically belongs together. Transactions can be cancelled through the Cancel End Event and handled through the Cancel Intermediate Boundary Event.

Data objects

Defines the Data Objects of the process or subprocess. Each data object is initialized as a process variable under the defined name.

Transaction method

The technique that is used to undo a transaction that has been canceled.

Subprocess type

Subprocess type is an attribute that defines whether the sub-process details are embedded within the higher level process or refers (Reference) to another, re-usable process. The default is Embedded.

Execution listeners

Active Execution Listeners of the activity. This lets you react to the following events:

  • Start: Occurs when the activity is started.

  • End: Occurs when the activity is completed.

Asynchronous

When enabled, the activity is started as an asynchronous job. The process state is persisted before this element is executed. Then the process execution is resumed asynchroneously. This can be used when the execution of an activity takes a long time to return the user interface. However, if an error occurs before the following wait state, there is no direct user feedback.

Is for compensation

Determines whether the activity can serve as a compensation for another activity.

Multi instance

Multi instance type

Determines if multiple instances of this activity are created. There are three choices:

  • None (default, only one instance is created).

  • MI parallel (activities are created in parallel. This is a good practice for User Tasks).

  • MI sequential (activities are created sequentially. This is a good practice for Service Tasks).

Once a type other than None is chosen, the following options appear:

  • Collection: The number of instances is determined by the elements of a collection. For each element in the collection, a new instance is created.

  • Element variable: The variable under which each element is available to the newly created instance.

  • Element index variable: The variable under which the current number of iterations is stored.

  • Completion condition: An expression which, if it evaluated to true, stops the creation of new instances.

  • Cardinality: An expression or numeric value (integer) which determines how many instances are created.

Visual

Font weight

The font weight of the element in the diagram.

Font size

The font size of the element in the diagram.

Font color

The font color of the element in the diagram.

Font style

The font style of the element in the diagram.

Background color

The background color of the element in the diagram.

Border color

The border color of the element in the diagram.