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

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

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

Підсистема, призначенням якої є формування витягів з даних реєстру з бізнес-процесів на базі налаштованих шаблонів та довгострокове їх зберігання.

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

  • Формування витягів з даними реєстру на базі налаштованих шаблонів

  • Перевірка статусу формування витягу

  • Отримання сформованого користувачем витягу з файлового сховища

  • Підписання згенерованих витягів

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

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

excerpt overview

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

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

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

excerpt-service-api-deployment

origin

github:/epam/edp-ddm-excerpt-service-api

Надання REST API для створення заявок на витяг, отримання статусу заявок та завантаження витягів

Сервіс генерації PDF-витягів

excerpt-worker-deployment

origin

github:/epam/edp-ddm-excerpt-worker

Генерація витягів у форматі pdf

Сервіс генерації CSV-витягів

excerpt-worker-csv-deployment

origin

github:/epam/edp-ddm-excerpt-worker-csv

Генерація витягів у форматі csv

Сервіс генерації DOCX-витягів

excerpt-worker-docx-deployment

origin

github:/epam/edp-ddm-excerpt-worker-docx

Генерація витягів у форматі docx

Утиліта генерації історичних витягів

history-excerptor-job

origin

github:/epam/edp-ddm-history-excerptor

github:/epam/edp-ddm-history-excerptor-chart

Генерація історичних витягів

Операційна БД витягів

operational:excerpt

origin

github:/epam/edp-ddm-registry-postgres/tree/main/platform-db/changesets/excerpt

Зберігання стану запитів на формування витягів

Операційне сховище файлів витягів

ceph:file-excerpt-bucket

origin

-

Зберігання згенерованих та підписаних витягів

Операційне сховище файлів підписаних витягів

ceph:excerpt-signature-bucket [deprecated]

origin

-

Зберігання підписаних витягів з реєстру

Операційне сховище файлів шаблонів витягів

ceph:excerpt-templates

origin

-

Зберігання шаблонів витягів

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

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

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

USER_EVENT

GENERATE EXCERPT CALL

Отримання запита на генерацію витягу

USER_EVENT

EXCERPT GENERATION

Генерація відповідного витягу

USER_EVENT

RETRIEVE EXCERPT CALL

Отримання згенерованого витягу

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

7.1. Observability

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

Детальніше з дизайном підсистем можна ознайомитись у відповідних розділах:

7.2. Auditability

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