Workflow User Interface

Knowledge Center > Workflow > Get Started with Workflow > Workflow User Interface

Workflow User Interface

Table of contents

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

workflow_tab_overview.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, and run workflows in 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.

Documentation is not a tab, but a link to the current documentation in the Knowledge Center.

Workflows Tab

workflow_tab_workflows.png

The Workflows tab displays existing workflows in the tile view by default. In the tile view, each workflow includes a pie chart and five buttons. 

For running workflows, the pie chart displays the distribution of tasks in different status (Queued, Processing, Success, Stopped, and Error).

For completed workflows, the pie chart also displays the status of the workflow (Success or Error).

The five buttons are:

  • 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 Create a Copy of a Workflow.

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

  • Delete - Deletes this workflow.

Use the icons in the control menu bar to add a workflow, switch the view, configure the displayed fields, or filter workflows.

Icon Function
workflow_icon_add.png Click to add a blank workflow or a workflow template.
workflow_icon_view.png Click to select the data fields to be displayed.
workflow_icon_table.png Click to switch to the table view. It is grey when the list is currently in the table view.
workflow_icon_tile.png Click to switch to the tile view. It is grey when the list is currently in the tile view.
workflow_icon_refresh.png Click to refresh the data being displayed.
workflow_icon_magnify.png Click and enter some characters to filter the results. 
Last modified

Tags

Classifications

(not set)