Business Rules

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.

The scheme below illustrates when before, after, and async after rules run. All rules execute after an action record start (insert, update, or delete).

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

Before rules run conditions:

• After record action start (insert, update, or delete).
• Before the system performs server updates.

After rules run conditions:

• After the system performs server updates.

Async after rules run conditions:

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

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 Definition → Business Rules.
2. Click New and fill in the fields.
3. Click Save or Save and Exit to apply changes.

Business rules form fields

Abort business rules 

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

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 Action checkbox.

4. In the When to Run tab, check that the When field has the before field.

5. Click Save or Save and Exit to apply changes.

Out-of-the-box business rules override 

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

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

(function executeRule(current, previous = null /*not null only when action is update*/) {
  if (previous) {
    current.getValue('field_name') = previous.getValue('field_name');
  }
})(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 правил без обеспечения очерёдности.

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

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

В скрипте бизнес правила доступны объекты записи, вызвавшей срабатывание правила – 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:

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

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

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

1. Используйте поле Filter Conditions для задания условия срабатывания правила. Это позволит оптимизировать работу приложения, сократив количество запускаемых правил.
2. Избегайте использования current.update() в скрипте бизнес правила т.к. это может привести к рекурсии. Если без вызова current.update() не обойтись – добавьте условие срабатывания для правила, которое перестанет выполняться после первого запуска правила. В противном случае рекурсия неизбежна.
3. Если бизнес правило используется для прерывания транзакции – обязательно добавляйте вывод сообщения для пользователя с причинами прерывания. По умолчанию, прерывание транзакции сопровождается сообщением с текстом Saving error / Ошибка сохранения:
   
   Используйте для вывода сообщения поле Message или метод ss.addErrorMessage() в скрипте правила.
4. Если в скрипте бизнес правила производится создание/обновление записей в других таблицах, используйте тип запуска 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:

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

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

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