Надсилання валідаційної помилки: Throw validation error

1. Загальна інформація

Інтеграційне розширення Throw validation error дозволяє налаштовувати завдання для надсилання валідаційних помилок у бізнес-процесі. Це розширення допомагає автоматизувати процеси перевірки умов та реагування на їх невідповідність, забезпечуючи належне оброблення валідаційних помилок. Розширення додає різні властивості до сервісного завдання (Service Task).

Таблиця 1. Короткі відомості про делегат
Назва Пояснення

Бізнес-назва інтеграційного розширення

Throw validation error

Службова назва інтеграційного розширення

${userDataValidationErrorDelegate}

Назва файлу у бібліотеці розширень

userDataValidationErrorDelegate.json

Відмінність делегата Throw validation error від Throw System Error полягає у його використанні поруч з XOR-шлюзом для перевірки умов. Якщо умови не задовольняються, процес видає користувачеві відповідну валідаційну помилку. Наприклад, якщо користувач вже існує, коли ви хочете створити нового користувача.

2. Перед початком

Якщо ви використовуєте функціональність Кабінету адміністратора регламентів для розробки реєстру, вам не потрібно встановлювати типові розширення, додаткові зовнішні застосунки та плагіни. Портал містить усе необхідне вбудоване з коробки.

При моделюванні бізнес-процесів із використанням сторонніх застосунків, важливо інтегрувати каталог типових розширень з нашого репозиторію. Завітайте до business-process-modeler-extensions, щоб завантажити необхідні файли. Наприклад, для таких інструментів, як Camunda Modeler, у вашій теці /element-templates мають бути включені відповідні JSON-файли. Для детальних інструкцій, будь ласка, перегляньте Встановлення типових розширень.

3. Налаштування

Делегат Throw validation error призначений для використання у сервісних завданнях (Service Task) бізнес-процесу. Він дозволяє налаштувати автоматичне надсилання валідаційних помилок з різними параметрами.

3.1. Налаштування сервісного завдання

  1. Створіть завдання типу Service Task у вашому бізнес-процесі.

  2. Назвіть завдання, наприклад, Надсилання валідаційної помилки.

  3. Застосуйте шаблон делегата, обравши Throw validation error зі списку в налаштуваннях завдання.

    throw validation error 1

3.2. Налаштування делегата

У розділі Inputs  Validation errors вкажіть деталізоване повідомлення про валідаційну помилку, яку повинен бачити користувач на цьому кроці процесу. Наприклад, Користувач зі вказаними атрибутами вже існує. Налаштуйте поля наступним чином:

  1. Local variable assignment  ON — це вмикає локальне призначення змінних.

  2. Assignment type  List — у нашому прикладі це список значень. Також доступні типи Map, Script та String or Expression.

  3. List values — налаштування значень у форматі списку. Вкажіть перелік значень у наступному форматі:

    {"field": "", "value": "", "message": "Користувач зі вказаними атрибутами вже існує"}

4. Приклад

Ось приклад, який показує, як відповідний делегат використовується у бізнес-процесі:

throw validation error 2
Зображення 1. Приклад. Налаштування делегата Throw validation error
Де можна знайти приклад бізнес-процесу?

Адміністратор Платформи може розгорнути для вас демо-реєстр — еталонний реєстр, що містить референтні та інші приклади файлів для створення цифрового регламенту. Він містить різноманітні елементи для розробки моделі даних, бізнес-процесів, UI-форм, аналітичної звітності, витягів, сповіщень, зовнішніх інтеграцій та багато іншого.

Еталонний регламент з прикладами для України зберігається в репозиторії ua-registry-demo-regulation.

Детальну інструкцію щодо розгортання демо-реєстру та отримання референтних прикладів моделювання ви знайдете на сторінці Розгортання демо-реєстру із референтними прикладами.

Throw validation error — делегат, який використовується у багатьох бізнес-процесах, що потребують перевірки умов та обробки валідаційних помилок.

Ви можете використати один із прикладів процесів за пошуком по ключовим словам — reference-officers-management.

У Кабінеті користувача бізнес-процес буде доступний у розділі Доступні послуги.

5. Пов’язані сторінки