You are here:
Step Flow Orchestration Resource
Organize the work done in an orchestration stage.
Required Editions
| View supported editions for Flow Orchestration. |
Orchestrations have background steps and interactive steps.
Background Steps
Background steps call autolaunched flows and run without user interaction. At run time, the orchestration run automatically determines whether the autolaunched flow runs synchronously or asynchronously.
| Field | Section | Description |
|---|---|---|
| Label | Helps you identify the element on the canvas. | |
| API Name | Automatically populated if empty when you fill out the Label field and press TAB. The requirement for uniqueness applies only to elements and resources within the current orchestration. Two items can have the same API name, provided they're used in different orchestrations. An API name can include underscores and alphanumeric characters without spaces. It must begin with a letter and can’t end with an underscore. It also can’t have two consecutive underscores. | |
| Description | Helps you remember what this resource does. When editing an element,
appears after you click . |
|
| Condition | Select When to Start the Step | Identifies the method used to determine whether a step is ready to start.
|
| Step Name | Select When to Start the Step | Specifies a step that must be marked completed before the current step can start. Available whenCondition is set to When another step is marked Completed, the step starts. |
| Requirements to Start Step | Select When to Start the Step | Determines the logic that evaluates whether the step can be started.
|
| Requirement Logic | Select When to Start the Step | Determines the logic that evaluates whether the step can be started.
|
| Resource | Select When to Start the Step | The resource evaluated by this requirement. Available when Condition is set to When the specified requirements are met, the step starts. |
| Operator | Select When to Start the Step | The operator to use to evaluate the resource. Available when Condition is set to When the specified requirements are met, the step starts. |
| Value | Select When to Start the Step | The value to compare the specified resource to, using the specified operator. Resource and Value must have compatible data types. Available when Condition is set to When the specified requirements are met, the step starts. |
| Evaluation Flow | Select When to Start the Step | Specifies the flow that determines if the step can start. Available when Condition is set to When the specified evaluation flow returns True, the step starts. |
| Action | Select an Action to Run | Specifies which autolaunched flow to run for a step. |
| User Type | Select Who to Run the Action As | Determines the context that the step is run in.
|
| User | Select Who to Run the Action As | Specifies the user to run the step as. Available when User Type is set to A Selected User. |
| User Resource | Select Who to Run the Action As | Specifies a variable that at run time contains the user to run the step as. Available when User Type is set to A User Specified by a Resources at Run Time. |
Interactive Steps
Interactive steps call screen flows and require user interaction.
| Field | Section | Description |
|---|---|---|
| Label | Helps you identify the element on the canvas. | |
| API Name | Automatically populated if empty when you fill out the Label field and press TAB. The requirement for uniqueness applies only to elements and resources within the current orchestration. Two items can have the same API name, provided they're used in different orchestrations. An API name can include underscores and alphanumeric characters without spaces. It must begin with a letter and can’t end with an underscore. It also can’t have two consecutive underscores. | |
| Description | Helps you remember what this resource does. When editing an element,
appears after you click . |
|
| Condition | Select When to Start the Step | Identifies the method used to determine whether a step can be started.
|
| Step Name | Select When to Start the Step | Specifies a step that must be marked completed before the current step can start. Available whenCondition is set to When another step is marked Completed, the step starts. |
| Requirements to Start Step | Select When to Start the Step | Determines the logic that evaluates whether the step can be started.
|
| Resource | Select When to Start the Step | The resource evaluated by this requirement. Available when Condition is set to When the specified requirements are met, the step starts. |
| Operator | Select When to Start the Step | The operator to use to evaluate the resource. Available when Condition is set to When the specified requirements are met, the step starts. |
| Value | Select When to Start the Step | The value to compare the specified resource to, using the specified operator. Resource and Value must have compatible data types. Available when Condition is set to When the specified requirements are met, the step starts. |
| Evaluation Flow | Select When to Start the Step | Specifies the flow that determines if the step can start or be marked complete. Available when Condition is set to When the specified evaluation flow returns True, the step starts. Also available when Condition is set to When the specified evaluation flow returns True, the step is marked Completed. |
| Action | Select an Action to Run | Specifies which screen flow to run for a step. |
| Assignee Type | Select Someone to Complete the Action | Identifies the type of assignee to assign the step to.
|
| User | Select Someone to Complete the Action | The name of the user to assign the step to. Available when Assignee Type is set to User. |
| Group | Select Someone to Complete the Action | The name of the group to assign the step to. Available when Assignee Type is set to Group. |
| Queue | Select Someone to Complete the Action | The name of the queue to assign the step to. Available when Assignee Type is set to Queue. |
| Resource | Select Someone to Complete the Action | The API name of the variable that contains the username of the user, the API name of the public group, or the API name of the queue to assign the step to. At run time, the orchestration run associated determines the type of assignee in the specified resource and dynamically resolves it. Available when Assignee Type is set to Resource. |
| Customize approver notification email | Select Someone to Complete the Action | Indicates whether to send the assignee a custom email notification when the orchestration work item associated with this step is created. |
| Subject | Select Someone to Complete the Action | The subject text of the custom email or the API name of a text template that contains the subject text at run time. |
| Body | Select Someone to Complete the Action | The body text of the custom email or the API name of a text template that contains the body text at run time. |
| Related Record ID | Select Where to Complete the Action | Specifies the ID of the record where the Work Guide displays the screen flow to the assigned user. |
| Condition | Select When to Complete the Step | Identifies the method used to determine whether a step can be marked as completed.
|
| Requirements to Start Step | Select When to Complete the Step | Determines the logic that evaluates whether the step can be marked as Completed.
|
| Resource | Select When to Complete the Step | The resource evaluated by this requirement. Available when Condition is set to When the specified requirements are met, the step is marked Completed. |
| Operator | Select When to Complete the Step | The operator to use to evaluate the resource. Available when Condition is set to When the specified requirements are met, the step is marked Completed. |
| Value | Select When to Complete the Step | The value to compare the specified resource to, using the specified operator. Resource and Value must have compatible data types. Available when Condition is set to When the specified requirements are met, the step is marked Completed. |
| Evaluation Flow | Select When to Complete the Step | Specifies the flow that determines if the step can be marked as completed. Available when Condition is set to When the specified evaluation flow returns True, the step is marked Completed. |
MuleSoft Steps
MuleSoft steps call operations imported from a MuleSoft API and run without user interaction. The actions called by a MuleSoft step run asynchronously.
| Field | Section | Description |
|---|---|---|
| Label | Helps you identify the element on the canvas. | |
| API Name | Automatically populated if empty when you fill out the Label field and press TAB. The requirement for uniqueness applies only to elements and resources within the current flow approval process. Two items can have the same API name, provided they're used in different flow approval processes.An API name can include underscores and alphanumeric characters without spaces. It must begin with a letter and can't end with an underscore. It also can't have two consecutive underscores. | |
| Description | Helps you remember what this resource does. When editing an element,
appears after you click . |
|
| Condition | Select When to Start the Step | Identifies the method used to determine whether a step is ready to start.
|
| Step Name | Select When to Start the Step | Specifies a step that must be marked completed before the current step can start. Available whenCondition is set to When another step is marked Completed, the step starts. |
| Requirements to Start Step | Select When to Start the Step | Determines the logic that evaluates whether the step can be started.
|
| Requirement Logic | Select When to Start the Step | Determines the logic that evaluates whether the step can be started.
|
| Resource | Select When to Start the Step | The resource evaluated by this requirement. Available when Condition is set to When the specified requirements are met, the step starts. |
| Operator | Select When to Start the Step | The operator to use to evaluate the resource. Available when Condition is set to When the specified requirements are met, the step starts. |
| Value | Select When to Start the Step | The value to compare the specified resource to, using the specified operator. Resource and Value must have compatible data types. Available when Condition is set to When the specified requirements are met, the step starts. |
| Evaluation Flow | Select When to Start the Step | Specifies the flow that determines if the step can start. Available when Condition is set to When the specified evaluation flow returns True, the step starts. |
| Action | Select an Action to Run | Specifies which operation imported from a MuleSoft API to run for a step. |
| User Type | Select Who to Run the Action As | Determines the context that the step is run in.
|
| User | Select Who to Run the Action As | Specifies the user to run the step as. Available when User Type is set to A Selected User. |
| User Resource | Select Who to Run the Action As | Specifies a variable that at run time contains the user to run the step as. Available when User Type is set to A User Specified by a Resources at Run Time. |
Step Status
| Step run Status | Description |
|---|---|
| Not Started | The step hasn't met its entry condition. |
| In Progress | The step was started. |
| Completed |
|
| Discontinued |
|
| Error |
|


