LogoLogo
Login to CortexBook a DemoCortex Academycortex.io
  • Cortex Docs
  • Cortex Quick Start
  • Ingesting data into Cortex
    • Managing Entities
      • Adding entities
        • Add services
        • Add domains
        • Add teams
        • Add custom entity types
        • Defining dependencies
      • Entity details page
      • Defining ownership
      • Defining relationship types
      • Grouping entities
      • Adding external documentation
      • Adding Deploy data
      • Adding custom data
      • Viewing discovered entities
      • Archiving entities
      • Relationship graph
      • Using On-call Assistant for incidents
      • Managing Terraform infra in Cortex
    • Managing Catalogs
    • Integrations
      • Internally hosted integrations
      • ArgoCD
      • AWS
      • Azure DevOps
      • Azure Resources
      • BambooHR
      • Bitbucket
      • BugSnag
      • Buildkite
      • Checkmarx
      • CircleCI
      • ClickUp
      • Codecov
      • Coralogix
      • Custom webhook integrations
      • Datadog
      • Dynatrace
      • Entra ID (Azure AD)
      • FireHydrant
      • GitHub
      • GitLab
      • Google
      • Grafana
      • incident.io
      • Instana
      • Jenkins
      • Jira
      • Kubernetes
      • LaunchDarkly
      • Lightstep
      • Mend
      • Microsoft Teams
      • New Relic
      • Okta
      • Opsgenie
      • PagerDuty
      • Prometheus
      • Rollbar
      • Rootly
      • Sentry
      • ServiceNow
      • Slack
      • Snyk
      • SonarQube
      • Splunk Observability Cloud (SignalFx)
      • Splunk On-Call (VictorOps)
      • Sumo Logic
      • Veracode
      • Wiz
      • Workday
      • xMatters
  • Scorecards
    • Initiatives and Action items
      • Creating issues based on Initiatives
    • Scorecard rule exemptions
    • Scorecard rule filters
    • Scorecard examples
    • Scorecards as code
  • Reports
    • Executive report
    • All Scorecards report
    • Bird's eye report
    • Progress report
    • Report card
  • Eng Intelligence
    • Custom Metrics
    • Jira Metrics
    • Metrics Explorer (Beta)
  • Cortex Query Language (CQL)
    • Using CQL reports
    • Using JQ in Cortex
  • Workflows
    • Creating a Workflow
      • Workflows as code
    • Blocks
    • Running a Workflow
    • Registering a Scaffolder template
      • Scaffolder advanced usage
    • Using a Workflow to sync in ArgoCD
    • Kicking off a Jenkins pipeline in a Workflow
    • Calling internal service endpoints in a Workflow
  • Plugins
    • Creating a plugin
      • Creating a plugin proxy
    • Migrating Backstage plugins to Cortex
  • Engineering homepage
  • Workspace Settings
    • Using GitOps for Cortex
      • GitOps logs
    • Managing users
      • Roles and permissions
        • Custom roles
        • Team ownership entity editing
      • Configuring SSO
        • Microsoft Entra ID
        • Google
        • Other OIDC providers
        • Okta
          • Okta SCIM
      • Configuring identity mappings
      • Onboarding management
    • API keys, secrets, and tokens
      • Secrets
      • Personal tokens
    • Audit logs
    • Entity settings
      • Data verification
      • Auto archiving entities
    • IP allowlist
    • Notifications
      • Notification logs
    • Customizing your workspace
    • Using search in Cortex
  • Cortex API
    • REST API operations
      • API Keys
      • Audit Logs
      • Catalog Entities
      • Custom Data
        • Custom Data (Advanced)
      • Custom Events
      • Custom Metrics
      • Dependencies
      • Deploys
      • Discovery Audit
      • Docs
      • Eng Intel: User Labels
      • Entity Relationship Types (Beta)
      • Entity Relationships (Beta)
      • Entity Types
      • GitOps Logs
      • Groups
      • Initiatives
      • Integrations APIs
        • Azure Active Directory (Entra ID) API
        • Azure Resources API
        • AWS API
        • Azure DevOps API
        • CircleCI API
        • Coralogix API
        • Datadog API
        • GitHub API
        • GitLab API
        • incident.io API
        • LaunchDarkly API
        • New Relic API
        • PagerDuty API
        • Prometheus API
        • SonarQube API
      • IP Allowlist
      • Notification Logs
      • On call
      • Packages
      • Plugins
      • Queries
      • SCIM
      • Scorecards
      • Secrets
      • Team Hierarchies
      • Teams
      • Workflows
