Versions Compared

Old Version 30

changes.mady.by.user Dina Baksheeva

Saved on

compared with

New Version Current

changes.mady.by.user Dina Baksheeva

Saved on

Key

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

A business rule is an action run on the server-side when a record is inserted, updated or deleted. Business rules are executed in a database transaction, irrespective regardless of the interface used to initiate the transaction (a user submitting a form, the execution of a server-side script, a REST request, the execution of a Workflow Activity block). The rule action of a rule can be executed both on the current record and on other records.

Info

Business rules can use scenarios scripts to perform actions with records in the database. There are other options of the script actions available, such as client-side scripts and UI-actions.

Business rules are used for:

  • changing values in the fields of a record that caused the rule to run when certain conditions are met;.
  • executing execution of a server-side script of the rule;.
  • displaying a message to on the client side;.
  • creating system events for sending e to send e-mail notifications or running other run other server-side scripts;.
  • aborting interrupting database transactions with the database.

To view all business rules navigate to System DefinitionSettings → Business Rules.

To view the business rules related to a specific table, complete the steps below:

  1. Navigate to the list or form view of the table; . 
  2. Select Configure → Business Rules from the burger menu.

Business rules types

Depending on the business task to be completed, you can you are solving, use one of the following types of business rules:

  • before;
  • after;
  • async after.
Each type of business rules has its own run conditions.

Before rules run conditions:

  • After record action start (insert, update, or delete).
  • Before the system performs server updates (before the database transaction is completed).

After rules run conditionscondition:

  • After the system performs server updates (after the database transaction is completed).

Async after rules run conditionscondition:

  • After all business rules of other types (after all after business rules).
Info

Async The async after business rules run after before the before and after business rules, so the user first , a user receives the form with all the changes, and then the async after rules run. Thus, using async the async after business business rules, you can optimize system response time – use async the async after rules for resource-intensive scripts that take a lot of time.

The following scheme below illustrates when the before, after  , and async after rules run. All rules execute after a record action start are executed after the start of an action on a record (insert, update, or delete).

Process The process starts with a form action: if it is the an update action, the data source is the database, and therefore so the record has the previous block. The previous block represents the form state before an the action (form submission – insert, update or delete), and the current blocks represent the form state after the action is completed. Form submission can be performed by a user, a script or a REST API request.

Image Removed  Image Added 

Business rules creation

Tip

Role required: admin.

To create a new business rule, perform the steps below:

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

Business rules form fields

Anchor
business rule fields
business rule fields

FieldMandatoryDescription
NameY Type in Specify a name for the business rule name.
TableYSelect the table on for which the business rule will runis executed.
DescriptionN Type in Add a brief description of the action description.
ActiveNSelect this checkbox to make activate the business rule active.
InheritanceNSelect this checkbox to apply this business rule to all child tables of the table defined in the specified Table field.
AdvancedNSelect this checkbox to display the Script field and advanced settings such as the type of the business rule (the When field in the When to Run tab).
When to Run tab
WhenN

Select the moment of the business rule execution:

  • before – the rule is executed before the trigger of the business rule is fired (before inserting, updating, or deleting a record);
  • after – the rule is executed after the trigger of the business rule is fired (after inserting, updating, or deleting a record).
  • async after – the rule is executed after all preceding business rules have been executed: the system returns the form with all changes, and runs the async after business rules in the background.
OrderN

Specify the order of the business rule execution. If there are multiple business rules of the same type (before, after, async after), they are executed in the ascending order.

info

This field appears when

the

the Advanced

checkbox

 checkbox is selected and

the

the When

field

 field value is set

to

to before

or

 or after.

PriorityN

Specify the importance priority of the business rule.

info

. If there are multiple business rules with the same Order, they are executed in the descending order according to their Priority.

This field appears when

the

the Advanced

checkbox

 checkbox is selected and

the

the When

field

 field value is set

to

to before

or

 or after.

Action InsertinsertNSelect this checkbox to execute the business rule when a new record is inserted.
Action UpdateupdateNSelect this checkbox to execute the business rule when a record is updated.
Action DeletedeleteN

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

info

This field appears when

the

the Advanced

checkbox

 checkbox is selected.

Filter ConditionsconditionsN

A condition builder that allows using static and dynamic filtersSpecify the conditions for the business rule execution. After specifying the Table, all fields of this table are available in the constructorcondition builder.

Info

Use the dynamic filter conditions like is (dynamic) or is not (dynamic) when composing setting up conditions to make your business rules more versatile.


Action tab

Info

The Action tab is not available for the async after business rules.


Set ValuevalueN

Select a column and define the value you need.
Available columns depend on the specified Table.

info

  • The values from
the
  • the Set value
field
  •  field are applied at the moment of the rule running.
The current
  • The current object state in the script is equal to the state after applying
the
  • the Set value
template
  •  template.

  • Application of

the

  • the Set value

template

  •  template occurs automatically in

the before

  • the before business rules. To use the template in

the after

  • the after business rules you should

call

  • call update()

for

  •  for the current object in the script:

Code Block
languagejs
themeConfluence
linenumberstrue
(function executeRule(current, previous /*null when async*/) {
    current.update();
})(current, previous);

 Warning
To avoid recursion, you should use the current.update() object only in the after business rules. See below in more detail.

Abort action Abort Action 
 Anchor
abort action
abort action
N
Select this checkbox to interrupt the transaction (insert, update, or delete) when all conditions are met.
 Tip
