Skip to content

Commit

Permalink
[EDP-DDM-28658] github: updated docs, set content attributes, added m…
Browse files Browse the repository at this point in the history
…inor fixes and missing images, aligned ua-en versions, removed old comments

Change-Id: Ie28b881d8cde5d9cfebaad2308fa670652e2eb7e
(cherry picked from commit c21eab29a002e6ff181ee2d9c34244c82cb852ea)
  • Loading branch information
[email protected] committed Oct 12, 2023
1 parent c289b90 commit f94c78e
Show file tree
Hide file tree
Showing 52 changed files with 369 additions and 1,186 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -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[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,43 +1,28 @@
: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`*.
====

image:registry-develop:registry-admin/admin-portal/process-models/process-models-16.png[]

[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[]
Expand Down
Original file line number Diff line number Diff line change
@@ -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:

//* &#9989; `Бізнес-процес "<Назва процесу>" успішно створено`
* &#9989; `Business process` `<Process name>` `successfully created`.
* &#9989; `Business process` `<process-name>` `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]_).
====
Loading

0 comments on commit f94c78e

Please sign in to comment.