Building

Executed

Hold

A workflow that is in the Idle state and is being imported either by the mzsh systemimport r | sr | sir | wr or by the System Importer configured to Hold Execution, enters the Hold state until the import activity is finished. The Workflow group then resumes its Idle state.

Idle

Invalid

Loading

The platform is uploading the workflow to the Execution Context. When the transfer is complete, the Execution Context initializes the agents. When the workflow starts running the state changes to Running.

Running

The workflow is currently executing.

Unreachable

If the Platform fails to establish a connection with the EC where a workflow is executing, the workflow enters the unreachable state. When the workflow server successfully reestablishes the connection, the workflow is marked as Running, Aborted, or Executed, depending on the state that the workflow is in. An Unreachable workflow may require manual intervention if the workflow is not running any moreanymore. For further information see Execution Context in Desktop User's Guide.

Waiting

The Waiting state applies only to workflows that are included as members in a workflow group. In the Waiting state, the workflow cannot start execution due to two parameters in the workflow group configuration: The Startup Delay parameter, and the Max Simultaneous Running quota. A workflow in the Waiting state will change to Running when triggered either by a user, the scheduling criteria of its parent workflow group, or by a more distant ancestor's scheduling criteria. For further information see Scheduling. 

Created

The agent is starting up. No data may be received during this phase. This state only exists for a short while during workflow startup.

Idle

The agent is started, awaiting data to process. This state is not available for a real-time workflow.

Running

The agent has received data and is executing.

Stopped

The agent has successfully finished processing data.

Aborted

The agent has been terminated erroneously.

The error reason can be tracked either by double-clicking the agent or by examining the System Log.

initialize

The initialize state is entered once for each invocation of the workflow. During this phase, the workflow is being instantiated and all agents are set up according to their configuration.

beginBatch

This state is only applicable for batch workflows.

At every start of a new batch, the batch collection agent will emit a beginBatch call. All agents will then prepare for a new batch. This is normally done every time a new file is collected , but can differ depending on the collection agent.

consume

The agents will handle all incoming UDRs or bytearrays during the consume state.

drain

This state is only applicable for to batch workflows.

When all UDRs within a batch have been executed, the agents enter the drain state. This state can be seen as a final consume state with the difference that there is no incoming UDR or bytearray. The agent may however send additional information before the endBatch state.

endBatch

This state is only applicable for to batch workflows.

The collection agent will call for the endBatch state when all UDRs or the byte arrays have been transferred into the workflow. This is normally done at the file end, but is dependent on the collection agent or when a hintEndBatch call is received from any agent capable of utilizing the APL code.

commit

This state is only applicable for to batch workflows.

Once the batch is successfully processed or sent to ECS, the commit state is entered. During this phase, all actions that concern transaction safety are executed.

deinitialize

This is the last execution state for each workflow invocation. The agents clean and release resources, such as memory and ports, and stop execution.

cancelBatch

rollback

This state is only applicable for to batch workflows.

If the last execution of the workflow is aborted, the agents will enter the rollback execution state right after the initialize state. The agents will recover the state prior to the failing transaction and then enter beginBatch or deinitialize depending on if there are additional batches to process.