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.
| 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 before and After rules run. after rules run. Both execute after an action record start (insert, update, or delete).
Process starts with a form action: if it is update or delete action, data source is the database, and therefore the record has the previous block. The previous block represents form condition before action (form submission – insert, update, or delete), and the current blocks represent a form condition after the action is completed. Form submission can be performed by a user, script, or REST API request.
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.
| Tip |
|---|
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 a business rule desiredrecord you need.
- In the When to Run tab, define the abort conditions.
- On In the form Action tab, check select the Abort Action box checkbox.
In the When to Run tab, check that the When field has the before field.
Tooltip onlyIcon true appendIcon info-filled iconColor blue The When field is displayed when the Advanced checkbox is selected.
Click Save or Save and Exit to apply changes.
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 Definition → Business Rules.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
Business rules form fieldsAnchor business rule fields business rule fields
| Field | Mandatory | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| Name | Y | Name a business Business rule name. | ||||||
| Table | Y | A table Table on which a business rule will be performingrun. | ||||||
| Description | N | A brief action description. | ||||||
| Set Value | N | Select a column of and define the value you need. Available columns depend on the table chosen specified 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 Select this checkbox to interrupt the transaction (update, insert, or delete) will be interruptedwhen all conditions are met. | ||||||
| Active | N | When set to TRUE, a business rule will be performing; otherwise, it will notSelect this checkbox to make the business rule active. | ||||||
| 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 tablesSelect this checkbox to apply this business rule to all child tables of the table defined in the Table field. | ||||||
| Advanced | N | When set to TRUE, additional fields for configuration are displayed on the business rule form, including Select this checkbox to display the Script field. | ||||||
| When to Run tab | ||||||||
| When | N | Defines the moment of a business rule execution:
| ||||||
| Order | N | Defines the order of the business rule execution. If there are several business rules, they will perform in the ascending order.
| ||||||
| Priority | N | Defines the importance of the business rule.
| ||||||
| Action Insert | N | When set to TRUE, a business rule will perform the actions when inserting Select this checkbox to execute the business rule when inserting a new record. | ||||||
| Action Update | N | When set to TRUE, a Select this checkbox to execute the business rule will perform the actions when updating a record. | ||||||
| Action Delete | N | When set to TRUE, a Select this checkbox to execute the business rule will perform the actions when deleting a record.
| ||||||
| 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.
| ||||||
| Action tab | ||||||||
| Add Message | N | Check Select this box checkbox 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. Here, you can also copy the value of a Source Message (source_message) record. See the Interface Localization article to learn more.
| ||||||
| Advanced tab | ||||||||
| Script | N | The action sequence that will be executed when a business rule is launched, previous and current variables are available:
| ||||||
| Table of Contents | ||||
|---|---|---|---|---|
|