Toggle menu

Workflow Activities

Workflow API Server Task

API Server task

Calls an iCM API Server worker using the specified function name and parameters.

PropertyDescription
IDAn optional unique ID for this element. The modeller will assign a random ID if left blank
NameA name for this element
DescriptionAn optional description for this element
AsynchronousWhen execution reaches a task that has been marked as asynchronous the engine will commit the current transaction and schedule a background job to continue the process from the asynchronous task
Worker NameThe name of the worker. For example serverlibrary or ajaxlibrary. Worker names can be found in the API Server section of iCM Management
Function NameThe function to call on that worker. This could, for example, be the name of an End Point
Parameter VariableThe name of the variable that contains the parameters that should be passed to the worker and function. This will be a JSON object, usually set in a preceding script task
Return VariableThe process variable that any return from the activity will be stored in
Transient Return Variable?If enabled, the result will be stored as a transient process variable instead of a persistent one. Transient variables are not saved to the database or process history, and are only visible until the process reaches its next wait state
Error VariableThe process variable that any error will be stored in
Error HandlingThere are three possible error handling mechanisms:
  • None - whichever strategy is used, a process variable is set with a user-specified name "Error Variable" on the main properties tab. If an error transition or BPMN error is not specified, it is the responsibility of the workflow to determine that an error has occurred by checking this variable.
  • Follow error transition - an outgoing flow from the API Server Task is given a specific label which is also given as the Error Transition property on the advanced properties tab. If an error is returned from the API call this flow will be followed instead of the default flow (note that the "happy path" must be set to be the default flow for this to work).
  • Throw BPMN error - the BPMN error specified on the advanced tab is thrown when the API call returns an error. This can then be caught by an Boundary error event, or other error catching event

iCM API Server Data Task

API Server data task

Calls an iCM API Server data integration worker using the specified context name and parameters. Note that this task is not an official task of the BPMN 2.0 specification.

PropertyDescription
IDAn optional unique ID for this element. The modeller will assign a random ID if left blank
NameA name for this element
DescriptionAn optional description for this element
AsynchronousWhen execution reaches a task that has been marked as asynchronous the engine will commit the current transaction and schedule a background job to continue the process from the asynchronous task
Talend Worker NameThe name of the Talend worker to call
Context NameThe Talend context
Context VariablesA JSON object containing the context variables for the Talend Job
Return VariableThe process variable that any return from the activity will be stored in
Error VariableThe process variable that any error will be stored in
Error HandlingShould an error occur will it be ignored, follow the transition specified on the advanced tab (ie the ID of a sequence flow from the current activity), or throw a BPMN error which could be caught by a boundary error event
Prev:Workflow End Point TaskNext:Workflow History Task
Print entire document (opens new window)
Last modified on 30 September 2026