Структура регламенту реєстру

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

Розгортання системи відбувається на підставі одного або декількох регламентів.

Адміністратор формує та розгортає регламент реєстру, що передбачає внесення змін до набору сутностей — елементів регламенту.

Розгортання регламенту реєстру автоматизовано інструментами CI/CD. За розгортання регламенту відповідає Jenkins-пайплайн MASTER-Build-registry-regulations та пов’язані пайплайни.

Каталог регламенту реєстру має чітко визначену структуру директорій. Нижче показано схему типового регламенту.

Структура типового регламенту реєстру

Пояснення до структури регламенту

Таблиця 1. Пояснення до структури регламенту
Регламент	Директорія/Файл	Опис
registry-regulations		Верхньорівнева тека, що містить вкладені директорії із сутностями регламенту.
	bp-auth	Тека, що містить `YAML`-файли доступу до бізнес-процесів для реалмів `citizen` (отримувач послуг), `officer` (посадова особа/надавач послуг) та `external-system` (зовнішні системи та реєстри).
	bp-grouping	Тека, що містить конфігураційний файл bp-grouping.yaml. Налаштування цього файлу призначені для групування бізнес-процесів реєстру.
	bp-trembita	Тека, що містить конфігураційні файли для налаштування взаємодії із зовнішніми сервісами та системами через SOAP-інтерфейси ШБО «Трембіта», а також через REST.
	bpmn	Тека, що містить схеми бізнес-процесів у форматі .bpmn (різновид XML)
	data-model	Тека, що містить схеми для розгортання БД та API-представлень, а також CSV-довідники для подальшого наповнення даними таблиць-довідників.
	dmn	Тека, що містить змодельовані перевірчі правила (таблиці прийняття рішень) у форматі .dmn (різновид XML)
	excerpts	Тека, що містить шаблони PDF-витягів реєстру
	excerpts-csv	Тека, що містить шаблони витягів-звітів у форматі CSV
	excerpts-docx	Тека, що містить шаблони витягів (проєктів наказів) у форматі DOCX
	forms	Тека, що містить змодельовані користувацькі форми введення даних у форматі JSON
	global-vars	Тека, що містить глобальні змінні бізнес-процесів реєстру
	mock-integrations	Тека, що містить змодельовані шаблони емуляцій зовнішніх інтеграцій у форматі JSON.
	notifications	тека, що містить шаблони для відправлення повідомлень через канали зв’язку `diia`, `email`, та `inbox`
	reports	Тека, що містить сформовану аналітичну звітність (запити та дашборди) у JSON-форматі
	roles	Тека, що містить конфігураційні файли для налаштування ролей у реєстрі (officer.yml — для призначення посадових осіб різних рангів, `citizen.yml` — для визначення отримувачів послуг)
	settings	Тека, що містить загальні налаштування регламенту (повна та скорочена назви реєстру тощо)
	settings.yaml	Конфігураційний файл, що містить системні налаштування реєстру та деяких сервісів

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