Workflows
  • 31 Jan 2024
  • 2 Minutes to read
  • Dark
    Light

Workflows

  • Dark
    Light

Article Summary

Workflows are the logic you design to automate security tasks and processes, comprising a trigger and a sequence of steps that implement an automation use case. 

All the workspace workflows are available on the Workflows page. You can work on individual workflows or perform bulk operations by checking the checkboxes next to the workflow names.

In this article

More information on workflows

Workflow states

Creating a workflow involves an iterative process that includes drafting, testing, publishing, and editing. You can see the workflow state on the Workflows page next to the workflow name.

Note

While editing a workflow, the published version remains operational in the production environment.

State nameIconDescription
Not publishedWorkflow draft. In this state, you can make changes to the workflow and perform test runs.
Published, and the trigger is enabledView-only. The workflow automatically runs in production when the trigger conditions are met.
Published, and the trigger is disabledView-only. The workflow is in production but will not run automatically because the trigger is disabled. You can run the workflow manually.
Has unpublished changesThe workflow automatically runs in production when the trigger conditions are met, and there is an active draft that you can edit.

Learn how to move the workflow between different states:

Publish a workflow

Publish a workflow when it's ready for production. Do a few Test runs before you publish to verify that the workflow is running as expected. 

  1. Go to the Workflows page.
  2. Open the workflow you want to publish. Alternatively, you can select Publish Workflow from the workflow three-dot menu on the Workflows page.
  3. Click Publish in the top right corner.
    1. Add a description explaining this workflow version.
    2. Add workflow tags.
    3. Set the TimeBack benchmark.
The Publish a workflow modal

Unpublish a workflow

Unpublish a workflow when you want to remove it from production.

  1. Go to the Workflows page.
  2. Open the workflow you want to unpublish.
  3. Click the three-dot menu in the top right corner and select Unpublish workflow.

Enable/disable a workflow

Enable and disable refer to the status of a workflow trigger. 

  • Enable: The workflow is in production and will run automatically (according to the trigger type). 
  • Disable: The workflow won't run automatically (even if it's published).
  1. Go to the Workflows page.
  2. Open the workflow you want to enable or disable.
  3. Click Enable or Disable in the top right corner, depending on the trigger's current status.

Edit a published workflow

When you edit a published workflow (create a draft), the published version is still active in production.

More than one user can edit a workflow at the same time. All users' changes are automatically saved, and the workflow is updated in real-time. When a user publishes a workflow or reverts a draft to the published version, all changes are published/reverted, respectively.

You can see the other users who have the workflow open next to the Test run button.

Note

When a parent workflow is in draft mode, nested workflows are run in their most up-to-date versions. They might differ from their published versions (if they have active drafts).

  1. Go to the Workflows page.
  2. Open the workflow you want to edit and click Edit in the top right corner.
  3. When you're ready to publish your edits, click Publish.

Stop executions

To stop all currently running executions of a workflow:

  1. Go to the Workflows page and locate the workflow in the list.
  2. Open the workflow three-dot menu and select Stop executions.

Note

To prevent future executions of the workflow, disable the trigger.

Go to the workflow menu to stop the workflow executions

Group workflows into sections

You can group workflows into sections to make the Workflows page easier to navigate.

  1. Choose one or more workflows to add to a new or existing section by selecting the checkboxes next to their names.
  2. Select Add to section from the actions suggested for the selected workflows.
Workflows grouped into sections



Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.