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 emits a beginBatch call. All agents then prepare for a new batch. This is normally done every time a new file is collected, but differs depending on the collection agent.

consume

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

drain

This state is only applicable for 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 batch workflows.

The collection agent calls for the endBatch state when all UDRs or the byte arrays are 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 APL code.

commit

This state is only applicable for batch workflows.

Once the batch is successfully processed or sent to the 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

This state is only applicable for batch workflows.

If an agent fails the processing of a batch it may emit a cancelBatch call and the setting in Workflow Properties defines how the workflow should act. For more information regarding the Workflow Properties, see Error Tab in Workflow Properties.

rollback

This state is only applicable for batch workflows.

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

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 workflows.

Running

The agent has received data and is executing. For agents that are running, there is a green square outline surrounding them.

Stopped

The agent has successfully finished processing data.

Aborted

The agent has terminated erroneously. For an agent that is aborted, there is a red square outline surrounding the aborted agent.

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