Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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 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.


Notetip

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:

  1. Open a business rule desired;.
  2. On the form, check the Abort Action box;.
  3. 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:

  1. Navigate to System Definitions → Business Rules.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exit to apply changes.

Business rules form fields

multiselect specifies the roles of users that must be met to perform a business rule
FieldDescription
NameName a business rule.
TableA table on which a business rule will be performing.
DescriptionA brief action description.
Set ValueSelect a column of the table chosen in the Table field and define the needed value.
Execute Function
Abort actionActionWhen set to TRUE, and all conditions of a business rule are met then the transaction (update, insert, or delete) will be interrupted.
ActiveWhen set to TRUE, a business rule will be performing; otherwise, it will not.
InheritanceWhen 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.
AdvancedWhen 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:

  • before – execution prior to the operation of the business rule launch trigger (prior to the updating, inserting or deleting a record)
;
  • after – execution after to the operation of the business rule launch trigger (after the updating, inserting or deleting a record).
  • async –
  • display –


Info

This field is available when the Advanced is TRUE.


Order

Defines the order of the business rule execution. If there are several business rules, they will perform in the ascending order.

Info

This field is available when the Advanced is TRUE.


Priority


Info

This field is available when the Advanced is TRUE.


Action InsertWhen set to TRUE, a business rule will perform the actions when inserting a new record.
Action UpdateWhen set to TRUE, a business rule will perform the actions when updating a record.
Action Delete

When set to TRUE, a business rule will perform the actions when deleting a record.

Role Conditions
Info

This field is available when the Advanced is TRUE.


Action Query


Info

This

field

is available when the Advanced is TRUE.


Filter Conditions

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.

Info

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 messageMessageCheck this box to display the Message text field if you want to show a message to a user when a business rule is performed.
MessageEnter the message text you want to show to a user when a business rule is 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 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

The action sequence that will be executed when a business rule is launched, previous and current variables are available:

  • previous – the state of a 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
absoluteUrltrue
classfixedPosition