Script task

A task that is executed by a business process engine to mainly perform simple calculations or operations. When the task is ready to start, the engine executes the script, and marks it as completed when the script has finished.

To configure script tasks, you must provide a script in Groovy language.

Because each script task is independent, include import statements for all the packages you are using in a script for each script task. Avoid using generic imports to reduce execution time.

Do not use script tasks to declare methods that a subsequent script task would use. Groovy compiles and temporarily caches the script at execution time. If you call the method in a subsequent script tasks:
  • The cached method might not be available anymore.
  • Even if the method is available, it retains the cached values of variables, which might lead to unexpected results.

Use the groovy-lib folder to store scripts that are common to a large number of tasks.

In the context of workflow script tasks, the <Resource>Api interfaces (such as AssetApi, CommunityTypeApi, FileApi, and so on) are already instantiated and accessible via <resource>Api variables (such as assetApi, communityTypeApi, fileApi, and so on).

Attributes: General

Attribute Description
Model ID The unique identifier of the element within the process model.
Name The name of the element displayed in the diagram.
Documentation A description and any additional information about this element.

Attributes: Details

Attribute Description
Script A script that is executed when the task is activated.

Attributes: Execution

Attribute Description
Asynchronous When enabled, the activity will be started as an asynchronous job.
Execution listeners Allows you to invoke Java logic after certain events.
Skip expression Defines an expression which is evaluated before executing the task. If it evaluates to true, the task is skipped.

Attributes: Multi instance

Attribute Description
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 good practice for User Tasks.
  • MI sequential - activities are created sequentially. This is good practice for Service Tasks.
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.
Cardinality An expression or numeric value which determines how many instances are created.
Completion condition An expression which, if evaluated to true, stops the creation of new instances.

Attributes: Visual

Attribute Description
Font color The font color of the element in the diagram.
Font size The font size of the element in the diagram.
Font style The font style of the element in the diagram.
Font weight The font weight 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.