Monitor and Troubleshoot a Workflow

Knowledge Center > Workflow > Using Workflow > Monitor and Troubleshoot a Workflow

Monitor and Troubleshoot a Workflow

You can monitor the statuses of workflow runs and tasks from the Run History and Tasks tabs. For each task in the Tasks tab, you can use the Swimlane tool to perform diagnosis, adjust parameters, and rerun the task. 

The Run History and Tasks tabs are also available on the home page of Workflow, where these two tabs display run histories and tasks for all workflows.

Workflow Runs

A workflow run is an execution of a workflow. Each workflow run is identified by a unique ID.

The Run History tab shows a list of workflow runs. 

workflows_run_history.png

Click a workflow link to go to the workflow editing page.

Click a run number link to view the tasks included in that run and the statuses of the tasks. 

Using the action menu workflow_menu_icon.png in each row, you can delete a finished run or stop a processing run.

Task Status

The Tasks tab displays a list of running or finished tasks. Use this tab to monitor the statuses of tasks and perform troubleshooting if necessary.

The tasks displayed in the list are task instances in workflow runs. If the same task is included in more than one workflow runs, multiple entries of the task will be displayed in the list.

workflows_tasks.png

The Error Code and Error Details fields provide additional information about errors, which can be useful in the initial error diagnosis.

The action menu for a task includes these possible actions:

  • Swimlane - A diagnosis and troubleshooting tool.
  • Files - View the files that are generated in this task. It can be CSV files in a data export task or email files in an email task, or other types of files.
  • Delete - Delete a task instance.
  • Rerun - Rerun a failed task instance.

Troubleshooting

Click Swimlane from the action menu of a task to start the Swimlane tool. With Swimlane, you can adjust parameters or configurations and rerun a task instance. 

In Swimlane, a failed task is beating like a heart. Click a task to show the configuration options. 

workflow_swimlane.png

The lower-left panel shows the data payload of this task. Expand an item to view the details.

The Info panel shows the associated workflow name, run number, task status, a brief error summary (if applicable), as well as two configuration buttons, Workflow Task Config and Instance Config.

  • Click Workflow Task Config to edit the task. The changes are saved to the task and will be picked up in the next workflow run.
  • Click Instance Config to edit the task instance. The changes are only saved to the task instance. Click Rerun to verify whether the errors are fixed. Use this button to test possible configurations. When a solution is found, you can apply the same changes to the task. 

The API Calls panel shows all the API calls that are performed in the task. Click an ID to view the complete request and response of the API call. 

workflow_api_call.png

If the task fails, the backtrace information will be displayed in the Error Details panel at the bottom of the page.

If you need further support troubleshooting workflows, contact your Engagement Manager or Zuora Global Support. The backtrace and the API call information can be useful in further troubleshooting. 

Last modified

Tags

Classifications

(not set)