Skip to main content

Workflow User Interface

Zuora

Workflow User Interface

  1. Last updated
  2. Save as PDF

When you start Workflow, you will see the landing page of Workflow.

Workflow_landingpage.png

The landing page of Workflow consists of six tabs.

  • Overview: The default tab of the landing page. It displays workflow and task information that is worth noting, including failed tasks, failed workflows, workflows of different priorities in the queue, and task usage metrics.
  • Workflows: Displays all workflows available in your Workflow instance. You can create, edit, run, and activate/deactivate workflows on this tab.
  • Run History: Displays all workflow runs. You can stop running workflow runs or delete completed workflow runs in this tab. For details about workflow runs, see Monitor and Troubleshoot a Workflow.
  • Tasks: Displays all task runs. You can delete completed task runs, rerun failed task runs, or start the Swimlane to debug task runs in this tab. For details about task runs, see Monitor and Troubleshoot a Workflow.
  • Settings: The global settings and maintenance utilities of the Workflow instance. For details about the global settings and maintenance utilities, see Global Constants of Workflow and Workflow Maintenance Utilities.
  • Metrics: Displays the task usage and workflow usage of the current Workflow instance. For details, see Workflow and Task Usage Metrics.

You can use the Category filter on the Workflows, Run History, and Tasks tabs to quickly filter out the related workflows, workflow runs, and tasks. The category of a workflow can be specified in the Workflow Information section on the Settings tab of the workflow definition. On the Workflows page, you can choose to display the category information as a column by clicking the Customize Columns icon and checking Category in the list.

Workflows Tab

workflows_page.png

The Workflows tab displays the information of existing workflows including active version, name, run information, and task status.

Select a time range from the Task Data Range dropdown to view the workflow Total Run and Task Total count details.

The following actions are available:

  • Run/Stop - Runs or stops this workflow.

  • Edit - Opens the workflow editing page, where you can design the flow of tasks and configure task parameters.

  • Export - Displays the JSON code of the workflow. You can copy the code and paste it into a blank workflow to create an exact copy of this workflow. For details, see Export and import a workflow.

  • Metrics - Views the execution time and runtime metrics for a selected period of time.

  • Activate/Deactivate - Activate or deactivate this workflow. If a workflow is in inactive status, the workflow is stopped and the queued items are removed. It cannot be executed by any means. It does not count against your license limits.

  • Delete - Deletes this workflow.

Use the icons in the control bar at the top of the table to add a workflow, configure the displayed fields, or filter workflows.

Icon Function
Screen Shot 2022-06-15 at 16.09.56.png Click to add a blank workflow definition or a workflow definition template.
Screen Shot 2022-06-15 at 16.01.18.png Click to select the data fields to be displayed.
Screen Shot 2022-06-15 at 16.10.08.png Click to refresh the data being displayed.
Screen Shot 2022-06-15 at 16.10.31.png Use the search field next to this icon to filter the results.