Term
Description
Example
Activate/Deactivate
Individual workflows can either be active or inactive.
The Workflows default view displays how many versions out of the total number of versions are active. Example: 6/12
When editing a workflow, its active status is indicated with a red or green dot. (🔴 or 🟢)
Canvas
The Workflows canvas is where you edit a workflow's graphical model, arranging and configuring the shapes and flows .
Data types
Every variable must have a data type to designate what kind of value it can store. The data type also helps you know how to map variables to the contract on a task in the workflow.
Learn more about data types .
Deploy
Individual workflows can be either deployed or pre-deployed (see below).
You can't "un-deploy" a workflow after it has been deployed. To stop the workflow from executing on its schedule or prevent it from being started manually, you must deactivate it.
—
Executed/Execution
Refers to a particular run of a workflow. A single numbered version of a workflow can have multiple executions.
You can to review a specific execution and get data about things like shape completion time and reasons for shape failure.
—
Flows
Refers to the lines that connect shapes on the Workflows canvas. You can make flows as long or short as you like, add shapes to them, or delete them.
Object
Defined
Open
A defined object is one possible data type .
You can configure a defined object with child property variables . Each child variable stores an individual value based on the data type selected.
Note : A child variable cannot be configured with an object data type—Workflows do not support nesting in defined objects.
An open object is configured with no defined child variables. An open object can store a JSON payload without limits to its structure or nesting. They are convenient to use when the workflow calls an API in a service task and the response is contained in a single parameter.
—
Permissions
Permissions are the user-specific levels of access that a person or group has to an individual workflow.
—
Pre-deployed
This refers to a workflow version that has never been deployed and may be edited by anyone with Write or Admin permission to the workflow.
After a workflow version is deployed, it can no longer be edited.
Shapes
Workflows use Business Process Model and Notation (BPMN), a standardized method of constructing flow charts to visually model a business process from end to end. Learn about the possible shapes .
—
Status
Deployed workflows have one of four statuses:
- In-Progress
- Completed
- Canceled
- Failed
Usage
Refers to the number of executions the workflow has completed, not filtered by status. This metric displays in your Workflows home.
—
Validation mode
When you try to deploy a workflow, it is validated for issues. If there are errors, you must resolve them before deploying the workflow. Validation mode provides information to help you resolve errors and other issues.
—
Variables
Variables store the data values that are passed or generated by the workflow. The values in variables can change as the workflow progresses from step to step, and variables can be mapped to inputs or outputs on tasks throughout the workflow.
Depending on your permissions for an individual workflow, you can add variables to the list of available variables for that workflow.
—
Versions/Versioning
Versions are numbered iterations of a workflow configuration. Learn how to manage your workflow versions .
—