Workflows
A workflow is how you can orchestrate a series of steps to be performed as a single unit of work. Workflows can contain any of the following step types:
- changes
- wait steps
- approval steps
- other workflows
These can be grouped into stages and each stage's steps can be executed sequentially or in parallel.
Workflows can be created via the GUI or via the API.
Create a workflow
You can create a workflow via the GUI by clicking the New workflow button at the top of the workflows page, which will take you to the workflow editor.
Viewing a workflow's steps
To visualize the step tree of your workflow, go to the overview tab in the workflow details page.
Running a workflow
The workflow details page provides the following buttons to control the execution of the workflow::
| Button | Description |
|---|---|
| Run workflow | Run the workflow, supplying an optional run description if required. |
| Schedule workflow | Schedule running the workflow, providing a cron schedule and conditional options to determine if and when the workflow is run. |
Workflow execution options
By default, OpsChain will only allow a single instance of each workflow to be running at any time. This restriction relates to the default change execution options for OpsChain changes that restricts running multiple changes in the same OpsChain project, environment or asset. Running the same workflow multiple times may cause this to happen and would slow the execution of the workflow. If you require the ability to run the same workflow multiple times concurrently, you can configure the use allow parallel runs of same workflow setting in the project's settings.
Viewing workflow runs
The runs tab of the workflow details page provides a list of each time the workflow has been run. Clicking on a run will take you to the workflow run details page to allow you to view each step of the workflow run.
Each step can be viewed or actioned according to its type. If all the workflow's steps complete successfully, the workflow run will be marked as successful. If a workflow step errors or is cancelled, the remaining steps in the workflow run will not execute and the workflow run will be marked as errored or cancelled based on the status of the step that ended the workflow run.
Viewing workflow scheduled activity
The scheduled activity tab of the workflow details page provides a list of all the scheduled activity that have been created for the workflow. To remove a schedule, click on the checkboxes for the schedules you wish to remove, then select delete selected from the bulk operations drop down.