Workflow step types
Select from a variety of workflow step types to build workflows from.
Inventory Record Stage Change
- Transitions a record into another stage.
- Requires available record stages associated with the workflow.1
| Field | Description |
|---|---|
| when these conditions are met (optional) | Add conditional requirements to qualify for this step.2 |
| set inventory record stage to | Select the record stage to transition to. |
Workflow State Change
Transitions the workflow into another workflow state.3
| Field | Description |
|---|---|
| set workflow state to | Select or add4 the workflow state to transition the workflow to. |
| progress | Indicate the progress of the workflow at this transition into the next state. |
4 Click Add New State to create a new state unique to this workflow.
User Action
Creates a button that performs an action on behalf of the user.
| Field | Description |
|---|---|
| display action button when (optional) | Add conditional requirements for displaying this step.5 |
| action button label | Text that displays on your action button. |
| requested fields (optional) | Include record or artifact fields alongside your action.6 |
| user action deadline (optional) | Include a deadline for when users should complete this action by.7 |
6 Select from the drop-down to add it to your User Action step. Users must have write permissions for the field in order to enter values.
7 Toggle Enable deadline on to configure a deadline.
Approval
Display a preconfigured message to users in the selected approval group.
- Select from either User Roles, Inventory Record Stakeholder Types, or either User Role or User Type inventory field.8
- Must be connected to both a rejection and approval Inventory Record Stage Change step.9
- Configure two Inventory Record Stage Change steps for your associated rejection and approval stages.
- Then, from the bottom of your Approval step:
- Connect the left (red) to your rejection step.
- Connect the right (green) to your approval step.
| Field | Description |
|---|---|
| approval group | Select the roles, stakeholders, or user fields responsible for approval. |
| fields to review (optional) | Select the record or artifact fields shown to approvers for read-only review.10 |
| Approval Message | When your workflow reaches this Approval step, the selected approval group is shown this message.11 |
11 Enter in a title and a message to display.
Broadcast
- Send email notifications to users in selected groups.
- Select from either User Roles or Inventory Record Stakeholder Types.12
| Field | Description |
|---|---|
| Select roles | Select the Inventory Record Stakeholder Types or User Roles to receive the email. |
| subject | Enter the subject of the email.13 |
| message | Enter the body of the email. |
13 Use the rich text editor to compose your subject and message:
- Include optional details about the record or artifact the workflow is running on using the { } Insert Variable drop-down.
- Click on the Preview tab and choose a record or artifact under select {inventory record/artifact} for preview to confirm how the notification will appear when rendered.
Condition Branch
- Allows diverging paths based on conditional requirements.
- A
defaultbranch will be automatically included as a catch-allelsepath to ensure that your conditional logic is complete.
Workflows cannot be saved until condition branches are connected to other steps.
To configure a condition branch:
On the Configure Condition Branch modal, click Add Branch.
Enter in the path name and designate the conditions14 that apply to this path.
Continue with steps 1 and 2 until your conditional branch logic is complete.
To remove a path, click and select Remove Path.
When you are finished setting up all your branch paths, click Update Step to save your step.
Proceed with linking the Condition Branch with your subsequent steps.15
Wait
- Creates a time condition for displaying next available action.16
- Used to enforce a time delay or a calendar date milestone.
To configure a wait step, select when you would like to resume workflow
| Option | Required field(s) | Description |
|---|---|---|
| After Time Interval | wait duration | Wait for a set amount of time. Applies to all records or artifacts under the workflow. |
| At Specified Date | wait until | Wait until a specific timestamp. Applies to all records or artifacts under the workflow. If the milestone date inputted is in the past, the next workflow step will display immediately. |
| At Specified Date on Custom Field | custom field17 | Wait until a specific timestamp as defined by a record or artifact field on a per record or per artifact basis. If the selected field is empty18 or the milestone date inputted is in the past, the next workflow step will display immediately. |
| Time Delta from Specified Date on Custom Field | custom field, time delta direction, wait duration | Wait for a calculated time relative to a date in a record or artifact field on a per record or per artifact basis. If the selected field is empty19 or the milestone date inputted is in the past, the next workflow step will display immediately. |
18 Make record or artifact fields required on registration to ensure necessary fields have valid values.
19 Make record or artifact fields required on registration to ensure necessary fields have valid values.
Run Workflow
Triggers another workflow indicated by select workflow to run, allowing you to chain workflows.
Webhook
When a workflow reaches a webhook step, the workflow will pause. Listen for a POST request to resume the workflow:
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 inventory20 to populate the target for the payload.
Click Copy to the right of Payload to copy the payload to your clipboard.
Include this payload when you send your
POSTrequest to the webhook URL.
Click to the right of the
x-api-keyand its value to copy them to your clipboard.Click to the right of the
x-api-secretand its value to copy them to your clipboard.
Send your POST request to the webhook URL and include these headers with your request to authenticate your call.
HTTP Request
Sends a HTTP request with optional additional conditions.21
| Field | Description |
|---|---|
| url | Enter in the URL to send the HTTP request to. |
| method | Select the HTTP request method: GET, POST, PUT, DELETE22 |
| timeout (seconds) | Enter in a request timeout in seconds.23 |
| fail on non-2xx (optional) | Toggle whether or not the request will be considered failed if the response status code is not in the 2xx range. |
| allow invalid certificates (optional) | Toggle whether or not the request will be allowed to use invalid certificates. |
| follow redirects (optional) | Toggle whether or not the request will follow redirects. |
| require https (optional) | Toggle whether or not the request will require HTTPS. |
| headers (optional) | Include headers with your request.24 |
22 PUT and POST requests have additional configuration fields:
- body type — Select whether the body is
JSONorText. - body — Enter in your payload.
23 Max 300 seconds, or enter 0 to disable timeout.
- 24
- Click Add Header to enter a header.
- Provide a Header Name and Header Value.
To avoid storing credentials in plaintext, use webhook secrets: enter {secret:name} as the header value. At runtime, the workflow engine replaces the placeholder with the stored secret value. See Manage secrets.
End
- Designates the end of your workflow.
- Use this step when all of your other steps have been configured and linked together.25