Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Merged branch "DOC0000159" into parent

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 and After rules run. Both execute after an action record start (insert, update, or delete).

Before rules run condition:

  • Before the system performs the server updates.

After rules run condition:

  • After the system performs the server updates.
Info

For more information about execution order for before and after business rules, please refer to the Execution order article.


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:

  1. Open a business rule desired.
  2. On the form, select the Abort Action checkbox.
  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 

Anchor
business rule fields
business rule fields

FieldMandatoryDescription
NameYName a business rule.
TableYA table on which a business rule will be performing.
DescriptionNA brief action description.
Set ValueNSelect a column of the table chosen in the Table field and define the needed value.
Abort ActionNSelect this checkbox to interrupt the transaction (update, insert, or delete) when all conditions are met.
ActiveN

Select this checkbox to make the business rule active.

InheritanceN

Select this checkbox to apply this business rule to all child tables of the table defined in the Table field.

AdvancedN

Select this checkbox to display

the Script field

additional fields for complex business rules:

  1. When to Run tab
    • When
    • Order
    • Priority
    • Action Delete
  2. Advanced tab
    • Script
Note

If the Advanced checkbox is unselected, the script will not be executed.


When to Run tab
WhenN

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).
Info

This field is available when the Advanced is selected.


OrderN

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 selected.


PriorityN

Defines the importance of the business rule.

Info

This field is available when the Advanced is selected.


Action InsertNSelect this checkbox to execute the business rule when inserting a new record.
Action UpdateNSelect this checkbox tp execute the business rule when updating a record.
Action DeleteN

Select this checkbox to execute the business rule when deleting a record.

Info

This field is available when the Advanced is selected.


Filter ConditionsN

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

Advanced tab 

Anchor
advanced tab
advanced tab

ScriptN

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 object before insert, update, or delete.
  • current – the state of a record that will be inserted, updated, or deleted. The current object is still available after record is deleted.
When a record is inserted
  • previous is equal to the empty SimpleRecord object.
  • current is equal to the SimpleRecord object that will be inserted.
When a record is updated
  • previous is equal to the empty SimpleRecord object.
  • current is equal to the SimpleRecord object at the moment when the rule execution starts.


Note

You can call REM attributes in your business rule of before type, In this case, while your business-rule is processed, you will get the current attribute values, before the transaction occurs.


Note

If the Advanced checkbox is unselected, the script will not be executed.




Table of Contents
absoluteUrltrue
classfixedPosition