Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Merged branch "STSK0000405" 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  rules run. Both execute after an action record start (insert

Image Added

Before Rules run conditions:

  • After record action start (create, update, or delete).
Image Removed
  • Before
rules run condition:
  • Before the system performs the server updates.

After rules Rules run condition:conditions:

  • After record action start (create, update, or delete).
  • 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 check the Abort Action checkbox 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  Anchorbusiness rule

fields

business rule fields
If the Advanced checkbox is unselected, the script will not be executedWhen set to TRUE, additional fields for configuration are displayed on the business rule form, including Script field.advanced tab
  • previous is equal to the empty SimpleRecord object.
  • current is equal to the SimpleRecord object at the moment when the rule execution starts
    • .


    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 When set to TRUE, and all conditions of a business rule are met then the transaction (update, insert, or delete) when all conditions are metwill be interrupted.
    ActiveNSelect this checkbox to make the business rule activeWhen set to TRUE, a business rule will be performing; otherwise, it will not.
    InheritanceNSelect this checkbox to apply this business rule to all child tables of the table defined in the Table fieldWhen 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.
    AdvancedN

    Select this checkbox to display additional fields for complex business rules:

    1. When to Run tab
      • When
      • Order
      • Priority
      • Action Delete
    2. Advanced tab
      • Script
    Note
    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 is TRUE.


    Note

    It is not recommended to call record validation within scripts of the business rule of before type. Validation is applied automatically after the business rule of this type is executed.


    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 is TRUE.


    PriorityN

    Defines the importance of the business rule.

    Info

    This field is available when the Advanced is selected is TRUE.


    Action InsertNSelect this checkbox to execute the business rule when inserting When set to TRUE, a business rule will perform the actions when inserting a new record.
    Action UpdateNSelect this checkbox tp execute the When set to TRUE, a business rule will perform the actions when updating a record.
    Action DeleteN

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

    Info

    This field is available when the Advanced is selected is TRUE.


    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 Check this checkbox box 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
    ScriptN

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

    • previous previous – the state of a record object before insert, update, or deletefield before saving. This variable is not available to use in Action Insert business rules.
    • current the state of a record fields values that will be inserted, updated, saved 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
    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