The Scope control allows grouping actions within a specific container/block in the Action Builder, that enables the encapsulation of actions in a set of actions, and specifies which actions should be executed based on the result of the action execution (IsSuccessful, HasFailed). The Scope control helps to organize actions and manage the action execution. The main advantage of the Scope control is the handling of errors within the scope: you can easily set up error handling within the scope in the HasFailed block. That helps to consolidate all errors in one and eliminates the need to set up error handling for each of the actions.
To configure the Scope control you need to add one or more actions in the appropriate blocks:
Configuration
| Property | Required | Type | Description |
|---|---|---|---|
Scope action block |
no | Block of actions within the scope | |
Is successful |
no | Block of actions to be executed when actions in the Scope block executed successfully | |
Has failed |
no | Block of actions to be executed when actions in the Scope block failed |
Output*
| Output Parameter | Type | Description |
|---|---|---|
| IsSuccessful | Boolean | The output of this action returns true or false depending on whether the action execution was successful or not |
| HasFailed | Boolean | The output of this action returns true or false depending on whether the action execution failed |
| ErrorMessage | String | Returns an error message if one of the actions in a Scope action block fails |
| WarningMessages | String | Returns a list of warning messages in case actions within Scope action are successfully finished but with warnings (only in Forms Studio Scheduled/Triggered Actions) |
* You can use outputs of the Scope inside the Scope in “Is Successful” and “Has Failed” blocks, and also outside the Scope control.
Example use in a subsequent Condition action:
