Отримання сутності із фабрики даних: Read entity from data factory

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

Інтеграційне розширення Read entity from data factory дозволяє налаштовувати завдання для читання даних із таблиці (сутності) за конкретним ідентифікатором в рамках бізнес-процесу. Це розширення допомагає автоматизувати процеси отримання окремих сутностей, забезпечуючи належне оброблення даних та передачу їх до наступних етапів бізнес-процесу. Розширення додає різні властивості до сервісного завдання (Service Task).

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

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

Read entity from data factory

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

${dataFactoryConnectorReadDelegate}

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

dataFactoryConnectorReadDelegate.json

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

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

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

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

Делегат Read entity from data factory призначений для використання у сервісних завданнях (Service Task) бізнес-процесу. Він дозволяє налаштувати автоматичне отримання даних із таблиці (сутності) за конкретним ідентифікатором.

3.1. Налаштування завдання

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

  2. Назвіть завдання, наприклад, Пошук даних за ID в дата-фабриці.

  3. Застосуйте шаблон делегата, обравши Read entity from data factory зі списку в налаштуваннях завдання.

    read entity 1

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

Виконайте наступні налаштування:

Resource

У полі Resource вкажіть назву ендпоінту / таблиці, з якої потрібно отримати дані. Наприклад, imagesnew.

Resource id

У полі Resource id вкажіть ідентифікатор ресурсу. Наприклад, ${imageId}.

imageId можна отримати зі скрипту, наприклад, наступним чином:

set_variable('imageId', response.responseBody.prop('id').value())

Цей скрипт обробляє відповідь від попереднього запита на створення сутності та зберігає ідентифікатор сутності у змінну imageId.

Запит на створення сутності можна виконати за допомогою делегата Створення сутності у Фабриці даних: Create entity in data factory. В результаті виконання делегата, у відповідь ви отримаєте таку JSON-структуру:

{
  "name": "string",
  "imagesnewId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "image": [
    {
      "id": "string",
      "checksum": "string"
    }
  ]
}

З цього JSON-об’єкта скрипт витягне ID сутності.

X-Access-Token

У полі X-Access-Token вкажіть токен доступу користувача, під яким виконується операція. Наприклад:

${initiator().accessToken}

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

${completer('previous user task ID').accessToken}
  • completer() — назва JUEL-функції.

  • 'previous user task ID' — ID попередньої задачі користувача.

  • accessToken — метод, який передає JWT-токен користувача.

Result variable

У полі Result variable вкажіть назву змінної, в яку необхідно записати результат. Наприклад, response.

Після успішного завершення операції, делегат отримує відповідь у такому форматі:

HTTP status code
204 OK
Тіло відповіді
{
  "name": "string",
  "imagesnewId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "image": [
    {
      "id": "string",
      "checksum": "string"
    }
  ]
}

4. Приклад

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

read entity 2
Зображення 1. Приклад. Налаштування делегата Read entity from data factory
Де можна знайти приклад бізнес-процесу?

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

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

Read entity from data factory — делегат, який використовується у бізнес-процесах, що потребують отримання окремих записів з БД.

Ви можете використати один із прикладів процесів за пошуком по ключовим словам — feature-external-system-file-saving.

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

Більш детально про бізнес-процес читайте на сторінці Завантаження цифрових документів за зовнішнім посиланням.