Powered by GitBook
On this page
  • Viewing Workflow run history
  • View all previous runs
  • View recent runs
  • Running a Workflow
  • Run a Workflow from the Workflows page
  • View completed Workflows
  • Running a Workflow with secret user input
  • Run a Workflow from an entity
  • Cancel a running Workflow

Was this helpful?

Export as PDF
  1. Workflows

Running a Workflow

Last updated 24 days ago

Was this helpful?

Overview

After following the steps to , you can run your Workflow to perform the sequential tasks defined in it.

Viewing Workflow run history

To view previous Workflow runs, you must have the View Workflow runs permission.

View all previous runs

In the Runs tab of the , view historic runs for each Workflow, as well as each run's status: In Progress, Paused, Successful, Canceled, or Error. Click any of the individual actions to view the action's inputs, outputs, and run context in the side panel. Click Waiting for approval to view any runs that are awaiting your approval.

For auditing and debugging purposes, Cortex stores run history, which includes the initiator, run context, and the inputs/outputs of each action, for 30 days.

View recent runs

Click into one of the recent runs to view the step-by-step progress of the Workflow and each step's inputs and outputs:

To navigate to the full Workflow configuration, click View flowchart in the upper right corner.

Running a Workflow

You must have the Execute Workflow runs permission.

Run a Workflow from the Workflows page

  1. At the top of the Workflow, click Run.

    • The Workflow will automatically launch. Workflows that require User input or Manual approval will pause until your configured input or approval is completed.

When a block completes, it is labeled as "Finished":

Blocks that require input or approval will be labeled "Paused."

View completed Workflows

When a run has been started, it appears in the Runs tab on the Workflows page with a "Successful" label. A Workflow awaiting input or approval will display as "Paused," and a Workflow that is currently running will display as "In progress."

Running a Workflow with secret user input

If the Workflow has a secret user input block configured, the user running the Workflow will be prompted to enter information into the field, which will be redacted in the Workflow's Outputs tab. If the Workflow has regex validation configured, the user must enter a secret matching the value of the Validation regex that was configured for this block.

The secret fields can be seen in the Output of the Workflow after it has been run, but the secret values will be redacted.

Note that it is inherently possible for users with permission Edit Workflows to obtain secret values using complex data transformation on secrets or echoing services.

Run a Workflow from an entity

You can also run a Workflow while viewing an entity:

  1. On the left navigation menu of Cortex, click Catalogs > All entities.

  2. Click an entity to view its details page.

  3. On the left side of the entity details, click Workflows to view and run any entity-scoped Workflows.

Cancel a running Workflow

If you cancel a run that is partially complete, it will not undo any successfully completed blocks.

To cancel a running Workflow:

  1. On the Workflows page, click the Runs tab then locate the Workflow you want to cancel.

  2. Click on the Workflow to view its run details page.

Recently run Workflows are displayed at the top of the :

When running a Workflow with Cortex-based blocks, you must have the relevant in order for the Cortex-based block to succeed. For example, if you configured a block to add for an entity, you would need the Configure Eng Intelligence Custom Metrics permission for that block to run successfully.

On the , locate the Workflow you want to run.

Click Cancel run.

Workflows page in Cortex
permission
Eng Intelligence custom metrics
Workflows page
create a Workflow
Workflows page in Cortex
Recent Workflow run, step by step
The Workflows page displays recent runs