Monitor Workflows
You can monitor workflows on the Execution Statistics view on the Monitor tab.
You can view information about workflow instances that run from a workflow in a deployed application. To monitor a workflow, expand an application in the Navigator and select the Workflows folder. A list of workflow instances appears in the contents panel. The contents panel shows properties about each workflow instance, such as the name, state, start time, and recovery properties of each workflow instance. If the workflow instance ran on a grid, the contents panel shows the node that ran each mapping in the workflow instance.
Select a workflow instance in the contents panel to perform the following tasks:
- •View logs for the workflow instance.
- •View the context of the workflow instance to view other workflow instances that started around the same time as the selected workflow instance.
- •Cancel or abort the workflow instance.
- •Recover the interrupted workflow instance.
Expand a workflow instance to view properties about the workflow objects.
Workflow Graph
You can view the details of a workflow that you run in the Monitoring tool in a graphical form.
After you run a workflow, you can see the graphical view of the workflow in the Monitoring tool. In the workflow graph, you can see the sequential run of the mapping tasks in the workflow. The workflow graph enables you to view the failure points in a workflow at a glance.
In the workflow graph, you can view the following details of a workflow:
- •Mapping tasks in the workflow
- •Task details
- •Recovery details
You can perform the following tasks from the workflow graph:
- •Abort a running workflow
- •Cancel a running workflow
- •Recover a failed workflow
- •View the workflow logs
Viewing a Workflow Graph
You can view a workflow graph that shows the sequential run of the mapping tasks in the workflow.
1. Click the Execution Statistics view.
2. In the Domain Navigator, expand an application.
3. Select the Workflows folder.
A list of workflows appears in the contents panel.
4. Select the workflow that you want to view.
5. Click Actions > View Workflow Graph.
The workflow graph appears in a new window.
View Workflow Objects
When you expand a workflow instance in the contents panel, you can view properties about workflow objects, such as the name, state, start time, and elapsed time for the object.
Workflow objects include events, tasks, and gateways. When you monitor workflows, you can monitor the tasks that run in a workflow instance. The Monitor tab does not display information about events or gateways in the workflow instance.
If an expression in a conditional sequence flow evaluates to false, the Data Integration Service does not run the next object or any of the subsequent objects in that branch. The Monitor tab does not list objects that do not run in the workflow instance. When a workflow instance includes objects that do not run, the instance can still successfully complete.
You can expand a task in the contents panel to view information about the work item run by the task. For example, if the workflow contains a mapping task, you can view throughput and resource usage statistics for the mapping run.
Viewing Summary Statistics for Workflow Objects
You can view throughput and resource usage statistics for mapping objects in workflows that run in separate local processes.
1. Click the Execution Statistics view.
2. In the Domain Navigator, expand a Data Integration Service.
3. Expand an application and select the Workflows folder.
A list of workflows appears in the contents panel.
4. Expand a workflow that contains a mapping object.
5. Expand the mapping task and select the mapping.
6. In the details panel, click the Summary Statistics view.
The Summary Statistics view displays throughput and resource usage statistics for the source and target.
Optionally, you can sort the statistics in ascending or descending order. Click a column header to sort the column in ascending order. Click the column header again to sort the column in descending order.
Viewing Detailed Statistics for Workflow Objects
You can view graphs of the throughput and resource usage for mapping objects in workflows that run in separate local processes. Detailed statistics appear for jobs that run longer than one minute.
1. Click the Execution Statistics view.
2. In the Domain Navigator, expand a Data Integration Service.
3. Expand an application and select the Workflows folder.
A list of workflows appears in the contents panel.
4. Expand a workflow that contains a mapping object.
5. Expand the mapping task and select the mapping.
6. Click the Detailed Statistics view in the details panel.
The Detailed Statistics view displays the throughput graph and resource usage graphs.
Optionally, you can complete the following tasks in the Detailed Statistics view:
Task | Description |
|---|
Enlarge a graph | Move the cursor over a graph, and then click the magnifying glass icon. |
Enlarge a section of an enlarged graph | Drag the cursor to select an area to enlarge. |
Switch between rows and bytes in the throughput graph | Click the Bytes option or the Rows option. |
Choose which statistics are plotted on the throughput graph | In the throughput field, select the sources and targets that you want to view. |
Workflow States
When you monitor a workflow instance, you can view the state of the workflow instance. If a workflow instance recovers after a task is interrupted, the Monitor adds an entry for the task instance that runs in the recovered workflow.
A workflow instance can have one of the following states:
- Aborted
A workflow instance aborts when you choose to abort the workflow instance from the Monitoring tool or using the infacmd wfs abortWorkflow command. You can also choose to abort a running workflow instance when you stop the application that contains the workflow or when you disable the workflow in the application.
Note: A workflow instance also aborts if the active sequence flow in the workflow reaches a Terminate event.
- Canceled
You choose to cancel the workflow instance from the Monitor tab or by using the infacmd wfs cancelWorkflow command.
The workflow can also enter a canceled state if the Data Integration Service shuts down unexpectedly. If the workflow is not configured for automatic recovery, the service process changes the workflow instance state to Canceled when the service process restarts. Before the Data Integration Service restarts, the workflow state and the task state appear as Running, although the workflow and the task are no longer running. If the workflow is configured for automatic recovery, the service process recovers the workflow instance and reruns the interrupted task when the service process restarts. The service process sets the workflow instance state to Running.
- Completed
The Data Integration Service successfully completes the workflow instance. A completed workflow instance might indicate that all tasks, gateways, and sequence flow evaluations either successfully completed or were in a branch that did not run.
A workflow can also enter a Completed state if a Command, Mapping, Notification, or Human task encounters a recoverable error or nonrecoverable error. When the task encounters the error, the Data Integration Service fails the task. The Data Integration Service runs subsequent workflow objects if expressions in the conditional sequence flows evaluate to true or if the sequence flows do not include conditions. If the workflow instance finishes running without another interruption, the Data Integration Service updates the workflow state to Completed.
When the task fails, the Data Integration Service continues to run additional objects in the workflow instance if expressions in the conditional sequence flows evaluate to true or if the sequence flows do not include conditions. If the workflow instance finishes running without another interruption, the Data Integration Service updates the workflow state to completed. A completed workflow instance can contain both failed and completed tasks.
- Failed
A workflow instance fails when a workflow error occurs. Workflow errors can occur when the Data Integration Service reads the parameter file at the start of the workflow run, copies workflow parameter and variable values to task input, or evaluates expressions in conditional sequence flows. In addition, a workflow error occurs if an Assignment task or a gateway fails.
When a workflow error occurs, the Data Integration Service stops processing additional objects and fails the workflow instance immediately. Workflow errors are nonrecoverable.
- Running
The Data Integration Service is running the workflow instance.
Workflow Object States
Workflows include tasks and gateways. When you monitor a workflow instance, you can view the state of the tasks that run in the workflow instance.
Tasks can have one of the following states:
- Aborted
- A task aborts in the following situations:
- - The task encounters an nonrecoverable error.
- - You abort the workflow instance.
When you abort the workflow instance, the Data Integration Service first aborts the task and then aborts the workflow instance.
If you choose to abort the workflow instance while an Assignment task is running, the Data Integration Service completes running the task. The Data Integration Service then aborts the workflow instance and does not start running other objects.
- Completed
- The Data Integration Service successfully completes the task.
- Failed
A task fails in the following situations:
- - Any task in a workflow not enabled for recovery encounters any type of error.
- - An Assignment task in a workflow enabled for recovery encounters any type of error.
- - A Command, Mapping, Notification, or Human task with a restart recovery strategy in a workflow enabled for recovery encounters a non recoverable error.
- - A Mapping task with a skip recovery strategy in a workflow enabled for recovery encounters any type of error.
Note: A workflow can complete if a task fails. The Data Integration Service runs subsequent workflow objects if expressions in the conditional sequence flows evaluate to true or if the sequence flows do not include conditions. If the workflow instance finishes running without another interruption, the Data Integration Service updates the workflow state to Completed.
- Running
- The Data Integration Service is running the task.
Mapping Task Work Item States
When you expand a Mapping task, you can view the state of the mapping run. When you expand a restarted Mapping task, you can view the mapping jobs run for each recovery attempt of the workflow instance. If a workflow instance recovers after a Mapping task is interrupted, the Monitor adds an entry for the task instance that runs in the recovered workflow.
You can also view the state of the mapping run from the workflow graph of the workflow that contains the mapping task.
Mappings run by a Mapping task can have one of the following states:
- Aborted
The Mapping task aborts while the mapping is running because you choose to abort the workflow instance.
- Completed
- The Data Integration Service successfully completes the mapping.
- Failed
- The mapping encounters an error. The mapping and the Mapping task appear as Failed in the Monitor. The states do not depend on the Mapping task recovery strategy.
- Running
- The Data Integration Service is running the mapping.
Canceling or Aborting a Workflow
You can cancel or abort a workflow instance at any time. You might want to cancel or abort a workflow instance that stops responding or that is taking an excessive amount of time to complete.
When you cancel a workflow instance, the Data Integration Service finishes processing any running task and then stops processing the workflow instance. The service does not start running any subsequent workflow objects.
When you abort a workflow instance, the Data Integration Service attempts to kill the process on any running task. If an Assignment task or a gateway is running, the Data Integration Service completes the task or gateway. After the task aborts or completes, the service aborts the workflow instance. The service does not start running any subsequent workflow objects.
You can also cancel or abort a workflow from the workflow graph.
1. Click the Execution Statistics view.
2. In the Navigator, expand a Data Integration Service.
3. Expand an application and select Workflows.
A list of workflow instances appears in the contents panel.
4. Select a workflow instance.
5. Click Actions > Cancel Selected Workflow or Actions > Abort Selected Workflow.
Workflow Recovery
Workflow recovery is the completion of a workflow instance from the point of interruption.
When a workflow is enabled for recovery, you can recover a workflow instance if a task encounters a recoverable error, if you cancel the workflow instance, or if the Data Integration Service process shuts down unexpectedly.
View the workflow log to identify the cause of the interruption. After fixing any recoverable errors, you can recover the interrupted workflow instance if it is enabled for recovery.
You cannot change a workflow definition between the interrupted run and the recovery run. If a workflow instance has a recoverable state and you change the workflow metadata in the Developer tool and redeploy the application that contains the workflow, then the workflow instance is no longer recoverable.
The Data Integration Service tries to recover the previous workflow state if the service restarts after an unexpected shutdown. By default, the Data Integration Service does not recover a workflow instance that stopped during a Command task, Mapping task, or Notification task. In addition, the Data Integration Service cannot recover a workflow instance by default if you cancel the workflow instance or cancel a running task in the workflow instance. You can configure the recovery options on the workflow to enable the Data Integration Service to recover a workflow instance in such cases.
When you configure the workflow options, you can configure the workflow for manual recovery or automatic recovery. If you configure automatic recovery, the Data Integration Service restarts the workflow from the point of interruption without any human interaction. If you configure manual recovery, you can restart the workflow.
When a workflow instance recovers or when you recover a workflow instance, the Data Integration Service restarts the task. The service continues processing the subsequent workflow objects. If a workflow instance recovers after a task is interrupted, the Monitor adds an entry for the task instance that runs in the recovered workflow. For example, if a workflow recovers three times and restarts a Mapping task each time, the Monitor contains three entries for the Mapping task.
Recovery Properties
The read-only recovery properties display for each workflow instance. You configure the recovery properties for the workflow definition in the Developer tool. You cannot change the values of the properties for the workflow instance.
The following table describes the read-only recovery properties for a workflow instance:
Property | Description |
|---|
Recovery Enabled | Indicates that the workflow is enabled for recovery. |
Automatically Recover Workflows | Indicates that the Data Integration Service process tries to automatically recover workflow instances that were interrupted. The workflow recovery starts after the Data Integration Service process restarts. |
Recovering a Workflow
You can recover interrupted workflow instances that are enabled for recovery.
1. Click the Execution Statistics view.
2. In the Domain Navigator, expand a Data Integration Service.
3. Expand an application and select Workflows.
A list of workflow instances appears in the contents panel.
4. Select the interrupted workflow instance that you want to recover.
5. Click Actions > Recover Selected Workflow.
Monitor the state of the workflow recovery run in the contents panel.
Workflow Logs
The Data Integration Service generates log events when you run a workflow. Log events include information about workflow errors, task progress, and the setting of workflow variables. Log events also include the analyses of the links that the Data Integration Service evaluates in a sequence flow.
If a workflow instance includes a Mapping task, the Data Integration Service generates a separate log file for the mapping. The mapping log file includes any errors encountered during the mapping run and load summary and transformation statistics.
You can view the workflow and mapping logs from the Monitor tab.
When you recover an interrupted workflow instance, the Data Integration Service appends log events to the current workflow log. When the recovered workflow instance includes a Mapping task that is restarted, the Data Integration Service creates a mapping log.
If the workflow runs on a grid, the recovery of the workflow instance might run on a different node than the original workflow instance run. If the recovery runs on a different node and the log directory is not in a shared location, the Data Integration Service creates a log file with the same name on the current node.
Workflow Log Information
The information in the workflow log file represents the sequence of events that occur when the workflow runs.
The Data Integration Service writes information to the workflow log when the following types of event occur:
- •The Data Integration Service starts to run a task or another object in the workflow.
- •A task or another object in the workflow is in progress.
- •The Data Integration Service finishes running a task or another object in the workflow.
- •The Data Integration Service sets or updates a workflow variable.
- •The Data Integration Service evaluates the links in a sequence flow and identifies the correct path for the workflow process.
- •The workflow encounters a workflow error.
Viewing Logs for a Workflow
You can download the log for a workflow instance to view the workflow instance details.
1. In the Administrator tool, click the Monitor tab.
2. Click the Execution Statistics view.
3. In the Domain Navigator, expand a Data Integration Service.
4. Expand an application and select Workflows.
A list of workflow instances appears in the contents panel.
5. Select a workflow instance.
6. Click Actions > View Logs for Selected Object.
A dialog box appears with the option to open or save the log file.
Viewing Logs for a Mapping Run in a Workflow
You can download the log for a mapping run in a workflow to view the mapping details.
1. Click the Execution Statistics view.
2. In the Domain Navigator, expand a Data Integration Service.
3. Expand an application and select Workflows.
A list of workflow instances appears in the contents panel.
4. Expand a workflow instance.
5. Expand a Mapping task, and then select the mapping run by the task.
6. Click Actions > View Logs for Selected Object.
A dialog box appears with the option to open or save the log file.