It is a good practice to specify the reason for the interruption of the action abortion. Select the Add Messagemessage checkbox and type add the text in the Message field.
If no message is specified, the standard  'Saving error'  message will be message is displayed when the action abortsis aborted: 
  
If the abort conditions cannot be set using the Filter Conditions field, use the script with the setAbortAction and ss.addErrorMessage methods. In this case, the Abort Actionaction checkbox should be cleared.
 Warning
When you use the setAbortAction() to abort a transaction, the script is not executed after calling this method.

Add MessagemessageNSelect this checkbox to display the Message field if you need to show a message to a user when the business rule is performed.
MessageN
Enter the message you need to show to a user when the business rule is performed. The message is displayed as a flash message. 
To enable localization of the messages, use the values of the  Source Message   (source_message) records from the   app  category category (determined by the value in the Category column). See Localization and Multi-language Language Support to learn more.
Do not use variables and dynamic links to other records in this message. In order to add a message with variables or dynamic links, select the Advanced checkbox and configure the script in the tab of the same name.
 Info
The Message 
 Info
This field appears when the Add Message checkbox is selected.

Advanced tab
ScriptN
 The action sequence that will Add a script that determines the actions to be executed when a the business rule is launched, . The previous and current variables are available:
  •  previous – the state of a record object before insertion, update, or deletion. The previous object is only available for the update action.
  •  current – the state of a record that is inserted, updated, or deleted. The current object is still available after the record is deleted.
When a record is inserted
  •  previous is null.
 current is 
  •  current is equal to the SimpleRecord object that will be inserted.
When a record is updated
 previous is 
  •  previous is equal to the SimpleRecord object as it was before transaction started.
 current is 
  •  current is equal to the SimpleRecord object at the moment when the rule execution starts.
When a record is deleted
  •  previous is null.
 current is 
  •  current is equal to the SimpleRecord object at the moment when the rule execution starts.
You can call the REM attributes in the business rules of before type. In this case, while the business rule is processedprocessing, you will get the current attribute values, before the transaction occurs.
 At the moment of triggering the When the async after business rule is triggered, the action of the rule action is sent to the queue. Because of this, there may be an insignificant lag a slight delay between the triggering of the business rule and execution of the action. The current and previous objects in the async after business rules contain the state of the object at the moment of execution of time the business rule action is executed.
info
 Warning
 Anchor
recursion_warning
recursion_warning
  • Avoid using  current.update() i n   in the before  or async after business rule scripts, since as it may cause recursion. If you cannot avoid using current.update(), add a run condition for the rule which stops being that is not satisfied after the first run execution of the rule. Otherwise, recursion is unavoidableinevitable. 
  • Avoid using the setAbortAction method with the async after business rules.
  • If a business rule script inserts or updates records in other tables, use the after  run business rule type. Otherwise, if a business rule is executed with an error in the process of transaction execution, a fails during a transaction, the before rule inserts/updates a record in other tables which will lead leads to data inconsistency of data. 
This field appears when 
 the 
the Advanced
 checkbox 
 checkbox is selected.

 Note
The server-side business logic may not work for system tables if the creation or updating of records is initiated by the backend. For example, an Impor Set is created as part of loading an Import Source, or an Email is created as a result of a notification rule, and so on.
Example of tables for which server-side business logic may not work:
  • Main Log (sys_log)
  • Script Log (sys_log_script)
  • Exception Log (sys_log_exception)
  • Record Deletion Log (sys_record_deletion_log)
  • Import Set (sys_import_set)
  • Activity Feed Item (sys_activity_feed_item)
  • Email (sys_email)
Abort business rules 
 Anchor
abort business rule
abort business rule
The abort 
It is possible to perform business rules that terminate abort the follow-up subsequent actions and processes.
 Info
: business rules
 terminate the following processes: Business rules, Notifications, Approval Rules, etc. See Approvals to learn more about approval rule rejection
,notifications,approval rules, and others.
To make your business rule abort the follow-up processes, complete the steps below:
  1. Open a business rule record you need.
  2. In the When to Run tab, define the abort conditions.
  3. In the Action tab, select the  Abort Actionaction  checkbox.
  4. In the When to Run tab, check that the When field is set to before. 
     Tooltip
    onlyIcontrue
    appendIconinfo-filled
    iconColorblue
    The When field is displayed when the Advanced checkbox is selected.

  5. Click Save or Save and Exit exit to apply the changes.
Out-of-the-box business rules override 
 Anchor
override
override
If necessary, some "out-of-the-box" business rules can be overridden.
  • For applications other than Simple it is enough to copy an "out-of-the-box" rule using the Make a copy action and deactivate the original rule. You can define the required logic in the copy of the rule.
  • For the Simple application, most rules are delivered with Protection Policypolicy = Protected, so you can not deactivate them. However, the rules of the When=before type can be overridden by rules of a higher order with the same start conditions. For example, an "out-of-the-box" rule with the before type generates a value in a fieldthe Subject field. The order of the rule is 999. To change the value generation logic, it is enough to make a copy of the rule using the Make a copy action, define a specific logic and set Order = 1000. If the value in the field should remain unchanged, use the rule triggered by an Action Updateupdate event with the following script:
 Code Block
languagejs
themeConfluence
titleExample
linenumberstrue
(function executeRule(current, previous = null /*not null only when action is update*/) {
  if (previous) {
    current.getValue('field_name')subject = previous.getValue('field_name')subject;
  }
})(current, previous);

 Table of Contents