For the complete documentation index, see llms.txt. This page is also available as Markdown.

Viewing Workflows

Workflows let you automate sequential actions and development processes using contextual data from your workspace. Workflows can be simple, like granting database permissions, or sophisticated, like creating a Jira ticket for an incident detected in Cortex.

Viewing the Workflows page

Users with the View Workflows permission can view existing Workflows.

The Workflows page can be accessed from the main sidebar.

The 'Workflows' tab in the Cortex main sidebar.

In the Workflows tab, view all existing Workflows, including each Workflow's name and description.

From this page, you can edit, duplicate, run, delete, share, or create a Workflow. Click the Overflow menu to view options to edit, duplicate, share, or delete the Workflow"

The 'Overflow' icon on the Workflows page.

If a Workflow is in draft mode, a draft icon appears next to its name:

The 'Draft' icon next to a Workflow's name.

If a Workflow is managed via GitOps, a Git icon appears next to its name:

The 'Gitt' icon next to a Workflow's name.

Click the pin icon to pin any frequently-used Workflows to the top of the page:

The 'Pin' icon.

Viewing Workflow runs

Users with the View Workflow Runs permission can view past Workflow runs.

On the Workflows page, select the Runs tab to view runs for each Workflow.

The 'Runs' tab shows a list of recently ran Workflows.

Select a run to see more information about it, including its status: In Progress, Paused, Successful, Canceled, or Error. While in the run, click View flowchart in the upper-right corner to view the entire Workflow step-by-step.

Filtering and sharing

On the Workflows page, click the Filter icon to narrow your results, or the Share icon to copy a link to the Runs page that you can send to your team.

Approvals

On the Workflows page, select the Waiting for approval tab to view runs that are awaiting your approval. Note that this tab is only visible if a run is waiting for your approval.

Run history and retention

For auditing and debugging, Cortex stores run history, including the initiator, run context, and the inputs and outputs of each action, for 30 days. Runs from deleted Workflows are not displayed.

Inspecting a workflow run

Run history is available from the Workflows page or the entity page where the workflow was run. Click a specific run to open the view, which shows:

  • Run context - The static context values used during execution, such as context.entity, context.secrets, and context.initiatedBy.

  • Inputs and outputs - The data passed into each block and the results returned.

To inspect a specific step, click any block in the visual to view its input and output payloads and execution status.

Tracking API‑initiated runs

Runs triggered through the Workflow Runs API appear on the Runs tab alongside runs started from the UI, marked with a key icon next to the initiator's name.

Runs that failed to initiate via the API appear on the Failures tab. Click View details on a failed entry to see the error. Note that the Failures tab only appears when there are failed runs.

Viewing Scaffolder templates

Users with the View Workflows permission can view Scaffolder templates on the Workflows page.

On the Workflows page, select the Scaffolders tab to view, edit, or delete registered Scaffolder templates.

The 'Scaffolders' tab shows a list of Scaffolder templates used in your Workflows..

To preview a Scaffolder template, click the preview icon next to it:

The 'Preview' icon next to a Scaffolder template.

To edit a template, click the pencil icon next to it:

The 'Pencil' icon next to a Scaffolder template.

To create a Workflow that contains a Scaffolder step with a particular template, click the rocket ship icon next to it:

The 'Rocket ship' icon next to a Scaffolder template.

To delete a Scaffolder template, click the trash icon next to it:

The 'Trash' icon next to a Scaffolder template.

Last updated

Was this helpful?