- 31 Jan 2024
- 2 Minutes to read
- DarkLight
Workflows
- Updated on 31 Jan 2024
- 2 Minutes to read
- DarkLight
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
- Workflow states
- Publish/unpublish
- Enable/disable
- Edit a published workflow
- Stop executions
- Group workflows into sections
More information on workflows
- Import and export
- Share workflows with other workspaces within the organization
- Version history
- Implement a workflow approval flow
- Get notifications on failed executions
- Tags
- Export as PDF
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 name | Icon | Description |
---|---|---|
Not published | Workflow draft. In this state, you can make changes to the workflow and perform test runs. | |
Published, and the trigger is enabled | View-only. The workflow automatically runs in production when the trigger conditions are met. | |
Published, and the trigger is disabled | View-only. The workflow is in production but will not run automatically because the trigger is disabled. You can run the workflow manually. | |
Has unpublished changes | The 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.
- Go to the Workflows page.
- Open the workflow you want to publish. Alternatively, you can select Publish Workflow from the workflow three-dot menu on the Workflows page.
- Click Publish in the top right corner.
- Add a description explaining this workflow version.
- Add workflow tags.
- Set the TimeBack benchmark.
Unpublish a workflow
Unpublish a workflow when you want to remove it from production.
- Go to the Workflows page.
- Open the workflow you want to unpublish.
- 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).
- Go to the Workflows page.
- Open the workflow you want to enable or disable.
- 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).
- Go to the Workflows page.
- Open the workflow you want to edit and click Edit in the top right corner.
- When you're ready to publish your edits, click Publish.
Stop executions
To stop all currently running executions of a workflow:
- Go to the Workflows page and locate the workflow in the list.
- Open the workflow three-dot menu and select Stop executions.
Note
To prevent future executions of the workflow, disable the trigger.
Group workflows into sections
You can group workflows into sections to make the Workflows page easier to navigate.
- Choose one or more workflows to add to a new or existing section by selecting the checkboxes next to their names.
- Select Add to section from the actions suggested for the selected workflows.