Registry regulations structure

System deployment is based on one or several regulations.

An administrator configures and deploys the registry regulations, which involves modifying a set of entities or elements of the regulations.

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

For details on the MASTER-Build-registry-regulations pipeline and deploying the regulations, see platform-develop:registry-regulations-deployment.adoc.

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

Example 1. Typical registry regulations structure

Table 1. Regulations structure explained
Regulations	Directory/file	Description
registry-regulations		A top-level directory containing nested directories with regulations entities.
	bp-auth	A directory containing business processes access `YAML` files for the `citizen` (service recipients), `officer` (service providers), and `external-system` (external systems and registries) realms.
	bp-trembita	A directory containing configuration files for interactions with external systems and services through SOAP and REST interfaces.
	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. 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 from the registry.
	excerpts-csv	A directory containing templates for CSV excerpts.
	excerpts-docx	A directory containing templates for DOCX excerpts.
	forms	A directory containing UI input forms modeled in JSON format.
	global-vars	A directory containing global variables for the registry business processes.
	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 is used to assign officers of various ranks, and citizen.yml defines service recipients).
	settings	A directory containing the registry’s general settings (such as full and system name of the registry and so on).
	settings.yaml	A configuration file that contains the system settings of the registry and several services.