Page History

---

Tip
Role required: admin.

To create ita new business rule, please perform the following 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

This field

is available

appears when

the

the Advanced checkbox is selected and

the

the When

field

 field value is set to before

or

 or after.

This field

is available

appears when

the

the Advanced checkbox is selected.

Field	Mandatory	Description
Name	Y	Business rule nameSpecify a name for the business rule.
Table	Y	Table on which a Select the table for which the business rule will runis executed.
Description	N	A Add a brief description of the action description.
Active	N	Select this checkbox to make activate the business rule active.
Inheritance	N	Select this checkbox to apply this business rule to all child tables of the table defined in the specified Table field.
Advanced	N	Select 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
When	N	Defines Select the moment of the business rule execution: before – execution prior to the operation the rule is executed before the trigger of the business rule launch trigger (prior to the is fired (before inserting, updating, inserting or deleting a record); after – execution – the rule is executed after to the operation trigger of the business rule launch trigger is fired (after the inserting, updating, inserting or deleting a record). async after – execution the rule is carried out executed after all preceding business rules are completedhave been executed: the system returns the form with all changes, and then runs the async after business rules in the background. Using async after business rules, you can optimize system response time.
Order	N	Defines Specify the order of the business rule execution. If there are several multiple business rules of the same type (before, after, async after), they will perform are executed in the ascending order. info This field is available appears when the the Advanced checkbox is selected and the the When field  field value is set to before or  or after.
Priority	N	Defines Specify the importance priority of the business rule. If there are multiple business rules with the same Order, they are executed in the descending order according to their Priority.
Info
Action Insertinsert	N	Select this checkbox to execute the business rule when inserting when a new record is inserted.
Action Updateupdate	N	Select this checkbox to execute the business rule when updating a record is updated.
Action Deletedelete	N	Select this checkbox to execute the business rule when deleting a record is deleted.
Info
Filter Conditionsconditions	N	A condition builder that allows using static and dynamic filtersSpecify the conditions for the business rule execution. After specifying a table in the Table field, all fields of this table will be are available in the constructorcondition builder. Info Use the dynamic filter conditions like is (dynamic) or is not (dynamic) when composing conditional expressions 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 Valuevalue	N	Select a column and define the value you need. Available columns depend on the table specified in the Table field. specified Table. The values from the Set value field are applied at the moment of the rule running. The current object state in the script is equal to the state after applying the Set value template. Application of the Set value template occurs automatically in the before business rules. To use the template in the after business rules you should call update() for the current object in the script: Code Block language js theme Confluence linenumbers true (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 Anchor abort action abort action Abort Action	N	Select this checkbox to interrupt the transaction (insert, update, or delete) when all conditions are met. Tip A It is a good practice is 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 the no message is not specified, only the standard 'Saving error' message  will occur message is displayed when the action abortsis aborted: Image Modified If the abort conditions cannot be set using the the Filter Conditions field field, you can use the script with the setAbortAction and ss.addErrorMessage methods in the script. 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 Messagemessage	N	Select this checkbox to display the Message text field if you want need to show a message to a user when a the business rule is performed.
Message	N	Enter the message text you want need to show to a user when a the business rule is performed. The message will appear in the bottom right corner.  Tooltip onlyIcon true appendIcon info-filled iconColor blue Image Removed is displayed as a flash message.  Here, you can also copy the value of a To enable localization of the messages, use the values of the  Source Message (source_message) record) records from the app category (determined by the value in the Category column). See the Localization and Multi-language Language Support article 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 field appears when the Add Message checkbox is selected.
Advanced tab
Script	N	Info This field is available when the Advanced is selected. 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 insertinsertion, update, or deletedeletion. The previous object is only available for the update action. current – the state of a record that will be is inserted, updated, or deleted. The current object is still available after the record is deleted. When a record is inserted previous  previous is null. current  current is equal to the  the SimpleRecord  object  object that will be inserted. When a record is updated previous  previous is equal to the SimpleRecord  object  object as it was before transaction started. current  current is equal to the  the SimpleRecord  object  object at the moment when the rule execution starts. When a record is deleted previous  previous is null. current  current is equal to the  the SimpleRecord  object  object at the moment when the rule execution starts. note You can call the REM attributes in your the business rule rules of before type , . In this case, while your the business rule is processed processing, you will get the current attribute values, before the transaction occurs. Info The previous object is available only for the update action. When the async after business rule is triggered, the action of the rule is sent to the queue. Because of this, there may be 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 time the business rule action is executed. Warning Anchor recursion_warning recursion_warning Avoid Warning It is strongly recommended to avoid using current.update() with in the before or async after business rule .It is strongly recommended to scripts, as it may cause recursion. If you cannot avoid using current.update() with asyncasync after business rules. It may cause unpredictable system behavior. business rules. It may cause unpredictable system behavior.It is strongly recommended to avoid using the setAbortAction method with async, add a run condition for the rule that is not satisfied after the first execution of the rule. Otherwise, recursion is inevitable. 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 business rule type. Otherwise, if a business rule fails during a transaction, the before rule inserts/updates a record in other tables which leads to data inconsistency. This field appears when the Advanced 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

It is possible to perform business rules that terminate abort the follow-up subsequent actions and processes.

: business rules,

notifications,

approval rules, and others.

See Approvals 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 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 has the is set to before field.

   Tooltip
   onlyIcon true appendIcon info-filled iconColor blue
   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 overrideoverride  

Anchor
override override

If necessary, some "out-of-the-box" business rules can be overridden.

• For applications other than Simple it is sufficient enough to copy an "out-of-the-box" rule using the Make a copy action and deactivate the original rule. Then you You can determine define the required logic in the copy of the rule.
• For the Simple application the majority of the , most rules are delivered with Protection Policypolicy = Protected, thus so you can not simply deactivate them. However, the rules of the When=before type can be overridden by rules of a higher order with the same start conditions of a higher order. 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 sufficient enough to make a copy of the rule using the Make a copy action, determine define a specific logic and set Order = 1000. If the value in the field must should remain unchanged, use the rule triggered by an Action Updateupdate event with the following script:

(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);

Бизнес правила

Бизнес правило представляет собой действие, запускаемое на серверной стороне после отправки формы записи (при создании, обновлении или удалении). Бизнес правила выполняются в рамках транзакции с БД, вне зависимости от интерфейса, через который была инициирована транзакция (отправка формы пользователем, выполнение серверного скрипта, REST запрос, выполнение блока Workflow Activity). Действие правила может выполнятся как в отношении текущей записи, так и в отношении других записей.

Бизнес правила используют для:

• изменения значений в полях записи вызвавшей срабатывание правила при соблюдении определённых условий;
• выполнения серверного скрипта правила;
• выведения сообщений на сторону клиента;
• создания системных событий для отправки уведомлений по электронной почте или выполнения других серверных скриптов;
• прерывания выполнения транзакции с БД.

Переход в список бизнес правил через пункт навигатора System Definition -> Business Rules. Для просмотра списка бизнес правил, связанных с таблицей необходимо:

1. перейти на список или форму таблицы;
2. выбрать пункт бургер меню Configure -> Business Rules.

В зависимости от решаемой бизнес задачи, используют соответствующий тип бизнес правил:

• before;
• after;
• async after (асинхронные).

Тип бизнес правила задаётся на вкладке When to Run в поле When (для отображения расширенного набора полей необходимо активировать атрибут Advanced/Расширенная настройка). Значение параметра When по умолчанию равно before, поле When скрыто с формы.

• Правила с типом before (When=before) запускаются до завершения транзакции с БД.
• Правила с типом after запускаются после завершения транзакции.
• Правила с типом async after (асинхронные бизнес правила) выполняются после блока after правил без обеспечения очерёдности.

Последовательность выполнения бизнес правил разных типов в контексте отправки формы:

Image Removed

Объекты доступные в скрипте правила

В скрипте бизнес правила доступны объекты записи, вызвавшей срабатывание правила – previous и current.

• previous – объект класса SimpleRecord, который является состоянием записи в БД до срабатывания правила. В бизнес правилах на Action Insert и Action Delete previous равен null.
• current – объект класса SimpleRecord, который хранит состояние записи в момент срабатывания правила. В бизнес правилах на Action Delete – содержит состояние объекта до удаления. Особенность работы асинхронных бизнес: в момент срабатывания бизнес правила, действие правила отправляется в очередь. Другими словами, возможен незначительный простой между срабатыванием бизнес правила и выполнением действия. Поэтому в асинхронных бизнес правилах current содержит состояние объекта на момент выполнения действия правила.

Запуск бизнес правил влияет на производительность приложения. Для оптимизации выполнения запросов при отправке формы задавайте условия срабатывания бизнес правил через поле Filter Conditions.
Например, в задаче Task существует поле caller. Поле ссылается на запись пользователя User. Если у пользователя значение поля Active меняется на true, устанавливать всем задачам пользователя поле Active равным true. И наоборот, если пользователь становится неактивным (Active=false) – активность его задач должна меняться на false. Скрипт бизнес правила, запускаемого после обновления записи User будет иметь вид:
(function executeRule(current, previous /*null when async*/) {
    if (previous.active != current.active) { // значение в поле active меняется?
        const task = new SimpleRecord('task');
        task.addQuery('caller', current.sys_id);
        task.addQuery('active', '!=', current.active); // исключить из выборки записи, для которых не нужно менять значение
        task.query();
        task.setMultipleValue('active', current.active);
        task.updateMultiple();
    }
})(current, previous);

В таком виде бизнес правило будет срабатывать при каждом обновлении текущей записи, вне зависимости от того, изменилось ли значение активности. Для оптимизации, условие срабатывания должно if (previous.active != current.active) быть вынесено в поле Filter Conditions:

Image Removed
Бизнес правила могут использоваться для прерывания выполнения транзакции с БД.
Существует два сценария настройки бизнес правила для прерывания транзакции:

1. No/Low-code сценарий. Применим если условие запуска правила может быть задано через поле Filter Condition. 
   Параметры бизнес правила:
     • When: before
     • Filter Condition: {условие запуска правила}
     • Abort Action: активно
     • Message: {текст сообщения с причинами прерывания}
2. Pro-code сценарий, если условие запуска не может задано через Filter Condition
   Параметры правила:
   • When: before
   • Advanced: активно
   • Abort Action: не активно
   • Script: {скрипт с вызовом метода ss.addErrorMessage() для вывода сообщения с причиной прерывания + вызов метода setAbortAction()}

Рекомендации по использованию бизнес правил

Используйте поле Filter Conditions для задания условия срабатывания правила. Это позволит оптимизировать работу приложения, сократив количество запускаемых правил.

Избегайте использования current.update() в скрипте бизнес правила т.к. это может привести к рекурсии. Если без вызова current.update() не обойтись – добавьте условие срабатывания для правила, которое перестанет выполняться после первого запуска правила. В противном случае рекурсия неизбежна.

Если бизнес правило используется для прерывания транзакции – обязательно добавляйте вывод сообщения для пользователя с причинами прерывания. По умолчанию, прерывание транзакции сопровождается сообщением с текстом Saving error / Ошибка сохранения:
Используйте для вывода сообщения поле Message или метод ss.addErrorMessage() в скрипте правила.

Если в скрипте бизнес правила производится создание/обновление записей в других таблицах, используйте тип запуска after. В противном случае, если в процессе выполнения транзакции одно из бизнес правил выполнится с ошибкой, правило запускаемое на before создаст/обновит запись в других таблицах, что приведет к несогласованности данных.

Особенности использования бизнес правил

1. Значения из поля Set value применяются в момент срабатывая правила. Состояние объекта current в скрипте правила равно состоянию после применения шаблона Set value.
2. Применение шаблона Set value происходит автоматически в правилах типа before. Для применения шаблона в правилах с типом after необходимо добавлять в Script вызов метода update() для объекта current:
    
   (function executeRule(current, previous /*null when async*/) {
    current.update();
})(current, previous);
3. Для прерывания транзакции необходимо использовать правила с типом before. Прерывание возможно реализовать, активируя поле Abort Action. В таком случае условия прерывания нужно задавать через поле Filter Condition. Если условие не может быть задано через Filter Condition – необходимо использовать метод SimpleRecord setAbortAction() для объекта current в скрипте правила: 
   (function executeRule(current, previous /*null when async*/) {
  if (String(current.serial_number).length != 10) {
   ss.addErrorMessage('Serial Number should be 10 characters length');
   current.setAbortAction(true);
  }
})(current, previous);
4. Используя метод прерывания транзакции setAbortAction() необходимо учитывать, что скрипт написанный после вызова метода не будет выполнен.
5. В качестве значения для поля Message могут использоваться значения из справочника Source Message (source_message), что позволит локализовать выводимые сообщения.
6. Системные поля записи: ID (sys_id), Updated by (sys_updated_by), Updated at (sys_updated_at), Created by (sys_created_by), Created at (sys_created_at), Table (sys_db_table_id) заполняются после создания (вставки) записи. Соответственно, в бизнес правилах с типом before срабатывающих при вставке, значения системных полей будут недоступны. Для получения значений системных полей (кроме sys_id) используйте методы
     • ss.getUserID()
     • new SimpleDateTime().getValue()
     • new SimpleRecord('sys_db_table').get('name', current.getTableName()).sys_id;
7. В бизнес правилах на Action Delete объект current содержит состояние объекта до удаления.
8. В момент срабатывания асинхронного бизнес правила, действие правила отправляется в очередь. Поэтому возможен незначительный простой между срабатыванием бизнес правила и выполнением действия. Объекты current и previous в асинхронных бизнес правилах содержит состояние объекта на момент выполнения действия правила.

Отладка правил

Историей срабатывания конкретного бизнес правила доступна на форме бизнес правила в связанном списке Script Log:

Image Removed

По умолчанию, логирование серверных скриптов отключено. Для включения перейдите в список системных свойств System Properties и укажите значение true для записи системного свойства simple.logs.enable_script_logging.

Выполнение каждого серверного скрипта логируется в таблицу Script Logs [sys_log_script]. Переход в список через навигатор –  System Logs -> Script Logs.

Выполните фильтрацию логов по документу, для которого необходимо проанализировать транзакцию, укажите промежуток выполнения транзакции +- 10 секунд и добавьте сортировку по полю Start time:
Image Removed