Business-rule is a server-side script running at the moment of inserting, updating, or deleting a record. Use them for such tasks as conditionally automatic value change in the form fields or event creation for email notifications and script actions.
| Info |
|---|
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 a user submits the form;
- Before the system performs the server updates.
After Rules run conditions:
- After a user submits a form;
- After the system performs the server updates.
| Note |
|---|
Role required: admin. |
Abort Business-rules
It is possible to perform business-rules that terminate the follow-up actions and processes.
| Info |
|---|
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 the 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;
- Fill in the form fields and save the business-rule.
Business rules form fields
| Field | Description | ||
|---|---|---|---|
| Name | The business-rule name. | ||
| Table | A table on which the business-rule will be performing. | ||
| Description | The brief action description. | ||
| Abort action | When set to TRUE, and all conditions of business-rule are met then the transaction (update, insert, delete) will be interrupted. | ||
| Active | When set to TRUE, this business-rule will be performing; otherwise, it will not. | ||
| Inheritance | When set to TRUE, this business-rule will be applied not only for the table specified in the Table field but also for all its child tables. | ||
| Advanced | When set to TRUE, additional fields for configuration are displayed on the business-rule form, including Script field. | ||
| Template | Use this setting to specify the field values of the Table records when performing a business-rule on it. In the right field, choose a Table column and set the desired value in the left field. | ||
| When to Run tab | |||
| When | Defines the moment of a business-rule execution:
| ||
| Order | Defines the order of the business-rule execution. If there are over one business-rules, they will perform in the ascending order. | ||
| Action Insert | When set to TRUE, this business-rule will perform the actions when inserting a new record. | ||
| Action Update | When set to TRUE, this business-rule will perform the actions when updating a record. | ||
| Action Delete | When set to TRUE, this business-rule will perform the actions when deleting a record. | ||
| Role Conditions | This multiselect field specifies the roles of users that must be met to perform a business-rule. | ||
| Filter Conditions | Business-rule launch 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.
| ||
| Action tab | |||
| Add message | Check this box to display the Message text field if you want to show a message to a user when the business-rule performed. | ||
| Message | Enter the message text you want to show to a user when the business-rule performed. | ||
| Advanced tab | |||
| Condition | The condition option written using server-side API defines situations when a business-rule runs. If this condition is met, then the 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 | The action sequence that will be executed when the business-rule is launched, Variables previous and current are available in the function: previous – the state of the record field before saving. This variable is not available to use in Action Insert business-rules; current – record fields values that will be saved. | ||
| Table of Contents | ||||
|---|---|---|---|---|
|