Skip to main content

Operate Workflows

The Workflows page in the Catalyst console gives platform engineers and business operators a live view of workflows across a projects.

Next sections will show the Catalyst Console features that will help in different scenarios:

  • Incident response: A downstream service is failing. Find and a pause affected instances stuck retrying on the service, fix or scale the downstream system, then resume.
  • Forensics on a failed instance. A workflow failed. Pull its history to see the exact activity that failed, the input it was called with, and the recorded exception.

For managing workflows using the cli, see diagrid workflow subcommand reference

Workflows list​

The Workflows view shows a summary of the executions per workflow, including number of executions and an execution status breakdown. Expanding a workflow entry in the list shows the detailed execution statistics by status.

List of Workflow in a project with execution statistics

Workflow details​

Selecting a workflow from the workflows view displays details of the most recent executions, with a breakdown by the execution statuses and a graph of the execution history.

Selecting an execution from the list shows the execution details view.

Selecting a node from the graph filters executions that executed this particular event. This is useful to quickly search for workflows that executed a conditional activity such requesting approval or fraud analysis.

The filter dialog allows further filtering by the status of the selected node and the status of the execution. This allow, for example, filtering all running executions that failed in the "notify" activity.

Workflow executions filter based on selected graph node

For each execution listed in the view is possible to execute actions. See Workflow execution actions for details of available actions.

List of actions on a execution

All Workflow Executions view​

The All workflow executions view shows a list of executions of workflows across all appIds, with their execution status, creation time and execution time.

Catalyst workflows console showing the list of workflow executions with their statuses

Filtering workflow executions​

The workflow executions list can be filtered by multiple criteria such as execution status, name, appId, execution time, and others.

Workflow execution filter selector

Workflow execution filtered by execution status

Executing actions​

For each execution listed in the view is possible to execute actions. See Workflow execution actions for details of available actions.

List of actions on a execution

Workflow execution details​

Selecting a workflow execution displays the details of the execution: input, output and the history graph.

Workflow execution graph

Graph node details​

Selecting any node in the graph opens a details dialog. For example, selecting a failed activity the inputs, outputs and the error message, if any. In this example, we can see the stack trace.

Activity details with error stack trace

Event history​

The history shows a step-by-step trace of the execution. This is useful for debugging workflow executions.

Workflow execution history with event sequence

Workflow execution actions​

For each execution in the executions listed in the workflow details or all workflow executions view it is possible to execute actions (suspend, resume, terminate, restart).

The available actions depends on the execution status:

  • Only running instances can be suspended or terminated
  • Only instances in terminal state (terminated or failed) can be restarted
  • Only suspended instances can be resumed
  • Events can be risen only in active (running, suspended) instances
Important

The workflows worker application must be running for this actions to take effect. Requests to execute any of this actions while the worker application is not running will result in API errors.

See also​

Last updated on