diff --git a/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/code.png b/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/code.png new file mode 100644 index 0000000000..5d137450b1 Binary files /dev/null and b/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/code.png differ diff --git a/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/constructor.png b/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/constructor.png new file mode 100644 index 0000000000..14415cfcc8 Binary files /dev/null and b/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/constructor.png differ diff --git a/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/main.png b/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/main.png new file mode 100644 index 0000000000..2cd9148433 Binary files /dev/null and b/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/main.png differ diff --git a/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/menu.png b/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/menu.png new file mode 100644 index 0000000000..9f19f3356a Binary files /dev/null and b/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/menu.png differ diff --git a/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/request.png b/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/request.png new file mode 100644 index 0000000000..23f0cef033 Binary files /dev/null and b/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/request.png differ diff --git a/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/view.png b/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/view.png new file mode 100644 index 0000000000..da161f99a4 Binary files /dev/null and b/docs/en/modules/registry-develop/images/registry-admin/admin-portal/ui-forms/view.png differ diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/overview.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/overview.adoc index 44ee61ae27..18628c2805 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/overview.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/overview.adoc @@ -1,4 +1,8 @@ = Registry regulations modeling +:sectlinks: +:sectanchors: + +include::platform:ROOT:partial$admonitions/language-en.adoc[] The *_Registry regulations modeling_* section provides essential tools and methods for effective registry development and management. It begins with setting the _global parameters_ and transitioning into the configuration of _business process models_. Further, it delves into the design of _user interface forms_, facilitating data interaction. Integral to this process are _tables_—fundamental structures storing registry data. For those seeking precision, modeling the structure through an _XML code editor_ provides an advanced approach. Additionally, this section encompasses the management of _analytical reporting templates_, ensuring comprehensive data representation. diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/edit-groovy-scripts.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/edit-groovy-scripts.adoc index 2d3b933490..d213cc031a 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/edit-groovy-scripts.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/edit-groovy-scripts.adoc @@ -1,98 +1,59 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Редагування скриптів бізнес-процесів у візуальному редакторі коду = Editing business process scripts in a visual code editor +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальний опис == General description -//Розробник регламенту реєстру може у вбудованому редакторі діаграм *BPMN.iO* редагувати https://uk.wikipedia.org/wiki/Groovy[*Groovy*]-скрипти через візуальний редактор коду. Для цього імплементовано рішення https://microsoft.github.io/monaco-editor/[Monaco Editor], візуалізоване темою *Visual Studio Dark*. The developer of the registry regulations can edit https://uk.wikipedia.org/wiki/Groovy[*Groovy*] scripts using the visual code editor in the embedded *BPMN.iO* diagram editor. The solution implements the https://microsoft.github.io/monaco-editor/[Monaco Editor], visualized with the *Visual Studio Dark* theme. -//Рішення є збагаченим вебредактором коду (спрощеною версією середовищ розробки IDE), яке дозволяє набагато ефективніше працювати із Groovy-скриптами у бізнес-процесах. Інструмент підтримує основні функції при роботі з вихідним кодом, дозволяючи створювати та редагувати скрипти в єдиному місці -- скрипт-задачах бізнес-процесів регламенту, не виходячи за межі середовища для використання сторонніх настільних додатків. -The solution provides an enriched web code editor (a simplified version of an IDE development environment) that significantly enhances working with Groovy scripts in business processes. The tool supports essential functions for working with source code, allowing you to create and edit scripts in a single place -- the script tasks of the registry's business processes, without the need for external desktop applications. +The solution provides an enriched web code editor (a simplified version of an IDE development environment) that significantly enhances working with Groovy scripts in business processes. The tool supports essential functions for working with source code, allowing you to create and edit scripts in a single place—the script tasks of the registry's business processes, without the need for external desktop applications. -//Підтримуються наступні функції при роботі з редактором: :: The following features are supported when working with the editor: :: -//* [*] Автодоповнення -//* [*] Автодоповнення для кастомних функцій -//* [*] Синтаксичний аналіз коду та перевірка помилок -//* [*] Підтримка коментарів -//* [*] Згортання та розгортання блоку з кодом * [*] Autocompletion * [*] Autocompletion for custom functions * [*] Syntax code analysis and error checking * [*] Comment support * [*] Code folding and unfolding -//== Функціональні можливості == Functional capabilities -//=== Загальний процес використання === General usage process -//Використовуйте візуальний редактор коду при створенні та редагуванні скриптів у рамках моделювання бізнес-процесів. Use the visual code editor when creating and editing scripts within the scope of business process modeling. [CAUTION] ==== -//Редагування складових регламенту реєстру можливе лише в рамках версій-кандидатів на внесення змін. Для майстер-версії доступна лише опція перегляду. Editing components of the registry regulations is only possible within change candidate versions. For the master version, only the viewing option is available. -//Детальніше про особливості роботи з версіями регламенту дивіться на сторінці For more details on working with versions of the regulations, refer to xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[]. ==== -//. У [.underline]#Кабінеті адміністратора регламентів# відкрийте розділ [.underline]#Моделі процесів#. . In the [.underline]#Regulations administrator portal#, open the [.underline]#Process models# section. + - -[TIP] -//Портал адміністратора ви можете знайти за посиланням: + -//https://admin-tools-<назва-реєстру>.apps.envone.dev.registry.eua.gov.ua/. -You can find the Regulations administrator portal at the following link: + -https://admin-tools-.apps.envone.dev.registry.eua.gov.ua/. -+ image:registry-develop:registry-admin/admin-portal/process-models/process-models-1.png[] -+ -//. В рамках версії-кандидата оберіть процес і натисніть [.underline]#🖉 іконку редагування#. + . Within the candidate version, select the process and click the [.underline]#🖉 edit icon#. + image:registry-develop:registry-admin/admin-portal/process-models/process-models-6.png[] -+ -//. Перейдіть на вкладку [.underline]#Конструктор# та змоделюйте бізнес-процес у вебредакторі. + . Navigate to the [.underline]#Builder# tab and model the business process in the web editor. + -//TIP: Можливості вкладки [.underline]#Конструктор# більш детально описані на сторінці TIP: The capabilities of the [.underline]#Builder# tab are described in more detail at xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-bpmn-editor.adoc[]. + image:registry-develop:registry-admin/admin-portal/process-models/process-models-4.png[] -+ -//. Створіть скрипт-задачу (*Script Task*). + . Create a script task (*Script Task*). -//. Натисніть kbd:[*Open script editor*], щоб відкрити [.underline]#Редактор скриптів#. . Click kbd:[Open script editor] to open the [.underline]#Script editor#. -+ -//. Створіть або відредагуйте скрипт. + . Create or edit the script. + -//TIP: Розгорніть вікно редагування, або перегляду скрипту у повноекранному режимі для зручності. TIP: Expand the editing window or view the script in full-screen mode for convenience. -+ -//* Натисніть kbd:[Зберегти], щоб зберегти зміни. + * Click kbd:[Save] to save the changes. -//* Натисніть kbd:[Закрити], щоб скасувати зміни. * Click kbd:[Close] to cancel the changes. + image::registry-admin/hierarchical-model/hierarchical-model-bp-2.png[] @@ -101,36 +62,28 @@ image::registry-admin/hierarchical-model/hierarchical-model-bp-3.png[] + [NOTE] ==== -//Якщо скрипт міститиме ймовірні помилки, редактор попередить про це через відповідне повідомлення на екрані. If the script contains any potential errors, the editor will provide a corresponding message on the screen. image:registry-admin/admin-portal/process-models/edit-groovy-scripts/edit-groovy-scripts-6.png[] ==== -//=== Автодоповнення коду та кастомних JUEL-функцій === Code autocompletion and custom JUEL function autocompletion -//При роботі зі скриптами у редакторі моделювальник може використовувати [.underline]#автодоповнення коду#, зокрема [.underline]#автодоповнення кастомних JUEL-функцій# з випадного списку. Це дозволить уникати помилок при ручному введенні параметрів. When working with scripts in the modeling editor, you can utilize [.underline]#code autocompletion#, including [.underline]#autocompletion for custom JUEL functions# from the dropdown list. This helps prevent errors during manual parameter entry. -//==== Автодоповнення коду ==== Code autocompletion -//Вбудовані можливості інтелектуального завершення передбачають тип і потік даних і пропонують параметри, що відповідають контексту. Наприклад, підказки щодо можливих методів, які використовуються у змінних, доповнення функцій тощо. -The built-in intelligent completion features predict data type and flow and suggest parameters based on the context. For example, prompts for possible methods used in variables, function completions, and more. +The built-in intelligent completion features predict a data type and flow and suggest parameters based on the context. For example, prompts for possible methods used in variables, function completions, and more. image:registry-admin/admin-portal/process-models/edit-groovy-scripts/edit-groovy-scripts-1-1.png[] -//==== Автодоповнення кастомних JUEL-функцій ==== Autocompletion for custom JUEL functions -//Вбудовані можливості інтелектуального завершення передбачають автодоповнення власних JUEL-функцій, які розширюють можливості бізнес-процесів та полегшують моделювання. The built-in intelligent completion features also include autocompletion for custom JUEL functions that enhance business process capabilities and facilitate modeling. [TIP] ==== -//Використовуйте платформні JUEL-функції для спрощення моделювання бізнес-процесів. Наразі імплементовано такі функції та їх автодоповнення у візуальному редакторі коду: Use platform JUEL functions to simplify business process modeling. Currently, the following functions and their autocompletion are implemented in the visual code editor: * *`initiator()`* @@ -146,7 +99,6 @@ Use platform JUEL functions to simplify business process modeling. Currently, th * *`save_digital_document_from_url()`* * *`get_trembita_auth_token()`*. -//Детальніше про використання JUEL-функцій ви можете переглянути на сторінці For more information on using JUEL functions, please refer to xref:bp-modeling/bp/modeling-facilitation/modelling-with-juel-functions.adoc[]. ==== @@ -155,76 +107,56 @@ image:registry-admin/admin-portal/process-models/edit-groovy-scripts/edit-groovy image:registry-admin/admin-portal/process-models/edit-groovy-scripts/edit-groovy-scripts-1-3.png[] -//=== Синтаксичний аналіз коду та перевірка помилок === Code syntax analysis and error checking -//Редактор підтримує синтаксиний аналіз коду та пояснення для деталізації помилок. The editor supports code syntax analysis and provides explanations to detail errors. -//При наведенні на певні елементи, наприклад, на змінну, що використовується у скрипті, редактор підкаже, до якого пакету та класу вона відновиться. When hovering over specific elements, such as a variable used in the script, the editor suggests the package and class it refers to. image:registry-admin/admin-portal/process-models/edit-groovy-scripts/edit-groovy-scripts-1.png[] -//==== Критичні помилки ==== Critical errors -//Якщо код містить критичну помилку, допущену моделювальником, редактор підсвітить червоним кольором, де саме у скрипті виявлено помилку, та виведе відповідне пояснення на екран. If the code contains a critical error made by the modeler, the editor highlights the error in red within the script and displays a corresponding explanation on the screen. image:registry-admin/admin-portal/process-models/edit-groovy-scripts/edit-groovy-scripts-2.png[] image:registry-admin/admin-portal/process-models/edit-groovy-scripts/edit-groovy-scripts-3.png[] -//==== Не критичні помилки ==== Non-critical errors -//Якщо код містить НЕ критичну помилку, допущену моделювальником, при наведенні курсора редактор підсвітить жовтим кольором, де саме у скрипті виявлено помилку, та виведе відповідне пояснення на екран. If the code contains a non-critical error made by the modeler, when hovering over the cursor, the editor highlights the error in yellow within the script and displays a corresponding explanation on the screen. image:registry-admin/admin-portal/process-models/edit-groovy-scripts/edit-groovy-scripts-4.png[] image:registry-admin/admin-portal/process-models/edit-groovy-scripts/edit-groovy-scripts-5.png[] -//=== Коментування коду === Code commenting -//Вбудований редактор скриптів дозволяє вносити коментарі до коду. Коментарі надають [.underline]#зрозуміле для розробника пояснення, або анотацію у вихідному коді# скрипту/програми. Вони додаються з метою зробити вихідний код легшим для розуміння людьми, й ігноруються компіляторами та інтерпретаторами. Тобто ви можете таким чином "приховати" від виконання частину програми, або певний рядок тощо. The built-in script editor allows you to add comments to the code. Comments provide clear explanations or annotations in the source code of the script/program. They are added to make the source code easier to understand for humans and are ignored by compilers and interpreters. This means you can "hide" parts of the program or specific lines from execution. -//Використовуйте [.underline]#однорядкові#, або [.underline]#багаторядкові# коментарі. Use [.underline]#single-line# or [.underline]#multi-line# comments. -//==== Однорядкові коментарі ==== Single-line comments -//Однорядкові коментарі починаються з *`//`* (подвійна коса риска) і можуть використовуватися у будь-якому місці рядка. Символи після *`//`* і до кінця рядка вважаються частиною коментаря. Single-line comments start with `//` (double forward slash) and can be used anywhere within a line. Characters after `//` until the end of the line are considered part of the comment. image:registry-admin/admin-portal/process-models/edit-groovy-scripts/edit-groovy-scripts-7.png[] -//==== Багаторядкові коментарі ==== Multi-line comments -//Багаторядковий коментар починається з +++/*+++ (_одинарна коса риска та зірочка_) і може бути використаний у будь-якому місці рядка. Символи після +++/*+++ вважатимуться частиною коментаря, включаючи символи нового рядка, до першого +++*/+++ (_зірочка та одинарна коса риска_), який закриває коментар. Таким чином, багаторядкові коментарі можна розмістити в кінці, або навіть усередині висловлювання тощо. Multi-line comments start with +++/*+++ (_forward slash followed by an asterisk_) and can be used anywhere within a line. Characters after +++/*+++ are considered part of the comment, including newline characters, until the first +++*/+++ (_asterisk followed by a forward slash_) that closes the comment. Therefore, multi-line comments can be placed at the end or even within an expression, and so on. image:registry-admin/admin-portal/process-models/edit-groovy-scripts/edit-groovy-scripts-8.png[] - -//=== Згортання та розгортання блоків коду === Code folding and unfolding -//Використовуйте функції згортання та розгортання блоків з кодом. Це дозволить зробити ваш код більш читабельним та сховати, або, навпаки, розкрити деталі певного блоку за потреби. Use code folding and unfolding functions to make your code more readable and hide or reveal details of specific blocks as needed. -//Ви можете організовувати блокову структуру, використовуючи зарезервовані висловлювання, як-то `def`, `for`, `if`, `else` тощо. You can organize block structure using reserved statements such as `def`, `for`, `if`, `else`, and so on. -//Якщо навести курсор навпроти певного висловлювання (відкритого блоку), з'явиться перемикач, який дозволить вам його згорнути. -When hovering the cursor next to a specific statement (an open block), a switch will appear allowing you to fold it. +When hovering the cursor next to a specific statement (an open block), a switch will appear to allow you to fold it. -//Перемикачі для розгортання видимі завжди. Просто натисніть на такий, щоб показати деталі у блоці з кодом. Unfolding switches are always visible. Simply click on one to show the details in the code block. image:registry-admin/admin-portal/process-models/edit-groovy-scripts/edit-groovy-scripts-9.png[] diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/process-components-overview.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/process-components-overview.adoc index 668c309acf..62f2452e7e 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/process-components-overview.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/process-components-overview.adoc @@ -1,12 +1,9 @@ = Viewing and editing business process components -//Адміністратор регламенту може працювати зі складовими бізнес-процесів на відповідних вкладках [.underline]#Загальна#, [.underline]#Код# та [.underline]#Конструктор#. -The Regulations administrator can work with the components of business processes on the corresponding [.underline]#General#, [.underline]#Code#, and [.underline]#Builder# tabs. +The registry regulations administrator can work with the components of business processes on the corresponding *General*, *Code*, and *Builder* tabs. -//== Огляд секції == Section overview -//* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc#tab-general[Керування назвами процесу] * [*] xref:registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc#tab-general[Managing process names] * [*] xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-code.adoc[] * [*] xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-bpmn-editor.adoc[] diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/copy-process.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/copy-process.adoc index ce2bb9ad1b..811a57125f 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/copy-process.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/copy-process.adoc @@ -1,32 +1,19 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Копіювання бізнес-процесів -= Copying business processes - -//Використовуйте функціональність копіювання бізнес-процесів. Це дозволяє полегшити та пришвидшити створення схем процесів. Не потрібно моделювати процеси з нуля -- просто оберіть подібну діаграму, змодельовану раніше та скопіюйте її. -Utilize the functionality of business process copying. This allows for easier and faster creation of process diagrams. There is no need to model processes from scratch -- simply select a similar diagram that has been previously modeled and copy it. - -//Відкрийте розділ [.underline]#Моделі процесів# та натисніть _іконку копіювання_ навпроти потрібного бізнес-процесу. += Copying business processes, +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] + +Utilize the functionality of business process copying. This allows for easier and faster creation of process diagrams. There is no need to model processes from scratch—simply select a similar diagram that has been previously modeled and copy it. + Open the [.underline]#Process models# section and click on the copying icon next to the desired business process. image:registry-develop:registry-admin/admin-portal/process-models/process-models-15.png[] -//В результаті створюється _повна копія_ обраного процесу (дублікат), тобто копіюється увесь код. As a result, a _complete copy_ of the selected process (duplicate) is created, meaning that the entire code is copied. [NOTE] ==== -//* Бізнес-назва процесу за замовчуванням створюється із префіксом `*Copy_*`. * The default business name of the process is created with the prefix *`Copy_`*. -//* Службова назва процесу за замовчуванням -- `*new-bp*`. * The default technical name of the process is *`new-bp`*. ==== @@ -34,10 +21,8 @@ image:registry-develop:registry-admin/admin-portal/process-models/process-models [CAUTION] ==== -//Редагування складових регламенту реєстру можливе лише в рамках версій-кандидатів на внесення змін. Для майстер-версії доступна лише опція перегляду. Editing the components of the registry regulations is only possible within change candidate versions. The master version only has the viewing option available. -//Детальніше про особливості роботи з версіями регламенту дивіться на сторінці: For more information on working with registry regulation versions, please refer to the following page: * xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[] diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc index 4a7ca928bc..f3344e4642 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc @@ -1,133 +1,97 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Створення бізнес-процесів = Creating business processes +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Кабінет адміністратора регламентів дозволяє легко та просто моделювати бізнес-процеси за допомогою вбудованого вебредактора https://bpmn.io/[BPMN.io] у вашому браузері. Функціональність надає можливості _перегляду, створення та редагування_ діаграм у нотації *BPMN 2.0* на базі XML. The Regulations administrator portal allows for easy and straightforward modeling of business processes using the built-in https://bpmn.io/[BPMN.io] web editor in your browser. The functionality provides viewing, creation, and editing of diagrams in BPMN 2.0 notation based on XML. -//Створіть новий бізнес-процес у кілька простих кроків: Create a new business process in a few simple steps: -//. У Кабінеті адміністратора регламентів відкрийте розділ [.underline]#Моделі процесів#. -. In the Regulations administrator portal, open the [.underline]#Process models# section. +. In the Regulations administrator portal, open the *Process models* section. + image:registry-develop:registry-admin/admin-portal/process-models/process-models-1.png[] -+ -//. Натисніть кнопку [.underline]#`+ Створити новий процес`#. -. Click the [.underline]#+ Create new process# button. + +. Click the *`Create new process`* button. + image:registry-develop:registry-admin/admin-portal/process-models/process-models-2.png[] + [#tab-general] -//. На вкладці [.underline]#Загальна# заповніть бізнес- та службову назви бізнес-процесу: -. On the [.underline]#General# tab, fill in the business and technical names of the business process: -+ -//* У полі `Бізнес-назва процесу` введіть зручну та зрозумілу назву. +. On the *General* tab, fill in the business and technical names of the business process: + * Enter a convenient and understandable name in the *Business process name* field. + [NOTE] ==== -//Бізнес-назва виконує інформативну функцію та може використовуватися, наприклад, для відображення в інтерфейсах Кабінетів посадової особи та отримувача послуг, для юридичних цілей, у документообігу тощо. + The business name serves an informative function and can be used, for example, for display in the interfaces of the Officer and Citizen portals, for legal purposes, in document circulation, and so on. -//Може мати від 3 до 100 символів. Допустимі символи: "А-Z", "a-z", "А-Я", "а-я", української абетки, "0-9", "-", "_", ",", ".", апостроф ('), пробіл. -It can have 3 to 100 characters. Allowed characters: "A-Z," "a-z," "А-Я," "а-я," Ukrainian alphabet, "0-9," "-", "_," ",", ".", apostrophe ('), space. +It can have 3 to 100 characters. Allowed characters: "A-Z", "a-z", cyrillic "А-Я", "а-я", "0-9", "-", "_", ",", ".", apostrophe ('), space. ==== -+ -//* У полі `Службова назва бізнес-процесу` введіть технічну назву процесу. + * Enter the technical name of the process in the *Business process technical name* field. + [NOTE] ==== -//Службова назва є ідентифікатором процесу (`process id`) в системі. Її використовують для технічних цілей: у коді, BPMN-нотації, файлах конфігурації тощо. The technical name is the process identifier (`process ID`) in the system. It is used for technical purposes, such as in code, BPMN notation, configuration files, and so on. -//Повинна бути унікальною у межах екземпляра реєстру. Довжина 3--50 символів. + -//Допустимі символи: "А-Z", "a-z", "0-9", "-", "_". При цьому цифри, "-" не можуть бути на початку, або в кінці службової назви. It must be unique within the registry instance. Length: 3-50 characters. Allowed characters: "A-Z," "a-z," "0-9," "-", "_." However, digits and "-" cannot be at the beginning or end of the technical name. ==== - + image:registry-develop:registry-admin/admin-portal/process-models/process-models-3.png[] + -//. Перейдіть на вкладку [.underline]#Конструктор# та змоделюйте бізнес-процес у вебредакторі. -. Switch to the [.underline]#Builder# tab and model the business process in the web editor. +NOTE: All changes on the xref:registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc#tab-general[General], xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-code.adoc[Code], and xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-bpmn-editor.adoc[Builder] tabs are synchronized. This means that if you modify an element in the constructor, it will be reflected in the code and vice versa. + +. Switch to the *Builder* tab and model the business process in the web editor. + -//TIP: Можливості вкладки [.underline]#Конструктор# більш детально описані на сторінці -TIP: The capabilities of the [.underline]#Builder# tab are more detailed at: +TIP: The capabilities of the *Builder* tab are more detailed at xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-bpmn-editor.adoc[]. + image:registry-develop:registry-admin/admin-portal/process-models/process-models-4.png[] -+ -//. Натисніть клавішу `Зберегти зміни`, щоб зберегти внесену інформацію. -. Press the **Save change**s button to save the entered information. + +. Press the *`Save changes`* button to save the entered information. + [TIP] ==== -//Користувач отримує нотифікацію про успішне створення процесу: The user receives a notification of successful process creation: -//* ✅ `Бізнес-процес "<Назва процесу>" успішно створено` -* ✅ `Business process` `` `successfully created`. +* ✅ `Business process` `` `successfully created`. ==== + image:registry-develop:registry-admin/admin-portal/process-models/process-models-5.png[] -+ -//Ви можете побачити створений бізнес-процес у загальному переліку процесів. Надалі його можна редагувати (детальніше -- на сторінці xref:registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc[]). -You can see the created business process in the general list of processes. It can be edited later (more details at xref:registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc[]). -+ + +You can see the created business process in the general list of processes. It can be edited later (_see more details at xref:registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc[]_). + [IMPORTANT] ==== -//Коли користувач намагається зберегти зміни при створенні, або редагуванні бізнес-процесу, чи UI-форми, та знаходиться на будь-якій вкладці розділів [.underline]#Моделі процесів# та [.underline]#UI-форми#, то на усіх вкладках цих розділів спрацьовує валідація, якщо: -When a user tries to save changes during creation or editing of a business process or UI forms and is on any tab of the [.underline]#Process models# and [.underline]#UI# Forms sections, validation is triggered if: +When a user tries to save changes during creation or editing of a business process or UI forms and is on any tab of the *Process models* and *UI forms* sections, validation is triggered if: + +* A business process with the same technical name already exists—then the user sees the following validation message in the top right corner: -//* Бізнес-процес із такою службовою назвою вже існує -- тоді користувач бачить наступне валідаційне повідомлення у правому верхньому куті: -* A business process with the same technical name already exists -- then the user sees the following validation message in the top right corner: -+ -//** `"Бізнес-процес із такою службовою назвою вже існує"`. ** `A business process with this technical name already exists`. -//* Валідаційні правила порушені -- тоді користувач бачить валідаційне повідомлення у правому верхньому куті: -* Validation rules are violated -- then the user sees a validation message in the top right corner: +* Validation rules are violated—then the user sees a validation message in the top right corner: + -//** `"Перевірте формат обов'язкових полів"`. + ** `Check the format of mandatory fields`. -//* Для бізнес-назви процесу: * For the business process name: -+ -//** Валідаційні правила порушені -- тоді користувач бачить валідаційне повідомлення у правому верхньому куті: -** Validation rules are violated -- then the user sees a validation message in the top right corner: -+ -//** `"Перевірте формат обов'язкових полів"` + +** Validation rules are violated—then the user sees a validation message in the top right corner: + ** `Check the format of mandatory fields`. image:registry-develop:registry-admin/admin-portal/process-models/process-models-5-1.png[] -//При спрацьовуванні перевірок, користувач лишається на поточній сторінці/вкладці. When the checks are triggered, the user stays on the current page/tab. - ==== [CAUTION] ==== -//Створення бізнес-процесу відбувається лише у межах вашої версії-кандидата. Як створити нову версію-кандидат -- дивіться на сторінці xref:registry-admin/admin-portal/version-control/create-new-change-request.adoc[]. The creation of a business process occurs only within your candidate version. To create a new candidate version, refer to xref:registry-admin/admin-portal/version-control/create-new-change-request.adoc[]. -//Ви можете переглянути внесені зміни та їх статус у секції [.underline]#Внесені зміни# (детальніше -- на сторінці xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#review-changes-candidate[Перегляд переліку внесених змін]). -You can review the made changes and their status in the [.underline]#Latest changes# section (see xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#review-changes-candidate[Viewing list of latest changes]) ) +You can review the made changes and their status in the *Latest changes* section (_see xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#review-changes-candidate[Viewing the list of latest changes]_). -//Якщо ви завершили створення бізнес-процесу і хочете опублікувати зміни у регламенті Gerrit-репозиторію, необхідно застосувати зміни до майстер-версії (детальніше -- на сторінці xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#push-changes-master[Застосування змін до майстер-версії]). -If you have finished creating a business process and want to publish the changes to the Gerrit repository, you need to apply the changes to the master version (more details on xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#push-changes-master[Applying changes to the master version]). +If you have finished creating a business process and want to publish the changes to the Gerrit repository, you need to apply the changes to the `master` version (_see more details at xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#push-changes-master[Applying changes to the master version]_). ==== \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/delete-process.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/delete-process.adoc index cba2ea2f5d..02cd9fd6c5 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/delete-process.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/delete-process.adoc @@ -1,44 +1,29 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Видалення бізнес-процесів = Deleting business processes +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Видаляйте непотрібні та застарілі бізнес-процеси -- тримайте регламент в актуальному стані. Remove unnecessary and outdated business processes to keep the regulations up to date. -//Відкрийте розділ [.underline]#Моделі процесів# та натисніть _іконку копіювання_ навпроти потрібного бізнес-процесу. Open the [.underline]#Process models# section and click on the _deletion icon_ next to the desired business process. image:registry-develop:registry-admin/admin-portal/process-models/process-models-17.png[] -//В результаті користувач отримує нотифікацію про успішне видалення процесу: As a result, the user receives a notification of successful process deletion: -//* ✅ `Бізнес-процес "<Назва процесу>" успішно видалено` -* ✅ `Business process "" successfully` deleted. +* ✅ `Business process "" successfully` deleted. image:registry-develop:registry-admin/admin-portal/process-models/process-models-18.png[] [IMPORTANT] ==== -//Видалення процесу відбувається у межах вашої версії-кандидата на внесення змін. Якщо необхідно видалити бізнес-процес із регламенту в Gerrit-репозиторії, необхідно xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#push-changes-master[застосувати зміни до майстер-версії]. The deletion of the process occurs within your change candidate version. If you need to delete a business process from the regulations in the Gerrit repository, you need to xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#push-changes-master[apply changes to the master version]. ==== [CAUTION] ==== -//Редагування складових регламенту реєстру можливе лише в рамках версій-кандидатів на внесення змін. Для майстер-версії доступна лише опція перегляду. Editing the components of the registry regulations is only possible within change candidate versions. The master version only has the viewing option available. -//Детальніше про особливості роботи з версіями регламенту дивіться на сторінці: For more information on the features of working with registry regulations versions, please refer to the following page: * xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[] diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc index eb5f75785c..ebbbd6143c 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc @@ -1,63 +1,42 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Редагування бізнес-процесів = Editing business processes +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Кабінет адміністратора регламентів дозволяє редагувати, змінювати та розвивати наявні бізнес-процеси. Якщо моделювальник припустився помилки у назві, або хоче змінити елемент діаграми процесів, чи підправити XML-код, то він може перейти до _режиму редагування_ та внести необхідні зміни. The Regulations administrator portal allows for editing, modifying, and developing existing business processes. If the modeler has made an error in the name, wants to change an element of the process diagram, or modify the XML code, they can enter the _editing mode_ and make the necessary changes. -//NOTE: Неможливо редагувати службову назву. При першому збереженні службова назва записується до сховища як унікальний ідентифікатор процесу в межах екземпляра реєстру і не може бути змінена. NOTE: It is not possible to edit the internal technical name. Upon initial save, the technical name is stored in the repository as a unique identifier for the process within the registry instance and cannot be changed. -Відредагуйте наявний бізнес-процес у кілька простих кроків: Edit an existing business process in a few simple steps: -//. У Кабінеті адміністратора регламентів відкрийте розділ [.underline]#Моделі процесів#. . In the Regulations administrator portal, open the [.underline]#Process Models# section. + image:registry-develop:registry-admin/admin-portal/process-models/process-models-1.png[] -+ -//. Оберіть процес і натисніть [.underline]#🖉 іконку редагування#. + . Select the process and click on the [.underline]#🖉 editing icon#. + image:registry-develop:registry-admin/admin-portal/process-models/process-models-6.png[] -+ -//. Змініть будь-яку складову бізнес-процесу (бізнес-назву, код чи BPMN-елемент у моделері). + . Modify any component of the business process (business name, code, or BPMN element in the modeler). + image:registry-develop:registry-admin/admin-portal/process-models/process-models-7.png[] -+ -//. Натисніть клавішу [.underline]#`Зберегти зміни`#, щоб зберегти внесену інформацію. + . Click the [.underline]#Save changes# button to save the entered information. + [TIP] ==== -//Користувач отримує нотифікацію про успішне створення процесу: The user receives a notification of successful process creation: -//* ✅ `Бізнес-процес "<Назва процесу>" успішно збережено` * ✅ `Business process "" successfully saved`. ==== - + image:registry-develop:registry-admin/admin-portal/process-models/process-models-8.png[] [CAUTION] ==== -//Редагування складових бізнес-процесу стосується лише вашої версії-кандидата. Як створити нову версію-кандидат -- дивіться на сторінці xref:registry-admin/admin-portal/version-control/create-new-change-request.adoc[]. Editing the components of the business process applies only to your change candidate version. To create a new change candidate version, refer to the page xref:registry-admin/admin-portal/version-control/create-new-change-request.adoc[]. -//Ви можете переглянути зміни та їх статус у секції [.underline]#Внесені зміни# (детальніше -- на сторінці xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#review-changes-candidate[Перегляд переліку внесених змін]). -You can review changes and their status in the [.underline]#Latest changes# section (more details at xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#review-changes-candidate[Viewing latest changes]). +You can review changes and their status in the [.underline]#Latest changes# section (_see more details at xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#review-changes-candidate[Viewing latest changes]_). -//Якщо ви завершили редагування і хочете опублікувати зміни у регламенті Gerrit-репозиторію, необхідно застосувати зміни до майстер-версії (детальніше -- на сторінці xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#push-changes-master[Застосування змін до майстер-версії]). -If you have finished editing and want to publish the changes to the Gerrit repository, you need to apply the changes to the master version (more details at xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#push-changes-master[Applying Changes to the Master Version page]). +If you have finished editing and want to publish the changes to the Gerrit repository, you need to apply the changes to the master version (_see more details at xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#push-changes-master[Applying Changes to the Master Version page]_). ==== diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-groups.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-groups.adoc index d5989f3a2a..e05bc476e1 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-groups.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-groups.adoc @@ -1,72 +1,42 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Categorizing available services in user portals +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Проблематика == Problem statement -//У Кабінетах користувачів усі доступні послуги представлені в єдиному списку, що є незручним для користувачів реєстрів із великою кількістю таких послуг. In user portals, all available services are presented in a single list, which is inconvenient for users of registries with a large number of such services. -//Щоб поліпшити досвід користувачів, реалізовано можливість категоризації послуг за допомогою груп та можливість управління порядком їх відображення. Це дозволяє більш ефективно відображати та знаходити необхідні послуги у реєстрах. To improve user experience, the ability to categorize services using groups and the ability to manage their display order has been implemented. This allows for more efficient display and easier access to the necessary services in registries. -//== Загальні принципи та положення == General principles and provisions -//Розробник регламенту може групувати та сортувати бізнес-процеси через вебінтерфейс адміністративного порталу. Зміни до налаштувань групування та сортування валідуються на етапі публікації регламенту реєстру та розгортаються на відповідному середовищі. -The regulations developer can group and sort business processes through the web interface of the administrative portal. Changes to grouping and sorting settings are validated during the publication of the registry regulations and deployed in the corresponding environment. +The registry regulations developer can group and sort business processes through the web interface of the administrative portal. Changes to grouping and sorting settings are validated during the publication of the registry regulations and deployed in the corresponding environment. -//Надалі користувачі Кабінетів посадової особи та отримувача послуг зможуть переглядати список бізнес-процесів із розділенням на групи та впорядкованих згідно з налаштуваннями регламенту. Subsequently, users of the Officer and Citizen portals will be able to view the list of business processes divided into groups and ordered according to the regulation settings. [NOTE] ==== -//Бізнес-процес не може бути прив'язаний до двох чи більше груп одночасно. Група не є обов'язковою, і якщо бізнес-процес не прив'язаний до групи, він відображається поза групою. Якщо відсутні налаштування груп, це означає, що жоден бізнес-процес не прив'язаний до групи. A business process cannot be assigned to two or more groups simultaneously. The group is not mandatory, and if a business process is not assigned to a group, it is displayed outside of any group. If there are no group settings, it means that no business process is assigned to a group. -//Групи, в яких немає жодного бізнес-процесу, доступного користувачу, не відображаються в Кабінетах користувачів, але вони відображаються в інтерфейсі Кабінету адміністратора регламентів. Вкладеність груп не підтримується. Groups that do not have any business processes available to the user are not displayed in user portals but are shown in the Regulations administrator portal's interface. Nesting of groups is not supported. ==== [#configure-bp-groups-in-admin-portal] -//== Налаштування груп бізнес-процесів у Кабінеті адміністратора регламентів == Configuring business process groups in the Regulations administrator portal -//TIP: Ви можете згрупувати бізнес-процеси, відсортувати групи та доступні послуги для відображення в Кабінетах. Користувачі бачитимуть лише ті послуги, до яких вони мають доступ. Група не відобразиться, якщо усі її процеси недоступні для користувача. TIP: You can group business processes, sort groups, and manage accessible services for display in the portals. Users will only see the services they have access to. A group will not be displayed if all its processes are inaccessible to the user. -//Налаштувати категоризацію бізнес-процесів за допомогою груп можна наступним чином: To configure the categorization of business processes using groups, follow these steps: -//. Увійдіть до [.underline]#Кабінету адміністратора регламентів# у своєму реєстрі. . Access the [.underline]#Regulations administrator portal# in your registry. -+ -//. Відкрийте, або створіть нову версію-кандидат на внесення змін. + . Open or create a new candidate version for merging changes. -//TODO: merging changes above is fine as a translation for внесення змін? -+ -//. Відкрийте розділ [.underline]#Моделі процесів# та перейдіть на вкладку `Відображення в кабінетах`. + . Go to the [.underline]#Process models# section and navigate to the *Display in portals* tab. -+ -//. Далі виконайте налаштування відповідно до потреб. Адміністратор регламенту може: -. Customize the settings according to your needs. The regulations administrator can: - -//* xref:#create-group[Створити групу] -//* xref:#rename-group[Перейменувати групу] -//* xref:#delete-group[Видалити групу] -//* xref:#sorting-groups[Сортувати групи] -//* xref:#add-bp-to-group[Додавати процеси до групи] -//* xref:#delete-bp-from-group[Видаляти бізнес-процеси із групи] -//* xref:#sorting-grouped-bp[Сортувати бізнес-процеси у групі] + +. Customize the settings according to your needs. The administrator can: + * xref:#create-group[Create a group] * xref:#rename-group[Rename a group] * xref:#delete-group[Delete a group] @@ -75,234 +45,174 @@ To configure the categorization of business processes using groups, follow these * xref:#delete-bp-from-group[Remove processes from a group] * xref:#sorting-grouped-bp[Sort business processes within a group] -//=== Операції з групами процесів === Operations with process groups -//Адміністратор регламенту може створювати, перейменовувати та видаляти групи процесів. -The regulations administrator can create, rename, and delete process groups. +The registry regulations administrator can create, rename, and delete process groups. -//NOTE: Усі операції зі створення та редагування можливо виконати лише в рамках версії-кандидата на внесення змін до регламенту. Для майстер-версії доступний лише режим перегляду (_детальніше -- див. xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[]_). NOTE: All creation and editing operations can only be performed within a change candidate version of the regulations. The master version only allows viewing mode (see more at _xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[]_) [#create-group] -//==== Створення групи бізнес-процесів ==== Creating a business process group -//Створити групу для об'єднання бізнес-процесів можна так: :: To create a group for consolidating business processes, follow these steps: :: -+ -//. Відкрийте вкладку `Відображення в кабінетах` та натисніть `[.underline]#Створити групу#`. + . Open the *Display in portals* tab and click on [.underline]#Create group#. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-1.png[] -+ -//. Введіть назву нової групи. Назва має бути унікальною у межах регламенту. + . Enter a unique name for the new group within the regulations. + -//NOTE: Може мати від 3 до 512 символів. Допустимі символи: “А-Я”, “а-я” української абетки, пробіл, апостроф, тире, дефіс, "()", "/",":", ";", ",", ".", "№", цифри 0-9. NOTE: The name can have 3 to 512 characters. Allowed characters include "A-Z," "a-z" of the Ukrainian alphabet, space, apostrophe, hyphen, parentheses, "/", ":", ";", ",", ".", "№," and numbers 0-9. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-2.png[] + [WARNING] ==== -//* Якщо порушено формат вводу даних, то ви отримаєте наступну валідаційну помилку: * If the data input format is violated, you will receive the following validation error: + image::registry-admin/admin-portal/process-models/process-groups/process-groups-2-1.png[] -//* Якщо група з такою назвою вже існує, то ви отримаєте наступну валідаційну помилку: * If a group with the same name already exists, you will receive the following validation error: + image::registry-admin/admin-portal/process-models/process-groups/process-groups-2-2.png[] - ==== -+ -//. Натисніть kbd:[Зберегти зміни]. + . Click kbd:[Save changes]. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-3.png[] [#rename-group] -//==== Перейменування групи бізнес-процесів ==== Renaming a business process group -//Перейменувати групу можна так: :: To rename a group, follow these steps: :: -//. Відкрийте вкладку `Відображення в кабінетах`. . Open the *Display in portals* tab. -+ -//. Навпроти відповідної групи, або всередині групи оберіть меню "три крапки" (⋮) та натисніть kbd:[Перейменувати]. + . Next to the corresponding group or inside the group, select the "ellipsis" menu (⋮) and click on kbd:[Rename]. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-4.png[] + image::registry-admin/admin-portal/process-models/process-groups/process-groups-4-1.png[] -+ -//. У новому вікні введіть бажану назву. + . In the new window, enter the desired name. + -//NOTE: Може мати від 3 до 512 символів. Допустимі символи: “А-Я”, “а-я” української абетки, пробіл, апостроф, тире, дефіс, "()", "/",":", ";", ",", ".", "№", цифри 0-9. NOTE: The name can have 3 to 512 characters. Allowed characters include "A-Z," "a-z" of the Ukrainian alphabet, space, apostrophe, hyphen, parentheses, "/", ":", ";", ",", ".", "№," and numbers 0-9. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-5.png[] -+ -//. Натисніть kbd:[Зберегти зміни]. + . Click kbd:[Save changes]. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-6.png[] [#delete-group] -//==== Видалення групи бізнес-процесів ==== Deleting a business process group -//NOTE: Зверніть увагу, що при видаленні групи, бізнес-процеси не видаляються, а переходять до стану [.underline]#не згрупованих#. NOTE: Note that when deleting a group, the business processes are not deleted but become [.underline]#ungrouped#. -//Видалити групу можна так: :: To delete a group, follow these steps: :: -//. Відкрийте вкладку `Відображення в кабінетах`. . Open the *Display in portals* tab. -+ -//. Навпроти відповідної групи, або всередині групи оберіть меню "три крапки" (⋮) та натисніть kbd:[Видалити]. + . Next to the corresponding group or inside the group, select the "ellipsis" menu (⋮) and click on kbd:[Delete]. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-7.png[] + image::registry-admin/admin-portal/process-models/process-groups/process-groups-8.png[] -+ -//. У новому вікні підтвердьте, або скасуйте дію. + . In the new window, confirm or cancel the action. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-9.png[] -+ -//. Натисніть kbd:[Зберегти зміни]. + . Click kbd:[Save changes]. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-10.png[] [#sorting-groups] -//==== Сортування груп ==== Sorting business process groups -//Використання вертикальних стрілок на інтерфейсі для переміщення груп бізнес-процесів дозволяє користувачам зручно та швидко знаходити та вибирати потрібні бізнес-процеси зі списку. Using the vertical arrows on the interface to move business process groups allows users to conveniently and quickly find and select the desired processes from the list. image::registry-admin/admin-portal/process-models/process-groups/process-groups-13.png[] -//Наприклад, якщо на інтерфейсі є список груп, таких як "Кадровий склад", "Заяви", "Майно" тощо, то використання вертикальних стрілок дозволяє сортувати ці групи за різними логічними критеріями, щоб надати користувачам зручний доступ до необхідної інформації. For example, if the interface has a list of groups such as "Personnel," "Requests," "Assets," etc., using the vertical arrows allows sorting these groups based on different logical criteria to provide users with convenient access to the necessary information. -//TIP: При створенні групи через Кабінет адміністратора регламентів, вона потрапляє у низ списку груп. Надалі її можна посунути, куди необхідно. TIP: When creating a group through the Regulations administrator portal, it is placed at the bottom of the group list. Later on, it can be moved wherever necessary. -//Крім того, сортування груп бізнес-процесів може допомогти забезпечити консистентність та логічність в інтерфейсі, що полегшує навігацію користувачів та поліпшує їх досвід взаємодії з системою. Additionally, sorting business process groups can help ensure consistency and logical structure in the interface, facilitating user navigation and improving their interaction experience with the system. -//=== Операції із процесами === Operations with processes [#add-bp-to-group] -//==== Додавання бізнес-процесів до групи ==== Adding business processes to a group -//Додати бізнес-процес до групи можна так: :: To add a business process to a group, follow these steps: :: -//. Відкрийте вкладку `Відображення в кабінетах`.. . Open the *Display in portals* tab. -+ -//. Створіть групу (_див. розділ xref:#create-group[]_). + . Create a group (_see xref:#create-group[]_). -+ -//. Навпроти відповідного бізнес-процесу, натисніть іконку з текою (📁). + . Next to the respective business process, click on the folder icon (📁) + image::registry-admin/admin-portal/process-models/process-groups/process-groups-11.png[] -+ -//. У новому вікні оберіть бажану групу, до якої необхідно перенести бізнес-процес. + . In the new window, select the desired group to which you want to transfer the business process. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-12.png[] + -//TIP: Ви можете перенести бізнес-процес в іншу групу чи виключити з поточної. Він буде доданий у кінець обраного переліку бізнес-процесів. TIP: You can move the business process to another group or exclude it from the current one. It will be added to the end of the selected list of business processes. -+ -//. Натисніть kbd:[Підтвердити]. + . Click kbd:[Confirm]. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-12-1.png[] -+ -//. Збережіть зміни. + . Save changes. [#delete-bp-from-group] -//==== Видалення бізнес-процесу із групи ==== Removing a business process from a group -//Видалити бізнес-процес із групи можна так: :: To remove a business process from a group, follow these steps: :: -//. Відкрийте вкладку `Відображення в кабінетах`. . Open the *Display in portals* tab. -+ -//. Відкрийте наявну групу із процесами. + . Open the existing group with processes. -+ -//. Навпроти відповідного бізнес-процесу, натисніть іконку з текою (📁). + . Next to the respective business process, click on the folder icon (📁) + image::registry-admin/admin-portal/process-models/process-groups/process-groups-14.png[] -+ -//. У новому вікні оберіть `Виключити з групи`, з якої необхідно виключити бізнес-процес. + . In the new window, select `Exclude from the group` to remove the business process from the group. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-15.png[] + -//TIP: Ви можете також перенести бізнес-процес в іншу групу. Він буде доданий у кінець обраного переліку бізнес-процесів. TIP: You can also move the business process to another group. It will be added to the end of the selected list of business processes. -+ -//. Натисніть kbd:[Підтвердити]. + . Click kbd:[Confirm]. + image::registry-admin/admin-portal/process-models/process-groups/process-groups-15-1.png[] -+ -//. Збережіть зміни. + . Save changes. [#sorting-grouped-bp] -//==== Сортування бізнес-процесів у групі ==== Sorting business processes within a group -//Впровадження можливості сортування бізнес-процесів на інтерфейсі дозволить користувачам легко та швидко знаходити та вибирати необхідні послуги. Зокрема, можна використовувати вертикальні стрілки для переміщення процесів у рамках груп, або за їх межами. Implementing the ability to sort business processes in the interface allows users to easily and quickly find and select the required services. Vertical arrows can be used to move processes within groups or outside of them. image::registry-admin/admin-portal/process-models/process-groups/process-groups-16.png[] -//== Моделювання регламенту реєстру == Modeling the registry regulations -//Налаштування категоризації (групування) бізнес-процесів у Кабінетах користувачів знаходяться у конфігураційному файлі *_bp-grouping.yaml_* у регламенті вашого реєстру. -The configuration of categorization (grouping) of business processes in user portals is located in the *_bp-grouping.yaml_* configuration file within the regulations of your registry. +The configuration for categorization (grouping) of business processes in user portals is located in the *_bp-grouping.yaml_* configuration file within the regulations of your registry. -//NOTE: Якщо такий файл відсутній, то створіть та заповніть його відповідно (_див. приклад нижче_). NOTE: If such a file is absent, create and fill it accordingly (_see the example below_). -//Є 2 способи, як можна налаштувати групування послуг у Кабінетах користувачів: :: There are two ways to configure service grouping in user portals: :: -//. xref:#configure-bp-groups-in-admin-portal[В інтерфейсі Кабінету адміністратора регламентів] -- в такому разі після внесення змін до майстер-версії регламенту, налаштування [.underline]#_автоматично_# застосуються до файлу *_bp-grouping.yaml_* у Gerrit-репозиторії. . In the xref:#configure-bp-groups-in-admin-portal[Regulations administrator portal interface] -- in this case, after making changes to the master version of the regulations, the settings will [.underline]#automatically# be applied to the *_bp-grouping.yaml_* file in the Gerrit repository. -+ -//. У структурі регламенту в Gerrit-репозиторії [.underline]#_вручну_# -- в такому разі, після розгортання регламенту пайплайном публікацій зміни стануть доступні в інтерфейсах Кабінетів адміністратора та користувачів. + . In the structure of the regulations in the Gerrit repository [.underline]#manually# -- in this case, after deploying the regulations through the publication pipeline, the changes will become available in the interfaces of the Regulations administrator portal. + -//NOTE: За замовчуванням налаштування групування _bp-grouping.yaml_ порожні. NOTE: By default, the *_bp-grouping.yaml_* grouping settings are empty. + -.Структура регламенту реєстру .Registry regulations structure [plantuml, registry-settings-regulation-structure, svg] ---- @@ -320,47 +230,39 @@ NOTE: By default, the *_bp-grouping.yaml_* grouping settings are empty. @endsalt ---- + -.Приклад конфігурації реєстру bp-grouping/bp-grouping.yaml .Registry configuration example: bp-grouping/bp-grouping.yaml ==== [source, yaml] ---- groups: - - name: Перша група + - name: First group processDefinitions: - bp-1-process_definition_id - bp-2-process_definition_id - - name: Друга група + - name: Second group processDefinitions: - bp-3-process_definition_id - - name: Третя група + - name: Third group ungrouped: - bp-4-process_definition_id - bp-5-process_definition_id ---- -//* Масив `*groups*` містить групи бізнес-процесів. * The `*groups*` array contains groups of business processes. -//* Масив `*ungrouped*` містить не згруповані бізнес-процеси. + * The `*ungrouped*` array contains ungrouped business processes. -//NOTE: Бізнес-процеси, що вказані у масивах `processDefinitions` та `ungrouped`, мають існувати у регламенті реєстру, у теці *_bpmn_*. NOTE: The business processes listed in the `processDefinitions` and `ungrouped` arrays must exist in the registry's regulations, in the *_bpmn_* directory. ==== -//NOTE: При видаленні бізнес-процесу, він автоматично видаляється з файлу *_bp-grouping.yml_*. NOTE: When a business process is deleted, it is automatically removed from the *_bp-grouping.yaml_* file. -//== Зовнішній вигляд Кабінетах користувачів == User portal interfaces -//Після розгортання регламенту та застосування налаштувань, групи бізнес-процесів відображатимуться у Кабінетах посадової особи та отримувача послуг. After deploying the regulations and applying the settings, groups of business processes will be displayed in the user portals for the Officers and Citizens. -.Групи процесів у Кабінеті посадової особи .Process groups in the Officer portal image::registry-admin/admin-portal/process-models/process-groups/process-groups-17.png[] -.Групи процесів у Кабінеті отримувача послуг .Process groups in the Citizen portal image::registry-admin/admin-portal/process-models/process-groups/process-groups-18.png[] \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-models-overview.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-models-overview.adoc index a2d2a43877..4d646040d0 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-models-overview.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-models-overview.adoc @@ -1,5 +1,6 @@ = Managing business process models -include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] +:sectlinks: +:sectanchors: include::platform:ROOT:partial$admonitions/language-en.adoc[] @@ -7,38 +8,32 @@ This section demonstrates the functionality of modeling and managing business pr image:registry-develop:registry-admin/admin-portal/process-models/process-models-1.png[] -The functionality allows you to: +The functionality allows you to: :: -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc[Create processes] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc[Edit processes] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/search-process.adoc[Search for processes by name] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/copy-process.adoc[Copy processes] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/upload-process.adoc[Upload processes] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/sorting-process.adoc[Sort processes] -* [*] xref:registry-develop:registry-admin/admin-portal/registry-modeling/process-models/process-groups.adoc[Categorize services] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/delete-process.adoc[Delete processes] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/components/process-components-overview.adoc[View and edit process components], namely: +* Create processes +* Edit processes +* Search for processes by name +* Copy processes +* Upload processes +* Sort processes +* Categorize processes +* Delete processes +* View and edit process components, namely: -** xref:registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc#tab-general[Managing process names]; -** xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-code.adoc[Viewing and editing the processes XML representation code]; -** xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-bpmn-editor.adoc[Modeling processes in the BPMN constructor]. +** Manage process names +** View and edit the processes XML representation code +** Build processes in the BPMN constructor [CAUTION] ==== -//Редагування складових регламенту реєстру можливе лише в рамках версій-кандидатів на внесення змін. Для майстер-версії доступна лише опція перегляду. Editing the components of the registry regulations is only possible within change candidate versions. For the master version, only the view option is available. -//У рамках майстер-версії на внесення змін моделювальник регламенту може: Within the master version, the regulation modeler can: -//* переглядати доступні бізнес-процеси; -// сортувати бізнес-процеси; -//* переглядати складові бізнес-процесів на вкладках [.underline]#Загальна#, [.underline]#Код# та [.underline]#Конструктор#. * View available business processes * Sort business processes -* View components of business processes on the [.underline]#General#, [.underline]#Code#, and [.underline]#Constructor# tabs +* View components of business processes on the *General*, *Code*, and *Builder* tabs -//Детальніше про особливості роботи з версіями регламенту дивіться на сторінці: For more information on working with regulation versions, please refer to the page: * xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[] @@ -46,19 +41,26 @@ For more information on working with regulation versions, please refer to the pa [WARNING] ==== -//Рекомендації для збереження та видалення об'єктів у Кабінеті адміністратора регламентів: Recommendations for saving and deleting objects in the Regulations administrator portal: -//* Зверніть увагу, що у Кабінеті адміністратора регламентів немає попереджувальних вікон, тому будьте особливо уважні та обережні при роботі з об'єктами. * Please note that there are no warning windows in the Regulations administrator portal, so be particularly careful when working with objects. -//* Будьте особливо обережні та уважні при збереженні або видаленні об'єктів, таких як бізнес-процеси, форми тощо. * Exercise caution and attentiveness when saving or deleting objects such as business processes, forms, and so on. -//* Перед створенням або видаленням об'єкта, рекомендується перевірити його, щоб уникнути непередбачуваних наслідків. * Before creating or deleting an object, it is recommended to check it to avoid unforeseen consequences. -//* Врахуйте, що видалення або зміна об'єкта може призвести до втрати даних та порушення бізнес-процесів. * Please be aware that deleting or modifying an object may result in data loss and disruption of business processes. ==== +== Section overview + +* xref:registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc[Create processes] +* xref:registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc[Edit processes] +* xref:registry-admin/admin-portal/registry-modeling/process-models/search-process.adoc[Search for processes by name] +* xref:registry-admin/admin-portal/registry-modeling/process-models/copy-process.adoc[Copy processes] +* xref:registry-admin/admin-portal/registry-modeling/process-models/upload-process.adoc[Upload processes] +* xref:registry-admin/admin-portal/registry-modeling/process-models/sorting-process.adoc[Sort processes] +* xref:registry-develop:registry-admin/admin-portal/registry-modeling/process-models/process-groups.adoc[Categorize services] +* xref:registry-admin/admin-portal/registry-modeling/process-models/delete-process.adoc[Delete processes] +* xref:registry-admin/admin-portal/registry-modeling/process-models/components/process-components-overview.adoc[View and edit process components] + diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/search-process.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/search-process.adoc index a5258a81f7..de8db376b3 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/search-process.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/search-process.adoc @@ -1,25 +1,14 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: += Searching processes by name +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] -//= Пошук процесів за назвою -= Searching for processes by name +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Використовуйте функціональність пошуку бізнес-процесів за назвою. Це дозволяє полегшити та пришвидшити роботу зі схемами процесів. Utilize the functionality of searching for business processes by name. This helps to streamline and expedite work with process diagrams. image:registry-develop:registry-admin/admin-portal/process-models/process-models-13.png[] -//Відкрийте розділ [.underline]#Моделі процесів# та введіть принаймні 3 перші символи назви процесу у полі `Шукати за назвою 🔍`. В результаті ви отримаєте список, що задовольняє введеному значенню. -Open the [.underline]#Process models# section and enter at least the first 3 characters of the process name in the `Search by name` field 🔍`. As a result, you will receive a list that matches the entered value. +Open the *Process models* section and enter at least the first 3 characters of the process name in the `Search by name` field 🔍`. As a result, you will receive a list that matches the entered value. -//NOTE: Шукати процес можна як за бізнес-, так і за службовою назвою. NOTE: You can search for a process by both the business name and the technical name. image:registry-develop:registry-admin/admin-portal/process-models/process-models-14.png[] \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/sorting-process.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/sorting-process.adoc index 6c5c241319..1251909bdf 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/sorting-process.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/sorting-process.adoc @@ -1,38 +1,22 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Сортування бізнес-процесів = Sorting business processes +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Використовуйте функціональність сортування бізнес-процесів. Це дозволяє упорядкувати доступні моделі процесів у висхідному `↑` та низхідному `↓` порядку, покращити користувацький досвід та досліджувати історичність створення та модифікації процесів. Utilize the functionality of sorting business processes. This allows you to arrange available process models in ascending `↑` or descending `↓` order, improve user experience, and explore the history of creation and modification of processes. -//Застосовуйте бажаний тип сортування до наступних колонок: :: Apply the desired sorting type to the following columns: :: -//* `Назва БП` -//* `Службова назва` -//* `Створено` -//* `Відредаговано` -* `Process name` -* `Technical name` -* `Created` -* `Last Edited` +* *Process name* +* *Technical name* +* *Created* +* *Last edited* image:registry-develop:registry-admin/admin-portal/process-models/process-models-19.png[] [TIP] ==== -//Механізм сортування є однаковим для бізнес-процесів UI-форм. The sorting mechanism is the same for both business processes and UI forms. -//Детальнішу інформацію щодо сортування записів у Кабінеті адміністратора ви можете переглянути на сторінці xref:registry-admin/admin-portal/registry-modeling/ui-forms/sorting-paginating-forms.adoc[]. For more detailed information on sorting records in the Regulations administrator portal, please refer to xref:registry-admin/admin-portal/registry-modeling/ui-forms/sorting-paginating-forms.adoc[]. ==== \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/upload-process.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/upload-process.adoc index 080d0ec359..e5c92667bb 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/upload-process.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/upload-process.adoc @@ -1,37 +1,21 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Завантаження (upload) бізнес-процесів = Uploading business processes +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] -//Завантажити бізнес-процес до регламенту можна через копіювання та вставлення XML-схеми готового процесу на вкладці [.underline]#Код#. Пряма опція `Drag & Drop` (перетягування файлу зі схемою) недоступна. -You can upload a business process to the regulation by copying and pasting the XML schema of the ready process in the [.underline]#Code# tab. The direct option of `Drag & Drop` (dragging a file with the schema) is not available. +include::platform:ROOT:partial$admonitions/language-en.adoc[] -.Вставлення коду BPMN-діаграми на вкладці [.underline]#Код# -.Inserting BPMN diagram code in the [.underline]#Code# tab +You can upload a business process to the regulation by copying and pasting the XML schema of the ready process in the *Code* tab. The direct option of `Drag & Drop` (dragging a file with the schema) is not available. + +.Inserting BPMN diagram code in the *Code* tab image::registry-develop:registry-admin/admin-portal/process-models/process-models-12-2.png[] -//TIP: Детальніше про особливості роботи з кодом бізнес-процесу -- на сторінці TIP: For more details on working with the code of a business process, please refer to xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-code.adoc[]. - [CAUTION] ==== -//Редагування складових регламенту реєстру можливе лише в рамках версій-кандидатів на внесення змін. Для майстер-версії доступна лише опція перегляду. Editing components of the registry regulations is only possible within change candidate versions. For the master version, only the viewing option is available. -//Детальніше про особливості роботи з версіями регламенту дивіться на сторінці: -For more information on working with regulations versions, please refer to - -* xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[] +For more information on working with registry regulations versions, please refer to xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[]. ==== diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/registry-global-settings.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/registry-global-settings.adoc index 2d74743e59..54652e151c 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/registry-global-settings.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/registry-global-settings.adoc @@ -1,122 +1,87 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Управління глобальними налаштуваннями реєстру = Configuring global registry settings +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Платформа надає можливість керувати глобальними налаштуваннями реєстру в інтерфейсі порталу адміністратора регламенту. The platform provides the ability to manage the global settings of the registry within the administrator portal interface. image:registry-admin/admin-portal/global-settings/registry-global-settings-1.png[] -//Наразі адміністратор регламенту може налаштувати такі параметри: :: Currently, the registry administrator can configure the following parameters: :: -//* xref:#support-email[Поштова адреса служби підтримки] * xref:#support-email[Support service mailing address] -//* xref:#registry-full-name[Повна назва реєстру] + * xref:#registry-full-name[Full registry name] -//* xref:#registry-short-name[Скорочена назва реєстру] + * xref:#registry-short-name[Abbreviated registry name] -//* xref:#ui-theme[Тема інтерфейсу] + * xref:#ui-theme[Interface theme] -//Надалі перелік налаштувань буде розширено. The list of settings will be expanded in the future. -//CAUTION: Редагування складових регламенту реєстру можливо внести лише в рамках версій-кандидатів на внесення змін. Для майстер-версії доступна лише опція перегляду. CAUTION: Editing the components of the registry regulations can only be done within change candidate versions. For the master version, only the view option is available. -//IMPORTANT: Для того, щоб застосувати бажані параметри, натисніть кнопку `Зберегти зміни`, як показано на зображенні вище. IMPORTANT: To apply the desired parameters, click the *Save changes* button as shown in the image above. [#support-email] -//== Поштова адреса служби підтримки == Support service mailing address -//Якщо користувач Кабінету посадової особи, або отримувача послуг отримає критичну помилку, він зможе звернутись до підтримки за цією адресою. If a user of the Officer or the Citizen portal encounters a critical error, they can contact support using this address. -//Параметр задається у полі `Поштова адреса служби підтримки`. The parameter is set in the *Support service mailing address* field. image:registry-admin/admin-portal/global-settings/registry-global-settings-2.png[] [IMPORTANT] ==== -//Електронна адреса має бути у форматі "test@example.com". Якщо введена адреса не відповідає заданому формату, користувач отримає відповідну валідаційну помилку: The email address should be in the format "test@example.com". If the entered address does not match the specified format, the user will receive a corresponding validation error: -//`❗ Електронна адреса має бути в форматі "test@example.com"` `❗ The email address should be in the format "test@example.com"` - image:registry-admin/admin-portal/global-settings/registry-global-settings-3.png[] ==== [WARNING] ==== -//Користувач не зможе вносити в налаштуваннях адреси доменів, що заборонені чинним законодавством України (наприклад, домени `mail.ru`, або `yandex.ru` тощо). Система видасть відповідну валідаційну помилку: -Users cannot enter domain addresses that are prohibited by current legislation in Ukraine (for example, domains like `mail.ru` or `yandex.ru`). The system will display a corresponding validation error: +Users cannot enter domain addresses that are prohibited by current legislation in Ukraine, for example, domains like `mail.ru` or `yandex.ru`. The system will display a corresponding validation error: -//`❗ Дана поштова адреса не може використовуватись через політику безпеки` `❗ This email address cannot be used due to security policy` image:registry-admin/admin-portal/global-settings/registry-global-settings-4.png[] ==== [#registry-full-name] -//== Повна назва реєстру == Full registry name -//_Повна назва_ -- це офіційна юридична назва реєстру. Використовується в офіційному листуванні, у документах, колонтитулах кабінетів тощо. _The full name_ is the official legal name of the registry. It is used in official correspondence, documents, and cabinet headers, among others. -//CAUTION: Може мати від 3 до 512 символів. Допустимі символи: `"А-Я"`, `"а-я"` української абетки, `"0-9"`, `"-"`, `","`, `"."`, апостроф (`'`), пробіл. CAUTION: It can have 3 to 512 characters. Permissible characters are: "A-Z," "a-z" of the Ukrainian alphabet, "0-9," "-", ",", ".", apostrophe ('), space. -.Повна назва реєстру ЄДР .Full name of the Unified state register ==== -//`ЄДИНИЙ ДЕРЖАВНИЙ РЕЄСТР ЮРИДИЧНИХ ОСІБ, ФІЗИЧНИХ ОСІБ - ПІДПРИЄМЦІВ ТА ГРОМАДСЬКИХ ФОРМУВАНЬ` `STATE REGISTER OF LEGAL ENTITIES, INDIVIDUAL ENTREPRENEURS, AND PUBLIC FORMATIONS` ==== image:registry-admin/admin-portal/global-settings/registry-global-settings-5.png[] [#registry-short-name] -//== Скорочена назва реєстру == Abbreviated registry name -//_Скорочену назву_ використовують у неофіційному спілкуванні, а також там, де недостатньо місця для повної назви, наприклад, у верхній частині кабінетів. _The abbreviated name_ is used in informal communication and where there is limited space for the full name, such as in the upper part of portals. -//CAUTION: Може мати від 1 до 42 символів. Допустимі символи: `"А-Я"`, `"а-я"` української абетки, `"0-9"`, `"-"`, `","`, `"."`, апостроф (`'`), пробіл. CAUTION: It can have 1 to 42 characters. Permissible characters are: "A-Z," "a-z" of the Ukrainian alphabet, "0-9," "-", ",", ".", apostrophe ('), space. image:registry-admin/admin-portal/global-settings/registry-global-settings-6.png[] [#ui-theme] -//== Тема інтерфейсу == Interface theme -//Обрана тема застосовується для усіх кабінетів (отримувача послуг, посадової особи, адміністратора). Не впливає на інтерфейс адміністративної панелі керування платформою та реєстрами Control Plane. The selected theme is applied to all portals (Citizens, Officers, Administrators). It does not affect the interface of the platform's administrative control panel and *Control Plane* registries. -//Наразі підтримуються 2 теми для інтерфейсів користувача: Currently, two themes for user interfaces are supported: -//* Світла тема (за замовчуванням) * Light theme (default) -//* Темна тема * Dark theme image:registry-admin/admin-portal/global-settings/registry-global-settings-7.png[] \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/report-templates.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/report-templates.adoc index fa20b66fa9..05c988603d 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/report-templates.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/report-templates.adoc @@ -3,111 +3,86 @@ include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Огляд == Overview -//Розділ +++Шаблони звітів+++ у Кабінеті адміністратора регламентів містить аналітичну звітність реєстру у форматі JSON, розроблену у відповідному екземплярі Вебінтерфейсу моделювання звітів (Redash Admin). -The *Report templates* section of the Regulations administrator portal contains a list of the registry's analytical reports in JSON format developed in the corresponding instance of the Reports modeling service (Redash Admin). +The *Report templates* section of the Regulations administrator portal contains a list of the registry's analytical reports in JSON format developed in the corresponding instance of the Report modeling service (Redash Admin). -//Ви маєте можливість переглядати та завантажувати створені об'єкти для подальшого публікування їх у регламенті. Here you can view and download these objects for further publication in the regulations. -//IMPORTANT: Цей розділ не залежить від обраної версії регламенту. Будь-які зміни застосовуються до всіх версій регламенту (включно з майстер-версією). -IMPORTANT: This section does not depend on the selected version of the regulations. Any changes apply to all versions of the regulations (including the master version). +IMPORTANT: This section does not depend on the selected version of the regulations. Any changes apply to all versions of the registry regulations, including the `master` version. [TIP] ==== -//* Детальніше про розробку аналітичної звітності дивіться на сторінці xref:registry-develop:data-modeling/reports/reports-overview.adoc[]. + * For details on developing analytical reports, see xref:registry-develop:data-modeling/reports/reports-overview.adoc[]. -//* Детальніше про публікацію аналітичних звітів у регламенті дивіться практичне завдання з розробки аналітичних звітів, розділ xref:registry-develop:study-project/study-tasks/task-6-registry-reports-modeling.adoc#reports-publication[Публікація створених об'єктів користувачам]. + * For details on publishing analytical reports to the regulations, see the study task for developing analytical reports, xref:registry-develop:study-project/study-tasks/task-6-registry-reports-modeling.adoc#reports-publication[Publishing the objects to users] section. ==== -//== Навігація та пошук == Navigation and search -//Ви можете переглядати об'єкти аналітичної звітності у Кабінеті адміністратора регламентів. You can view the analytical reporting objects in the Regulations administrator portal. -//. Увійдіть до Кабінету адміністратора регламентів. . Sign in to the Regulations administrator portal. -+ -//. Відкрийте розділ +++Шаблони звітів+++. + . Open the *Report templates* section. + image:registry-develop:registry-admin/admin-portal/report-templates/report-templates-section.png[] -+ -//. На сторінці +++Змодельовані звіти+++ переглядайте об'єкти аналітичної звітності за допомогою навігаційних елементів та пошуку. + . On the *Modeled reports* page, browse the analytical reporting objects using navigation and search. -//=== Пошук === Search -//Ви можете шукати об'єкти за назвою звіту. Для цього введіть назву звіту у пошукове поле. You can search objects by the report name. For this, enter the report name into the search field. -//NOTE: Пошук працює як за бізнес-назвою, так і за службовою назвою звіту. NOTE: You can search by the report's business name or service name. image:registry-develop:registry-admin/admin-portal/report-templates/report-templates-search.png[] -//=== Сортування === Sorting -//Ви можете сортувати об'єкти за будь-яким стовпцем таблиці. Для цього виконайте наступні кроки: You can sort objects by any of the table's columns. For this, perform the following steps: -//. Натисніть назву стовпця, за якою треба відсортувати об'єкти. . Click the name of the column by which you wish to sort the objects. + image:registry-develop:registry-admin/admin-portal/report-templates/report-templates-sort.png[] + -//. Оберіть опцію сортування: + . Select the sorting option: -//* `↓` -- Низхідне сортування (ascending). За алфавітом -- від `А` до `Я`. За датою -- найновіші вгорі. За числами -- від найменших до найбільших. + * `↓` -- Sort ascending. String values sort alphabetically A through Z, numbers sort lowest to highest, and dates sort latest to earliest (latest on top). -//* `↑` -- Висхідне сортування (descending). За алфавітом -- від `Я` до `А`. За датою -- найдавніші вгорі. За числами -- від найбільших до найменших. + * `↑` -- Sort descending. String values sort alphabetically Z through A, numbers sort highest to lowest, and dates sort earliest to latest (earliest on top). -//=== Пагінація === Pagination -//Ви можете переходити між сторінками та змінювати кількість рядків, що відображаються на одній сторінці. Для цього прокрутіть бігунок униз сторінки. You can switch between pages and adjust the number of rows displayed on a page. For this, scroll down to the bottom of the page. -//* Для переходу між сторінками використовуйте позначки `>` (вперед) або `<` (назад). * To switch between pages, use the `>` (next) or `<` (previous) icons. -//* Тут ви також можете обрати кількість рядків на сторінці (10 за замовчанням). + * Here you can also change the number of rows displayed on a page (10 by default). image:registry-develop:registry-admin/admin-portal/report-templates/report-templates-pagination.png[] -//== Завантаження об'єктів == Downloading objects -//Після того, як ви знайшли потрібний об'єкт на сторінці +++Змодельовані звіти+++, можете завантажити його для подальшої публікації у регламенті. Для цього виконайте наступні кроки: After you find the object on the *Modeled reports* page, you can download it for further publication in the regulations. For this, perform the following steps: -//. Натисніть іконку завантаження (`⤓`) біля потрібного об'єкта. . Click the download icon (`⤓`) next to the object. + image:registry-develop:registry-admin/admin-portal/report-templates/report-templates-download.png[] -+ -//. Розпакуйте отриманий архів. + . Unzip the archive. [TIP] ==== -//Архів містить дві сутності: The archive contains two entities: -//* Дашборди у JSON форматі. Кожний дашборд зберігається в окремому файлі з унікальною назвою (наприклад, _dashboard_1.json_, _dashboard_2.json_, _dashboard_3.json_ тощо). * Dashboards in JSON format. Each dashboard is stored in a separate file with a unique name (for example, _dashboard_1.json_, _dashboard_2.json_, _dashboard_3.json_, and so on). -//* Файл _queries.json_, що містить запити (queries), які формують обраний звіт. + * The _queries.json_ file containing the queries that define the selected report. ==== -//== Пов'язані сторінки == Related topics * xref:registry-develop:data-modeling/reports/reports-overview.adoc[] diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-data-structures.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-data-structures.adoc index 39d46b8e21..f784630d9e 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-data-structures.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-data-structures.adoc @@ -1,81 +1,52 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Таблиці моделі даних реєстру та їх структури = Registry data model tables and their structures +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Розробка регламенту передбачає розробку моделі даних реєстру. Кабінет адміністратора регламентів дозволяє працювати із таблицями бази даних реєстру у режимі перегляду (read-only). The development of regulations involves the creation of a registry data model. The Regulations administrator portal allows working with registry database tables in a read-only mode. [NOTE] ==== -//Перегляд переліку таблиць та їх структури доступний для майстер- та кандидат-версії регламенту. The list of tables and their structures is available for both the master and candidate versions of the regulations. -//Детальніше про версійність регламенту ви можете переглянути за посиланням: For more information about the versioning of regulations, see xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[] ==== [#overview] -//== Загальний огляд == General overview -//Адміністратор може виконати пошук таблиці за назвою (латиницею), сортувати таблиці за назвою, історичністю, суб'єктністю та описом, а також досліджувати їх структуру відповідно до моделі даних. The administrator can search for a table by its name (in Latin characters), sort tables by name, historicity, subjectivity, and description, as well as explore their structure according to the data model. -//Переглянути повний перелік таблиць можна наступним чином: You can view the complete list of tables as follows: -//. Увійдіть до Кабінету адміністратора регламентів. . Sign in to the Regulations administrator portal. -//. Оберіть майстер-версію змін, або версію-кандидат. + . Select either the master version of changes, or the candidate version. + -TIP: Майстер-версія -- це гілка регламенту за замовчуванням. При вході до Кабінету, адміністратор завжди потрапляє на ⌂ Домашню сторінку із майстер-версією змін. TIP: Master version is the default branch of the regulations. Upon entering the portal, the administrator always lands on the ⌂ Home page with the master version of changes. -+ -//. Перейдіть до розділу [.underline]#Таблиці#. -. Navigate to the [.underline]#Tables# section. + +. Navigate to the *Tables* section. + image:registry-admin/admin-portal/tables-data-structures/tables-data-structures-1.png[] -//== Пошук таблиць за назвою == Searching tables by name -//Адміністратор регламенту може швидко та зручно знайти потрібну таблицю за допомогою поля `Шукати за назвою`. Просто введіть початкові літери. Registry regulations administrator can quickly and conveniently find the required table using the *Search by name* field. Simply enter the initial letters. image:registry-admin/admin-portal/tables-data-structures/tables-data-structures-2.png[] -//== Сортування таблиць == Sorting tables -//Адміністратор регламенту може сортувати таблиці за назвою, історичністю, суб'єктністю та описом, швидко знаходячи необхідні значення. Registry regulations administrator can sort tables by name, historical relevance, subjectivity, and description, quickly finding the necessary values. -//Підтримується 2 типи сортування: :: There are 2 types of sorting supported: :: -//* `↓` -- Низхідне сортування. -//* `↑` -- Висхідне сортування. * `↓` -- Descending sorting. * `↑` -- Ascending sorting. -//Поля, до яких застосовується сортування: :: Fields to which sorting is applied: :: -//* `Назва таблиці`; -//* `Історична`; -//* `Суб'єкт`; -//* `Опис`. * `Table name`; * `Historical`; * `Subject`; @@ -83,133 +54,92 @@ Fields to which sorting is applied: :: image:registry-admin/admin-portal/tables-data-structures/tables-data-structures-3.png[] -//== Перегляд структури таблиць == Viewing table structures -//Адміністратор регламенту може переглядати структуру таблиць бази даних реєстру відповідно до передбаченої моделі. Registry regulations administrator can view the structure of the database registry tables according to the provided model. -//Щоб переглянути структуру таблиць, у розділі [.underline]#Таблиці# відкрийте будь-яку таблицю. -To view the table structures, open any table in the [.underline]#Tables# section. +To view the table structures, open any table in the *Tables* section. image:registry-admin/admin-portal/tables-data-structures/tables-data-structures-5.png[] [#tab-general] -//=== Вкладка "Загальна" -=== "General" tab +=== _General_ tab -//На вкладці [.underline]#Загальна# доступна основна інформація про таблицю, що дозволяє поверхнево ознайомитися із призначенням цієї таблиці, а також деякими її атрибутами, а саме: -The [.underline]#General# tab provides basic information about the table, allowing a superficial understanding of the purpose of the table, as well as some of its attributes, namely: +The *General* tab provides basic information about the table, allowing a superficial understanding of the purpose of the table, as well as some of its attributes, namely: -//* Поле `Назва` -- містить назву таблиці із бази даних реєстру. Наприклад, `diplomas`. -* `Name` field -- contains the name of the table from the database registry. For example, `diplomas`. -//* Поле `Опис` -- містить опис, тобто призначення таблиці у базі даних реєстру. Наприклад, `Отримані дипломи`. -* `Description` field -- contains the description, i.e., the purpose of the table in the database registry. For example, `Received diplomas`. +* *Name* field—contains the name of the table from the database registry. For example, `diplomas`. -//// -This checkbox has been removed in 1.9.2. See NOTE. +* *Description* field—contains the description, i.e., the purpose of the table in the database registry. For example, `Received diplomas`. -* Чекбокс `Історичність` -- дозволяє визначати історичність таблиці. -+ -NOTE: Усі таблиці розгортаються з атрибутом історичності за замовчуванням. Без цього атрибута таблиця не створиться. Наприклад, ``. Тому в майбутніх релізах цей чекбокс буде прибрано з інтерфейсу. -//// +This checkbox has been removed in 1.9.2. See NOTE. -//* Чекбокс `Суб'єктність` -- дозволяє визначати суб'єктність таблиці. -* `Subject` checkbox -- allows determining the subjectivity of the table. +* *Subject* checkbox—allows determining the subjectivity of the table. + -//NOTE: Чекбокс показує наявність зв'язку із суб'єктом. На рівні таблиці об'єктів можна задати атрибут `isObject="true"`, який дозволяє додати колонку із посиланням до таблиці суб'єктів (`tableName="subject"`), тобто до певного власника даних. NOTE: The checkbox indicates the presence of a connection with the subject. At the object level, it is possible to set the attribute `isObject`="`true`," which adds a column with a reference to the subject table (`tableName=`"`subject`"), i.e., to a specific data owner. + image:registry-admin/admin-portal/tables-data-structures/tables-data-structures-6.png[] -//=== Вкладка "Індекси" -=== "Indexes" tab +=== _Indexes_ tab -//Вкладка [.underline]#Індекси# дозволяє переглядати перелік індексів конкретної таблиці у базі даних, а також правил, за якими вони працюють. -The [.underline]#Indexes# tab allows viewing the list of indexes for a specific table in the database, as well as the rules by which they operate. +The *Indexes* tab allows viewing the list of indexes for a specific table in the database, as well as the rules by which they operate. [TIP] ==== -//Індекс (_англ. index_) -- об'єкт бази даних, що створений з метою підвищення ефективності виконання запитів. Таблиці в базі даних можуть мати велику кількість рядків, які зберігаються у довільному порядку, і їх пошук за заданим значенням шляхом послідовного перегляду таблиці, рядок за рядком, може займати багато часу. An index is a database object created to improve query execution efficiency. Database tables can contain a large number of rows stored in arbitrary order, and searching for them based on a given value by sequentially scanning the table row by row can be time-consuming. -//Індекс формується зі значень одного чи кількох стовпчиків таблиці й вказівників на відповідні рядки таблиці й, таким чином, дозволяє знаходити потрібний рядок за заданим значенням. The index is formed from the values of one or more columns of the table and pointers to the corresponding rows of the table, thus enabling the retrieval of the required row based on the given value. ==== image:registry-admin/admin-portal/tables-data-structures/tables-data-structures-7.png[] -//Вкладка містить 2 колонки: :: The tab contains 2 columns: :: -//* `Назва` -- назва індекса (об'єкта). * `Name` -- the name of the index (of an object). -//* `Правило` -- правило, що застосовуються до відповідного індекса при вибірці даних. Наприклад, як саме представити дані у відповіді на запит -- висхідним списком (`ASC`), або низхідним (`DESC`) тощо. * `Rule` -- the rule applied to the corresponding index when selecting data. For example, how to represent the data in response to a query - in ascending order (`ASC`), or descending (`DESC`), and so on. -//Моделювальник може також відсортувати (висхідне та низхідне сортування) індекси за назвою, а також правилом, яке застосовується до індекса при пошуку даних. The modeler can also sort the indexes by name and the rule applied to the index when searching for data. -//Також доступна опція пагінації (розбивки на сторінки), якщо кількість записів з індексами перевищує 10 на сторінці. Pagination option (paging) is also available if the number of records with indexes exceeds 10 per page. -//=== Вкладка "Колонки" -=== "Columns" tab +=== _Columns_ tab -//Вкладка "Колонки" дозволяє переглядати структуру колонок у певній таблиці бази даних реєстру. The *Columns* tab allows you to view the structure of columns in a specific table of the registry database. -//Наразі є можливість переглянути такі параметри: :: Currently, you can view the following parameters: :: -//* `Колонка` -- назва колонки у БД реєстру. -//* `Тип` -- тип даних, який зберігається у полі. -//* `Значення за замовчуванням` -- значення поля за замовчуванням, якщо не явно не вказане інше. * `Column` -- the name of the column in the registry database. * `Type` -- the data type stored in the field. * `Default value` -- the default value of the field if another value is not explicitly specified. image:registry-admin/admin-portal/tables-data-structures/tables-data-structures-4.png[] -//Також підтримується 2 типи сортування за усіма колонками: :: Two types of sorting by all columns are supported: :: -//* `↓` -- Низхідне сортування. -//* `↑` -- Висхідне сортування. * `↓` -- Descending sorting. * `↑` -- Ascending sorting. [#data-model-version-candidate] -//== Особливості роботи з таблицями в рамках версій-кандидатів == Working with tables within candidate versions -//Розробка регламенту передбачає розробку моделі даних реєстру. Перегляд переліку таблиць та їх структури доступний у режимі читання (read-only) для версій-кандидатів (детальніше -- див. The development of regulations involves designing a data model for the registry. Viewing the list of tables and their structure is available in read-only mode for candidate versions (for more information, see _xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[]_). -//Функціональні сценарії: :: Functional scenarios: :: -//- Перегляд поточного стану моделі даних регламенту реєстру (перелік таблиць), що розробляється (в рамках версії-кандидату). - Viewing the current state of the data model for the registry regulations (list of tables) being developed (within a candidate version). -//- Отримання результату перевірки можливості успішного розгортання моделі даних. + - Obtaining the result of checking the feasibility of successful deployment of the data model. -//- Перегляд значення атрибута "суб'єктність" у переліку таблиць. + - Viewing the "subjectivity" attribute value in the list of tables. -//- Видалення тимчасових БД для версій-кандидатів - Deleting temporary databases for candidate versions. -//=== Особливості розгортання тимчасових реплік === Deploying temporary replicas -//При роботі з даними реєстру, [.underline]#для кожної версії-кандидата# створюється та розгортається тимчасова репліка з еталонної бази даних (PostgreSQL). Еталонна БД містить лише структуру, без жодних даних реєстру. -When working with registry data, a temporary replica is created and deployed [.underline]#for each candidate version# from the reference database (PostgreSQL). The reference database contains only the structure without any registry data. +When working with registry data, a temporary replica is created and deployed _for each candidate version_ from the reference database (PostgreSQL). The reference database contains only the structure without any registry data. -//Підсистема розгортання регламенту (регламентний jenkins) створює структуру БД шляхом розгортання liquibase-конфігурацій регламенту реєстру (див. детальніше -- The regulations deployment subsystem (regulatory Jenkins) creates the database structure by deploying the liquibase configurations of the registry regulations. For more details, see -xref:data-modeling/data/physical-model/overview.adoc[]). +xref:data-modeling/data/physical-model/overview.adoc[]. -.Скрипт автоматичного розгортання тимчасової репліки з еталонної БД .Script for automatic deployment of temporary replica from the reference database ==== [source,sql] @@ -217,90 +147,62 @@ xref:data-modeling/data/physical-model/overview.adoc[]). CREATE DATABASE [registry-dev-] WITH TEMPLATE registry-template OWNER [our owner user]; ---- -//Цей скрипт створює нову тимчасову БД з іменем `registry-dev-`, яка буде скопійована з еталонної БД `registry-template`. `` -- це унікальний ідентифікатор версії-кандидата. This script creates a new temporary database with the name `registry-dev-`, which is copied from the reference database `registry-template`. `` is a unique identifier of the candidate version. -//* `registry-template` -- ім'я еталонної БД, отриманої після відпрацювання OKD run-db-script-job. -//* `registry-dev-` -- шаблон імені тимчасової БД для версії-кандидата. * `registry-template` -- the name of the reference database obtained after running the OKD run-db-script-job. * `registry-dev-` -- the template name for the temporary database for the candidate version. ==== -//Підсистема управління регламентом (`registry-regulations-management`) зчитує структуру дата-моделі тимчасової БД та зберігає її як знімок поточного стану моделі даних до файлу _DataModelSnapshot_ у форматі JSON. Надалі ці дані передаються до Кабінету адміністратора регламентів, де для кожної окремої версії-кандидата відображається актуальний стан таблиць БД. -The regulations management subsystem (`registry-regulations-management`) reads the data model structure of the temporary database and saves it as a snapshot of the current state of the data model to the _DataModelSnapshot_ file in JSON format. Later, this data is passed to the Regulations administrator portal, where the current state of the database tables is displayed for each individual candidate version. +The Registry regulations management subsystem (`registry-regulations-management`) reads the data model structure of the temporary database and saves it as a snapshot of the current state of the data model to the _DataModelSnapshot_ file in JSON format. Later this data is passed to the Regulations administrator portal, where the current state of the database tables is displayed for each candidate version. -//Після успішної генерації тимчасової БД для певної версії-кандидата, адміністратор матиме змогу працювати зі створеною реплікою та може переглядати усі таблиці та їх структуру у розділі [.underline]#Таблиці# Кабінету адміністратора регламентів. -After successfully generating the temporary database for a specific candidate version, the administrator can work with the created replica and view all the tables and their structure in the [.underline]#Tables# section of the Regulations administrator portal. +After successfully generating the temporary database for a specific candidate version, the administrator can work with the created replica and view all the tables and their structure in the *Tables* section of the Registry regulations administrator portal. -//Загальний вигляд інтерфейсу Кабінету адміністратора регламентів для версій _майстер_ та _кандидат_ при роботі із таблицями однаковий (_див. розділ xref:#overview[]_). -The general interface of the Regulations administrator portal for master and candidate versions when working with tables is the same (see xref:#overview[]_). +The general interface of the Regulations administrator portal for master and candidate versions when working with tables is the same (_see xref:#overview[]_). -//=== Перевірка працездатності наявної конфігурації розгортання тимчасової БД === Verifying the operability of the temporary database deployment configuration -//Під час розгортання тимчасових БД проводиться також перевірка працездатності наявної конфігурації _liquibase changelog_ регламенту реєстру. Під час цього процесу до Кабінету адміністратора регламентів передається інформація про стан виконання відповідного Jenkins-пайплайну. During the deployment of temporary databases, the operability of the existing _liquibase changelog_ configuration of the registry regulations is also checked. During this process, information about the execution status of the corresponding Jenkins pipeline is passed to the Regulations administrator portal. -//До відповідного MR (запита на злиття змін до майстер-гілки) у Gerrit публікується статус розгортання тимчасової БД. The deployment status of the temporary database is published to the corresponding merge request (MR or change request to merge the changes into the master branch) in Gerrit. -//Підсистема управління регламентом зчитує стан розгортання регламенту реєстру (розгортання liquibase) з відповідного MR у Gerrit. Стан виконання відповідного пайплайну відображається в Gerrit MR для версії-кандидата за допомогою специфічних міток (specific labels): -The regulations management subsystem reads the deployment status of the registry regulations (liquibase deployment) from the corresponding merge request in Gerrit. The execution status of the corresponding pipeline is displayed in the Gerrit merge request for the candidate version using specific labels: +The Registry regulations management subsystem reads the deployment status of the registry regulations (liquibase deployment) from the corresponding merge request in Gerrit. The execution status of the corresponding pipeline is displayed in the Gerrit merge request for the candidate version using specific labels: -//* `*SUCCESS*`: процес розгортання та перевірки успішний (`Verified +1`) * `*SUCCESS*`: the deployment and verification process is successful (`Verified +1`) + image:registry-admin/admin-portal/tables-data-structures/tables-data-structures-8.png[] -//* `*FAILED*`: процес розгортання та перевірки не успішний (`Verified -1`) * `*FAILED*`: the deployment and verification process is unsuccessful (`Verified -1`) + image:registry-admin/admin-portal/tables-data-structures/tables-data-structures-9.png[] -//* `*UNKNOWN*`: процес розгортання та перевірки відбувається/не відбувався (відсутня мітка `Verified`) * `*UNKNOWN*`: the deployment and verification process is ongoing/not performed (`Verified` label is absent) + image:registry-admin/admin-portal/tables-data-structures/tables-data-structures-10.png[] -//=== Реконсиляція застарілих схем тимчасових БД === Reconciling outdated schemas of temporary databases -//При роботі з даними реєстру, для кожної версії-кандидата створюється та розгортається тимчасова репліка з еталонної бази даних (PostgreSQL). Часто це призводить до того, що гілка-кандидат може бути вже видалена, а тимчасова БД продовжує існувати та використовувати ресурси реєстру. -When working with registry data, a temporary replica is created and deployed from the reference database (PostgreSQL) for each candidate version. Often, this leads to a situation where the candidate branch may have been deleted, but the temporary database continues to exist and utilize registry resources. +When working with registry data, a temporary replica is created and deployed from the reference database (PostgreSQL) for each candidate version. Often, this leads to a situation where the candidate branch may have been deleted, but the temporary database continues to exist and utilizes registry resources. -//Для розв'язання цієї проблеми впроваджено спеціальний [.underline]#процес реконсиляції (reconciliation process)# для періодичного видалення застарілих схем БД по версіях-кандидатах (версії-кандидати, що були інтегровані/злиті до майстер-версії, або ж такі, що видалені без інтеграції). -To address this issue, a special [.underline]#reconciliation process# has been implemented to periodically remove outdated database schemas based on candidate versions (candidate versions that have been integrated/merged into the master version or those that have been deleted without integration). +To address this issue, a special *reconciliation process* has been implemented to periodically remove outdated database schemas based on candidate versions (_candidate versions that have been integrated/merged into the master version or those that have been deleted without integration_). -//[.underline]#Reconciliation process# (пайплайн `cleanup-of-version-candidate-db`) -- це Jenkins-процес, запланований до виконання у певний час. Параметр періодичності виклику налаштовується на рівні _helm_-файлу конфігурації реєстру та передається на рівень тригера Jenkins-пайплайну. Значення за замовчуванням: 1 раз на добу, 17:00 GMT+2 (Київ). -[.underline]#Reconciliation process# (`cleanup-of-version-candidate-db` pipeline) is a Jenkins process scheduled to run at a specific time. The frequency parameter for triggering the process is configured at the _helm_ configuration file level of the registry and passed to the Jenkins pipeline trigger level. The default value is once a day at 17:00 GMT+2 (Kyiv time). +*Reconciliation process* (`cleanup-of-version-candidate-db` pipeline) is a Jenkins process scheduled to run at a specific time. The frequency parameter for triggering the process is configured at the _helm_ configuration file level of the registry and passed to the Jenkins pipeline trigger level. The default value is once a day at 17:00 GMT+2 (Kyiv time). -//Налаштувати процес можна у сервісі Jenkins вашого реєстру. Для цього: :: You can configure the process in your registry's Jenkins service by following these steps: :: -//. Відкрийте Jenkins-консоль у проєкті вашого реєстру. -//. Знайдіть пайплайн *cleanup-of-version-candidate-db*. -//. Відкрийте налаштування (⚙ *Configure*). . Open the Jenkins console in your registry project. . Find the *`cleanup-of-version-candidate-db`* pipeline. . Open the settings (⚙ *Configure*). + image:registry-admin/admin-portal/tables-data-structures/tables-data-structures-11.png[] -+ -//. Перейдіть до розділу *`Build Triggers`* та задайте бажану періодичність запуску процесу. Періодичність налаштовується у форматі https://uk.wikipedia.org/wiki/Cron[*unix-cron*]. + . Go to the *`Build Triggers`* section and set the desired frequency for running the process. The frequency is configured in the https://uk.wikipedia.org/wiki/Cron[*unix-cron*] format. + image:registry-admin/admin-portal/tables-data-structures/tables-data-structures-12.png[] - -//При виклику процесу реконсиляції здійснюється: :: When the reconciliation process is triggered, the following actions are performed: :: -//* Отримання переліку версій-кандидатів у Gerrit-репозиторії. -//* Отримання переліку тимчасових БД для версій-кандидатів у базі даних. -//* Видалення тимчасових схем БД версій-кандидатів, для яких не існує відкритих запитів на внесення змін (MR) у Gerrit. * Retrieval of the list of candidate versions from the Gerrit repository. * Retrieval of the list of temporary databases for candidate versions in the database. * Deletion of temporary database schemas for candidate versions for which there are no open merge requests (MR) in Gerrit. -//Після запуску процесу `cleanup-of-version-candidate-db`, система видаляє усі тимчасові БД, які не є у статусі `*Open*` у Gerrit. After running the `cleanup-of-version-candidate-db process`, the system deletes all temporary databases that are not in an "*`Open`*" status in Gerrit. \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-overview.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-overview.adoc index d708e3e44a..199fd6d186 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-overview.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-overview.adoc @@ -1,7 +1,9 @@ -//= Таблиці = Tables +:sectanchors: +:sectlinks: + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Огляд секції == Section overview * xref:registry-develop:registry-admin/admin-portal/registry-modeling/tables/tables-data-structures.adoc[] diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/xml-editor.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/xml-editor.adoc index a4addb80aa..7831dabfc5 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/xml-editor.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/xml-editor.adoc @@ -1,117 +1,85 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Modeling the structure of registry database tables in an XML code editor +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//== Загальні положення == General provisions -//Адміністративний портал пропонує вбудований XML-редактор, який спеціалізується на роботі зі структурою таблиць у файлі *_data-model/createTables.xml_* і спрощує роботу з моделлю даних у регламенті реєстру. Всього існують два підходи до створення та редагування таблиць: The administrative portal offers a built-in XML editor specialized in working with the table structure in the *_data-model/createTables.xml_* file, simplifying the data model management in the registry regulations. There are two approaches to creating and editing tables: -// Робота безпосередньо у файлах регламенту Gerrit. У цьому випадку може бути декілька різних файлів для роботи з різними таблицями. * Working directly with the registry regulations files in Gerrit. In this case, there can be multiple files for different tables. + -//TIP: Детальніше про роботу з таблицями у моделі даних див. -- + TIP: For more information on working with tables in the data model, refer to -xref:data-modeling/data/physical-model/liquibase-ddm-ext.adoc#table-management[Керування таблицями]. +xref:data-modeling/data/physical-model/liquibase-ddm-ext.adoc#table-management[Tables management]. -//* Робота через XML-редактор в адміністративному порталі. Зміни, внесені тут, після їх застосування до майстер гілки репозиторію *_registry-regulations_*, потрапляють лише до одного файлу -- *_data-model/createTables.xml_*. * Working through the XML editor in the administrative portal. Changes made here, after being applied to the master branch of the *_registry-regulations_* repository, only affect one file - *_data-model/createTables.xml_*. + [NOTE] ==== -//У такому випадку необхідно дотримуватися таких рекомендацій: + In this case, it is necessary to follow the following recommendations: -//* Усі операції, пов'язані зі створенням або зміною структури таблиць бази даних, слід зберігати у файлі _data-model/createTables.xml_. Це допоможе забезпечити правильну організацію структури даних та зручність роботи з ними. * All operations related to creating or modifying the structure of database tables should be saved in the _data-model/createTables.xml_ file. This ensures proper organization of data structure and facilitates work with them. -//* Файл *_data-model/createTables.xml_* має бути явно включений до переліку файлів для розгортання у конфігурації *_data-model/main-liquibase.xml_*. Це гарантує належне врахування змін у таблицях бази даних під час розгортання системи. * The *_data-model/createTables.xml_* file should be explicitly included in the list of deployment files in the *_data-model/main-liquibase.xml_* configuration. This guarantees that changes in database table structures are correctly accounted for during system deployment. -//Дотримуючись цих рекомендацій, ви зможете забезпечити ефективну роботу зі структурою таблиць та забезпечити коректність розгортання бази даних у вашому реєстрі. By adhering to these recommendations, you can ensure efficient work with table structures and ensure the correctness of database deployment in your registry. ==== -//Ви самі обираєте, який підхід використовувати для створення та редагування таблиць. Якщо ви обираєте роботу з адміністративного порталу через вбудований XML-редактор, то для полегшення роботи зі структурою таблиць у файлі _createTables.xml_ було імплементовано рішення https://microsoft.github.io/monaco-editor/[Monaco Editor], візуалізоване темою *Visual Studio Dark*. Це дозволяє швидко та зручно вносити зміни через єдиний інтерфейс і зменшує кількість помилок, забезпечуючи більш продуктивний процес роботи з моделлю даних. You can choose which approach to use for creating and editing tables. If you choose to work with the administrative portal through the built-in XML editor, for easier handling of table structures in the _createTables.xml_ file, the https://microsoft.github.io/monaco-editor/[Monaco Editor] solution has been implemented, visualized with the *Visual Studio Dark* theme. This allows for quick and convenient changes through a unified interface and reduces the number of errors, ensuring a more productive data model management process. -//Однією з переваг цього редактора є _синтаксичний аналіз коду_ -- можливість отримувати сповіщення про синтаксичні помилки, якщо такі виникли. Крім того, редактор надає підказки та дозволяє використовувати функцію автозаповнення, що спрощує процес додавання нової таблиці до моделі даних. One advantage of this editor is _syntax code analysis_, which provides notifications about syntax errors, if any occur. Additionally, the editor provides suggestions and enables auto-completion, simplifying the process of adding new tables to the data model. -//== Сценарії використання == Usage scenarios -//* Зручне редагування структури даних у моделі регламенту реєстру за допомогою простого вікна редагування. * Convenient editing of data structure in the registry regulations model using a simple editing window. -//* Автоматичне збереження внесених змін до версії-кандидата регламенту, що дозволяє ефективно вести процес редагування. + * Automatic saving of changes made to the candidate version of the regulations, facilitating efficient editing process. -//* Відображення повідомлень про помилки у вікні редагування структури таблиць моделі даних регламенту реєстру, що допомагає швидко виявляти та виправляти помилки. + * Display of error messages in the table structure editing window of the registry regulations data model, aiding in quick error detection and correction. -//* Надання автопідказок та автодоповнень при редагуванні *`liquibase changelog xml`*, що спрощує процес редагування та дозволяє уникнути помилок. + * Provision of auto-suggestions and auto-completion while editing *`liquibase changelog xml`*, simplifying the editing process and preventing errors. -//* Перевірка liquibase-конфігурації згідно з *liquibase* та *DDM xsd*, що допомагає налаштувати конфігурацію коректно та уникнути проблем. + * Verification of liquibase configuration according to *liquibase* and *DDM xsd*, helping configure the configuration correctly and avoid issues. -//== Функціональні можливості == Functional capabilities -//=== Загальний процес використання === General usage process -//Використовуйте візуальний редактор коду при створенні та редагуванні таблиць моделі даних реєстру за допомогою XML-тегів. Use the visual code editor to create and edit tables in the registry data model using XML tags. [CAUTION] ==== -//Редагування складових регламенту реєстру можливе лише в рамках версій-кандидатів на внесення змін. Для майстер-версії доступна лише опція перегляду. + Editing registry regulations components is only possible within change candidate versions. For the master version, only the viewing option is available. -//Детальніше про особливості роботи з версіями регламенту дивіться на сторінці For more information on working with regulation versions, refer to xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[]. ==== -//. У [.underline]#Кабінеті адміністратора регламентів# відкрийте розділ [.underline]#Таблиці#. -. In the [.underline]#Regulations administrator portal# open the [.underline]#Tables# section. -+ -//TIP: Портал адміністратора ви можете знайти за посиланням: -TIP: You can find the Regulations administrator portal at + -https://admin-tools-<назва-реєстру>.apps.envone.dev.registry.eua.gov.ua/. +. In the *Administrative portal* open the *Tables* section. + image:registry-develop:registry-admin/admin-portal/tables-data-structures/xml-editor/xml-editor-1.png[] + -//. В рамках версії-кандидата відкрийте вкладку [.underline]#Файл опису структури# та розгорніть візуальний редактор у повноекранному режимі, натиснувши `Розгорнути`. -. Within the change candidate version, open the [.underline]#Structure description file# tab and expand the visual editor in full-screen mode by clicking on `Expand`. -+ -//. Внесіть відповідні зміни до моделі даних та натисніть kbd:[Зберегти зміни]. -. Make the necessary changes to the data model and click kbd:[Save Changes]. + +. Within the change candidate version, open the *Structure description file* tab and expand the visual editor in full-screen mode by clicking on *`Expand`*. + +. Make the necessary changes to the data model and click *`Save Changes`*. + -//TIP: Детальніше про роботу з моделлю даних реєстру ви можете дізнатися на сторінці -TIP: For more information on working with the registry data model, refer to -xref:data-modeling/data/physical-model/overview.adoc[]. +TIP: For more information on working with the registry data model, refer to xref:data-modeling/data/physical-model/overview.adoc[]. + image:registry-develop:registry-admin/admin-portal/tables-data-structures/xml-editor/xml-editor-2.png[] + -//Ви отримаєте відповідне повідомлення-підказку про те, що зміни збережено. You will receive a corresponding notification indicating that the changes have been saved. + image:registry-develop:registry-admin/admin-portal/tables-data-structures/xml-editor/xml-editor-3.png[] + -//Скасуйте зміни, натиснувши kbd:[Відмінити зміни]. При натисканні на цю кнопку, ви отримаєте наступне попереджувальне повідомлення із варіантами продовження: + Cancel the changes by clicking kbd:[Cancel changes]. When you click this button, you will receive the following warning message with options for proceeding: + ==== -//`Ви впевнені, що хочете скасувати зміни?` `Are you sure you want to cancel the changes?` ==== + @@ -120,140 +88,104 @@ image:registry-develop:registry-admin/admin-portal/tables-data-structures/xml-ed + [WARNING] ==== -//Якщо ви змінили файл, але не зберегли зміни, і хочете вийти із вікна редагування, то отримаєте наступне повідомлення: -If you have made changes to the file but have not saved them and want to exit the editing window, you will receive the following message: +If you have made changes to the file but have not saved them and want to exit the editing window, you will receive the following message: ===== -//`Файл опису структури було змінено. Якщо покинути сторінку зараз, то незбережені зміни будуть скасовані.` `The structure description file has been modified. If you leave the page now, unsaved changes will be discarded.` ===== image:registry-develop:registry-admin/admin-portal/tables-data-structures/xml-editor/xml-editor-4.png[] - ==== + -//NOTE: Кнопка kbd:[Зберегти зміни] заблокована, якщо файл опису структури містить помилки, знайдені під час аналізу коду та liquibase-конфігурації згідно з liquibase та DDM xsd (_детальніше -- див. у розділі xref:#xsd-liquibase-validation[]_). + NOTE: The kbd:[Save changes] button is disabled if the structure description file contains errors detected during code analysis and liquibase configuration according to liquibase and DDM xsd (_for more details, see xref:#xsd-liquibase-validation[]_) + -//. Перейдіть до розділу [.underline]#Огляд версії# та перевірте, що зміни у файлі додалися до переліку змін вашої версії-кандидата з відповідним статусом. -. Go to the [.underline]#Version overview# section and verify that the changes in the file have been added to the list of changes in your change candidate version with the corresponding status. + +. Go to the *Version overview* section and verify that the changes in the file have been added to the list of changes in your change candidate version with the corresponding status. + -//NOTE: Якщо у файлі *_data-model/createTables.xml_* було внесено зміни через адміністративний портал або безпосередньо через додавання патчсет-у в Gerrit у відповідний MR до версії-кандидата, то на сторінці [.underline]#Огляд версії# в розділі [.underline]#Внесені зміни# відображатиметься секція [.underline]#Структура таблиць БД#. -NOTE: If changes have been made to the *_data-model/createTables.xml_* file through the administrative portal or directly by adding a patch set to Gerrit in the corresponding merge request for the change candidate version, the *Structure the database tables* section will be displayed on the [.underline]#Version overview# page under [.underline]#Latest changes#. + +NOTE: If changes have been made to the *_data-model/createTables.xml_* file through the administrative portal or directly by adding a patch set to Gerrit in the corresponding merge request for the change candidate version, the *Structure the database tables* section will be displayed on the *Version overview* page under the *Latest changes*. + image:registry-develop:registry-admin/admin-portal/tables-data-structures/xml-editor/xml-editor-9.png[] + -//. Застосуйте зміни до майстер-версії регламенту. + . Apply the changes to the master version of the regulation. + -//TIP: Детальніше дивіться на сторінці + TIP: For more information, see xref:registry-admin/admin-portal/version-control/overview-new-change-request.adoc[]. [WARNING] ==== -.Виникнення помилок під час обробки файлу з описом структури моделі даних -.Error handling during the processing of the data model description file. +.Error handling during the processing of the data model description file [%collapsible] ===== - -* При відкритті вкладки [.underline]#Файл опису структури# в адміністративному порталі, у разі відсутності файлу _data-model/createTables.xml_ у репозиторії з регламентом, може виникнути 404 помилка. +* Upon opening an XML editor on the Admin Portal's *File description structure* tab, if the file data-model/createTables.xml is missing in the registry regulations repository, a `404` error might occur. + image:registry-admin/admin-portal/tables-data-structures/xml-editor/xml-editor-7.png[] -* У випадку проблем із обробкою файлу _data-model/createTables.xml_, може виникнути 500 помилка. +* In case of issues processing the file data-model/createTables.xml, a `500` error might occur. + image:registry-admin/admin-portal/tables-data-structures/xml-editor/xml-editor-8.png[] - ===== ==== - [#xsd-liquibase-validation] -//=== Синтаксичний аналіз коду, підказки та автодоповнення === Code syntax analysis, hints, and auto-completion -//Вбудований синтаксичний аналізатор коду в редакторі Monaco пропонує переваги, які є специфічними для роботи з XML-розміткою: The built-in code syntax analyzer in the Monaco editor offers advantages specific to working with XML markup: -//TODO: Add screenshot -//. [.underline]#Підсвічування синтаксису XML#: Редактор Monaco підсвічує відповідні елементи XML-файлу, такі як теги, атрибути та текстовий контент. Це полегшує читання та редагування XML-файлів. . [.underline]#XML syntax highlighting#: The Monaco editor highlights the relevant elements of an XML file, such as tags, attributes, and text content. This makes it easier to read and edit XML files. -+ -//TODO: Add screenshot -//. [.underline]#Автодоповнення XML-тегів#: Редактор Monaco надає автодоповнення закривальних тегів, базуючись на відкритих тегах, а також автодоповнення для тегів `` та їхнього вмісту. Крім того, він пропонує автодоповнення для типових і нетипових (розширених) тегів та атрибутів Liquibase, що сприяє правильній структурі XML-файлів та знижує ризик виникнення помилок. + . [.underline]#Auto-completion of XML tags#: The Monaco editor provides auto-completion for closing tags based on open tags. It also offers auto-completion for `` tags and their contents. Additionally, it suggests auto-completion for standard and non-standard (extended) Liquibase tags and attributes, promoting proper XML file structure and reducing the risk of errors. + -//TIP: Детальніше про доступні теги для побудови моделі даних див. на сторінках -//xref:data-modeling/data/physical-model/liquibase-standard-change-types.adoc[] та xref:data-modeling/data/physical-model/liquibase-ddm-ext.adoc[] відповідно. TIP: For more information on available tags for building a data model, refer to xref:data-modeling/data/physical-model/liquibase-standard-change-types.adoc[] and xref:data-modeling/data/physical-model/liquibase-ddm-ext.adoc[] respectively. -//. [.underline]#Валідація XML#: Синтаксичний аналізатор перевіряє коректність XML-структури в реальному часі, виявляючи неправильні або відсутні теги та атрибути, що дозволяє швидко виправити помилки. . [.underline]#XML validation#: The syntax analyzer checks the correctness of the XML structure in real-time, detecting incorrect or missing tags and attributes. This allows for quick error correction. + image:registry-develop:registry-admin/admin-portal/tables-data-structures/xml-editor/xml-editor-6.png[] [NOTE] ==== -//Функції синтаксичного аналізатора коду ґрунтуються на правилах, встановлених у XSD для редагування XML Liquibase документів. Відповідні XSD зберігаються у сховищі артефактів Nexus Платформи. The code syntax analyzer functions are based on the rules established in the XSD for editing Liquibase XML documents. The corresponding XSD files are stored in the Nexus artifact repository of the Platform. -//Для використання автопідказок, автодоповнення та аналізу коду згідно з `Liquibase XSD` та `DDM Liquibase Extension` під час редагування файлу структури моделі даних, замініть `http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.5.xsd` та `https://nexus-public-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/repository/extensions/com/epam/digital/data/platform/liquibase-ext-schema/latest/liquibase-ext-schema-latest.xsd` на актуальні схеми, розміщені у Nexus. To use auto-suggestions, auto-completion, and code analysis according to the `Liquibase XSD` and `DDM Liquibase Extension` while editing the data model structure file, replace `http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.5.xsd` and `https://nexus-public-mdtu-ddm-edp-cicd.apps.cicd2.mdtu-ddm.projects.epam.com/repository/extensions/com/epam/digital/data/platform/liquibase-ext-schema/latest/liquibase-ext-schema-latest.xsd` with the updated schemas hosted in Nexus. -//Зверніться до адміністратора платформи для отримання посилань на схеми. Please contact the platform administrator for the links to the schemas. ==== -//== Інтеграція структури таблиць БД з різних файлів регламенту для відображення в адміністративному порталі == Integration of database table structures from various rule files for display in the administrative portal -//Цей розділ допоможе вам інтегрувати структуру таблиць бази даних (БД) із різних файлів регламенту для відображення у Кабінеті адміністратора регламентів. Мета полягає у тому, щоб зібрати всі структури таблиць БД в одному файлі -- *_createTables.xml_*. This section will help you integrate the structure of database tables from different rule files to display them in the Regulations administrator portal. The goal is to gather all database table structures in one file, *_createTables.xml_*. -//. Аналіз файлів регламенту . Analysing regulations files + -//Перегляньте файли теки *_data-model_*, такі як _createTables.xml_, _tablesCommon.xml_, _tablesKatottg.xml_ тощо, які містять набори змін (changeSets) із таблицями та їх атрибутами. Review the files in the *_data-model_* directory, such as _createTables.xml_, _tablesCommon.xml_, _tablesKatottg.xml_, etc., which contain sets of changesets with tables and their attributes. -+ -//. Перенесення структур таблиць до файлу _createTables.xml_. + . Transferring table structures to the _createTables.xml_ file -+ -//* Знайдіть усі changeSets, які стосуються структури таблиць БД, у різних файлах регламенту. + * Identify all changesets related to the structure of the database tables in the different regulations files. -+ -//* Перенесіть ці changeSets до файлу _createTables.xml_ у хронологічному порядку. + * Transfer these changesets to the _createTables.xml_ file in chronological order. -+ -//. Визначення дати створення changeSet. + . Determining the creation date of a changeset + -//Щоб знайти дату створення changeSet, скористайтеся функцією *`Annotate with Git Blame`* в Intellij IDEA (або іншому середовищі розробки): To find the creation date of a changeset, use the *`Annotate with Git Blame`* function in IntelliJ IDEA (or any other development environment): -+ -//* Натисніть правою кнопкою миші на лівому стовпці з номерами рядків у файлі. + * Right-click on the left column with line numbers in the file. -+ -//* Оберіть опцію *`Annotate with Git Blame`*. + * Select the *`Annotate with Git Blame`* option. + image:registry-admin/admin-portal/tables-data-structures/xml-editor/xml-editor-10.png[] -+ -//* Після цього лівий стовпчик розшириться, і поряд з номером рядка будуть відображені _дата останнього оновлення_ та _автор_ цього рядка. -* After that, the left column will expand, and next to each line number, you will see the date of the last update and the author of that line. -+ +* After that, the left column will expand, and next to each line number, you will see the date of the last update and the author of that line. + image:registry-admin/admin-portal/tables-data-structures/xml-editor/xml-editor-11.png[] -+ -//. Перевірка результатів у Кабінеті адміністратора регламентів. + . Checking the results in the Regulations administrator portal. + -//Після завершення попередніх кроків, відкрийте адміністративний портал та перейдіть до розділу [.underline]#Таблиці# > [.underline]#Файл опису структури#. Тепер ви повинні побачити всю структуру таблиць БД, зібрану з різних файлів регламенту та відображену в одному файлі _createTables.xml_. -After completing the previous steps, open the administrative portal and navigate to the [.underline]#Tables# section > [.underline]#Structure description file#. You should now see the entire structure of the database tables collected from various rule files and displayed in the _createTables.xml_ file. +After completing the previous steps, open the administrative portal and navigate to the *Tables* section > *Structure description file*. You should now see the entire structure of the database tables collected from various rule files and displayed in the _createTables.xml_ file. -//NOTE: Зверніть увагу, що інтеграція структури таблиць БД в одному файлі -- це лише рекомендація для поліпшення відображення структури даних у Кабінеті адміністратора. Ви завжди можете продовжити розробку структури даних безпосередньо в адміністративному порталі, враховуючи ваші власні вимоги та обмеження. NOTE: Please note that integrating the database table structure in one file is a recommendation to improve the visualization of data structure in the Regulations administrator portal. You can always continue developing the data structure directly in the administrative portal, considering your own requirements and limitations. \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/copy-forms.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/copy-forms.adoc index 232d349c27..af69bcd421 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/copy-forms.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/copy-forms.adoc @@ -3,30 +3,26 @@ include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Розробники регламенту мають можливість створювати дублікати UI-форм, що передбачає відтворення усіх їх складових, включаючи JSON-код і компоненти моделювання. Кожна копія отримує префікс `_COPY_` у своїй назві. Ця функція особливо корисна, коли потрібно розробити ряд схожих форм або використовувати наявну форму як шаблон. Regulation developers have the ability to create duplicates of UI forms, which involves reproducing all their components, including JSON code and modeling components. Each copy is given the prefix `_COPY_` in its name. This feature is especially useful when developing a series of similar forms or when using an existing form as a template. - -//Копіюйте UI-форму наступним чином: Follow these steps to copy a UI form: -//. Оберіть розділ "UI-форми" у меню зліва. . Select the *UI forms* section in the left-hand menu. + image:registry-admin/admin-portal/ui-forms/ui-forms-1.png[] . Click on the _copy icon_ next to the form you want to copy -- 📋 -//. Натисніть _іконку копіювання_ біля потрібної форми -- 📋 + image:registry-admin/admin-portal/ui-forms/ui-forms-5.png[] . Fill in the fields: _Business form name_ and _Service form name_, and then click on `Create form`." -//. Заповніть поля: _Бізнес-назва форми_ та _Службова назва форми_, після чого натисніть `Створити форму`. + image:registry-admin/admin-portal/ui-forms/ui-forms-6.png[] -//NOTE: Після завершення ви побачите сповіщення про успішне створення копії. -NOTE: After completion, you will receive a notification of the successful creation of a copy. -image:registry-admin/admin-portal/ui-forms/ui-forms-7.png[] +[NOTE] +==== +After completion, you will receive a notification of the successful creation of a copy. +image:registry-admin/admin-portal/ui-forms/ui-forms-7.png[] +==== \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/create-forms.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/create-forms.adoc index 9dffece8d0..1b382071b4 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/create-forms.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/create-forms.adoc @@ -3,31 +3,26 @@ include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Розробники регламенту можуть легко створювати UI-форми для бізнес-процесів. Registry developers can easily create UI forms for business processes. + [NOTE] ==== -//Щоб розпочати створення форми, спершу визначтеся з версією регламенту. To start creating a form, first determine the version of the regulation. -//Наразі розробники можуть створювати та редагувати форми як майстер-версії, так і у версії-кандидаті регламенту. -//Докладніше про версії змін читайте на сторінці + At present, developers can create and edit forms in both master versions and candidate versions of the regulation. For more information about versions of changes, please refer to the corresponding page xref:registry-develop:registry-admin/admin-portal/version-control/version-control-overview.adoc[]. ==== -//Для створення форми необхідно виконати наступні кроки: + To create a form, you need to follow these steps: -//. Відкрийте розділ "UI-форми" у меню зліва. . Open the *UI forms* section in the left-hand menu." + image:registry-admin/admin-portal/ui-forms/ui-forms-1.png[] -//. Натисніть `Створити нову форму`. . Click on *Create new form*. + image:registry-develop:bp-modeling/forms/admin-portal-form-modeling-step-4.png[] -//TIP: Ознайомтеся детальніше із процесом створення форм на сторінці xref:registry-develop:bp-modeling/forms/registry-admin-modelling-forms.adoc[]. TIP: Learn more about the process of creating forms on the page xref:registry-develop:bp-modeling/forms/registry-admin-modelling-forms.adoc[]. \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/delete-forms.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/delete-forms.adoc index 45118a423d..8214f1d5cd 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/delete-forms.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/delete-forms.adoc @@ -3,21 +3,20 @@ include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Розробники регламенту мають змогу видаляти UI-форми. Для цього виконайте наступні кроки: -Regulation developers have the ability to delete UI forms. To do so, follow these steps +Registry regulations developers can delete UI forms. To do so, follow these steps . Open the *UI forms* section in the left-hand menu. -//. Відкрийте розділ "UI-форми" у меню зліва. + image:registry-admin/admin-portal/ui-forms/ui-forms-1.png[] . Select the context menu *Three dots* and click on `Delete`. -//. Оберіть контекстне меню "Три крапки" та натисніть `Видалити`. + image:registry-admin/admin-portal/ui-forms/ui-forms-8.png[] -//NOTE: Після завершення ви побачите сповіщення про успішне видалення. -NOTE: After completion, you will receive a notification of the successful deletion. +[NOTE] +==== +After completion, you will receive a notification of the successful deletion. image:registry-admin/admin-portal/ui-forms/ui-forms-9.png[] +==== diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/download-forms.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/download-forms.adoc index 74a084510e..bef4da1495 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/download-forms.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/download-forms.adoc @@ -3,23 +3,18 @@ include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Розробники регламенту мають змогу завантажувати (download) UI-форми у форматі JSON для подальшого опрацювання в локальному середовищі. Regulation developers have the ability to download UI forms in JSON format for further processing in a local environment. -//Щоб завантажити форму, виконайте наступні кроки: To download a form, follow these steps: . Open the *UI forms* section in the left-hand menu. -//. Відкрийте розділ "UI-форми" у меню зліва. + image:registry-admin/admin-portal/ui-forms/ui-forms-1.png[] . Click on the _download icon_ ⤓ -//. Натисність _іконку завантаження_ ⤓ + image:registry-admin/admin-portal/ui-forms/ui-forms-10.png[] -//NOTE: Після успішного завантаження форми ви побачите відповідне сповіщення NOTE: After successfully downloading the form, you will see a corresponding notification. image:registry-admin/admin-portal/ui-forms/ui-forms-11.png[] diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/edit-forms.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/edit-forms.adoc index 0eadedeaee..32aba3662b 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/edit-forms.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/edit-forms.adoc @@ -3,26 +3,19 @@ include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Розробники регламенту можуть редагувати UI-форми для бізнес-процесів. Щоб редагувати форму, виконайте наступні кроки: - Regulation developers can edit UI forms for business processes. To edit a form, follow these steps: . Open the *UI forms* section in the left-hand menu. -//. Відкрийте розділ "UI-форми" у меню зліва. + image:registry-admin/admin-portal/ui-forms/ui-forms-1.png[] . Click on the _edit icon_ ✎ -//. Натисність _іконку редагування_ ✎ + image:registry-admin/admin-portal/ui-forms/ui-forms-2.png[] . Make the necessary changes to the components of the UI form and click `Save changes`. -//. Внесіть необхідні зміни до складових UI-форми та натисніть `Зберегти зміни`. + image:registry-admin/admin-portal/ui-forms/ui-forms-3.png[] -//TIP: Ознайомтеся детальніше зі складовими UI-форми на сторінці - TIP: Learn more about the components of UI forms on the page xref:registry-admin/admin-portal/registry-modeling/ui-forms/form-tabs.adoc[] \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/form-tabs.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/form-tabs.adoc index 39fc02a59b..63b84b3007 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/form-tabs.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/form-tabs.adoc @@ -3,96 +3,66 @@ include::ROOT:partial$templates/document-attributes/default-set-en.adoc[] include::ROOT:partial$admonitions/language-en.adoc[] -//Сторінка редагування UI-форми доступна за натисканням назви форми або іконки редагування (🖉). Для редагування форми, функціональність сторінки розділена на наступні вкладки: The UI-form editing page is accessed by clicking on a form name, or `edit form` icon (🖉). The functionality of the page is provided on the following tabs: [#general] -//== Загальна == General -//Тут користувачеві доступні поля для заповнення бізнес-назви та службової назви форми. Бізнес-назву можна змінювати без обмежень, а службова назва формується один раз під час створення, і більше не змінюється. Fields for entering UI-form business-name and service name are available on this tab. Business-name can be edited without any restrictions, while the service name is entered once on form creation, and can't be changed. image:registry-admin/admin-portal/ui-forms/main.png[] [#code] -//== Код == Code -//На цій вкладці формується код форми, який можна редагувати та копіювати. Якщо форма створюється у xref:#constructor[Конструкторі], то код заповнюється автоматично, і навпаки. -This tab displays UI-form code, which can be copied and edited. If the form is being created in the xref:#constructor[], the code will be updated automatically, and vice versa. +This tab displays UI-form code, which can be copied and edited. If the form is being created in the xref:#builder[], the code will be updated automatically, and vice versa. image:registry-admin/admin-portal/ui-forms/code.png[] -//TIP: Ознайомтеся детальніше із функціональністю на сторінці xref:registry-admin/admin-portal/registry-modeling/ui-forms/json-code-view-edit.adoc[]. TIP: You can find more details on the functionality on the following page: xref:registry-admin/admin-portal/registry-modeling/ui-forms/json-code-view-edit.adoc[]. -[#constructor] -//== Конструктор -== Constructor +[#builder] +== Builder -//Ця вкладка дозволяє розробникам створювати форму за допомогою вбудованих UI-компонентів. Компоненти знаходяться у меню ліворуч, звідки їх можна перетягнути у робочу зону, щоб сформувати відповідні поля UI-форми. Пошукове поле дозволяє відшукати потрібний елемент за назвою або частиною назви. This tab allows UI-form developers to create forms using in-built UI-components. The components can be found in the left menu, where they can be dragged from onto the work zone to create the corresponding fields of the UI-form. The search field on top of the menu allows the user to search for the required element by name or part of the name. image:registry-admin/admin-portal/ui-forms/constructor.png[] [TIP] ==== -//Детальніше ознайомитися із процесом, а також компонентами моделювання UI-форм ви можете на відповідних сторінках: + You can find more details on the process, and UI-form modeling components on the corresponding pages: * xref:bp-modeling/forms/registry-admin-modelling-forms.adoc[] * xref:bp-modeling/forms/components/index.adoc[] ==== -//== Перегляд == Preview -//Тут розробник може перевірити, як виглядатиме створена ним форма у Кабінетах надавачів та отримувачів послуг. Вкладка частково емулює роботу форми, щоб можна було переглянути її елементи. Here the developer can check the way their UI-form looks in the service provider or service recipient portals. The tab emulates part of the form's operation, so that all its elements can be previewed. image:registry-admin/admin-portal/ui-forms/view.png[] -//== Запит == Request -//На цій вкладці знаходиться код запиту форми до API _Фабрики даних_. Цей код можна скопіювати, але редагування доступне лише через певні зміни у вкладках xref:#constructor[Конструктор] чи xref:#code[Код]. -This tab displays the form's _Data Factory_ API request code. This code can be copied, but it only can be edited indirectly by making certain changes in the xref:#constructor[] чи xref:#code[] tabs. +This tab displays the form's _Data Factory_ API request code. This code can be copied, but it only can be edited indirectly by making certain changes in the xref:#builder[] or xref:#code[] tabs. image:registry-admin/admin-portal/ui-forms/request.png[] -//== Контекстне меню ⋮ == Context menu (⋮) -//Окрім вкладок сторінка має контекстне меню, що відкривається натисканням іконки *`⋮`*. У цьому меню є наступні пункти: Near the tabs you can find a context menu that is activated by clicking the *`⋮`* icon. This menu includes the following items: -//* [*] Скопіювати форму. Цей пункт дозволяє створити копію вашої форми, і почати її редагувати на вкладці xref:#general[Загальна]. * [*] Copy form. This item allows the user to copy the current form and start editing the copy in its xref:#general[] tab. + - -//// -TIP: Також читайте про копіювання форм на сторінці xref:registry-admin/admin-portal/registry-modeling/ui-forms/copy-forms.adoc[]. -//// - TIP: You can find more information on form copying on the following page: xref:registry-admin/admin-portal/registry-modeling/ui-forms/copy-forms.adoc[]. -//* [*] Експорт `.json`. Цей пункт дозволяє експортувати код форми у форматі `.json`. * [*] Export `.json`. This item allows the user to export the form in `.json` format. + - -//// -TIP: Також читайте про експорт/завантаження форм на сторінці xref:registry-admin/admin-portal/registry-modeling/ui-forms/download-forms.adoc[]. -//// TIP: You can find more information on form downloading/exporting on the following page: xref:registry-admin/admin-portal/registry-modeling/ui-forms/download-forms.adoc[]. -//* [*] Видалити. Цей пункт дозволяє видалити форму. * [*] Delete. This item allows the user to delete the form. + - -//// -TIP: Також читайте про видалення форм на сторінці xref:registry-admin/admin-portal/registry-modeling/ui-forms/delete-forms.adoc[]. -//// TIP: You can find more information on form deleting on the following page: xref:registry-admin/admin-portal/registry-modeling/ui-forms/delete-forms.adoc[]. diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/json-code-view-edit.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/json-code-view-edit.adoc index aa4db13c68..b850c22020 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/json-code-view-edit.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/json-code-view-edit.adoc @@ -1,84 +1,56 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Viewing and editing a UI form JSON representation +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] -//Платформа надає можливість переглядати та редагувати JSON-представлення форми на вкладці [.underline]#Код#. -The platform provides the ability to view and edit the JSON representation of a form on the [.underline]#Code# tab. +The platform provides the ability to view and edit the JSON representation of a form on the *Code* tab. -//Функціональність дозволяє швидко та легко внести зміни до даних форми без використання конструктора для моделювання. -This functionality allows for quick and easy changes to the form data without using the modeling constructor. +This functionality allows for quick and easy changes to the form data without using the modeling builder. -//CAUTION: Редагування складових регламенту реєстру можливе лише в рамках версій-кандидатів на внесення змін. Для майстер-версії доступна лише опція перегляду. CAUTION: Editing the components of a registry regulation is only possible within change candidate versions. The master version only allows viewing. -//. Увійдіть до розділу для управління UI-формами. . Go to the section for managing UI forms. -+ -//. Відкрийте будь-яку форму. + . Open any form. + image:registry-admin/admin-portal/ui-forms/json-code/form-json-code-view-edit-1.png[] + -//Припустімо, що ви помітили помилку у назві текстового поля й хочете її виправити. Let's assume you have noticed an error in the label of a text field and would like to correct it. + image:registry-admin/admin-portal/ui-forms/json-code/form-json-code-view-edit-2.png[] -+ -//. Перейдіть до вкладки [.underline]#Код# та внесіть зміни до відповідного поля (у нашому прикладі -- значення параметра `label` масиву `components`). -. Go to the [.underline]#Code# tab and make changes to the respective field (in our example, the value of the `label` parameter in the `components` array). + +. Go to the *Code* tab and make changes to the respective field (in our example, the value of the `label` parameter in the `components` array). + image:registry-admin/admin-portal/ui-forms/json-code/form-json-code-view-edit-3.png[] + -//IMPORTANT: Вкладки [.underline]#Загальна#, [.underline]#Код# та [.underline]#Конструктор# пов'язані між собою. Зміни, що вносяться на одній із цих вкладок, з'являються і на інших. -IMPORTANT: The [.underline]#General#, [.underline]#Code#, and [.underline]#Constructor# tabs are interconnected. Changes made on one of these tabs will appear on the others as well. +IMPORTANT: The *General*, *Code*, and *Builder* tabs are interconnected. Changes made on one of these tabs will appear on the others as well. Open a preview of the form and ensure that the changes have been applied correctly. -+ -//. Відкрийте попередній перегляд форми та переконайтеся, що зміни внесено вірно. + . Open a preview of the form and ensure that the changes have been applied correctly. -. + image:registry-admin/admin-portal/ui-forms/json-code/form-json-code-view-edit-4.png[] -+ -//. Натисніть `Зберегти зміни`, щоб застосувати оновлення коду форми. + . Click `Save changes` to apply the updated form code. -//TODO: Move to form-modeling section after it's created [IMPORTANT] ==== -//Коли користувач намагається зберегти зміни при створенні, або редагуванні бізнес-процесу, чи UI-форми, та знаходиться на будь-якій вкладці розділів [.underline]#Моделі процесів# та [.underline]#UI-форми#, то на усіх вкладках цих розділів спрацьовує валідація, якщо: -When a user attempts to save changes during the creation or editing of a business process or UI form and is on any tab within the [.underline]#Process models# or [.underline]#UI Forms# sections, validation is triggered if: +When a user attempts to save changes during the creation or editing of a business process or UI form and is on any tab within the *Process models* or *UI Forms* sections, validation is triggered if: + +* The UI form with the same system name already exists. In this case, the user will see the following validation message in the top right corner: -//* UI-форма з такою службовою назвою вже існує -- тоді користувач бачить наступне валідаційне повідомлення у правому верхньому куті: -* An UI form with the same system name already exists. In this case, the user will see the following validation message in the top right corner: -+ -//** `"Форма з такою службовою назвою вже існує"`. ** `Form with this system name already exists`. -+ -//* Валідаційні правила порушені -- тоді користувач бачить валідаційне повідомлення у правому верхньому куті: + * Validation rules are violated. In this case, the user will see the validation message in the top right corner: -+ -//** `"Перевірте формат обов'язкових полів"`. + ** `Check the format of required fields`. -+ -//* Для бізнес-назви UI-форми: + * For the business name of the UI form: -//** Валідаційні правила порушені -- тоді користувач бачить валідаційне повідомлення у правому верхньому куті: + ** Validation rules are violated. In this case, the user will see the validation message in the top right corner: -+ -//** `"Перевірте формат обов'язкових полів"` + ** `Check the format of required fields`. image:registry-develop:registry-admin/admin-portal/ui-forms/json-code/form-json-code-view-edit-5.png[] -//При спрацьовуванні перевірок, користувач лишається на поточній сторінці/вкладці. During validation checks, the user remains on the current page/tab. - ==== \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/search-forms.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/search-forms.adoc index d7b521948a..0e148169e5 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/search-forms.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/search-forms.adoc @@ -3,32 +3,22 @@ include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Розробники регламенту можуть здійснювати пошук UI-форм. -//Пошук спрацьовує динамічно за одним з параметрів: Regulation developers can search for UI forms. The search works dynamically based on one parameter:" -//// -* назвою форми; -* службовою назвою форми. -//// * form name; * service form name. -//Шукати змодельовані UI-форми на інтерфейсі можна так: To search for modeled UI forms in the interface, follow these steps: . Open the *UI forms* section in the left-hand menu. -//. Відкрийте розділ "UI-форми" у меню зліва. + image:registry-admin/admin-portal/ui-forms/ui-forms-1.png[] . Enter the form name in the search window. -//. Введіть назву форми в пошуковому вікні + image:registry-admin/admin-portal/ui-forms/ui-forms-4.png[] -//NOTE: Пошук спрацьовує при введенні від 3 і більше символів. NOTE: The search works when 3 or more characters are entered. diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/sorting-paginating-forms.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/sorting-paginating-forms.adoc index af008cf875..e3d8e8424b 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/sorting-paginating-forms.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/sorting-paginating-forms.adoc @@ -3,103 +3,76 @@ include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc include::platform:ROOT:partial$admonitions/language-en.adoc[] -//Платформа дозволяє сортувати змодельовані форми за різними параметрами: The platform allows you to sort modeled forms by various parameters: -//* xref:#sorting-by-name[назвою]; -//* xref:#sorting-by-date[датою та часом створення або редагування]. * xref:#sorting-by-name[by name]; * xref:#sorting-by-date[by creation or modification date and time]. -//Також доступна xref:#pagination[пагінація] рядків. -There is also the rows xref:#pagination[pagination] option available. +There is also the row xref:#pagination[pagination] option available. [#sorting-by-name] -//== Сортування форм за назвою == Sorting forms by name -//Платформа надає дозволяє відсортувати наявні форми за назвою у Кабінеті адміністратора регламентів. Такий тип сортування надає можливість сформувати висхідний, або низхідний список форм для зручності та покращення користувацького досвіду. The platform provides you with the ability to sort existing forms by name in the Regulations administrator portal. This type of sorting allows generating an ascending or descending list of forms for convenience and improved user experience. -//. Увійдіть до розділу для управління UI-формами. . Navigate to the section for managing UI forms. + -.Розділ управління формами .Forms management section image::registry-admin/admin-portal/ui-forms/ui-forms-1.png[] -+ -//. У стовпці `Назва форми` оберіть опцію сортування: + . In the `Form name` column, select the sorting option: -//* `↓` -- Низхідне сортування за назвою (від `А` до `Я` за алфавітом). -//* `↑` -- Висхідне сортування за назвою (від `Я` до `А` за алфавітом) -* `↓` -- Descending sorting by name (from `A` to `Z` alphabetically). -* `↑` -- Ascending sorting by name (from `Z` to `A` alphabetically). + +* `↓` — Descending sorting by name (from `A` to `Z` alphabetically). +* `↑` — Ascending sorting by name (from `Z` to `A` alphabetically). + -.Сортування форм за назвою .Sorting forms by name image::registry-admin/admin-portal/ui-forms/sorting/form-sorting-1.png[] [#sorting-by-date] -//== Сортування форм за датою і часом створення або редагування == Sorting forms by creation or modification date and time -//Платформа дозволяє відсортувати наявні форми за датою і часом створення або редагування у Кабінеті адміністратора регламентів. Такий тип сортування надає можливість сформувати висхідний, або низхідний список форм для зручності та покращення користувацького досвіду. The platform allows sorting existing forms by creation or modification date and time in the Regulations administrator portal. This type of sorting enables creating an ascending or descending list of forms for convenience and improved user experience. -//. Увійдіть до розділу для управління UI-формами. . Navigate to the section for managing UI forms. + -.Розділ управління формами .Forms management section image::registry-admin/admin-portal/ui-forms/ui-forms-1.png[] -+ -//. У стовпці `Дата створення` оберіть опцію сортування за датою і часом створення форми: + . In the `Creation date` column, select the sorting option by creation date and time: -//* `↓` -- Низхідне сортування (найновіші зверху списку). -//* `↑` -- Висхідне сортування (найновіші знизу списку). -* `↓` -- Descending sorting (most recent on top of the list). -* `↑` -- Ascending sorting (most recent at the bottom of the list). + +* `↓` — Descending sorting (most recent on top of the list). +* `↑` — Ascending sorting (most recent at the bottom of the list). + -.Сортування форм за датою і часом редагування .Sorting forms by the date and time modified image::registry-admin/admin-portal/ui-forms/sorting/form-sorting-2.png[] -+ -//. У стовпці `Відредаговано` оберіть опцію сортування за датою і часом редагування форми: . In the `Modified` column, select the sorting option by modification date and time of the form: -//* `↓` -- Низхідне сортування (найновіші зверху списку). -//* `↑` -- Висхідне сортування (найновіші знизу списку). -* `↓` -- Descending sorting (most recent on top of the list). -* `↑` -- Ascending sorting (most recent at the bottom of the list). + +* `↓` — Descending sorting (most recent on top of the list). +* `↑` — Ascending sorting (most recent at the bottom of the list). + -//.Сортування форм за датою і часом створення .Sorting forms by creation date and time image::registry-admin/admin-portal/ui-forms/sorting/form-sorting-3.png[] [NOTE] ==== -//Після редагування форми, змінюється дата і час редагування, а форма підіймається уверх списку, якщо обрано низхідне сортування. After editing a form, the modification date and time change, and the form moves up the list if descending sorting is chosen. -//UI-форми можливо редагувати лише в рамках версії-кандидата на внесення змін. Для того, щоб зміни із версії-кандидата потрапили до майстер-версії, необхідно їх xref:registry-develop:registry-admin/admin-portal/version-control/overview-new-change-request.adoc#push-changes-master[застосувати]. Після застосування змін до майстер-версії, усі гілки-кандидати автоматично отримають оновлення, включно з датами редагування форм. UI forms can only be edited within the change candidate version. To apply the changes from the candidate version to the master version, they need to be applied. After applying the changes to the master version, all candidate branches will automatically receive updates, including the form's modification dates. -//Такий підхід дозволяє розробникам регламенту працювати у різних гілках-кандидатах на внесення змін та досліджувати історичність форм. -This approach allows regulations developers to work in different change candidate branches and explore the history of forms. +This approach allows developers to work in different change candidate branches and explore the history of forms. ==== [#pagination] == Pagination -//Ви можете переходити між сторінками та змінювати кількість рядків, що відображаються на одній сторінці. Для цього прокрутіть бігунок униз сторінки. You can switch between pages and adjust the number of rows displayed on a page. For this, scroll down to the bottom of the page. -//* Для переходу між сторінками використовуйте позначки `>` (вперед) або `<` (назад). * To switch between pages, use the `>` (next) or `<` (previous) icons. -//* Тут ви також можете обрати кількість рядків на сторінці (10 за замовчанням). + * Here you can also change the number of rows displayed on a page (10 by default). image::registry-admin/admin-portal/ui-forms/sorting/form-sorting-4.png[] \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/ui-forms-overview.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/ui-forms-overview.adoc index ab62e6ad3d..f21eb0e6c1 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/ui-forms-overview.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/ui-forms-overview.adoc @@ -1,5 +1,6 @@ -:sectlinks: = Managing UI forms +:sectlinks: +:sectanchors: include::platform:ROOT:partial$admonitions/language-en.adoc[] diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/overview.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/overview.adoc index 99bf62b0a5..f3ef725b4e 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/overview.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/overview.adoc @@ -1,4 +1,8 @@ = Моделювання регламенту реєстру +:sectanchors: +:sectlinks: + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] Розділ *_Моделювання регламенту реєстру_* надає основні інструменти та методи для ефективної розробки та управління реєстром. Він починається зі встановлення _глобальних параметрів_ і переходить до розробки _моделей бізнес-процесів_. Далі розділ заглиблюється у дизайн _форм користувацького інтерфейсу_, сприяючи взаємодії з даними. Невіддільною частиною цього процесу є _таблиці_ — основні структури, де зберігаються дані реєстру. Для тих, хто прагне до точності, моделювання структури через _редактор XML-коду_ пропонує просунутий підхід. Також цей розділ охоплює управління _шаблонами аналітичної звітності_. diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/edit-groovy-scripts.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/edit-groovy-scripts.adoc index 5184988597..6d4fe82377 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/edit-groovy-scripts.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/edit-groovy-scripts.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Редагування скриптів бізнес-процесів у візуальному редакторі коду +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/process-components-overview.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/process-components-overview.adoc index a19d5393fb..58b3596ad2 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/process-components-overview.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/components/process-components-overview.adoc @@ -1,4 +1,6 @@ = Перегляд та редагування складових бізнес-процесу +:sectanchors: +:sectlinks: Адміністратор регламенту може працювати зі складовими бізнес-процесів на відповідних вкладках [.underline]#Загальна#, [.underline]#Код# та [.underline]#Конструктор#. diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/copy-process.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/copy-process.adoc index df8d17e36a..58cc035322 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/copy-process.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/copy-process.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Копіювання бізнес-процесів +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] Використовуйте функціональність копіювання бізнес-процесів. Це дозволяє полегшити та пришвидшити створення схем процесів. Не потрібно моделювати процеси з нуля -- просто оберіть подібну діаграму, змодельовану раніше та скопіюйте її. diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc index 4097ad3ce2..e17239ea15 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Створення бізнес-процесів +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] Кабінет адміністратора регламентів дозволяє легко та просто моделювати бізнес-процеси за допомогою вбудованого вебредактора https://bpmn.io/[BPMN.io] у вашому браузері. Функціональність надає можливості _перегляду, створення та редагування_ діаграм у нотації *BPMN 2.0* на базі XML. @@ -52,10 +36,12 @@ image:registry-develop:registry-admin/admin-portal/process-models/process-models Повинна бути унікальною у межах екземпляра реєстру. Довжина 3--50 символів. + Допустимі символи: "А-Z", "a-z", "0-9", "-", "_". При цьому цифри, "-" не можуть бути на початку, або в кінці службової назви. ==== - + image:registry-develop:registry-admin/admin-portal/process-models/process-models-3.png[] ++ +NOTE: Усі зміни на вкладках xref:registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc#tab-general[Загальна], xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-code.adoc[Код] та xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-bpmn-editor.adoc[Конструктор] синхронізуються. Тобто, якщо ви зміните елемент у конструкторі, це відобразиться й у коді, й навпаки. + . Перейдіть на вкладку [.underline]#Конструктор# та змоделюйте бізнес-процес у вебредакторі. + TIP: Можливості вкладки [.underline]#Конструктор# більш детально описані на сторінці xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-bpmn-editor.adoc[]. diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/delete-process.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/delete-process.adoc index 6bf1b92865..e778ffa90e 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/delete-process.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/delete-process.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Видалення бізнес-процесів +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] Видаляйте непотрібні та застарілі бізнес-процеси -- тримайте регламент в актуальному стані. diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc index a2ae857f8f..93ef4d2cd0 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Редагування бізнес-процесів +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] Кабінет адміністратора регламентів дозволяє редагувати, змінювати та розвивати наявні бізнес-процеси. Якщо моделювальник припустився помилки у назві, або хоче змінити елемент діаграми процесів, чи підправити XML-код, то він може перейти до _режиму редагування_ та внести необхідні зміни. diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-groups.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-groups.adoc index 70963ec21a..fbfae08c81 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-groups.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-groups.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Категоризація доступних послуг у кабінетах користувачів +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Проблематика diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-models-overview.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-models-overview.adoc index b571275791..03d227bee4 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-models-overview.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/process-models-overview.adoc @@ -1,5 +1,6 @@ = Управління моделями бізнес-процесів реєстру -include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] +:sectlinks: +:sectanchors: include::platform:ROOT:partial$admonitions/language-ua.adoc[] @@ -7,22 +8,21 @@ include::platform:ROOT:partial$admonitions/language-ua.adoc[] image:registry-develop:registry-admin/admin-portal/process-models/process-models-1.png[] -Функціональність дозволяє: +Функціональність дозволяє: :: -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc[Створювати процеси] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc[Редагувати процеси] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/search-process.adoc[Шукати процеси за назвою] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/copy-process.adoc[Копіювати процеси] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/upload-process.adoc[Завантажувати (upload) процеси] -//TODO: TBD in future: Експортувати (download) процеси -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/sorting-process.adoc[Сортувати процеси] -* [*] xref:registry-develop:registry-admin/admin-portal/registry-modeling/process-models/process-groups.adoc[Категоризувати послуги] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/delete-process.adoc[Видаляти процеси] -* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/components/process-components-overview.adoc[Переглядати та редагувати складові процесів], зокрема: +* Створювати процеси +* Редагувати процеси +* Шукати процеси за назвою +* Копіювати процеси +* Завантажувати (upload) процеси +* Сортувати процеси +* Категоризувати процеси +* Видаляти процеси +* Переглядати та редагувати складові процесів, зокрема: -** xref:registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc#tab-general[керувати назвами процесу]; -** xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-code.adoc[переглядати та редагувати код XML-представлення процесів]; -** xref:registry-admin/admin-portal/registry-modeling/process-models/components/tab-bpmn-editor.adoc[моделювати процеси у BPMN-конструкторі]. +** керувати назвами процесу; +** переглядати та редагувати код XML-представлення процесів; +** моделювати процеси у BPMN-редакторі. [CAUTION] ==== @@ -49,6 +49,18 @@ image:registry-develop:registry-admin/admin-portal/process-models/process-models * Врахуйте, що видалення або зміна об'єкта може призвести до втрати даних та порушення бізнес-процесів. ==== +== Огляд секції + +* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/create-process.adoc[Створення процесів] +* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/edit-process.adoc[Редагування процесів] +* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/search-process.adoc[Пошук процесів] +* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/copy-process.adoc[Копіювання процесів] +* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/upload-process.adoc[Завантаження (upload) процесів] +* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/sorting-process.adoc[Сортування процесів] +* [*] xref:registry-develop:registry-admin/admin-portal/registry-modeling/process-models/process-groups.adoc[Категоризація процесів] +* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/delete-process.adoc[Видалення процесів] +* [*] xref:registry-admin/admin-portal/registry-modeling/process-models/components/process-components-overview.adoc[Перегляд та редагування складових процесу] + diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/search-process.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/search-process.adoc index 64b36346ff..de238daae9 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/search-process.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/search-process.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Пошук процесів за назвою +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] Використовуйте функціональність пошуку бізнес-процесів за назвою. Це дозволяє полегшити та пришвидшити роботу зі схемами процесів. diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/sorting-process.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/sorting-process.adoc index b0c24fec7b..aee870ed34 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/sorting-process.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/sorting-process.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Сортування бізнес-процесів +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] Використовуйте функціональність сортування бізнес-процесів. Це дозволяє упорядкувати доступні моделі процесів у висхідному `↑` та низхідному `↓` порядку, покращити користувацький досвід та досліджувати історичність створення та модифікації процесів. diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/upload-process.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/upload-process.adoc index ad61455580..a00c6b3910 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/upload-process.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/process-models/upload-process.adoc @@ -1,22 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: - = Завантаження (upload) бізнес-процесів +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] Завантажити бізнес-процес до регламенту можна через копіювання та вставлення XML-схеми готового процесу на вкладці [.underline]#Код#. Пряма опція `Drag & Drop` (перетягування файлу зі схемою) недоступна. diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/registry-global-settings.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/registry-global-settings.adoc index db1927b49f..68b0ec0866 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/registry-global-settings.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/registry-global-settings.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Управління глобальними налаштуваннями реєстру +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] Платформа надає можливість керувати глобальними налаштуваннями реєстру в інтерфейсі порталу адміністратора регламенту. diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-data-structures.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-data-structures.adoc index 90db78d287..0443a7da78 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-data-structures.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-data-structures.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Таблиці моделі даних реєстру та їх структури +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] Розробка регламенту передбачає розробку моделі даних реєстру. Кабінет адміністратора регламентів дозволяє працювати із таблицями бази даних реєстру у режимі перегляду (read-only). diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-overview.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-overview.adoc index 7338abcff3..351ab4553a 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-overview.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/tables-overview.adoc @@ -1,4 +1,8 @@ = Таблиці +:sectlinks: +:sectanchors: + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Огляд секції diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/xml-editor.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/xml-editor.adoc index ff62a74238..c8a3df6933 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/xml-editor.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/tables/xml-editor.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Моделювання структури таблиць БД реєстру в XML-редакторі коду +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальні положення diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/copy-forms.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/copy-forms.adoc index aa6a524b44..532faf5176 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/copy-forms.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/copy-forms.adoc @@ -5,7 +5,6 @@ include::platform:ROOT:partial$admonitions/language-ua.adoc[] Розробники регламенту мають можливість створювати дублікати UI-форм, що передбачає відтворення усіх їх складових, включаючи JSON-код і компоненти моделювання. Кожна копія отримує префікс `COPY_` у своїй назві. Ця функція особливо корисна, коли потрібно розробити ряд схожих форм або використовувати наявну форму як шаблон. - Копіюйте UI-форму наступним чином: . Оберіть розділ "UI-форми" у меню зліва. diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/json-code-view-edit.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/json-code-view-edit.adoc index 6245d08ce7..fad398968f 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/json-code-view-edit.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/json-code-view-edit.adoc @@ -1,23 +1,7 @@ -:toc-title: ЗМІСТ -:toc: auto -:toclevels: 5 -:experimental: -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - = Перегляд та редагування коду JSON-представлення форми +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] Платформа надає можливість переглядати та редагувати JSON-представлення форми на вкладці [.underline]#Код#. diff --git a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/ui-forms-overview.adoc b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/ui-forms-overview.adoc index 9a606d768a..e8ac1ce3b9 100644 --- a/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/ui-forms-overview.adoc +++ b/docs/ua/modules/registry-develop/pages/registry-admin/admin-portal/registry-modeling/ui-forms/ui-forms-overview.adoc @@ -1,6 +1,6 @@ += Управління схемами UI-форм реєстру :sectanchors: :sectlinks: -= Управління схемами UI-форм реєстру include::platform:ROOT:partial$admonitions/language-ua.adoc[]