Configure workflows
Set up workflows to match your organizational needs. Workflows can be as simple or as complex as required, with multiple and discrete workflows supported for unique triggers and scenarios.
Prerequisites
Create custom workflows
To set up a new custom workflow, you’ll need to complete these four steps in sequence:
- Add a new workflow — Create a new workflow in
Draftstatus. - Configure the workflow steps — Configure the workflow steps to define the workflow’s logic.
- Link the workflow together — Link the workflow steps together to define the workflow’s flow.
- Publish the workflow — Publish the workflow to make it available for use.
1. Add new workflows
To add a new blank workflow:
In the left sidebar, click Settings.
Under Governance, select Workflows.
Click Add Workflow.
Select the workflow target type to add:
Enter in a title and a description the workflow.
Select the record type5 this workflow applies to.
Under workflow start, select when the workflow should be initiated:
- Manually — Start this workflow manually.6
- On Inventory Record Registration — Start this workflow when a record is registered in your inventory.7
- On Field Change — Start this workflow on a change to a specific record inventory field.8 To configure, select a field under inventory record field to monitor.
- Via Webhook — Start this workflow when a webhook event is received.
8 Edit inventory fields
When selecting date or date time fields, check Schedule workflow start for this date to set the workflow to trigger on the existing date captured in the field rather than when its value changes.
Under workflow expected duration, define the SLA for the workflow based on the start date in days, weeks, months, or years.
Click Save Draft to save your blank workflow, and then configure your workflow steps.
Enter in a title and a description the workflow.
Select the artifact type9 this workflow applies to.
Under workflow start, select when the workflow should be initiated:
- Manually — Start this workflow manually.10
- On Artifact Registration — Start this workflow when a artifact is logged on a record.11
- Via Webhook — Start this workflow when a webhook event is received.
Select the artifact type12 this workflow applies to.
Under workflow expected duration, define the SLA for the workflow based on the start date in days, weeks, months, or years.
Click Save Draft to save your blank workflow, and then configure your workflow steps.
2. Configure workflow steps
To add or edit workflow steps:
In the left sidebar, click Settings.
Under Governance, select Workflows.
Click on the workflow you’d like to modify, then:
- For workflows that start when a webhook is received, double-click the Start node to configure the webhook.13
- To add a step, drag and drop a new step onto the canvas.
- Double-click the new step to open up the configuration modal.
After you’re finished with step configuration, click Update Step to apply your changes.
After you’ve configured a step,14 you can then link your workflow together.
- 13
- Click Copy to the right of URL to copy the webhook URL to your clipboard. This webhook URL is where you should send your
POSTrequest. - Under select target record for payload, choose a record from your inventory to populate the target for the payload.
- Click Copy to the right of Payload to copy the payload to include in your
POSTrequest to your clipboard. - Click to the right of
x-api-keyandx-api-secretand their values to copy them to your clipboard. - Send your
POSTrequest to the webhook URL and include these headers with your request to authenticate your call.
14 To delete a step, refer to: Delete workflow steps
3. Link workflow together
To initiate the beginning of your workflow:15
15 After you’ve configured your workflow steps, you can then link your workflow together.
Locate the Start of your workflow.
Drag from the at the bottom of Start to the top on the first step of your workflow.
Continue with linking the rest your steps together.
To link subsequent steps together:
- Click the below or to the right or left of the earlier step and drag it to connect to the top on the subsequent step.
- You’re also able to link several different steps together at various points in the workflow, including stages that may circle back to previous steps.
Link approval steps
Approval steps need to be subsequently linked to both a Rejected and an Approved Inventory Record Stage Change step:16
First, configure an Approval step.
Then, drag two Inventory Record Stage Change steps onto the canvas:
- Assign a stage associated with rejection to one in the set inventory record stage to field.
- Assign a stage associated with approval to the other in the set inventory record stage to field.
Then, from the bottom of your Approval step:
17 When complete, the workflow arrow will display as Rejected.
18 When complete, the workflow arrow will display as Approved.
When all your workflow steps have been linked together:
Designate the end of your workflow by dragging an End step onto the canvas.
Link relevant previous steps to the End step by clicking on the bottom of those steps, and dragging to the top of the End step.
When you are finished configuring your workflow, click Save to apply your changes.
4. Publish workflow
You can continue to make changes to published workflows by creating new versions of workflows.19
Once you are satisfied with the setup of your workflow, publish the workflow for use:
In the left sidebar, click Settings.
Under Governance, select Workflows.
Hover over the workflow you want to publish.
Under the actions column, click and select Publish Workflow.
Click Yes, Publish to confirm the publication of the workflow.
Clone existing workflows
To create a copy of an existing workflow as a new draft workflow:20
20 If a cloned workflow’s workflow start trigger conflicts with an existing workflow, the cloned workflow will be set to manual initiation instead.
In the left sidebar, click Settings.
Hover over the workflow you’d like to clone.21
When the appears, click on it and select Clone Workflow.
Make your changes to the workflow’s title and workflow type.
Additional changes can be made to the cloned workflow after cloning by editing.
Once you are satisfied with the setup of your workflow, publish the workflow for use.
Edit existing workflows
You can edit a workflow in several ways:
In the left sidebar, click Settings.
Under Governance, select Workflows.
Click on the workflow you’d like to modify to edit the configuration for that workflow.23
In the left sidebar, click Inventory.
Select a record or find your record by applying a filter or searching for it.24
On the landing page of your record, locate the active workflows section.
Click on the name of the workflow you’d like to edit to open that specific workflow’s details.
On the workflow’s detail modal, click on the in the top-right hand corner and select Edit Workflow.
On the details page of your artifact,25 locate the active workflows section.
Click on the name of the workflow you’d like to edit to open that specific workflow’s details.
On the workflow’s detail modal, click on the in the top-right hand corner and select Edit Workflow.
Make your desired changes to step configuration26 and step relationships27 on your workflow.
When you are finished, click Save New Version to apply your changes.
Enter in your version notes to describe your changes.
Delete workflow steps
Deleting workflow steps on workflows active on records may result in malfunctioning workflows.
Hover over the step you want to delete.
When the menu appears, click on it and select Delete.
Click Yes, Delete Step to confirm removal of the step.
When you are finished, click Save New Version to apply your changes.
Remove links between steps
Hover over a connection until the appears.
Click to delete the connection.
Click Yes, Delete Connection to confirm removal of the connection.
When you are finished, click Save New Version to apply your changes.
Delete existing workflows
- If a workflow is in use on a record, that record will not be impacted.
- Deletion will prevent any future runs of that workflow.
In the left sidebar, click Settings.
Under Governance, select Workflows.
Hover over the workflow you would like to remove.28
When the appears, click on it and select Delete Workflow.
Click Yes, Delete Workflow to permanently remove that workflow and make it inaccessible for any future runs.