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

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

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

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

Детальніше про пайплайн MASTER-Build-registry-regulations та особливості розгортання регламенту дивіться на сторінці Модель розгортання регламенту та пайплайн публікацій.

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

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

Таблиця 1. Пояснення до структури регламенту
Регламент	Директорія/Файл	Опис
registry-regulations		Верхньорівнева папка, що містить вкладені директорії із сутностями регламенту.
	bp-auth	Папка, що містить `YAML`-файли доступу до бізнес-процесів для реалмів `citizen` (отримувач послуг), `officer` (посадова особа/надавач послуг) та `external-system` (зовнішні системи та реєстри).
	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	Папка, що містить глобальні змінні бізнес-процесів реєстру
	notifications	Папка, що містить шаблони для відправлення повідомлень через канали зв’язку `diia`, `email`, та `inbox`.
	reports	Папка, що містить сформовану аналітичну звітність (запити та дашборди) у JSON-форматі
	roles	Папка, що містить конфігураційні файли для налаштування ролей у реєстрі (officer.yml — для призначення посадових осіб різних рангів, `citizen.yml` — для визначення отримувачів послуг)
	settings	Папка, що містить загальні налаштування регламенту (повна та скорочена назви реєстру тощо)
	settings.yaml	Конфігураційний файл, що містить системні налаштування реєстру та деяких сервісів