Running a Workflow
Last updated
Was this helpful?
Last updated
Was this helpful?
After following the steps to , you can run your Workflow to perform the sequential tasks defined in it.
To view previous Workflow runs, you must have the View Workflow runs permission.
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.
Runs are not displayed for Workflows that have been deleted.
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.
You must have the Execute Workflow runs permission.
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."
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."
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.
You can also run a Workflow while viewing an entity:
On the left navigation menu of Cortex, click Catalogs > All entities.
Click an entity to view its details page.
On the left side of the entity details, click Workflows to view and run any entity-scoped Workflows.
If you cancel a run that is partially complete, it will not undo any successfully completed blocks.
To cancel a running Workflow:
On the Workflows page, click the Runs tab then locate the Workflow you want to cancel.
Click on the Workflow to view its run details page.
could not find workflow with id: xyz?This can happen in a scenario where you have multiple tenants, and you are using an API key from the wrong tenant. Ensure that you are using the correct API key, or create a new API key and try again.
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.
