About the Workflow Monitor
The Workflow Monitor allows users to analyze the status of Ignition workflows run in the organization. The Workflow Monitor provides a flow diagram of the workflow that updates in real-time.
To access the Workflow Manager, open the Workflows menu and select Monitor. The Workflow monitor page is displayed.
The Workflow Monitor contains the following sections:
- The preview of the workflow execution that contains the task status, canvas options and shortcuts
- The canvas that displays the execution with all the steps included in the workflow definition.
- The workflow instance details that contains information about the definition.
- The list of workflow executions that were run on the organization using Ignition.
Canvas actions
The canvas displays a preview of the workflow execution that allows users to:
- Check status of each step in an execution, which can be one of the following: Canceled, Failed, Pending, Running, Succeeded, TimedOut, Completed or Failed.
- Change the layout orientation (vertical or horizontal). To change the layout, click Switch layout orientation.
- Zoom in, zoom out, zoom to default level or zoom to fit the diagram to the visible area.
- Focus on the active execution path, which will hide any step which was not taken during the execution. This can be toggled on or off.
- Go to definition, that redirects users to the workflow definition used for the execution.
The Canvas
This section displays the status of the workflow updated in real-time. The path that the workflow is taking is always highlighted.
Users can click on a step in the workflow execution to see more details about that step or click on the background of the workflow to view general workflow details.
Details section
This details section contains the following information, based on what step of the workflow execution was selected:
- For Workflow details - visible when no step is selected:
Name
ID
Trigger
- will always be SystemIngestTrigger
in the current Ignition version.Status
Start time
End time
Elapsed
Variables
- the list of variables that the workflow execution started with.Related executions
- for a workflow execution that is rerun, the related workflow executions are displayed.
For Tasks:
inputs
- key | value pairingoutputs
- key | value pairing
For Choice steps
- A list of conditions. For each condition, you can click on it to see more details.
For Parallel steps
- A list of parallel branches, marked by the first step on each branch. For each branch, you can click on it to move to that step.
The Workflow Execution List
This section is a list of all the workflow executions that were run on the organization. You can search through them, sort and filter the columns to fit your needs.
For each workflow execution, you can perform the following actions:
- View details. When selecting this action, the Workflow Monitor page is displayed in a separate page.
- Export. When selecting this action, the workflow execution is exported as a YAML file.
- Rerun. This action is only available for workflow executions that have been completed, either successfully, unsuccessfully or canceled. When selecting this action, a new workflow execution is created, and it is linked to the original.
- Cancel. This action is only available for workflow executions that are running. When selecting this action, the workflow execution will be stopped and its status will be set to Canceled.