Business rule is a server-side script running at the moment of inserting, updating, or deleting a record. Business rules are used for such tasks as conditionally automatic value change in the form fields or event creation for email notifications and script actions.
Business rules can use scenarios to perform actions with records in the database. Even so, there are several other options of the script actions available, such as client-side scripts and UI-actions.
The scheme below illustrates when Before and After rules run.
Before Rules run conditions:
- After record action start (create, update, or delete).
- Before the system performs the server updates.
After Rules run conditions:
- After record action start (create, update, or delete).
- After the system performs the server updates.
Role required: admin.
Abort business rules
It is possible to perform business rules that terminate the follow-up actions and processes.
The abort business rules terminate the following processes: Business rules, Notifications, Approval Rules, etc.
See Approval Management to learn more about approval rule rejection.
To make your business rule abort the follow-up processes, complete the steps below:
- Open a business rule desired.
- On the form, check the Abort Action box.
- Click Save or Save and Exit.
Business rules creation
You can create business rule that will be running when inserting, updating or deleting a record.
To create it, please perform the following steps:
- Navigate to System Definitions → Business Rules.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
Business rules form fields
| Field | Mandatory | Description |
|---|---|---|
| Name | Y | Name a business rule. |
| Table | Y | A table on which a business rule will be performing. |
| Description | N | A brief action description. |
| Set Value | N | Select a column of the table chosen in the Table field and define the needed value. |
| Abort Action | N | When set to TRUE, and all conditions of a business rule are met then the transaction (update, insert, or delete) will be interrupted. |
| Active | N | When set to TRUE, a business rule will be performing; otherwise, it will not. |
| Inheritance | N | When set to TRUE, a business rule will be applied not only for the table specified in the Table field but also for all its child tables. |
| Advanced | N | When set to TRUE, additional fields for configuration are displayed on the business rule form, including Script field. |
| When to Run tab | ||
| When | N | Defines the moment of a business rule execution:
This field is available when the Advanced is TRUE. |
| Order | N | Defines the order of the business rule execution. If there are several business rules, they will perform in the ascending order. This field is available when the Advanced is TRUE. |
| Priority | N | Defines the importance of the business rule. This field is available when the Advanced is TRUE. |
| Action Insert | N | When set to TRUE, a business rule will perform the actions when inserting a new record. |
| Action Update | N | When set to TRUE, a business rule will perform the actions when updating a record. |
| Action Delete | N | When set to TRUE, a business rule will perform the actions when deleting a record. This field is available when the Advanced is TRUE. |
| Action Query | N | When set to TRUE, a business rule will perform the actions when querying a record. This field is available when the Advanced is TRUE. |
| Filter Conditions | N | A condition builder that allows using static and dynamic filters. After specifying a table in the Table field, all fields of this table will be available in the constructor. Use dynamic filter conditions like is (dynamic) or is not (dynamic) when composing conditional expressions to make your business rules more versatile. |
| Action tab | ||
| Add Message | N | Check this box to display the Message text field if you want to show a message to a user when a business rule is performed. |
| Message | N | Enter the message text you want to show to a user when a business rule is performed. |
| Advanced tab | ||
| Condition | N | The condition option written using server-side API defines situations when a business rule runs. If this condition is met, then a Script will be executed. Use logical operators && (AND) and || (OR) for making up the complex conditional expressions. Condition option allows invoking server-side Script Includes created. |
| Script | N | The action sequence that will be executed when a business rule is launched, previous and current variables are available:
|
