Guard
The Guard rule is meant to terminate the execution of an action on on a particular document and prevents a status transition in a particular situation. If the action that contains the Guard rule is a scheduled or bulk action, the action will continue to process the next document. If the action that triggers the rule is a user action, an error notification will be displayed to the user unless the silent option is enabled.
Availability
The rule can be added to:
- User actions
- Bulk actions
- Scheduled actions
- Rest actions
Properties
| Property | Required | Description |
|---|---|---|
| Label | No | A brief description of the rule. This description is visible in the list of rules and meant to distinguish similar rules from each other. |
| Description | No | A longer description of the rule. You can use this field to describe the purpose of the rule is. |
| Reason | No | Here you can add some descriptive information which will be shown in the logs. The field does support BizzStream expressions. |
| Confirmation | No | Enter a question that you want to ask. If the user does not confirm this question, the rule will execute. This field is only available for Guard rules that are added to user actions. |
| Silent | No | If this option is checked and the action that triggers is a user action, no error notification will be displayed. |
| Execute Only If | No | The condition that needs to be met in order for this rule to execute. If this field is empty, the rule will always be executed. |
Confirmations
A Guard rule that is added to a user action allows you to ask a confirmation of the user/visitor. If he/she does not confirm, the rule will terminate the execution of the user action. Even if the user or visitor confirms the question, the guard rule will still terminate the user action if the Execute Only If condition is met.
Multiple Guard rules with confirmation questions can be added to a single user action. In this case
- BizzStream will show a confirmation dialog for each of the guard rules with a confirmation question.
- If a confirmation dialog is cancelled, no further confirmation dialogs are presented to the user. BizzStream will execute the rules up to the guard rule that was not confirmed.
- If one of theu rules throws an error or a guard rule is triggered via the Execute Only If conditoin, the user action is interrupted at that point.