Registry regulations structure

🌐 This document is available in both English and Ukrainian. Use the language toggle in the top right corner to switch between versions.

The system deployment relies on one or multiple regulations.

Configuring and deploying registry regulations involves changing a set of entities/elements within the regulations, which an administrator typically does.

CI/CD tools automate the deployment of the registry regulations. The MASTER-Build-registry-regulations Jenkins pipeline and other related pipelines are responsible for deploying the regulations.

The registry regulations directory has a well-defined structure. The following diagram shows a typical regulations structure.

Typical registry regulations structure

Regulations structure explained

Regulations Directory/file Description

registry-regulations

A top-level directory containing nested directories with entities of the registry regulations.

bp-auth

A directory houses YAML files used for authorizing users in business processes. The associated Keycloak realms are:

citizen: represents the service recipient;
officer: denotes the service provider;
external-system: refers to an external system or registry.

bp-grouping

A directory containing the configuration file bp-grouping.yaml. This file’s settings group the business processes of the registry.

bp-trembita

A directory containing configuration files for interactions with external systems and services through SOAP and REST interfaces.

The bp-trembita settings relate to the Ukrainian implementation in part of the SOAP connection. They may not apply or function as described in other contexts or regions. Please consult the local guidelines or documentation if you are implementing this outside of Ukraine.

bpmn

A directory containing business process diagrams in .bpmn format (a type of XML).

data-model

A directory containing data model diagrams for deploying the database and API representations. It also includes CSV datasets used to populate tables with reference data.

dmn

A directory containing decision rules modeled in .dmn format (a type of XML).

excerpts

A directory containing templates for PDF excerpts.

excerpts-csv

A directory containing templates for CSV excerpts.

excerpts-docx

A directory containing templates for DOCX excerpts.

forms

A directory containing UI forms for business processes modeled in JSON format.

global-vars

A directory containing global variables for the registry business processes.

mock-integrations

A directory containing modeled templates for external API simulation in .json format.

notifications

A directory containing message templates for email and inbox notifications.

reports

A directory containing generated analytical reports (queries and dashboards) in JSON format.

roles

A directory containing configuration files for registry roles.

officer.yml defines officers of various ranks — service providers.
citizen.yml defines citizens — service recipients.

settings

A directory containing the registry’s general settings such as full name, system name of the registry, and so on.

settings.yaml

A configuration file containing the system settings of the registry and several services.

For details on the registry regulations and its deployment, see Digital registry regulations.