Підсистема моделювання регламенту реєстру

🌐 Цей документ доступний українською та англійською мовами. Використовуйте перемикач у правому верхньому куті, щоб змінити версію.

1. Загальний опис

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

2. Функції підсистеми

  • Моделювання складових регламенту реєстру за принципами Low-code

  • Пакетне завантаження користувачів

  • Внесення змін у декларативний опис регламенту реєстру

  • Версіонування регламенту реєстру з історією внесення змін

  • Проведення інспекції змін перед внесенням їх до регламенту реєстру

  • Перегляд результатів перевірки змін в регламент реєстру Підсистемою розгортання регламенту реєстру

3. Технічний дизайн підсистеми

regulation management design
Зображення 1. Компонентна діаграма підсистеми моделювання регламенту. Загальна
  • (1) - Архів звіту - це zip архів який в собі містить перелік запитів та налаштування звітів в декларативному форматі.

  • (2) - Сценарії які релевантні для моделювання

  • (3) - Внутрішня структура компонентів Redash описана у Підсистемі аналітичної звітності реєстру

3.1. Аудит та журналювання подій

Події відправки повідомлень користувачам системою фіксуються у журналі аудиту з повним контекстом.

Тип події Службова назва Опис

SYSTEM_EVENT

USER_CREATE

Подія створення нового користувача під час імпорту.

Детальніше з дизайном Підсистеми журналювання подій аудиту можна ознайомитися за посиланням.

4. Складові підсистеми

Назва компоненти Представлення в реєстрі Походження Репозиторій Призначення

Вебінтерфейс моделювання регламенту

admin-portal

origin

gerrit:/mdtu-ddm/low-code-platform/platform/frontend/applications/common-web-app

Клієнтський вебдодаток для моделювання регламенту реєстру за принципами Lowcode

Вебінтерфейс моделювання звітів

  • redash-admin

  • redash-admin-adhocworker

  • redash-admin-scheduler

  • redash-admin-postgresql

  • redash-admin-redis-master

fork

Клієнтський вебдодаток для створення та налаштування аналітичних звітів та дашбордів

Сервіс інспекції та зберігання змін регламенту

  • gerrit

  • gerrit-operator

3rd-party

Програмний інструмент, що дозволяє зберігати та керувати версіями регламентів реєстрів.

Сервіс управління регламентом

registry-regulation-management

origin

github:/epam/edp-ddm-registry-regulation-management

Сервіс який надає REST API для роботи з версіями регламенту реєстру та його складовими

Language сервер

ddm-language-server

origin

github:/epam/edp-ddm-language-server

Сервіс який надає функціональність підказок, автодоповнення функцій та перевірки при редагуванні коду у Вебінтерфейсі моделювання регламенту

Сервіс вивантаження звітів

report-exporter

origin

github:/epam/edp-ddm-report-exporter

Сервіс який надає REST API доступ для експорту звітів з Вебінтерфейсу моделювання звітів

Утиліта завантаження надавачів послуг

publish-users-job

origin

github:/epam/edp-ddm-user-publisher

Сервіс який надає REST API доступ для експорту звітів з Вебінтерфейсу моделювання звітів

Операційне сховище файлів з користувачами

ceph:user-import

origin

github:/epam/edp-ddm-registry-configuration/blob/main/deploy-templates/templates/CephObjectBucketClaim.yaml

Зберігання файлу з користувачами для імпорту

Архівне сховище файлів з користувачами

ceph:user-import-archive

origin

github:/epam/edp-ddm-registry-configuration/blob/main/deploy-templates/templates/CephObjectBucketClaim.yaml

Архів файлів з користувачами для імпорту

Git репозиторій Цифрового регламенту реєстру

gerrit:registry-regulations

origin

github:/epam/edp-ddm-empty-template-registry-regulation

Git репозиторій Цифрового регламенту реєстру у сервісі інспекцій та зберігання змін регламенту

5. Технологічний стек

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

6. Атрибути якості підсистеми

6.1. Security

Доступ до вебінтерфейсів підсистеми можливий тільки для авторизованих користувачів. Для авторизації використовуються стандартні механізми системи, зокрема OpenID Connect та SAML інтеграція з Підсистемою управління користувачами та ролями.

6.2. Usability

Моделювання регламенту у вебінтерфейсах підсистеми здійснюється за принципами Lowcode з впровадженням автопідказок для користувача, автодоповнення та валідації введеної інформації що дозволяє зменшити час на розробку регламенту та збільшити навченість користувачів.

6.3. Modifiability

Структура цифрового регламенту реєстру підсистеми розділена на окремі елементи, які слабо пов’язані один з одним (принцип Low coupling) та використовують принципи Lowcode для розробки, що спрощує внесення нових змін до регламенту, прискорює швидкість розробки та зменшує необхідну експертизу моделювальника.