13.3.1. Guard Properties

In the Guard Properties window, users can create a new guard for the application.

1. Name: This is a text field that allows users to input the name of the guard. It is a mandatory field.
   • There are the following rules determining the validity of names:
     • A valid name can contain letters, numbers, and the underscore symbol. It cannot, however, contain spaces or other special characters. It also cannot begin with a number.
     • A guard must have a unique name. It cannot have the same name as another guard in the program.
2. Title: This is a text field that allows users to input the title of the guard.
   • Unlike with names, there are no guidelines determining the validity of titles.
3. Active: This is a checkbox which, if selected, allows users to mark the guard out as active.
4. Entity: This is a single-select dropdown field that retrieves the list of entities (from the Entity Designer section of the Entities module). It allows users to select the entity associated with the guard.
5. Scope: This table displays all defined events in the application (as retrieved from the Events section of the Processes module). It allows users to assign a scope to the guard.
   • To select a scope from the table, double-click on it.
     • When a scope is selected from the table, the associated access name will automatically populate the Event Name field.
   • Assigning a scope to a guard is optional. If a scope is assigned, the guard will execute automatically when the corresponding event occurs. If not, the guard must be executed manually.

*If a scope is assigned, the guard can be linked to a scheduled event. For more information on scheduled events, click here.

6. Event Name: When a scope is selected from the table, the associated access name will automatically populate this field.
   • To remove the event name, click on the button.
7. Process: This is a single-select dropdown field that retrieves the list of processes (from the Process Design section of the Processes module). It allows users to select the process during which the guard will be executed.

*If a process is not selected from this dropdown, the guard will be executed in all processes associated with the chosen entity.

8. Process Version: This is a single-select dropdown field that displays the list of versions associated with the selected process. It allows users to select the version of the process during which the guard will be executed.
   • Depending on the process selected, the process versions displayed in this dropdown may vary.
     • If -1 is selected as a process version, the guard will be executed in all versions of the selected process.

*If a process version is selected from this dropdown, the guard will be triggered only for that particular version of the process.

9. State Name: This is a single-select dropdown field that displays the list of states in the selected process. It allows users to select the state during which the guard will be executed.
   • Depending on the process and process version selected, the states displayed in this dropdown may vary.

*If a state is not selected from this dropdown, the guard will be assigned to all states associated with the chosen process.

Guard Execution:

*To save changes, click on the Apply button. To save changes and exit the Guard Properties window, click on the OK button. To cancel changes or exit the window, click on the Cancel button or the Exit (X) button.