Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt

The Workflow Monitor controls workflow execution and presents a detailed view of the workflow execution status. 

Agent states and events can be monitored during workflow execution.

...

State

Description

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 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 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 APL code.

commit

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

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 will define how the workflow should act. For more information regarding the Workflow Properties, see Error Tab in Workflow Properties.

Note
titleNote!

The execution states cancelBatch and endBatch are mutually exclusive - only one per batch can be executed.


rollback

This state is only applicable for batch workflows.

If the last execution of the workflow 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.


Viewing Abort Reasons

In most cases if a workflow has aborted, one of its agents will have a red square outline surrounding it. Double-clicking such an agent will display the Agent Status dialog containing the abort reason. The System Log also holds valid information for these cases.

...


StateDescription

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. For agents that are running, there will be a green square outline surrounding the agents.

Stopped

The agent has successfully finished processing data.

Aborted

The agent has terminated erroneously. For an agent that has aborted, there will be 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.


Agent Configuration

Some agents allows parts of them to be reconfigured while active. When double-clicking the agent in monitor mode, the agent's configuration is shown in the displayed dialog if the agent can be reconfigured. When the configuration has been updated it can be committed to the active workflow using the Dynamic Update button in the toolbar.

...