diff --git a/docs/en/modules/arch/pages/architecture/registry/administrative/regulation-management/overview.adoc b/docs/en/modules/arch/pages/architecture/registry/administrative/regulation-management/overview.adoc index 903d879ea2..04352d6e50 100644 --- a/docs/en/modules/arch/pages/architecture/registry/administrative/regulation-management/overview.adoc +++ b/docs/en/modules/arch/pages/architecture/registry/administrative/regulation-management/overview.adoc @@ -6,59 +6,47 @@ include::platform:ROOT:partial$admonitions/language-en.adoc[] == General description The subsystem that provides capability of the registry development functionality based on the _Lowcode_ principles in the form of xref:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[_digital registry regulations_] and provides capabilities for managing the officer accounts. -//Підсистема, яка реалізує можливості розробки функціональності реєстру за принципами _Lowcode_ у вигляді xref:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[_цифрового регламенту реєстру_] та надає можливості по управлінню обліковими записами посадових осіб. == Subsystem functions -//== Функції підсистеми * Modeling of the xref:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[registry regulations components] based on the _Lowcode_ principles: -//* Моделювання -//xref:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[складових регламенту реєстру] -//за принципами _Lowcode_ + * Batch download of users. -//* Пакетне завантаження користувачів + * Amendments to the declarative description of the registry regulations. -//* Внесення змін у декларативний опис регламенту реєстру + * Versioning of the registry regulations with a history of changes. -//* Версіонування регламенту реєстру з історією внесення змін + * Monitoring of changes before entering them into the registry regulations. -//* Проведення інспекції змін перед внесенням їх до регламенту реєстру + * Viewing the results of monitoring of changes to the registry regulations by the xref:architecture/registry/administrative/regulation-publication/overview.adoc[Registry regulations deployment subsystem]. -//* Перегляд результатів перевірки змін в регламент реєстру -//xref:architecture/registry/administrative/regulation-publication/overview.adoc[Підсистемою розгортання регламенту реєстру] == Subsystem technical design -//== Технічний дизайн підсистеми .Component diagram of regulations modeling subsystem. General -//.Компонентна діаграма підсистеми моделювання регламенту. Загальна image::architecture/registry/administrative/regulation-management/regulation-management-design-1.svg[] -* _(1)_ - The report archive is a zip archive that contains a list of requests and report settings in a declarative format. -//* _(1)_ - Архів звіту - це zip архів який в собі містить перелік запитів та налаштування звітів в декларативному форматі. -* _(2)_ - Scenarios that are relevant for modeling -//* _(2)_ - Сценарії які релевантні для моделювання -* _(3)_ - The internal structure of the Redash components is described in the xref:arch:architecture/registry/operational/reporting/overview.adoc[Registry analytical reporting subsystem] -//* _(3)_ - Внутрішня структура компонентів Redash описана у xref:arch:architecture/registry/operational/reporting/overview.adoc[Підсистемі аналітичної звітності реєстру] +* _(1)_ -- The report archive is a zip archive that contains a list of requests and report settings in a declarative format. + +* _(2)_ -- Scenarios that are relevant for modeling + +* _(3)_ -- The internal structure of the Redash components is described in the xref:arch:architecture/registry/operational/reporting/overview.adoc[Registry analytical reporting subsystem] [#subsystem-components] == Subsystem components -//== Складові підсистеми |=== |Component name|Representation in register|Origin|Repository|Purpose -//|Назва компоненти|Представлення в реєстрі|Походження|Репозиторій|Призначення |_Regulation modeling web interface_ -//|_Веб-інтерфейс моделювання регламенту_ + |`admin-portal` |origin -|https://gerrit-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/admin/repos/mdtu-ddm/low-code-platform/platform/frontend/applications/common-web-app[github:/mdtu-ddm/low-code-platform/platform/frontend/applications/common-web-app] +|https://gerrit-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/admin/repos/mdtu-ddm/low-code-platform/platform/frontend/applications/common-web-app[gerrit:/mdtu-ddm/low-code-platform/platform/frontend/applications/common-web-app] |Client web application for modeling registry regulations based on _Lowcode_ principles -//|Клієнтський вебдодаток для моделювання регламенту реєстру за принципами _Lowcode_ |_Report modeling web interface_ -//|_Веб-інтерфейс моделювання звітів_ + a| * `redash-admin` * `redash-admin-adhocworker` @@ -67,87 +55,76 @@ a| * `redash-admin-redis-master` |fork a| -* https://gerrit-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/admin/repos/mdtu-ddm/data-architecture/devops-application/redash-chart[gerrit:/mdtu-ddm/data-architecture/devops-application/redash-chart] -* https://gerrit-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/admin/repos/mdtu-ddm/data-architecture/application/redash[gerrit:/mdtu-ddm/data-architecture/application/redash] +* https://github.com/epam/edp-ddm-redash-chart[github:/epam/edp-ddm-redash-chart] +* https://github.com/epam/edp-ddm-redash[github:/epam/edp-ddm-redash] * https://github.com/getredash/redash[github:/getredash/redash] |Client web application for creating and configuring analytical reports and dashboards -//|Клієнтський вебдодаток для створення та налаштування аналітичних звітів та дашбордів |_Service for monitoring and storage of changes to regulations_ -//|_Сервіс інспекції та зберігання змін регламенту_ + a| * `gerrit` * `gerrit-operator` |3rd-party a| -* https://gerrit-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/admin/repos/mdtu-ddm/devops/operators/gerrit-operator[gerrit:/mdtu-ddm/devops/operators/gerrit-operator] +* https://github.com/epam/edp-ddm-gerrit-operator[github:/epam/edp-ddm-gerrit-operator] * https://gerrit.googlesource.com/gerrit/[gerrit:/googlesource/gerrit] |Software tool allowing storage and management of registry regulations versions. -//|Програмний інструмент, що дозволяє зберігати та керувати версіями регламентів реєстрів. |_Regulations management service_ -//|_Сервіс управління регламентом_ + |`registry-regulation-management` |origin |https://github.com/epam/edp-ddm-registry-regulation-management[github:/epam/edp-ddm-registry-regulation-management] |The service that provides a REST API for working with versions of the registry regulations and their components -//|Сервіс який надає REST API для роботи з версіями регламенту реєстру та його складовими |_Language server_ -//|_Language сервер_ + |`ddm-language-server` |origin -|https://gerrit-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/admin/repos/mdtu-ddm/low-code-platform/platform/backend/applications/ddm-language-server[gerrit:/mdtu-ddm/low-code-platform/platform/backend/applications/ddm-language-server] +|https://github.com/epam/edp-ddm-language-server[github:/epam/edp-ddm-language-server] |The service that provides the functionality of hints, autocompletion of functions and checks when editing code in the _Regulation modeling web interface_ -//|Сервіс який надає функціональність підказок, автодоповнення функцій та перевірки при редагуванні коду у _Веб-інтерфейсі моделювання регламенту_ |_Reports exporting service_ -//|_Сервіс вивантаження звітів_ + |`report-exporter` |origin |https://github.com/epam/edp-ddm-report-exporter[github:/epam/edp-ddm-report-exporter] |The service that provides REST API access to export reports from the _Report modeling web interface_ -//|Сервіс який надає REST API доступ для експорту звітів з _Веб-інтерфейсу моделювання звітів_ |Utility for downloading officers -//|_Утіліта завантаження надавачів послуг_ + |`publish-users-job` |origin |https://github.com/epam/edp-ddm-user-publisher[github:/epam/edp-ddm-user-publisher] |The service that provides REST API access to export reports from the _Report modeling web interface_ -//|Сервіс який надає REST API доступ для експорту звітів з _Веб-інтерфейсу моделювання звітів_ |xref:architecture/registry/administrative/regulation-management/ceph-storage.adoc#_user_import[Operational storage of file with users] -//|xref:architecture/registry/administrative/regulation-management/ceph-storage.adoc#_user_import[Операційне сховище файлів з користувачами] + |`ceph:user-import` |origin |https://github.com/epam/edp-ddm-registry-configuration/blob/main/deploy-templates/templates/CephObjectBucketClaim.yaml[github:/epam/edp-ddm-registry-configuration/blob/main/deploy-templates/templates/CephObjectBucketClaim.yaml] |Storing a file with users for import -//|Зберігання файлу з користувачами для імпорту |xref:architecture/registry/administrative/regulation-management/ceph-storage.adoc#_user_import_archive[Archive storage of files with users] -//|xref:architecture/registry/administrative/regulation-management/ceph-storage.adoc#_user_import_archive[Архівне сховище файлів з користувачами] + |`ceph:user-import-archive` |origin |https://github.com/epam/edp-ddm-registry-configuration/blob/main/deploy-templates/templates/CephObjectBucketClaim.yaml[github:/epam/edp-ddm-registry-configuration/blob/main/deploy-templates/templates/CephObjectBucketClaim.yaml] |Archive of files with users for import -//|Архів файлів з користувачами для імпорту |xref:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[Git repository of the Digital registry regulations] -//|xref:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[Git репозиторій Цифрового регламенту реєстру] + |`gerrit:registry-regulations` |origin |https://github.com/epam/edp-ddm-empty-template-registry-regulation[github:/epam/edp-ddm-empty-template-registry-regulation] |Git repository of the Digital registry regulations in the service for monitoring and storage of changes to the regulations -//|Git репозиторій Цифрового регламенту реєстру у сервісі інспекцій та зберігання змін регламенту |=== == Technology stack -//== Технологічний стек The following technologies were used when designing and developing the subsystem: -//При проєктуванні та розробці підсистеми, були використані наступні технології: * xref:arch:architecture/platform-technologies.adoc#java[Java] * xref:arch:architecture/platform-technologies.adoc#spring[Spring] @@ -171,14 +148,11 @@ The following technologies were used when designing and developing the subsystem === Security Only authorized users can access to the subsystem web interfaces. The standard system mechanisms, such as https://openid.net/developers/how-connect-works/[OpenID Connect] and https://saml.xml.org/saml-specifications[SAML] integration with the xref:architecture/platform/operational/user-management/overview.adoc[Users and roles management subsystem], are used for authorization. -//Доступ до веб-інтерфейсів підсистеми можливий тільки для авторизованих користувачів. Для авторизації використовується стандартні механізми системи такі як https://openid.net/developers/how-connect-works/[OpenID Connect] та https://saml.xml.org/saml-specifications[SAML] інтеграція з xref:architecture/platform/operational/user-management/overview.adoc[Підсистемою управління користувачами та ролями]. === Usability -Modeling of the regulations in the subsystem web interfaces is performed according to the principles of _Lowcode_ with auto-prompts for users, auto-completion and validation of the entered information. This allows to reduce the time for development of the regulations and enhance training of users. -//Моделювання регламенту у веб-інтерфейсах підсистеми здійснюється за принципами _Lowcode_ з впровадженням автопідказок для користувача, автодоповнення та валідації введеної інформації що дозволяє зменшити час на розробку регламенту та збільшити навченість користувачів. +Modeling of the regulations in the subsystem web interfaces is performed according to the principles of _Low-code_ with auto-prompts for users, auto-completion and validation of the entered information. This allows reducing the time for development of the regulations and enhancing training of users. === Modifiability -The structure of the subsystem's xref:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[_digital registry regulations_] is divided onto individual elements that are loosely coupled to each other (the principle of Low coupling) and use the principles of _Lowcode_ for development, which simplifies implementation of new changes to the regulations, accelerates the speed of development and reduces the required expertise of a modeler. -//Структура xref:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[_цифрового регламенту реєстру_] підсистеми розділена на окремі елементи, які слабо пов'язані один з одним (принцип Low coupling) та використовують принципи _Lowcode_ для розробки, що спрощує внесення нових змін до регламенту, прискорює швидкість розробки та зменшує необхідну експертизу моделювальника. \ No newline at end of file +The structure of the subsystem's xref:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[_digital registry regulations_] is divided onto individual elements that are loosely coupled to each other (the principle of Low coupling) and use the principles of _Low-code_ for development, which simplifies implementation of new changes to the regulations, accelerates the speed of development and reduces the required expertise of a modeler. diff --git a/docs/ua/modules/arch/pages/architecture/registry/administrative/regulation-management/overview.adoc b/docs/ua/modules/arch/pages/architecture/registry/administrative/regulation-management/overview.adoc index 6eb8f102c7..0d1e03242a 100644 --- a/docs/ua/modules/arch/pages/architecture/registry/administrative/regulation-management/overview.adoc +++ b/docs/ua/modules/arch/pages/architecture/registry/administrative/regulation-management/overview.adoc @@ -1,5 +1,4 @@ = Підсистема моделювання регламенту реєстру - include::platform:ROOT:partial$templates/document-attributes/arch-set-ua.adoc[] include::platform:ROOT:partial$admonitions/language-ua.adoc[] @@ -14,7 +13,7 @@ xref:architecture/registry/administrative/regulation-management/registry-regulat * Моделювання xref:architecture/registry/administrative/regulation-management/registry-regulation/registry-regulation.adoc[складових регламенту реєстру] -за принципами _Lowcode_ +за принципами _Low-code_ * Пакетне завантаження користувачів * Внесення змін у декларативний опис регламенту реєстру * Версіонування регламенту реєстру з історією внесення змін @@ -52,13 +51,13 @@ xref:arch:architecture/registry/operational/audit/overview.adoc[за посил |=== |Назва компоненти|Представлення в реєстрі|Походження|Репозиторій|Призначення -|_Веб-інтерфейс моделювання регламенту_ +|_Вебінтерфейс моделювання регламенту_ |`admin-portal` |origin -|https://gerrit-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/admin/repos/mdtu-ddm/low-code-platform/platform/frontend/applications/common-web-app[github:/mdtu-ddm/low-code-platform/platform/frontend/applications/common-web-app] +|https://gerrit-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/admin/repos/mdtu-ddm/low-code-platform/platform/frontend/applications/common-web-app[gerrit:/mdtu-ddm/low-code-platform/platform/frontend/applications/common-web-app] |Клієнтський вебдодаток для моделювання регламенту реєстру за принципами _Lowcode_ -|_Веб-інтерфейс моделювання звітів_ +|_Вебінтерфейс моделювання звітів_ a| * `redash-admin` * `redash-admin-adhocworker`