diff --git a/docs/en/modules/ROOT/partials/admonitions/ua-specific.adoc b/docs/en/modules/ROOT/partials/admonitions/ua-specific.adoc index 4ce7baeae6..26d5bd7b53 100644 --- a/docs/en/modules/ROOT/partials/admonitions/ua-specific.adoc +++ b/docs/en/modules/ROOT/partials/admonitions/ua-specific.adoc @@ -1,3 +1,3 @@ [NOTE,caption=UA-specific] This functionality is specific to the Ukrainian implementation and may not apply or function as described in other contexts or regions. -Please consult the local guidelines or documentation if you are implementing this outside of Ukraine. \ No newline at end of file +Please consult the local guidelines or documentation if you are implementing this outside Ukraine. \ No newline at end of file diff --git a/docs/en/modules/registry-develop/images/bp-modeling/bp/element-temp/bp-element-temp-01.png b/docs/en/modules/registry-develop/images/bp-modeling/bp/element-temp/bp-element-temp-01.png new file mode 100644 index 0000000000..d8bd3f54cd Binary files /dev/null and b/docs/en/modules/registry-develop/images/bp-modeling/bp/element-temp/bp-element-temp-01.png differ diff --git a/docs/en/modules/registry-develop/images/bp-modeling/bp/element-temp/bp-element-temp-05.jpg b/docs/en/modules/registry-develop/images/bp-modeling/bp/element-temp/bp-element-temp-05.jpg new file mode 100644 index 0000000000..1292f98a8a Binary files /dev/null and b/docs/en/modules/registry-develop/images/bp-modeling/bp/element-temp/bp-element-temp-05.jpg differ diff --git a/docs/en/modules/registry-develop/images/bp-modeling/bp/element-temp/element-temp-install-bpmnlint.png b/docs/en/modules/registry-develop/images/bp-modeling/bp/element-temp/element-temp-install-bpmnlint.png new file mode 100644 index 0000000000..3e5ebae084 Binary files /dev/null and b/docs/en/modules/registry-develop/images/bp-modeling/bp/element-temp/element-temp-install-bpmnlint.png differ diff --git a/docs/en/modules/registry-develop/images/bp-modeling/bp/element-temp/element-temp-turn-on-bpmnlint.png b/docs/en/modules/registry-develop/images/bp-modeling/bp/element-temp/element-temp-turn-on-bpmnlint.png new file mode 100644 index 0000000000..8ff2fda9fd Binary files /dev/null and b/docs/en/modules/registry-develop/images/bp-modeling/bp/element-temp/element-temp-turn-on-bpmnlint.png differ diff --git a/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-install.adoc b/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-install.adoc new file mode 100644 index 0000000000..23710d4fce --- /dev/null +++ b/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-install.adoc @@ -0,0 +1,149 @@ += Installing extensions to business processes (_for local development_) +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] + +Standard extension connectors -- **Element Templates** have been developed to simplify business process modeling. + +IMPORTANT: If you use the functionality of the xref:registry-admin/admin-portal/overview.adoc[Administrative portal] to develop the registry, you don't need to install business process extensions, additional external applications, or plugins. The portal has everything necessary built in out of the box. The instructions below in this document are intended _ONLY_ for local development. + +[#preconditions] +== Preconditions + +=== Installing Camunda Modeler + +. Download the archive with the **Camunda Modeler** application via this link:https://downloads.camunda.cloud/release/camunda-modeler/4.8.0/[link]. ++ +[NOTE] +==== +It is recommended to use version 4.8.0 for stable system operation. +==== +. Select the **Open Source Modeler** product and download the version compatible with your operating system, e.g., *Windows 64bit*. +. After downloading the application archive, unpack it on your local machine. ++ +[TIP] +==== +The folder with the application might, for example, be named: + +*`camunda-modeler-4.8.1-win-x64`* +==== + +=== Installing the BPMN Linter plugin + +Install the **BPMN Linter** plugin to extend Camunda functionality and validate your BPMN diagrams. + +. Go to the official repository at https://github.com/camunda/camunda-modeler-linter-plugin[link]. + +. Click the *`Code`* > *`Download ZIP`* button and download the archive. ++ +image:bp-modeling/bp/element-temp/element-temp-install-bpmnlint.png[] + +. After downloading, unpack the archive content to the _camunda-modeler-4.8.1-win-x64\resources\plugins_ application folder of Camunda. + +. Restart the Camunda Modeler application. +. Enable the plugin by pressing *Plugins* > *BPMN Linter* > *Toggle Linting*. ++ +Alternatively, use the kbd:[Ctrl+L] keyboard shortcut. ++ +image:bp-modeling/bp/element-temp/element-temp-turn-on-bpmnlint.png[] ++ +TIP: The plugin can be turned on and off using `Ctrl+L`. + +[#element-temp-install] +== Installing the catalog of business process extensions + +[#element-temp-install-windows] +=== Installing the catalog of extensions for Windows OS + +Follow the instructions below to install the Element Templates catalog. + +. Download the business process extensions catalog analogously to the point xref:#element-temp-install-windows[]. +. Open the terminal. +. Navigate to the local directory where Camunda Modeler resources are located using the command: ++ +[source, bash] +---- +cd ~/Library/Application\ Support/camunda-modeler/resources +---- + +. Create a new directory under the extensions category `element templates` if it doesn't exist using the command: ++ +[source, bash] +---- +mkdir element-templates +---- + +. Copy all JSON extension files from the `business-process-modeler-extensions` directory to the created directory using the command: ++ +[source,bash] +---- +cp business-process-modeler-extensions/*.json ~/Library/Application\ Support/camunda-modeler/resources/element-templates +---- + +. The final directory structure should look like this: ++ +---- +~/Library/Application\ Support/camunda-modeler/resources/element-templates/ +---- ++ +image:registry-develop:bp-modeling/bp/element-temp/bp-element-temp-05.jpg[] + +. Restart the Camunda Modeler application. +. Check the availability of extensions in the catalog while modeling a business process: + +.. Create a task—select *Create Task*. +.. Click on the key icon—choose *Change Type*. +.. Specify the task type: *Service Task*, *User Task* or *Call Activity*. +.. Press the *`Open Catalog`* button. + +As a result, the *Element Templates* extension catalog will open, which can be applied during modeling. + ++ +image:registry-develop:bp-modeling/bp/element-temp/bp-element-temp-01.png[] + +[#element-temp-install-macos] +=== Installing the catalog of extensions for macOS + +Follow the instructions below to install the Element Templates catalog. + +. Download the catalog of extensions to business processes analogously to point xref:#element-temp-install-windows[]. +. Open the terminal. +. Navigate to the local directory where the Camunda Modeler resources are stored using the command: ++ +[source, bash] +---- +cd ~/Library/Application\ Support/camunda-modeler/resources +---- + +. Create a new directory for the `element templates` extensions category if it doesn't exist already using the command: ++ +[source, bash] +---- +mkdir element-templates +---- + +. Copy all the JSON extension files from the `business-process-modeler-extensions` directory to the newly created directory using the command: ++ +[source,bash] +---- +cp business-process-modeler-extensions/*.json ~/Library/Application\ Support/camunda-modeler/resources/element-templates +---- + +. The end directory structure should look something like this: ++ +---- +~/Library/Application\ Support/camunda-modeler/resources/element-templates/ +---- ++ +image:registry-develop:bp-modeling/bp/element-temp/bp-element-temp-05.jpg[] + +. Restart the Camunda Modeler application. +. Check the availability of extensions in the catalog during business process modeling: + +.. Create a task—select *Create Task*. +.. Click on the key icon - choose *Change Type*. +.. Specify the type of the task: *Service Task*, *User Task* or *Call Activity*. +.. Click on the *`Open Catalog`* button. + +This action will open the *Element Templates* extension catalog, which can be applied during modeling. + ++ +image:registry-develop:bp-modeling/bp/element-temp/bp-element-temp-01.png[] \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-overview.adoc b/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-overview.adoc index 73a54afd38..8dd6846787 100644 --- a/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-overview.adoc +++ b/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-overview.adoc @@ -1,26 +1,26 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: += Business process extensions (Element templates) :sectlinks: -:partnums: +:sectanchors: -= Business process extensions (Element templates) +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//CAUTION: Розділ у процесі модернізації. CAUTION: This section is being refactored. -//Для спрощення моделювання бізнес-процесів розроблені типові інтеграційні розширення-конектори -- **Element Templates**. Вони є ланкою взаємодії між рівнем виконання бізнес-процесів та API фабрики даних. Standard integration connectors/extensions, or *Element Templates*, are meant to simplify business process modeling. They serve as a link between the business processes execution layer and the data factory API. - -[overview] == Section overview -* [*] xref:registry-develop:bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc[User task templates] -* [*] xref:bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc[Service task templates] -* [*] xref:bp-modeling/bp/element-templates/call-activities/call-activities-overview.adoc[Call activity templates] -* [*] xref:bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc[Standard extensions for integrating with other registries on the Platform] \ No newline at end of file +[%collapsible] +._Installing business process extensions_ +==== +* [*] xref:registry-develop:bp-modeling/bp/element-templates/element-templates-install.adoc[] +==== + +[%collapsible] +._Business process extensions catalog_ +==== +* [*] xref:registry-develop:bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc[Типові розширення для користувацьких задач (User task templates)] +* [*] xref:bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc[Типові розширення для сервісних задач (Service task templates)] +* [*] xref:bp-modeling/bp/element-templates/call-activities/call-activities-overview.adoc[] +* [*] xref:bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc[Типові розширення для інтеграції з іншими реєстрами на Платформі] +==== \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc b/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc index 873cff3aaf..aa9b7501cc 100644 --- a/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc +++ b/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc @@ -1,36 +1,28 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 += Integrating extensions :sectanchors: :sectlinks: -:partnums: -= Integrating extensions +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//В рамках REST-взаємодії з іншими реєстрами на Платформі та бізнес-процесами, що змодельовані всередині регламентів таких реєстрів, імплементовано додаткові розширення-конектори (делегати) для передачі або отримання даних до/з цих реєстрів. Additional extensions, or delegates, are implemented to transfer and receive data as part of the REST interaction between the different registries on the Platform and the business process modeled within their regulations. -//На сьогодні Платформа підтримує 2 таких делегати: :: The Platform supports the following delegates: :: -//* xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/start-bp-another-registry.adoc[Start business process in another registry] -- делегат для ініціювання бізнес-процесу, що змодельований в рамках регламенту іншого реєстру на Платформі. -* xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/start-bp-another-registry.adoc[Start business process in another registry]: A delegate for initiating a business process modeled in the regulations of another registry on the Platform. -//* xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/search-for-entities-another-registry.adoc[Search for entities in another registry data factory] -- делегат для отримання даних сутностей (таблиць) у базі даних іншого реєстру, що розгорнутий на Платформі. -* xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/search-for-entities-another-registry.adoc[Search for entities in another registry data factory]: A delegate for obtaining data from entities (tables) in the database of another registry deployed on the Platform. +* *Start business process in another registry*: A delegate for initiating a business process modeled in the regulations of another registry on the Platform. +* *Search for entities in another registry data factory*: A delegate for obtaining data from entities (tables) in the database of another registry deployed on the Platform. [CAUTION] ==== -//Для того, щоб взаємодіяти з цільовим реєстром на Платформі, а також бізнес-процесами, що у ньому розгорнуті, недостатньо просто використовувати інтеграційні конектори. Using integration connectors is not enough to interact with a target registry on the Platform, as well as its business processes. -//Необхідно попередньо: :: You also need to: :: -//* Відкрити доступ до такого реєстру в адмін-консолі для керування реєстрами Control Plane (_детальну інструкцію ви можете переглянути на сторінці xref:admin:registry-management/control-plane-registry-grant-access.adoc[]_). * Grant access to the target registry using the Control Plane admin console. For details, see xref:admin:registry-management/control-plane-registry-grant-access.adoc[]. -//* Надати доступ до відповідних представлень та REST API реєстру на рівні моделі даних (_детальну інструкцію ви можете переглянути на сторінці xref:data-modeling/data/physical-model/rest-api-view-access-to-registry.adoc[]_). * Grant access to the relevant views and registry's REST API at the data model level. For details, see xref:data-modeling/data/physical-model/rest-api-view-access-to-registry.adoc[]. -==== \ No newline at end of file +==== + +== Section overview + +* xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/start-bp-another-registry.adoc[Start business process in another registry] + +* xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/search-for-entities-another-registry.adoc[Search for entities in another registry data factory] \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc b/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc index 6ee83592c5..586eced182 100644 --- a/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc +++ b/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc @@ -1 +1,42 @@ -= Service task extensions \ No newline at end of file += Service task extensions +:sectanchors: +:sectlinks: + +include::platform:ROOT:partial$admonitions/language-en.adoc[] + +== Section overview + +****** Managing users and roles +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/add-role-to-keycloak-user.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/save-user-roles.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/get-roles-from-keycloak.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/keycloak-get-officer-users-by-attributes-equals-start-with.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/remove-role-from-keycloak-user.adoc[] +****** Managing user settings +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/read-user-settings.adoc[] +****** Creating entities +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/create-entity.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/create-nested-entities.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/batch-creation-entities.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/batch-creation-entities-v2.adoc[] +****** Reading and searching entities +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/read-entity.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/batch-read-entities-from-data-factory.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/search-entities-in-data-factory.adoc[] +****** Updating entities +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/update-entity-in-data-factory.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/update-entity-in-data-factory-partially.adoc[] +****** Deleting entities +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/delete-entity.adoc[] +****** Modeling digital signatures +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/digital-signature-by-dso-service.adoc[] +****** Integrating with external systems +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/connect-to-external-system-v2.adoc[] +****** Modeling business process errors +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/throw-system-error.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/throw-validation-error.adoc[] +****** Modeling statuses +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/define-bp-status.adoc[] + + + diff --git a/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc b/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc index b6ac8fd88c..cc65e6290c 100644 --- a/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc +++ b/docs/en/modules/registry-develop/pages/bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc @@ -1,4 +1,7 @@ = User task extensions +:sectanchors: +:sectlinks: + include::platform:ROOT:partial$admonitions/language-en.adoc[] == Section overview @@ -7,29 +10,3 @@ include::platform:ROOT:partial$admonitions/language-en.adoc[] * xref:bp-modeling/bp/element-templates/user-task-templates/officer-sign-task.adoc[] * xref:bp-modeling/bp/element-templates/user-task-templates/user-form.adoc[] - - -//// -[#business-process-modeler-extensions-configuration] -== Налаштування типових розширень до бізнес-процесів - -Цей розділ описує налаштування типових розширень для бізнес-процесів -- **Element Templates**. - -Типи задач для застосування розширень :: - -Типові розширення **Element Templates** можуть бути застосовані до різних типів задач, наприклад: - -* xref:#element-temp-user-task[] -* xref:#element-temp-service-task[] -* xref:#element-temp-call-activity[] -* xref:#element-temp-send-task[] -* xref:#extensions-integrate-bp-another-registries[] - -[CAUTION] -==== -Налаштування типових розширень-конекторів відбувається у застосунку *Camunda Modeler*. - -Перед початком роботи переконайтеся, що виконано всі передумови, описані у розділі xref:business-process-modeler-extensions-installation[Встановлення каталогу типових розширень до бізнес-процесів]. -==== -//// - diff --git a/docs/en/modules/registry-develop/pages/bp-modeling/bp/rest-connector.adoc b/docs/en/modules/registry-develop/pages/bp-modeling/bp/rest-connector.adoc index 83563fdcba..837ee69888 100644 --- a/docs/en/modules/registry-develop/pages/bp-modeling/bp/rest-connector.adoc +++ b/docs/en/modules/registry-develop/pages/bp-modeling/bp/rest-connector.adoc @@ -1,195 +1,106 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Інтеграція із зовнішніми сервісами за допомогою REST-конектора = Integration with external services using the REST connector +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] -//`REST Connector` -- це конектор для підключення до зовнішніх захищених сервісів/систем поза кластером Платформи. You can use the `REST connector` to connect to secured services or systems outside the Platform cluster. -//Для налаштування конектора необхідно виконати наступні кроки. This guide describes the steps required to set up the connector. [#create-service-entry] -//== Створення ServiceEntry == Creating a Service Entry -//Для того, щоб запит на отримання зовнішніх ресурсів міг вийти за межі кластера Платформи, необхідно на рівні реєстру створити *`Service Entry`* -- точку виходу трафіку за межі системи. Before a request for an external resource can go beyond the Platform cluster, you need to create a *Service Entry* at the registry level to serve as an entry point for the outbound traffic. [NOTE] ==== -//Service Entry створюється автоматично, після того, як адміністратор реєстру налаштує інтеграцію в адміністративній панелі Control Plane. Після застосування змін до конфігурації реєстру та проходження Jenkins-пайплайну `*MASTER-Build-*`, підключення до зовнішньої системи буде налаштовано. + A Service Entry is created automatically after the registry administrator configures the integration in the Control Plane admin console. Once the changes are applied to the registry configuration and the *MASTER-Build-``* Jenkins pipeline runs, the connection to the external system is set up. -//За деталями налаштувань у консолі Control Plane зверніться до сторінки xref:registry-develop:registry-admin/external-integration/cp-integrate-ext-system.adoc[]. For details on Control Plane settings, see xref:registry-develop:registry-admin/external-integration/cp-integrate-ext-system.adoc[]. ==== [WARNING] ==== -//Для версій реєстру 1.9.2 та нижче Service Entry створюється автоматично, після запуску пайплайну публікацій та розгортання змін до регламенту реєстру. + For registry versions 1.9.2 or earlier, a Service Entry is created automatically after the publication pipeline is launched and changes to the registry regulations are deployed. ==== -//Перевірити, що Service Entry створено, можна у списку `*ServiceEntries*` в OpenShift-консолі. Для цього: You can check whether the Service Entry was created using the `*ServiceEntries*` list in the OpenShift console. -//. Увійдіть до OpenShift консолі. . Sign in to the OpenShift web console. -+ -//. Перейдіть до меню `Home` → `API Explorer`. У рядку пошуку `Filter by kind` введіть значення `ServiceEntry`, в результатах фільтрування виберіть відповідний сервіс. + . Go to *Home* > *API Explorer*. . In the *Filter by kind* search field, search for `ServiceEntry` and select the corresponding service. + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-1.png[] + -//. Виберіть реєстр з випадного списку `Project`, в якому буде використовуватись зовнішній сервіс. Перейдіть до меню `Instances` і знайдіть необхідну `ServiceEntry`. + . From the *Project* dropdown list, select the registry that will use the external service. . Open the *Instances* tab and find the required `ServiceEntry`. + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-2-1.png[] -// The following text was commented out in the original doc -//// - -Starting from 1.8.2 release, the ServiceEntry is created automatically - -How to create ServiceEntry manually? ONLY for versions up to 1.8.1 - -. Авторизуйтесь до OpenShift консолі. - -. Перейдіть до меню `Home` → `API Explorer`. У рядку пошуку `Filter by kind` введіть значення `ServiceEntry`, в результатах фільтрування виберіть відповідний сервіс. -+ -image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-1.png[] - -. Виберіть проєкт з випадного списку `Project`, в якому буде використовуватись зовнішній сервіс. Перейдіть до меню `Instances` і натисніть `Create ServiceEntry`. -+ -image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-2.png[] - -. Далі необхідно вказати налаштування для YAML файлу. -+ -image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-3.png[] -+ -* для параметра `name` потрібно вказати назву сервісу, наприклад, `httpbin-org`; -* для параметра `spec` необхідно зазначити наступне: -+ -[source, yaml] ----- -spec: - exportTo: - - . - hosts: - - httpbin.org - location: MESH_EXTERNAL - ports: - - name: https - number: 443 - protocol: HTTPS - - name: http - number: 80 - protocol: HTTP - resolution: DNS ----- -+ -** у параметрі `hosts` зазначається адреса сервісу, що буде використовуватися; -** у параметрі `ports` вказуються налаштування виклику для `https` чи `http`, або для обох варіантів одночасно. - -. Після налаштування натисніть `Create`. -+ -image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-4.png[] - -. У результаті успішного виконання налаштувань буде створено сервіс, через який буде дозволено пропускати трафік із кластера. -+ -image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-5.png[] -//// - [#create-secret] -//== Створення секрету для авторизації сервісу == Creating a secret for service authorization [WARNING] ==== -//Для версій реєстру 1.9.3 і вище не потрібно створювати секрети вручну в Openshift. + For registry versions 1.9.3 or later, there is no need to create secrets manually in Openshift. -//Секрети (токен, пароль тощо) створюються автоматично після застосування налаштувань взаємодії з іншими системами, які необхідно виконати в адмін-панелі Control Plane. The secrets (such as a token or password) are created automatically after the external system interaction settings are applied via the Control Plane admin console. -//В результаті застосування змін до конфігурації реєстру та проходження Jenkins-пайплайну `*MASTER-Build-*`, разом із Service Entry створюється й секрет для авторизації у зовнішньому сервісі. Він додається до *user-management:hashicorp-vault* для тієї системи/сервісу, до якої необхідно виконувати запити. Once the changes are applied to the registry configuration and the *MASTER-Build-``* Jenkins pipeline runs, a secret for external service authorization is created along with the Service Entry. The secret is added to the *user-management:hashicorp-vault* for the system or service to which requests will be made. -//Зверніться до сторінки xref:registry-admin/external-integration/cp-integrate-ext-system.adoc[] для отримання детальної інформації щодо налаштування взаємодії з іншими системами. For details on configuring interactions with external systems, see xref:registry-admin/external-integration/cp-integrate-ext-system.adoc[]. ==== -//Щоб створити секрет вручну, необхідно виконати наступні кроки: To create the secret manually, perform these steps: -//. В OpenShift консолі перейдіть до меню `Workloads` → `Secrets` та оберіть відповідний проєкт з випадного списку `Project`. Натисніть `Create` → `Key/value secret`. . Sign in to the OpenShift web console. . Go to *Workloads* > *Secrets* and select your project from the *Project* dropdown list. . Select *`Create`* > *Key/value secret*. + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-6.png[] -+ -//. Вкажіть назву секрету у полі `Secret name`, наприклад, `httpbin-basic-authentication`. + . Enter the name of the secret into the *Secret name* field. For example: `httpbin-basic-authentication`. + -//NOTE: Назву секрету необхідно буде використати у параметрі `*secret-name*` при налаштуванні регламенту (_див. детальніше у розділі xref:#regulations-configuration[]_). NOTE: You will need the name of the secret for the `*secret-name*` parameter when configuring the regulations. For details, jump to xref:#regulations-configuration[]. + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-7.png[] -+ -//. Доступно два типи аутентифікації сервісу: + . Specify the type of service authentication to use: -//* Для типу аутентифікації `BASIC` необхідно додати два параметри `Key`: + * For `BASIC` authentication, add two *Key* parameters: ** `username` ** `password` + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-8.png[] -+ -//* Для типу аутентифікації `PARTNER_TOKEN` необхідно додати один параметр `Key`: + * For `PARTNER_TOKEN` authentication, add one *Key* parameter: ** `token` + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-9.png[] -+ -//. У результаті успішного виконання налаштувань буде створено секрет, за допомогою якого можливо авторизуватися в зовнішньому сервісі. + . Once the settings are applied successfully, the secret is created. You can use this secret for authorization in the external service. + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-10.png[] [#regulations-configuration] -//== Налаштування регламенту == Configuring the regulations [WARNING] ==== -//Для версій реєстру 1.9.3+ та вище основні інтеграційні налаштування виконуються на рівні екземпляра реєстру в адміністративній панелі Control Plane (_див. детальніше -- xref:registry-admin/external-integration/cp-integrate-ext-system.adoc[]_). For registry versions 1.9.3 or later, the main integration settings are performed at the registry instance level in the Control Plane admin console. For details, see xref:registry-admin/external-integration/cp-integrate-ext-system.adoc[]. -//На рівні налаштувань регламенту адміністратор конфігурує лише: :: -At the regulations level, the administrator configures only the following: :: +At the registry regulations level, the administrator configures only the following: :: -//* назву системи; * system name -//* дозволені операції: * allowed operations: -//** ендпоінт/шлях до ресурсу; ** endpoint and resource path -//** метод. ** method -//.Налаштування external-systems у файлі bp-trembita/configuration.yml для версій реєстру 1.9.3+ .external-systems config in the bp-trembita/configuration.yml file for registries version 1.9.3 or later ===== [source, yaml] @@ -213,13 +124,10 @@ external-systems: ===== ==== -//Для версії реєстру 1.9.2 та нижче виконайте попередні конфігурації на рівні регламенту реєстру. For registries version 1.9.2 or earlier, perform the configuration at the registry regulations level. -//Для цього потрібно налаштувати параметри блоку `*external-systems*` у конфігураційному файлі *_bp-trembita/configuration.yml_* відповідного реєстру. To do this, you need to configure the `*external-systems*` block in the *_bp-trembita/configuration.yml_* file of a corresponding registry. -//.Приклад для типу аутентифікації `BASIC` .An example of `BASIC` authentication [example] [source, yaml] @@ -238,14 +146,6 @@ external-systems: [NOTE] ==== -//* після заголовка `external-systems` зазначається назва сервісу, що буде використовуватись, наприклад, `httpbin`; -//* для параметра `url` вказується адреса сервісу, наприклад, `http://httpbin.org/`; -//* в заголовку `methods` вказується назва методу взаємодії з сервісом, наприклад, `get`: -//** `path` шлях до сервісу, наприклад, `/get`; -//** `method` HTTP-метод взаємодії з сервісом, наприклад, `GET`. -//* для заголовка `auth` зазначаються параметри секрету: -//** `type` створений типу аутентифікації `BASIC` або `PARTNER_TOKEN`; -//** `secret-name` назву секрету, наприклад, `httpbin-basic-authentication`. * The `external-systems` header must be followed by the name of the external service, for example, `httpbin`. * The `url` parameter must contain the service address, for example, `http://httpbin.org/` * The `methods` header must contain the name of the method used to interact with the service, for example, `get`. @@ -256,8 +156,6 @@ external-systems: ** The `secret-name` is the name of the secret, for example, `httpbin-basic-authentication`. ==== -//.Приклад для типу аутентифікації `PARTNER_TOKEN` -//TODO: Example contains ua-specific diia mention, but maybe as a url example that's fine? .An example of `PARTNER_TOKEN` authentication [example] [source, yaml] @@ -277,84 +175,67 @@ external-systems: ---- [#bp-modeling] -//== Моделювання бізнес-процесу з використанням делегата Connect to external system == Modeling business processes using the "Connect to external system" delegate -//Для налаштування шаблону делегата в Camunda Modeler, необхідно виконати наступні кроки: To configure the delegate template in Camunda Modeler, perform these steps: -//. Створіть *Service Task*. . Open the business process modeling interface. . Create a *Service Task*. -+ -//. На панелі налаштувань справа натисніть кнопку kbd:[*Open Catalog*], оберіть відповідний шаблон *`Connect to external system v2`* зі списку та натисніть kbd:[*Apply*] для підтвердження. . In the settings panel on the right, click the *`Open Catalog`* button and select the *Connect to external system v2* delegate template from the list. Click *`Apply`* to confirm your action. + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-11.png[] -+ -//. Сконфігуруйте обраний шаблон: + . Configure the following options: -//* У полі `Name` вкажіть назву задачі, наприклад, `Створити запит (GET)`. * *Name*: Specify the task name. For example, `Create a GET request`. * *Input Parameters*: -//** Розгорніть блок `External system name` та вкажіть назву сервісу, з яким буде відбуватися взаємодія: + ** Expand the *External system name* section and specify the name of the target external system: -//*** Активуйте позначку `Local Variable Assignment` → `ON`. Це дозволить створити локальну змінну для метода. + *** Set the *Local Variable Assignment* toggle to *On*. This will allow creating a local variable for the method. -//*** У полі `Variable Assignment Type` оберіть з випадного списку тип призначення змінної — `String or Expression`. + *** From the *Variable Assignment Type* dropdown list, select *String or Expression*. -//*** У полі `Variable Assignment Value` введіть назву сервісу — `httpbin`. + *** In the *Variable Assignment Value* field, enter the name of the external system. For example, `httpbin`. + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-12.png[] -+ -//** Розгорніть блок `External system method name` та вкажіть HTTP-метод для взаємодії з сервісом: + ** Expand the *External system method name* section and specify the HTTP method for interacting with the external system: -//*** Активуйте позначку `Local Variable Assignment` → `ON`. Це дозволить створити локальну змінну для метода. + *** Set the *Local Variable Assignment* toggle to *On*. This will allow creating a local variable for the method. -//*** У полі `Variable Assignment Type` оберіть з випадного списку тип призначення змінної — `String or Expression`. + *** From the *Variable Assignment Type* dropdown list, select *String or Expression*. -//*** У полі `Variable Assignment Value` введіть назву методу — `get`. + *** In the *Variable Assignment Value* field, enter the name of the method. For example, `get`. + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-13.png[] -+ -//TODO: parametErs in ua version -//** Розгорніть блок `Request parametrs` (використовується для методу GET) та вкажіть необхідні параметри запиту: + ** When using the GET method, expand the *Request parameters* section and specify the required request parameters: -//*** Активуйте позначку `Local Variable Assignment` → `ON`. Це дозволить створити локальну змінну для метода. + *** Set the *Local Variable Assignment* toggle to *On*. This will allow creating a local variable for the method. -//*** У полі `Variable Assignment Type` оберіть з випадного списку тип призначення змінної — `Map`. *** From the *Variable Assignment Type* dropdown list, select *Map*. -//**** `Key` вкажіть ключ параметра запита. + **** *Key*: Specify the request parameter key. -//**** `Value` вкажіть значення параметра запита. **** *Value*: Specify the request parameter value. + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-14.png[] -+ -//** Розгорніть блок `Additional request headers` та вкажіть додаткові заголовки запиту: + ** Expand the *Additional request headers* section and specify additional request headers: -//*** Активуйте позначку `Local Variable Assignment` → `ON`. Це дозволить створити локальну змінну для метода. + *** Set the *Local Variable Assignment* toggle to *On*. This will allow creating a local variable for the method. -//*** У полі `Variable Assignment Type` оберіть з випадного списку тип призначення змінної — `Map`. *** From the *Variable Assignment Type* dropdown list, select *Map*. -//**** `Key` вкажіть ключ заголовка запита. **** *Key*: Specify the request header key. -//**** `Value` вкажіть значення заголовка запита. **** *Value*: Specify the request header value. + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-15.png[] -+ -//** Блок `Request payload` використовується для POST і PUT методів запиту. + ** The *Request payload* section is used for the POST and PUT request methods. * *Output Parameters*: -//** Розгорніть блок `Result variable` та вкажіть назву змінної процесу, до якої необхідно записати результат (за замовчуванням — `response`): + ** Expand the *Result variable* section and specify the process variable to put response to. The default value is `response`. -//** Активуйте позначку `Process Variable Assignment` → `ON`. + ** Set the *Process Variable Assignment* toggle to *On*. -//** У полі `Assign to Process Variable` введіть назву результівної змінної (за замовчуванням — `response`). + ** In the *Assign to Process Variable* field, enter the name of the result variable or leave the default `response` value. + image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-16.png[] \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/bp-modeling/external-integration/api-call/connectors-external-registry.adoc b/docs/en/modules/registry-develop/pages/bp-modeling/external-integration/api-call/connectors-external-registry.adoc index f8aacb625c..b40f398bf3 100644 --- a/docs/en/modules/registry-develop/pages/bp-modeling/external-integration/api-call/connectors-external-registry.adoc +++ b/docs/en/modules/registry-develop/pages/bp-modeling/external-integration/api-call/connectors-external-registry.adoc @@ -1,523 +1,65 @@ -:toc-title: On this page: -:toc: auto -:toclevels: 5 -:experimental: -:sectnums: -:sectnumlevels: 5 -:sectanchors: -:sectlinks: -:partnums: - -//= Типові інтеграційні SOAP-конектори до інших реєстрів -= SOAP-based integration connectors with other registries -//TODO: This topic omits a lot of ua-specific content and reframes it as more general "SOAP integration" without mentioning Trembita or connectors other than SOAP HTTP. += SOAP integration connectors with other registries +include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[] + +include::platform:ROOT:partial$admonitions/language-en.adoc[] == Overview -//Взаємодія з реєстрами, що знаходяться поза межами Платформи, можлива завдяки шлюзу безпечного обміну даними (ШБО) "Трембіта". -//TODO: Using the indefinite article here to not imply any specific SEG implementation =) -Integration with registries outside the Platform is possible through a secure exchange gateway (SEG). +SOAP integration with external registries primarily occurs via the "Trembita" Secure Exchange Gateway (SEG) and corresponding SOAP connectors. -//ШБО "Трембіта" є захищеним інтерфейсом для електронної взаємодії між державними системами, який розгортається в межах Платформи реєстрів як сервіс і дозволяє використовувати власні ресурси для отримання інформації із зовнішніх систем. -The goal of using SEG is to provide a secure interface for electronic interactions between various state systems. Once SEG is deployed within the Platform as a service, it enables receiving information from external systems using its own resources. +SOAP connectors :: +These are specialized connectors employed within business processes. They're designed to retrieve data from registries outside the Platform using the SOAP protocol, which uses XML format for data representation. -//Для виклику зовнішніх сервісів через ШБО "Трембіта", на Платформі реєстрів розроблено типові інтеграційні розширення-конектори, що дозволяють комунікувати через інтерфейс ШБО із зовнішніми сервісами за протоколом SOAP. -To call external services, you can use the Platform's standard integration connector that enables communication with external services via the SOAP protocol over the SEG interface. +Purpose of the "Trembita" SEG :: +SEG's primary function is to offer a secure interface for electronic interactions across various state systems. When integrated within the Platform, SEG harnesses its inherent resources to access data from external systems. -//Кожний конектор використовується у бізнес-процесах для отримання даних із реєстрів поза межами Платформи. -The SOAP connector is used in business processes to receive data from registries outside the Platform. +Platform's standard integration :: +For interacting with external services, the Platform boasts standard integration connectors. These are tailored for communication with external entities using the SOAP protocol, all transpiring over the SEG interface. -//WARNING: Наразі функціонування розроблених конекторів можливе лише з використанням серверів-заглушок, що імітують живе з'єднання. -WARNING: The SOAP connector can only be used with mock servers that simulate a live connection. +Region-specific application :: +It's crucial to note that using the "Trembita" SEG is particularly tuned for the Ukrainian setting. Hence, it and _may not apply or function as described in other contexts or regions_. -//// -//TODO: Commenting this CAUTION out because it links to a topic out of translation scope -[CAUTION] -==== -Щоб мати змогу використовувати розроблені на Платформі SOAP-інтеграційні конектори до зовнішніх сервісів та отримувати інформацію від інших реєстрів через ШБО "Трембіта", необхідно попередньо виконати конфігурації на рівні реєстру в адміністративній панелі Control Plane. +Universal SOAP HTTP connector :: +We've implemented a universal SOAP HTTP connector to augment the Platform's SOAP interoperability and amplify its integration potential. -_Детальніше про налаштування інтеграцій через ШБО "Трембіта" ви можете переглянути у статті xref:registry-develop:registry-admin/external-integration/cp-integrate-trembita.adoc[]_. -==== -//// +WARNING: Always use SOAP connectors in conjunction with mock servers that replicate the behavior of live connections for development purposes. -//== Встановлення типових розширень-конекторів == Installing standard integration connectors -//Налаштування розширень-конекторів відбувається у застосунку **Camunda Modeler**. Перед початком роботи переконайтеся, що виконано всі передумови, описані у розділі xref:bp-modeling/bp/element-templates/bp-element-templates-installation-configuration.adoc#business-process-modeler-extensions-installation[Встановлення каталогу типових розширень до бізнес-процесів]. -Connectors are configured in the *Camunda Modeler* application. Before you start, ensure all prerequisites described in the xref:bp-modeling/bp/element-templates/bp-element-templates-installation-configuration.adoc#business-process-modeler-extensions-installation[Installing a catalog of standard extensions to business processes] section are fulfilled. - -//// -[#edr] -== Розширення-конектори для отримання даних з ЄДР - -Для спрощення моделювання бізнес-процесів розроблені типові інтеграційні конектори для отримання інформації з ЄДРfootnote:[**ЄДР** -- Єдиний державний реєстр юридичних осіб, фізичних осіб-підприємців та громадських формувань.], налаштування яких відбувається на схемах бізнес-процесів у додатку **Camunda Modeler**. - -Наразі імплементовано 2 типи конекторів для отримання даних із ЄДР: :: - -. Інтеграційний конектор `searchSubject` -- призначений для отримання інформації про суб'єкт за кодом ЄДРПОУ або РНОКПП (раніше -- ІПН). -. Інтеграційний конектор `subjectDetails` -- призначений для отримання деталізованої інформації про суб'єкт за ID. - -=== Отримання інформації за суб'єктом в ЄДР - -Розширення *Search Subjects Edr Registry* -- делегат для виклику зовнішнього SOAP-сервісу, призначений для отримання інформації про суб'єкт за кодом ЄДРПОУ або РНОКПП (раніше -- ІПН), який налаштовується за допомогою шаблону *Search Subjects Edr Registry* (_searchSubjectsEdrRegistryConnectorDelegate.json_). - -[WARNING] -==== -Передумови :: - -За умови налаштування шаблону у *Camunda Modeler* переконайтеся, що папка із застосунком *_resources/element-templates_* містить файл _searchSubjectsEdrRegistryConnectorDelegate.json_. -==== - -. Відкрийте **Service Task**. -. На панелі налаштувань справа натисніть `Open Catalog` та оберіть шаблон *Search Subjects Edr Registry* зі списку. -+ -image:registry-develop:bp-modeling/ext-integration/connectors/edr/element-template-settings-01.png[] -. Налаштуйте обраний шаблон: - -* У полі `Name` вкажіть назву задачі. Наприклад, `Пошук інформації за суб'єктом в ЄДР` -* У полі `Authorization token` зазначте токен для доступу до СЕВ ДЕІР "Трембіта". Наприклад, `{token}`. -+ -NOTE: `Authorization token` надається постачальником сервісу (в нашому випадку -- ЄДР), який є іншим учасником СЕВ ДЕІР "Трембіта". - -* У полі `Code` введіть код (ЄДРПОУ або РНОКПП) для пошуку в ЄДР. Наприклад, `88888888`. -* У полі `Result variable` зазначте назву вихідного параметру, до якого буде записано відповідь від сервісу. Наприклад, `response`. - -+ -image:registry-develop:bp-modeling/ext-integration/connectors/edr/element-template-settings-1.png[] - -=== Отримання деталізованої інформації за суб'єктом в ЄДР - -Розширення *Get Subject Detail Edr Registry* -- делегат для виклику зовнішнього SOAP-сервісу, призначений для отримання деталізованої інформації про суб'єкт за ID, який налаштовується за допомогою шаблону *Get Subject Detail Edr Registry* (_subjectDetailEdrRegistryConnectorDelegate.json_). - -[WARNING] -==== -Передумови :: -За умови налаштування шаблону у *Camunda Modeler* переконайтеся, що папка із застосунком *_resources/element-templates_* містить файл _subjectDetailEdrRegistryConnectorDelegate.json_. -==== - -. Відкрийте **Service Task**. -. На панелі налаштувань справа натисніть `Open Catalog` та оберіть шаблон *Get Subject Detail Edr Registry* зі списку. -+ -image:registry-develop:bp-modeling/ext-integration/connectors/edr/element-template-settings-02.png[] - -. Налаштуйте обраний шаблон: - -* У полі `Name` вкажіть назву задачі. Наприклад, `Пошук деталізованої інформації за суб'єктом в ЄДР`. -* У полі `Authorization token` зазначте токен для доступу до СЕВ ДЕІР "Трембіта". Наприклад, `{token}`. -+ -NOTE: `Authorization token` надається постачальником сервісу (в нашому випадку -- ЄДР), який є іншим учасником СЕВ ДЕІР "Трембіта". - -* У полі `Id` зазначте унікальний ідентифікатор суб'єкта для пошуку в ЄДР. Наприклад, `{subject_id}`. -* У полі `Result variable` зазначте назву вихідного параметру, до якого буде записано відповідь від сервісу. Наприклад, `response`. - -+ -image:registry-develop:bp-modeling/ext-integration/connectors/edr/element-template-settings-2.png[] - -=== Приклади використання у бізнес-процесі - -Розглянемо ситуацію, коли у бізнес-процесі необхідно перевірити статус суб'єкта в ЄДР. - -Для цього у процесі необхідно налаштувати інтеграційний конектор для пошуку суб'єкта з ЄДР (в нашому випадку відповідь буде записано до змінної `responseEDR`). - -image:registry-develop:bp-modeling/ext-integration/connectors/edr/element-template-settings-3.png[] - -.Приклад відповіді від сервісу -==== -[source,json] ----- - { - "name": "active user", - "code": "77777777", - "id": 213123, - "state": "ACTIVE" - } ----- - -Відповідь містить параметр `state`, що має значення `"ACTIVE"`. -Далі на шлюзі відбувається перевірка: - -NOTE: Якщо `state` має значення `SUSPENDED` або `CANCELLED`, то бізнес-процес видає валідаційну помилку. -==== - -.Приклад налаштування гілки -==== ----- -${responseEdr.value.responseBody.elements().get(0).prop('state').value().equals('SUSPENDED') || responseEdr.responseBody.elements().get(0).prop('state').value().equals('CANCELED')} ----- - -image:registry-develop:bp-modeling/ext-integration/connectors/edr/element-template-settings-4.png[] - -NOTE: Якщо `state` не дорівнює `SUSPENDED` або `CANCELLED`, то відбудеться подальше виконання процесу. -==== - -.Приклад налаштування гілки -==== ----- -${!responseEdr.value.responseBody.elements().get(0).prop('state').value().equals('SUSPENDED') && !responseEdr.value.responseBody.elements().get(0).prop('state').value().equals('CANCELED')} ----- - -image:registry-develop:bp-modeling/ext-integration/connectors/edr/element-template-settings-5.png[] -==== - -[#extension-conectory_for_retrieving_data_from_DRACS] -== Розширення-конектори для отримання даних із ДРАЦС - -Для спрощення моделювання бізнес-процесів розроблено типові інтеграційні конектори для отримання інформації із ДРАЦСfootnote:[*ДРАЦС* -- Державна реєстрація актів цивільного стану.], налаштування яких відбувається на схемах бізнес-процесів у додатку **Camunda Modeler**. - -Наразі імплементовано 2 типи конекторів для отримання даних із ДРАЦС: :: - -. Типове інтеграційне розширення-конектор до SOAP-сервісу ДРАЦС для отримання даних Свідоцтва про народження за вказаними серією і номером Свідоцтва, та датою народження -- `GetCertByNumRoleBirthDate`. - -. Типове інтеграційне розширення-конектор до SOAP-сервісу ДРАЦС для отримання даних Свідоцтва про народження за вказаними серією і номером Свідоцтва, та ПІБ -- `GetCertByNumRoleNames`. - -=== Отримання даних Свідоцтва про народження за вказаними серією і номером Свідоцтва, та датою народження - -Розширення *Get Certificate By Birthdate* -- делегат для виклику зовнішнього SOAP-сервісу для отримання даних Свідоцтва про народження за вказаними серією і номером Свідоцтва, та датою народження, який налаштовується за допомогою шаблону *Get Certificate By Birthdate* (_getCertificateByBirthdateDracsRegistryDelegate.json_). - -[WARNING] -==== -Передумови :: - -За умови налаштування шаблону у *Camunda Modeler* переконайтеся, що папка із застосунком *_resources/element-templates_* містить файл _getCertificateByBirthdateDracsRegistryDelegate.json_. -==== - -. Відкрийте **Service Task**. -. На панелі налаштувань справа натисніть `Open Catalog` та оберіть шаблон *Get Certificate By Birthdate* зі списку. -+ -image:bp-modeling/ext-integration/connectors/dracs/get-certificate-dracs-1.png[] -. Налаштуйте обраний шаблон: -* У полі `Name` вкажіть назву задачі. Це може бути призначення сервісної задачі. Наприклад, `Отримати дані зі Свідоцтва про народження`. -* У полі `Certificate Number` вкажіть номер сертифіката. Наприклад, `218727`. -* У полі `Certificate Serial` вкажіть серію сертифіката. Наприклад, `IV-AM`. -+ -TIP: Актуальний формат номера свідоцтва та серію можна перевірити за https://minjust.gov.ua/dep/ddr/svidotstva-pro-narodjennya[посиланням]. -* У полі `Role` вкажіть роль `CHILD`. -+ -NOTE: Наразі Платформа реєстрів підтримує отримання даних виключно для ролі `CHILD`. Тобто із сервісу ДРАЦС можна отримати виключно дані дитини із сертифіката Свідоцтва про народження. Всі інші передбачені ДРАЦС ролі не підтримуються. -* У полі `Birth Year` введіть рік народження дитини. Наприклад, `2021`. -* У полі `Birth Month` вкажіть місяць народження дитини. Наприклад, `10`. -* У полі `Birth Day` вкажіть день народження дитини. Наприклад, `21`. -* У полі `Result variable` вкажіть результівну змінну, до якої необхідно записати відповідь від сервісу -- `response`. -+ -TIP: Приклад відповіді можна подивитися у розділі xref:#dracs-api-implementation[] -+ - -image:bp-modeling/ext-integration/connectors/dracs/get-certificate-dracs-3.png[] - -=== Отримання даних Свідоцтва про народження за вказаними серією і номером Свідоцтва, та ПІБ - -Розширення *Get Certificate By Name* -- делегат для виклику зовнішнього SOAP-сервісу для отримання даних за вказаними серією і номером Свідоцтва, та ПІБ, який налаштовується за допомогою шаблону *Get Certificate By Name* (_getCertificateByNameDracsRegistryDelegate.json_). - -[WARNING] -==== -Передумови :: - -За умови налаштування шаблону у *Camunda Modeler* переконайтеся, що папка із застосунком *_resources/element-templates_* містить файл _getCertificateByNameDracsRegistryDelegate.json_. -==== - -. Відкрийте **Service Task**. -. На панелі налаштувань справа натисніть `Open Catalog` та оберіть шаблон *Get Certificate By Name* зі списку. -+ -image:bp-modeling/ext-integration/connectors/dracs/get-certificate-dracs-2.png[] -. Налаштуйте обраний шаблон: -* У полі `Name` вкажіть назву задачі. Це може бути призначення сервісної задачі. Наприклад, `Отримати дані зі Свідоцтва про народження`. -* У полі `Certificate Number` вкажіть номер сертифіката. Наприклад, `218727`. -* У полі `Certificate Serial` вкажіть серію сертифіката. Наприклад, `IV-AM`. -+ -TIP: Актуальний формат номера свідоцтва та серію можна перевірити за https://minjust.gov.ua/dep/ddr/svidotstva-pro-narodjennya[посиланням]. -* У полі `Role` вкажіть роль `CHILD`. -+ -NOTE: Наразі Платформа реєстрів підтримує отримання даних виключно для ролі `CHILD`. Тобто із сервісу ДРАЦС можна отримати виключно дані дитини із сертифіката Свідоцтва про народження. Всі інші передбачені ДРАЦС ролі не підтримуються. -* У полі `Name` введіть ім'я дитини. Наприклад, `Павло`. -* У полі `Surname` прізвище дитини. Наприклад, `Сидоренко`. -* У полі `Patronymic` по батькові дитини. Наприклад, `Іванович`. -* У полі `Result variable` вкажіть результівну змінну, до якої необхідно записати відповідь від сервісу -- `response`. -+ -TIP: Приклад відповіді можна подивитися у розділі xref:#dracs-api-implementation[] -+ -image:bp-modeling/ext-integration/connectors/dracs/get-certificate-dracs-4.png[] - -[#dracs-api-implementation] -=== Імплементація на рівні API - -При налаштуванні шаблонів делегата у бізнес-процесі, делегати формують запити у форматі XML і за протоколом SOAP надсилають їх відповідним сервісам ДРАЦС. - -.Приклад SOAP-запита до API-сервісу GetCertByNumRoleBirthDate згідно з контрактом -[%collapsible] -==== -[source,xml] ----- - - - ... - - - - 3 - 218727 - IV-AM - 2021-21-10T00:00:00 - - - 1 - - - - - ----- -==== - -.Приклад SOAP-запита до API-сервісу GetCertByNumRoleNames згідно з контрактом -[%collapsible] -==== -[source,xml] ----- - - - ... - - - - 4 - 218727 - IV-AM - - Павло - Іванович - 1 - Сидоренко - - - - ----- -==== - -.Приклад відповіді від API згідно з контрактом для обох сервісів ДРАЦС -[%collapsible] -==== -[source,json] ----- -{ - "certificate":[ - { - "certStatus":1, - "certRepeat":0, - "certSerial":"IV-AM", - "certNumber":"218727", - "certSerialNumber":null, - "certOrg":null, - "certDate":null, - "arOrg":null, - "arNumb":null, - "arComposeDate":null, - "childSurname":"Сидоренко", - "childName":"Павло", - "childPatronymic":"Іванович", - "childBirthdate":null, - "fatherSurname":null, - "fatherName":null, - "fatherPatronymic":null, - "fatherCitizenship":null, - "fatherCitizenshipAnother":null, - "motherSurname":null, - "motherName":null, - "motherPatronymic":null, - "motherCitizenship":null, - "motherCitizenshipAnother":null, - "oldSurname":null, - "oldName":null, - "oldPatronymic":null, - "newSurname":null, - "newName":null, - "newPatronymic":null, - "dateOfBirth":null, - "placeofBirth":null, - "husbandOldSurname":null, - "husbandSurname":null, - "husbandName":null, - "husbandPatronymic":null, - "husbandCitizenship":null, - "husbandBirthdate":null, - "husbandPlaceofBirth":null, - "wifeOldSurname":null, - "wifeSurname":null, - "wifeName":null, - "wifePatronymic":null, - "wifeCitizenship":null, - "wifeBirthdate":null, - "wifePlaceOfBirth":null - } - ] -} ----- -NOTE: Параметри зі значенням `null` не використовуються. -==== - -[#eibdvpo] -== Розширення-конектор для отримання даних з ЄІБДВПО - -Для спрощення моделювання бізнес-процесів розроблено типовий інтеграційний конектор для обміну інформацією з ЄІБДВПОfootnote:[**ЄІБДВПО** -- Єдина інформаційна база даних внутрішньо переміщених осіб.], налаштування якого відбувається на схемах бізнес-процесів у додатку *Camunda Modeler*. - -_Наразі імплементовано 1 тип конектора для обміну даними з ЄІБДВПО:_ - -* Типове інтеграційне розширення-конектор до SOAP-сервісу ЄІБДВПО для отримання інформації за довідкою внутрішньо переміщеної особи -- `idpExchangeServiceRegistryConnector`. - -=== Отримання інформації за довідкою внутрішньо переміщеної особи (ВПО) - -Розширення *Idp Exchange Service Registry Connector* -- інтеграційний конектор для виклику зовнішнього SOAP-сервісу для отримання даних за довідкою внутрішньо переміщеної особи (ВПО), який налаштовується за допомогою шаблону *Idp Exchange Service Registry Connector* (_idpExchangeServiceRegistryConnector.json_). - -[WARNING] -==== -Передумови :: - -За умови налаштування шаблону у *Camunda Modeler* переконайтеся, що папка із застосунком *_resources/element-templates_* містить файл _idpExchangeServiceRegistryConnector.json_. -==== - -. Відкрийте Service Task. - -. На панелі налаштувань справа натисніть Open Catalog та оберіть шаблон *Idp Exchange Service Registry Connector* зі списку. - -+ -image:registry-develop:bp-modeling/ext-integration/connectors/eibdvpo/get-vpo-eibdvpo-01.png[] - -. Налаштуйте обраний шаблон: - -* У полі `Name` вкажіть назву задачі. Це може бути призначення сервісної задачі. Наприклад, `Idp Exchange Service Registry`. -* У полі `Url` вкажіть шлях до сервісу. Наприклад, `/idp/getCertificateByGUID/${submission('FORM_IDP_INPUT').formData.prop('uid').value()}`. -* У полі `Metgod` вкажіть HTTP-спосіб взаємодії з сервісом `GET` або `POST`. -* У полі `Body`, у разі використання методу `POST`, вкажіть тіло запиту. Наприклад, `${submission('FORM_IDP_INPUT').formData}`. -* У полі `Result variable` вкажіть результівну змінну, до якої необхідно записати відповідь від сервісу -- `response`. - -+ -image:registry-develop:bp-modeling/ext-integration/connectors/eibdvpo/get-vpo-eibdvpo-02.png[] - -=== Імплементація на рівні API - -При налаштуванні шаблонів делегата у бізнес-процесі, делегати формують запити у форматі XML і за протоколом SOAP надсилають їх відповідним сервісам ЄІБДВПО. - -.Приклад SOAP-запита до API-сервісу IDPexchangeService згідно з контрактом: -[%collapsible] -==== -* запит за РНОКПП: -+ -[source, json] ----- -{ -"method": "GET", -"url": "/idp/getCertificateByRNOKPP/3333333333", -"body": null -} ----- -* запит за UID (унікальний ідентифікатор довідки в реєстрі ВПО): -+ -[source, json] ----- -{ -"method": "GET", -"url": "/idp/getCertificateByGUID/79cefcce20028d82fc1d6dda6a498da2", -"body": null -} ----- -==== +Connectors are configured in the *Camunda Modeler* application. Before you start, ensure all prerequisites described in the xref:bp-modeling/bp/element-templates/element-templates-install.adoc[] section are fulfilled. -.Приклад відповіді від API-сервісу IDPexchangeService згідно з контрактом: -[%collapsible] -==== -[source, json] ----- -{ - "person": { - "idpSurname": "ІВАНОВ", - "idpName": "ІВАН", - "idpPatronymic": "ІВАНОВИЧ", - "birthDate": "01.01.1979 00.00.00.000", - "birthPlace": "хутір Ізбушенка, Луганської області", - "RNOKPP": "3333333333", - "gender": "Жінка", - "documentType": "1", - "documentSerie": "ЕК", - "documentNumber": "633666", - "documentDate": "13.11.1997 00.00.00.000", - "documentIssuer": "Артемівським РВЛМУУМВС укр. в Луг. обл.", - "regAddress": "ЛУГАНСЬКА ОБЛАСТЬ/М.ЛУГАНСЬК ЛУГАНСЬК ВУЛ.ПОГРАНИЧНА буд.0", - "factAddress": "М.БАХМУТ ДОНЕЦЬКА ОБЛ. ВУЛ. МИРУ буд. 00 кв. 00", - "certificateNumber": "1419-69164", - "certificateDate": "02.09.2015 00.00.00.000", - "certificateIssuer": "М.БАХМУТ ДОНЕЦЬКА ОБЛ.", - "certificateState": "знята з обліку", - "UID": "f895ad5fbbe66605979afb7e18847c1b" - }, - "accompanied": [] -} ----- -==== - -[TIP] -==== -У разі необхідності використання окремого параметру(наприклад, `idpSurname`) при моделюванні бізнес-процесу, можливе використання наступного скрипту: - -[source, groovy] ----- -def serviceResponse = response.responseBody.elements().get(0) -serviceResponse.prop('person').prop('idpSurname') - - -accompanied.each{ - it ... -} ----- -==== -//// - -//== Загальний SOAP http-конектор == General integration SOAP HTTP connector -//CAUTION: Конектор можна використати для інтеграції з будь-яким SOAP-сервісом. - -//Розширення *SOAP http connector* -- інтеграційний конектор для виклику зовнішнього SOAP-сервісу, який налаштовується за допомогою шаблону *SOAP http connector* (_soapHttpConnector.json_). You can use the *SOAP http connector* extension to call any external SOAP service. This connector is configured using the *SOAP http connector* template (_soapHttpConnector.json_). [WARNING] ==== Prerequisites :: - -//За умови налаштування шаблону у *Camunda Modeler* переконайтеся, що папка із застосунком *_resources/element-templates_* містить файл _soapHttpConnector.json_. When configuring the template in Camunda Modeler, ensure the _resources/element-templates_ folder of the application contains the _soapHttpConnector.json_ file. ==== [#configure-soap-http-delegate] -//=== Налаштування конектора === Configuring the connector -//Конектор конфігурується за допомогою спеціального шаблону-розширення для сервісної (системної) задачі бізнес-процесу. The connector is configured via an extension template for the service task of the business process. -//. Створіть *Service Task* (Сервісну задачу). . Open the business process modeling interface. . Create a *Service Task*. -//. На панелі справа натисніть `*Select*`, оберіть та налаштуйте шаблон *SOAP http connector* зі списку: . In the panel on the right, click *`Select`*, then select the *SOAP http connector* from the list. Configure the template: -+ -//* У полі `*Name*` вкажіть назву задачі. `Наприклад, Пошук інформації за суб'єктом в ЄДР`. + * *Name*: Specify the task name -- for example, `Search by registry subject`. -+ -//* У полі `*Url*` вкажіть адресу ресурсу (повний шлях до ендпоінту). Наприклад, `https://trembita-edr-registry-mock.apps.envone.dev.registry.eua.gov.ua/mockEDRService`. + * *Url*: Specify the resource address -- for example, `https://trembita-edr-registry-mock.apps.envone.dev.registry.eua.gov.ua/mockEDRService`. -+ -//* У полі `*Headers*` вкажіть заголовки запита. Наприклад, *${requestHeaders}*. + * *Headers*: Specify the request headers -- for example, `${requestHeaders}`. -+ -//* У полі `*Payload*` вкажіть тіло запита. Наприклад, *`${requestPayload}`*. + + * `*Payload*: Provide the request body -- for example, `${requestPayload}`. + -//* У полі `*Result variable*` вкажіть змінну, до якої необхідно записати відповідь від сервісу. Наприклад, `*edrResponseBody*`. * *Result variable*: Specify the variable to store the service response -- for example, `edrResponseBody`. + image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-1.png[] -//.Відповідь від API згідно з контрактом для сервісу ЄДР .API response from EDR service ==== [source,xml] @@ -545,23 +87,20 @@ image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-htt ---- [NOTE] -//Сервіс повертає відповідь у вигляді рядка, тобто об'єкта типу `*String*` у форматі XML. The response from a service returns in the form of a string -- that is, a *String* type object in XML format. -//Надалі ви можете використати цю відповідь у xref:#soap-http-script-form-output[скрипті для виводу даних на UI-форму]. You can further use the response in the xref:#soap-http-script-form-output[script for outputting data to the UI form]. ==== -//=== Використання у бізнес-процесі на прикладі надсилання запита до сервісу ЄДР -=== An example of querying the EDR service as part of the business process +=== An example of querying the SOAP service as part of the business process + +[NOTE,caption=UA-specific] +This example presents the universal SOAP connector with the Ukrainian-specific system -- Unified State Register or EDR (as it sounds in Ukraine). -//Розглянемо приклад використання розробленого інтеграційного конектора у бізнес-процесі, який має взаємодію із SOAP-сервісом ЄДР (_тут -- виконує пошук інформації про посадову особу за кодом ЄДРПОУ (атрибутом `edrpou`)_). -//TODO: ua-specific example Let's consider an example of using the integration connector in a business process that interacts with the EDR SOAP service. In our case, it searches for information about officers by their EDRPOU code (the `edrpou` attribute). [TIP] ==== -//Скористайтеся референтними прикладами бізнес-процесу та UI-форм для кращого розуміння деталей моделювання: Download the following business process and UI form examples for reference: * [*] Business process: _link:{attachmentsdir}/bp-modeling/soap-connectors/soap-http-connector-edr.bpmn[soap-http-connector-edr.bpmn]_ @@ -569,75 +108,57 @@ Download the following business process and UI form examples for reference: * [*] Result view form: _link:{attachmentsdir}/bp-modeling/soap-connectors/soap-http-connector-edrpou-edr-result-view.json[soap-http-connector-edrpou-edr-result-view.json]_ ==== -//. Створіть бізнес-процес і додайте пул до панелі моделювання. . Create a business process and add a pool to the modeling canvas. + image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-2.png[] -+ -//. Створіть стартову задачу для ініціювання процесу. + . Create a start task to initiate the process. + [WARNING] ==== -//Для того, щоб використовувати змінну `*initiator*` у бізнес-процесі, необхідно визначити її на стартовій події як `*initiator*` у полі `*Start initiator*`. To use the `*initiator*` variable in the business process, you need to define it in the *Start initiator* field of the start event. image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-2-1.png[] ==== -//==== Користувацька задача введення даних для пошуку в іншому реєстрі ==== A user task for entering data to search another registry -//Далі змоделюйте користувацьку задачу (*User Task*), оберіть шаблон *User Form* (користувацька UI-форма) та виконайте налаштування. Next, model the *User Task*, select the *User Form* template, and configure it. -//. Введіть назву задачі. Наприклад, `Ввести ЄДРПОУ для пошуку`. . Specify the task name -- for example, `Enter EDRPOU to search by`. -//. У полі `*ID*` введіть ідентифікатор задачі (`activity_id`). Його ви можете використовувати надалі у бізнес-процесі відповідно до вашої логіки. Наприклад, `*searchEdrpouCodeOfficer*`. . In the *ID* field, enter the task ID (`activity_id`). You can use it in the business process according to your business logic -- for example, `*searchEdrpouCodeOfficer*`. -//. У полі `*Form key*` введіть службову назву UI-форми вводу даних. Наприклад, `*soap-http-connector-edrpou-search-in-edr*`. . In the *Form key* field, enter the service name of the data entry UI form -- for example, `*soap-http-connector-edrpou-search-in-edr*`. -//. У полі `Assignee` введіть токен ініціатора процесу -- `${initiator}`. . In the *Assignee* field, specify the process initiator token -- for example, `${initiator}`. image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-3.png[] -//Приклад UI-форми на інтерфейсі користувача може виглядати так: :: Here is an example of a UI form as it appears to the users: :: + image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-5.png[] [#request-soap-http-connector] -//==== Скрипт для виконання запита через SOAP-конектор ==== A script for making requests through the SOAP connector -//Далі сформуйте Groovy-скрипт, в якому необхідно визначити параметри, а саме _заголовки_ та _тіло_ запита, які будуть використані SOAP-конектором для отримання даних в іншому реєстрі. Next, create a Groovy script defining the parameters to be used by the SOAP connector to get data from another registry -- namely, the request _headers_ and _body_. -//. Створіть скрипт-задачу (*Script Task*). . Create a *Script Task*. -//. Введіть назву. Наприклад, `Підготувати дані для запита`. . Specify the task name -- for example, `Preparing request data`. -//. Відкрийте візуальний редактор скриптів та напишіть необхідний скрипт. . Open the script visual editor and create your script. + image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-4.png[] -//Загалом скрипт може виглядати так: :: Here is an example of a script: :: + image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-4-1.png[] -+ -//* 3.1. Отримуємо код ЄДРПОУ, який ввели на першій формі: -* 3.1. Get the EDRPOU code from the first form: + +.. Get the EDRPOU code from the first form: + [source,groovy] ---- def edrpou = submission('searchEdrpouCodeOfficer').formData.prop('edrpou').value() ---- -+ -//* 3.2. Готуємо заголовки запита: -* 3.2. Prepare the request headers: + +.. Prepare the request headers: + [source,groovy] ---- @@ -646,22 +167,18 @@ requestHeaders['SOAPAction'] = 'SearchSubjects' requestHeaders['Content-Type'] = 'text/xml;charset=UTF-8;' ---- + -//NOTE: Підставте відповідне значення для свого запита замість `'SearchSubjects'`. NOTE: Replace `'SearchSubjects'` with your own request. -+ -//* 3.3. Зберігаємо заголовки до транзитної змінної процесу `*requestHeaders*`. Значення цієї змінної ми використаємо як вхідний параметр запита у налаштуваннях SOAP-конектора. -* 3.3. Save headers to the `*requestHeaders*` transient variable. We will use the value of this variable as an input parameter of the request in the SOAP connector settings. + +.. Save headers to the `*requestHeaders*` transient variable. We will use the value of this variable as an input parameter of the request in the SOAP connector settings. + [source,groovy] ---- set_transient_variable('requestHeaders', requestHeaders) ---- + +.. Form the body of the SOAP request to the EDR API according to the API contract: + -//* 3.4. Формуємо тіло SOAP-запита до API-сервісу ЄДР згідно з контрактом: -//TODO: What is the contract in this context? -* 3.4. Form the body of the SOAP request to the EDR API according to the contract: -+ -.SOAP request body +._SOAP request body_ [%collapsible] ==== [source,groovy] @@ -715,7 +232,6 @@ def requestPayload = """ + [TIP] ==== -//Підставляємо змінну *`${edrpou}`* у тіло запита: Put the *`${edrpou}`* variable into the request body: [source,xml] @@ -729,40 +245,31 @@ Put the *`${edrpou}`* variable into the request body: ---- ==== -//* 3.5. Зберігаємо тіло запита до транзитної змінної процесу `*requestPayload*`. Значення цієї змінної ми використаємо як вхідний параметр запита у налаштуваннях SOAP-конектора. -* 3.5. Save the request body to the `*requestPayload*` transient variable. We will use the value of this variable as an input parameter of the request in the SOAP connector settings. + +.. Save the request body to the `*requestPayload*` transient variable. We will use the value of this variable as an input parameter of the request in the SOAP connector settings. + [source,groovy] ---- set_transient_variable('requestPayload', requestPayload as String) ---- + -//NOTE: `*requestPayload*` необхідно передати як рядок (*`as String`*). NOTE: The `*requestPayload*` variable must be passed as a string. -//Використовуйте параметри, збережені до змінних у скрипті, в рамках сервісної задачі та налаштуванні SOAP-конектора. Use the parameters from the script's variables for the service task and to configure the SOAP connector. -//==== Сервісна задача для відправлення пошукового запита до іншого реєстру ==== A service task for sending a search query to another registry -//Далі необхідно створити сервісну задачу, застосувати та налаштувати шаблон для *SOAP-http-конектора*. Next, you need to create a service task and apply and configure the *SOAP-http-connector* template. TIP: For details, jump to xref:#configure-soap-http-delegate[]. [#soap-http-script-form-output] -//==== Скрипт для виводу даних на UI-форму користувача ==== A script for outputting data to the user's UI form -//Далі необхідно передати дані на UI-форму, отримані в іншому реєстрі за допомогою SOAP-http-конектора. Для цього спочатку сформуйте відповідний скрипт, який зможе це зробити. Next, you need to pass the data obtained from another registry using the SOAP HTTP connector to the UI form. For this, you need to create a corresponding script. -//. Створіть скрипт-задачу (*Script Task*). . Create a *Script Task*. -//. Введіть назву. Наприклад, `Підготовка отриманих даних для виведення на форму`. -. Specify the task name -- for example, `Preparing the obtained data for the form`. -//. Відкрийте візуальний редактор скриптів та напишіть необхідний скрипт. +. Specify the task name—for example, `Preparing the obtained data for the form`. . Open the script visual editor and create your script. + image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-6.png[] @@ -770,13 +277,10 @@ image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-htt Here is an example of a script: :: + image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-6-1.png[] -+ -//* 3.1. Формуємо JSON-об'єкт з параметрами *`state`*, `*name*`, `*code*`, `*id*`, щоб передати їх на форму. -* 3.1. Form a JSON object with the *`state`*, `*name*`, `*code*`, and `*id*` parameters to pass to the form. -+ -//* 3.2. Зберігаємо об'єкт до змінної *`payload`*, яку ми й використаємо як вхідний параметр для передачі даних на форму. -* 3.2. Save the object to the *`payload`* variable, which we will use as an input parameter for passing data to the form. -//._Скрипт для виводу даних на UI-форму користувача_ + +.. Form a JSON object with the *`state`*, `*name*`, `*code*`, and `*id*` parameters to pass to the form. + +.. Save the object to the *`payload`* variable, which we will use as an input parameter for passing data to the form. + ._A script for outputting data to the user's UI form_ [%collapsible] @@ -801,386 +305,26 @@ def getValueByPropertyName(String propName) { ---- ==== + -//NOTE: Функція *`S(edrResponseBody, 'application/xml')`* повертає об'єкт відповідно до специфікації https://javadoc.io/static/org.camunda.spin/camunda-spin-core/1.6.3/org/camunda/spin/xml/SpinXmlElement.html[SpinXmlElement]. NOTE: The *`S(edrResponseBody, 'application/xml')`* function returns the object using the https://javadoc.io/static/org.camunda.spin/camunda-spin-core/1.6.3/org/camunda/spin/xml/SpinXmlElement.html[SpinXmlElement] specification. -//==== Користувацька задача передачі даних на UI-форму ==== A user task for passing data to the UI form -//Насамкінець необхідно вивести отримані в іншому реєстрі та опрацьовані скриптом дані на UI-форму користувача. Finally, you need to output the data obtained from another registry and processed by the script to the user's UI form. -//Змоделюйте користувацьку задачу (*User Task*), оберіть шаблон *User Form* (користувацька UI-форма) та виконайте налаштування. Model the *User Task*, select the *User Form* template, and configure it. -//. Введіть назву задачі. Наприклад, `Переглянути дані з ЄДР`. . Specify the task name -- for example, `View EDR data`. -//. У полі `*ID*` введіть ідентифікатор задачі (`activity_id`). Наприклад, `*writeResultForm*`. . In the *ID* field, enter the task ID (`activity_id`) -- for example, `*writeResultForm*`. -. У полі `*Form key*` введіть службову назву UI-форми вводу даних. Наприклад, `*soap-http-connector-edrpou-edr-result-view*`. -//TODO: Скоріш за все, тут має бути "UI-форми перегляду результату" . In the *Form key* field, enter the service name of the result view UI form -- for example, `*soap-http-connector-edrpou-edr-result-view*`. -//. У полі `Assignee` введіть токен ініціатора процесу -- `${initiator}`. . In the *Assignee* field, specify the process initiator token -- for example, `${initiator}`. -//. У полі `*Form data pre-population*` вкажіть як змінну об'єкт із параметрами, які необхідно передати на форму, -- `*${payload}*`. . In the *Form data pre-population* field, specify the variable for the object with parameters to pass to the form: `*${payload}*`. + -//TIP: Змінна формується у задачі xref:#soap-http-script-form-output[]. TIP: The variable is formed in the following task: xref:#soap-http-script-form-output[]. image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-7.png[] -//Приклад UI-форми на інтерфейсі користувача може виглядати так: :: Here is an example of a UI form as it appears to the users: :: + image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-8.png[] -//Змоделюйте задачу завершення процесу та збережіть зміни. -Model the process end task and save your changes. - -//// -[#trembita-connector] -== Загальний Trembita SOAP-конектор -[CAUTION] -==== -Конектор можна використати для інтеграції з будь-яким SOAP-сервісом, зареєстрованим у СЕВ ДЕІР "Трембіта". - -Детальніше про налаштування взаємодії з "Трембітою" див. на сторінці xref:registry-admin/external-integration/cp-integrate-trembita.adoc[]. -==== - -*Trembita SOAP connector* -- інтеграційне розширення-делегат *`${trembitaSoapConnectorDelegate}`*, призначене для виклику зовнішнього SOAP-сервісу через ШБО "Трембіта". Воно налаштовується у бізнес-процесі за допомогою шаблону *Trembita SOAP connector* (*_trembitaSoapConnectorDelegate.json_*). - -[WARNING] -==== -Передумови :: - -За умови налаштування делегата в Camunda Modeler переконайтеся, що папка застосунку *_resources/element-templates_* містить файл шаблону *_trembitaSoapConnectorDelegate.json_*. -==== - -[#configure-trembita-soap-delegate] -=== Налаштування делегата - -Делегат конфігурується за допомогою спеціального шаблону-розширення для сервісної (системної) задачі бізнес-процесу. - -. Створіть *Service Task* (Сервісну задачу). - -. На панелі справа натисніть `*Select*`, оберіть та налаштуйте шаблон *Trembita SOAP connector* зі списку: - -. У полі `*Name*` секції *General* вкажіть назву задачі. Наприклад, `Відправлення запита до ЄДР`. - -. Розділ *Custom properties*: - -* У полі `*Trembita system name*` вкажіть назву зовнішньої системи-учасника СЕВ ДЕІР "Трембіта", з якою встановлено підключення через адміністративну панель *Control Plane*. Наприклад, *`trembita-registry-test`*. - -* У полі `*Trembita service name*` вкажіть назву сервісу зовнішньої системи "Трембіта", куди необхідно виконати запит. Наприклад, *`testAction`*. -+ -NOTE: [.underline]#Назва сервісу = SOAP Action#. Вона визначає, який процес або програму необхідно викликати, коли запит надсилається клієнтом сервісу. - -* У полі `*Content type*` визначається формат представлення даних та кодування. За замовчуванням -- *`text/xml;charset=UTF-8;`*. - -* У полі *`Request payload`* вкажіть змінну, яка містить дані запита. Наприклад, *`${requestPayload}`*. -+ -NOTE: *`${requestPayload}`* формується попередньо у скрипті (_див. детальніше -- xref:#request-trembita-soap-connector[]_). -+ -Тіло запита може виглядати так: -+ -.Тіло запита згідно з контрактом для сервісу ЄДР -==== -[source,xml] ----- - - $edrpou - ----- -==== - -* У полі `*Result variable*` вкажіть змінну, до якої необхідно записати відповідь від сервісу. Наприклад, `*edrResponseBody*`. - -+ -image:registry-develop:bp-modeling/ext-integration/connectors/trembita-connector/trembita-connector-1.png[] - -+ -.Відповідь від API згідно з контрактом для сервісу ЄДР -==== -[source,xml] ----- - - - ... - - - - - - 1 - зареєстровано - Сидоренко Василь Леонідович - http://zqedr-api.nais.gov.ua/1.0/subjects/2222 - 2222 - 2222 - - - - - ----- - -[NOTE] -Делегат повертає відповідь у вигляді об'єкта типу https://javadoc.io/static/org.camunda.spin/camunda-spin-core/1.6.3/org/camunda/spin/xml/SpinXmlElement.html[SpinXmlElement]. -==== - -=== Використання у бізнес-процесі на прикладі надсилання запита до сервісу ЄДР - -Розглянемо приклад використання розробленого інтеграційного конектора у бізнес-процесі, який має взаємодію із SOAP-сервісом ЄДР (_тут -- виконує пошук інформації про посадову особу за кодом ЄДРПОУ (атрибутом `edrpou`)_). - -[TIP] -==== -Скористайтеся референтними прикладами бізнес-процесу та UI-форм для кращого розуміння деталей моделювання: - -* [*] Бізнес-процес: _link:{attachmentsdir}/bp-modeling/soap-connectors/trembita-connector.bpmn[trembita-connector.bpmn]_ -* [*] Форма введення даних: _link:{attachmentsdir}/bp-modeling/soap-connectors/soap-http-connector-edrpou-search-in-edr.json[soap-http-connector-edrpou-search-in-edr.json]_ -* [*] Форма перегляду результату: _link:{attachmentsdir}/bp-modeling/soap-connectors/soap-http-connector-edrpou-edr-result-view.json[soap-http-connector-edrpou-edr-result-view.json]_ -==== - -[NOTE] -==== -Конектор можна використати для інтеграції з будь-яким SOAP-сервісом, зареєстрованому у СЕВ ДЕІР "Трембіта". -==== - -. Створіть бізнес-процес і додайте пул до панелі моделювання. -+ -image:registry-develop:bp-modeling/ext-integration/connectors/trembita-connector/trembita-connector-2.png[] - -. Створіть стартову задачу для ініціювання процесу. -+ -[WARNING] -==== -Для того, щоб використовувати змінну `*initiator*` у бізнес-процесі, необхідно визначити її на стартовій події як `*initiator*` у полі `*Start initiator*`. - -image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-2-1.png[] - -==== - -==== Користувацька задача введення даних для пошуку в іншому реєстрі - -Далі змоделюйте користувацьку задачу (*User Task*), оберіть шаблон *User Form* (користувацька UI-форма) та виконайте налаштування. - -. Введіть назву задачі. Наприклад, `Ввести ЄДРПОУ для пошуку`. -. У полі `*ID*` введіть ідентифікатор задачі (`activity_id`). Його ви можете використовувати надалі у бізнес-процесі відповідно до вашої логіки. Наприклад, `*searchEdrpouCodeOfficer*`. -. У полі `*Form key*` введіть службову назву UI-форми вводу даних. Наприклад, `*soap-http-connector-edrpou-search-in-edr*`. -. У полі `Assignee` введіть токен ініціатора процесу -- `${initiator}`. - -image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-3.png[] - -Приклад UI-форми на інтерфейсі користувача може виглядати так: :: -+ -image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-5.png[] - -[#request-trembita-soap-connector] -==== Скрипт для виконання запита через Trembita SOAP-конектор - -Далі сформуйте Groovy-скрипт, в якому необхідно визначити параметри, а саме _тіло_ запита й опціонально -- _заголовки_, які будуть використані SOAP-конектором для отримання даних в іншому реєстрі. - -[WARNING] -==== -Делегат _автоматично додасть наступні системні заголовки_ при виконанні запита до SOAP-сервісу. - -.Перелік і структура заголовків -[%collapsible] -===== -[source,xml] ----- - - ? - ? - ? - ? - - - ? - ? - ? - ? - ? - ? - -? -? -? ----- -===== -==== - -. Створіть скрипт-задачу (*Script Task*). -. Введіть назву. Наприклад, `Підготувати дані для запита`. -. Відкрийте візуальний редактор скриптів та напишіть необхідний скрипт. -+ -image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-4.png[] - -Загалом скрипт може виглядати так: :: -+ -image:registry-develop:bp-modeling/ext-integration/connectors/trembita-connector/trembita-connector-3.png[] - -* 3.1. Отримуємо значення коду `*edrpou*`, який ввели на першій формі вводу даних (`*formData*`): -+ -[source,groovy] ----- -def edrpou = submission('searchEdrpouCodeOfficer').formData.prop('edrpou').value() ----- - -* 3.2. Отримуємо токен авторизації для доступу до сервісу за допомогою JUEL-функції *`get_trembita_auth_token()`*. -+ -[source,groovy] ----- -def registryAuthSecretValue = get_trembita_auth_token('trembita-registry-test') ----- -+ -[NOTE] -==== -Функція *`get_trembita_auth_token()`* дозволяє отримати токен авторизації для доступу до сервісів СЕВ ДЕІР "Трембіта", з якими попередньо налаштовано взаємодію у Control Plane (_див. детальніше -- xref:bp-modeling/bp/modeling-facilitation/modelling-with-juel-functions.adoc[]_). -==== - -* 3.3. Створюємо шаблон заголовка SOAP-запита із токеном авторизації. -+ -[source,groovy] ----- -def authHeaderTagTemplate = """ - - $registryAuthSecretValue - -""" ----- - -* 3.4. Заповнюємо шаблон заголовка із токеном авторизації. -+ -[source,groovy] ----- -def headerString = sprintf(authHeaderTagTemplate, registryAuthSecretValue) ----- - -* 3.5. Створюємо шаблон тіла SOAP-запита для пошуку суб'єкта за кодом ЄДРПОУ. -+ -[source,groovy] ----- -def bodyTemplate = """ - - $edrpou - -""" ----- - -* 3.6. Заповнюємо шаблон тіла SOAP-запита зі значенням `*edrpou*`. -+ -[source,groovy] ----- -def bodyString = sprintf(bodyTemplate, edrpou) ----- - -* 3.7. Створюємо шаблон SOAP-запита зі згенерованим заголовком та тілом. -+ -[source,groovy] ----- -String requestTemplate = """ - - - $headerString - - - $bodyString - - -""" ----- -+ -Змінні `*headerString*` та `*bodyString*` формуються з шаблонів `*authHeaderTagTemplate*` та `*bodyTemplate*` відповідно, де змінні `*$registryAuthSecretValue*` і `*$edrpou*` замінюються на значення змінних `*registryAuthSecretValue*` та *`edrpou`*, що були отримані на попередніх етапах у скрипті. - -* 3.8. Далі формуємо запит на отримання інформації про суб'єкт за його ЄДРПОУ. -+ -[source,groovy] ----- -def requestPayload = sprintf(requestTemplate, headerString, bodyString) ----- -+ -Запит формується за допомогою змінної *`requestTemplate`*, в якій змінні *$headerString* і *$bodyString* замінюються на їх відповідні значення. - -* 3.9. Кінцевий запит зберігаємо у змінній `*requestPayload*` і додаємо до тимчасових змінних за допомогою функції *`set_transient_variable()`*. Значення цієї змінної ми використаємо як вхідний параметр запита у налаштуваннях Trembita SOAP-конектора (_див. детальніше -- xref:#configure-trembita-soap-delegate[]_). -+ -[source,groovy] ----- -set_transient_variable('requestPayload', requestPayload) ----- -+ -TIP: Тимчасові змінні дозволяють зберігати дані на певний час, щоб вони були доступні наступним етапам скрипту (до наступної користувацької задачі), але не були збережені назавжди. - - -==== Сервісна задача для відправлення пошукового запита до іншого реєстру - -Далі необхідно створити сервісну задачу, застосувати та налаштувати делегат для *Trembita SOAP*-конектора. - -TIP: Див. детальніше у розділі xref:#configure-trembita-soap-delegate[]. - -[#trembita-soap-script-form-output] -==== Скрипт для виводу даних на UI-форму користувача - -Далі необхідно передати дані на UI-форму, отримані в іншому реєстрі за допомогою SOAP-http-конектора. Для цього спочатку сформуйте відповідний скрипт, який зможе це зробити. - -. Створіть скрипт-задачу (*Script Task*). -. Введіть назву. Наприклад, `Підготовка отриманих даних для виведення на форму`. -. Відкрийте візуальний редактор скриптів та напишіть необхідний скрипт. -+ -image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-6.png[] - -Загалом скрипт може виглядати так: :: -+ -image:registry-develop:bp-modeling/ext-integration/connectors/trembita-connector/trembita-connector-4.png[] - -* 3.1. Формуємо JSON-об'єкт із параметрами *`state`*, `*name*`, `*code*`, `*id*`, щоб передати їх на форму. - -* 3.2. Зберігаємо об'єкт до змінної *`payload`*, яку ми й використаємо як вхідний параметр для передачі даних на форму. -+ -._Скрипт для виводу даних на UI-форму користувача_ -[%collapsible] -==== -[source,groovy] ----- -def payload = [:] - - payload['state'] = getValueByPropertyName("state_text") - payload['name'] = getValueByPropertyName("name") - payload['code'] = getValueByPropertyName("code") - payload['id'] = getValueByPropertyName("id") - - set_transient_variable('payload', S(payload, 'application/json')) - - def getValueByPropertyName(String propName) { - return edrResponseBody.childElement("Body") - .childElement("http://nais.gov.ua/api/sevdeir/EDR", "SearchSubjectsResponse") - .childElement("SubjectList") - .childElement("SubjectInfo") - .childElement(propName) - .textContent() -} ----- -==== - -==== Користувацька задача передачі даних на UI-форму - -Насамкінець необхідно вивести отримані в іншому реєстрі та опрацьовані скриптом дані на UI-форму користувача. - -Змоделюйте користувацьку задачу (*User Task*), оберіть шаблон *User Form* (користувацька UI-форма) та виконайте налаштування. - -. Введіть назву задачі. Наприклад, `Переглянути дані з ЄДР`. -. У полі `*ID*` введіть ідентифікатор задачі (`activity_id`). Наприклад, `*writeResultForm*`. -. У полі `*Form key*` введіть службову назву UI-форми вводу даних. Наприклад, `*soap-http-connector-edrpou-edr-result-view*`. -. У полі `Assignee` введіть токен ініціатора процесу -- `${initiator}`. -. У полі `*Form data pre-population*` вкажіть як змінну об'єкт із параметрами, які необхідно передати на форму, -- `*${payload}*`. -+ -TIP: Змінна формується у задачі xref:#trembita-soap-script-form-output[]. - -image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-7.png[] - -Приклад UI-форми на інтерфейсі користувача може виглядати так: :: -+ -image:registry-develop:bp-modeling/ext-integration/connectors/soap-http/soap-http-8.png[] - -Змоделюйте задачу завершення процесу та збережіть зміни. \ No newline at end of file +Model the process end task and save your changes. \ No newline at end of file diff --git a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/overview.adoc b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/overview.adoc index bcddf69f96..8eda532aa8 100644 --- a/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/overview.adoc +++ b/docs/en/modules/registry-develop/pages/registry-admin/admin-portal/overview.adoc @@ -3,27 +3,10 @@ include::ROOT:partial$templates/document-attributes/default-set-en.adoc[] include::ROOT:partial$admonitions/language-en.adoc[] - == Functional capabilities -//Кабінет адміністратора регламентів (Адміністративний портал) -- це інструмент, призначений для розробників та моделювальників реєстру, який надає користувачам наступні функціональні можливості: The administrative portal is an instrument for Registry developers and modelers, which provides the users with the following functional capabilities: - -//// -Управління версіями регламенту:: -* [*] Огляд майстер-версії регламенту; -* [*] Створення запитів на внесення змін; -* [*] Активація запита на внесення змін; -* [*] Перегляд запитів на внесення змін; -* [*] Перегляд статусів сутностей-складових у версії-кандидаті; -* [*] Внесення змін до складових версії-кандидата; -* [*] Автоматичне оновлення та актуалізація стану відкритих запитів на внесення змін; -* [*] Інтеграція запитів на внесення змін до майстер-версії регламенту; -* [*] Перегляд метаданих відкритого запита на внесення змін до регламенту. Застосування та відкликання запита; -* [*] Перевірка та фіксація наявності конфліктів запита на внесення змін до майстер-версії регламенту. -//// - Regulations version management:: * [*] Viewing regulations master-version; * [*] Creating requests for changes; @@ -36,55 +19,23 @@ Regulations version management:: * [*] Viewing open change request metadata. Applying and recalling request; * [*] Checking and recording change request conflicts with the master-version. - -//// -Моделювання регламенту:: -* [*] Управління глобальними налаштуваннями реєстру; -* [*] Перегляд та вивантаження шаблонів звітів; -* [*] Перегляд переліку таблиць моделі даних та їх структур; -* [*] Управління бізнес-процесами. -//// - Regulations modeling:: * [*] Registry global configuration management; * [*] Viewing and downloading report templates; * [*] Viewing the list of data model tables and their structures; * [*] Business Process management. - - -//// -Управління користувачами:: -* [*] Завантаження користувачів в систему. -//// User management:: * [*] Importing users into the system. - -//// -Зв'язок зі службою підтримки:: -* [*] Зв'язок зі службою підтримки під час виникнення некритичних помилок -//// Contacting support service:: * [*] Contacting support for non-critical errors. - -//.Функціональні можливості адміністративного порталу .Administrative portal functional capabilities image::registry-admin/admin-portal/admin-portal-new-diagram.png[] -//== Огляд секції == Section overview - -//// -* [*] xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[Управління версіями регламенту] -* [*] xref:registry-admin/admin-portal/registry-modeling/overview.adoc[Моделювання регламенту] -* [*] xref:registry-admin/admin-portal/admin-portal-user-mgmt.adoc[Управління користувачами] -* [*] xref:registry-admin/admin-portal/error-non-critical.adoc[Зв'язок зі службою підтримки] -//// - - * [*] xref:registry-admin/admin-portal/version-control/version-control-overview.adoc[] * [*] xref:registry-admin/admin-portal/registry-modeling/overview.adoc[] * [*] xref:registry-admin/admin-portal/admin-portal-user-mgmt.adoc[] diff --git a/docs/en/modules/registry-develop/partials/nav.adoc b/docs/en/modules/registry-develop/partials/nav.adoc index 113252c89e..fab086cc46 100644 --- a/docs/en/modules/registry-develop/partials/nav.adoc +++ b/docs/en/modules/registry-develop/partials/nav.adoc @@ -177,9 +177,8 @@ **** xref:registry-develop:bp-modeling/bp/what-is-bp.adoc[What are business processes: analysis, structure and operation types] //**** xref:registry-develop:bp-modeling/bp/bp-modeling-general-description.adoc[] //**** xref:registry-develop:bp-modeling/bp/bp-modeling-instruction.adoc[] -//**** xref:registry-develop:bp-modeling/bp/element-templates/element-templates-overview.adoc[] -//***** xref:registry-develop:bp-modeling/bp/element-templates/bp-element-templates-installation-configuration.adoc[] **** xref:registry-develop:bp-modeling/bp/element-templates/element-templates-overview.adoc[] +***** xref:registry-develop:bp-modeling/bp/element-templates/element-templates-install.adoc[Installing extensions to business processes (for local development)] ***** xref:registry-develop:bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc[] ****** xref:registry-develop:bp-modeling/bp/element-templates/user-task-templates/user-form.adoc[] ****** xref:registry-develop:bp-modeling/bp/element-templates/user-task-templates/officer-sign-task.adoc[] diff --git a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/call-activities/call-activities-overview.adoc b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/call-activities/call-activities-overview.adoc index 1a52e013ae..f94a4f7771 100644 --- a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/call-activities/call-activities-overview.adoc +++ b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/call-activities/call-activities-overview.adoc @@ -1,8 +1,17 @@ = Типові розширення для виклику глобальних підпроцесів (Call Activity) +:toclevels: 5 +:experimental: +:important-caption: ВАЖЛИВО +:note-caption: ПРИМІТКА +:tip-caption: ПІДКАЗКА +:warning-caption: ПОПЕРЕДЖЕННЯ +:caution-caption: УВАГА +:sectanchors: +:sectlinks: include::platform:ROOT:partial$admonitions/language-ua.adoc[] -NOTE: Каталог розроблених шаблонів для налаштування делегатів зберігається у сховищі коду Gerrit, в окремому репозиторії _business-process-modeler-extensions_ -> _element-templates_. +NOTE: Каталог розроблених шаблонів для налаштування делегатів зберігається у сховищі коду Gerrit, в окремому репозиторії _business-process-modeler-extensions_ > _element-templates_. TIP: Особливості використання Call Activity у бізнес-процесах дивіться за xref:bp-modeling/bp/bpmn/subprocesses/call-activities.adoc[посиланням]. @@ -10,5 +19,4 @@ TIP: Особливості використання Call Activity у бізне == Огляд секції * xref:bp-modeling/bp/element-templates/call-activities/call-activity.adoc[] - * xref:bp-modeling/bp/element-templates/call-activities/check-excerpt-status.adoc[] \ No newline at end of file diff --git a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-install.adoc b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-install.adoc new file mode 100644 index 0000000000..fab276dbcb --- /dev/null +++ b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-install.adoc @@ -0,0 +1,157 @@ += Встановлення типових розширень до бізнес-процесів (_для локальної розробки_) +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] + +Для спрощення моделювання бізнес-процесів розроблені типові розширення-конектори -- **Element Templates**. + +IMPORTANT: Якщо ви використовуєте функціональність xref:registry-admin/admin-portal/overview.adoc[Кабінету адміністратора регламентів] для розробки реєстру, вам не потрібно встановлювати типові розширення, додаткові зовнішні застосунки та плагіни. Портал містить усе необхідне вбудоване з коробки. Інструкції нижче у цьому документі призначені _ЛИШЕ_ для локальної розробки. + +[#preconditions] +== Передумови + +=== Встановлення застосунку Camunda Modeler + +. Завантажте архів із застосунком **Camunda Modeler** за link:https://downloads.camunda.cloud/release/camunda-modeler/4.8.0/[посиланням]. ++ +[NOTE] +==== +Рекомендовано використовувати версію саме 4.8.0 для стабільної роботи системи. +==== +. Оберіть продукт **Open Source Modeler** та завантажте відповідну версію, сумісну із вашою операційною системою (наприклад, `Windows 64bit`); +. Після завантаження архіву з додатком, розпакуйте його на локальній машині. ++ +[TIP] +==== +Папка із застосунком може мати, наприклад, таку назву: + +_camunda-modeler-4.8.1-win-x64_ +==== + +=== Встановлення плагіну BPMN Linter + +Встановіть плагін **BPMN Linter** для розширення функціональності Camunda та валідації ваших BPMN-діаграм. + +. Перейдіть до офіційного репозиторію за https://github.com/camunda/camunda-modeler-linter-plugin[посиланням]. + +. Натисніть кнопку `Code` -> `Download ZIP` та завантажте архів. ++ +image:bp-modeling/bp/element-temp/element-temp-install-bpmnlint.png[] + +. Після завантаження, розпакуйте вміст архіву до папки _camunda-modeler-4.8.1-win-x64\resources\plugins_ застосунку Camunda. + +. Перезапустіть додадок Camunda Modeler. +. Увімкніть плагін. Для цього натисність *Plugins* -> *BPMN Linter* -> *Toggle Linting*. ++ +Альтернативно застосуйте комбінацію клавіш `Ctrl+L`. ++ +image:bp-modeling/bp/element-temp/element-temp-turn-on-bpmnlint.png[] ++ +TIP: Плагін вмикається та вимикається однаково -- `Ctrl+L`. + +[#element-temp-install] +== Встановлення каталогу типових розширень + +[#element-temp-install-windows] +=== Встановлення каталогу типових розширень для Windows OS + +Виконайте настанови, подані нижче, для інсталювання каталогу Element Templates. + +. Завантажте каталог типових розширень одним зі способів: + +* _Спосіб 1._ + +Отримайте каталог з Github-репозиторію за https://github.com/epam/edp-ddm-business-process-modeler-extensions/tree/main/element-templates[посиланням]. + +* _Спосіб 2._ + +Отримайте каталог із захищеного сховища артефактів **Nexus** за посиланням: `https://nexus-{CP-NAMESPACE}.{DNS-WILDCARD}/[]`: ++ +[TIP] +==== +`{CP-NAMESPACE}` _та `{DNS-WILDCARD}` є змінними, де `{CP-NAMESPACE}` -- назва namespace (простору імен) у Nexus, а `{DNS-WILDCARD}` -- значення DNS wildcardfootnote:[В системі DNS можна задавати запис за замовчуванням для неоголошених піддоменів. Такий запис називається **wildcard**.]. + +Наприклад: :: https://nexus.apps.envone.dev.registry.eua.gov.ua/nexus +==== + +** знайдіть папку _business-process-modeler-extensions_; +** буде показано каталог папок типу _version.build_ (наприклад, _0.0.1-SNAPSHOT.12_); +** оберіть папку з останньою версією; +** оберіть `.zip`-файл у папці, що була відкрита (останньою версією zip може бути, наприклад, файл _business-process-modeler-extensions-1.7.0.zip_); +** на вкладці *Summary* натисніть правою кнопкою миші на посилання `Path`. Таким чином розпочнеться завантаження `.zip`-архіву; + +. Розпакуйте із заміною завантажений `.zip`-файл у підпапці _resources_ вашої локальної директорії, де зберігається додаток. Приклад шляху може бути наступним: _C:\Users\Downloads\camunda-modeler-4.8.1-win-x64\resources_. ++ +[TIP] +==== +* _camunda-modeler-4.8.1-win-x64_ -- локальна директорія, в якій зберігається додаток. +* _resources_ -- папка, що містить розширення (_element-templates_) та плагіни (_plugins_)_. +==== + +. Підсумкова структура директорії _resources_ має виглядати наступним чином: ++ +image:registry-develop:bp-modeling/bp/element-temp/bp-element-temp-02.png[] + +. Підсумкова структура директорії _element-templates_ має виглядати наступним чином: ++ +image:registry-develop:bp-modeling/bp/element-temp/bp-element-temp-03.png[] + +. Підсумкова структура директорії _plugins_ має виглядати наступним чином: ++ +image:registry-develop:bp-modeling/bp/element-temp/bp-element-temp-04.png[] + +. Перезапустіть додаток Camunda Modeler. +. Перевірте доступність розширень у каталозі при моделюванні бізнес-процесу: + +* Створіть задачу -- оберіть *Create Task*. +* Натисніть іконку ключа -- оберіть *Change Type*. +* Вкажіть тип задачі -- сервісна (*Service Task*), користувацька (*User Task*) або *Call Activity*. +* Натисніть кнопку `Open Catalog`. + +В результаті відкриється каталог розширень *Element Templates*, які можна застосувати в процесі моделювання. ++ +image:registry-develop:bp-modeling/bp/element-temp/bp-element-temp-01.png[] + +[#element-temp-install-macos] +=== Встановлення каталогу типових розширень для macOS + +Виконайте настанови, подані нижче, для інсталювання каталогу Element Templates. + +. Завантажте каталог розширень до бізнес-процесів за аналогією до пункту xref:#element-temp-install-windows[]. +. Відкрийте термінал. +. Перейдіть до локальної директорії розміщення ресурсів Camunda Modeler за допомогою команди: ++ +[source, bash] +---- +cd ~/Library/Application\ Support/camunda-modeler/resources +---- + +. Створіть нову директорію під розширення категорії `element templates` у випадку, якщо її там немає, за допомогою команди: ++ +[source, bash] +---- +mkdir element-templates +---- + +. Скопіюйте всі JSON-файли розширень із директорії `business-process-modeler-extensions` до директорії, що була створена, за допомогою команди: ++ +[source,bash] +---- +cp business-process-modeler-extensions/*.json ~/Library/Application\ Support/camunda-modeler/resources/element-templates +---- + +. Підсумкова структура директорії виглядатиме наступним чином: ++ +---- +~/Library/Application\ Support/camunda-modeler/resources/element-templates/ +---- ++ +image:registry-develop:bp-modeling/bp/element-temp/bp-element-temp-05.jpg[] + +. Перезапустіть додаток Camunda Modeler. +. Перевірте доступність розширень у каталозі при моделюванні бізнес-процесу: + +* Створіть задачу -- оберіть *Create Task*. +* Натисніть іконку ключа -- оберіть *Change Type*. +* Вкажіть тип задачі -- сервісна (*Service Task*), користувацька (*User Task*) або *Call Activity*. +* Натисніть кнопку `Open Catalog`. + +В результаті відкриється каталог розширень *Element Templates*, які можна застосувати в процесі моделювання. ++ +image:registry-develop:bp-modeling/bp/element-temp/bp-element-temp-01.png[] \ No newline at end of file diff --git a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-overview.adoc b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-overview.adoc index bf61b5a913..0304c8942f 100644 --- a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-overview.adoc +++ b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/element-templates-overview.adoc @@ -1,5 +1,4 @@ -:toc-title: ЗМІСТ -//:toc: auto += Типові розширення до бізнес-процесів :toclevels: 5 :experimental: :important-caption: ВАЖЛИВО @@ -7,27 +6,29 @@ :tip-caption: ПІДКАЗКА :warning-caption: ПОПЕРЕДЖЕННЯ :caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -//:sectnums: -:sectnumlevels: 5 :sectanchors: :sectlinks: -:partnums: -= Типові розширення до бізнес-процесів +include::platform:ROOT:partial$admonitions/language-ua.adoc[] CAUTION: Розділ у процесі модернізації. Для спрощення моделювання бізнес-процесів розроблені типові інтеграційні розширення-конектори -- **Element Templates**. Вони є ланкою взаємодії між рівнем виконання бізнес-процесів та API фабрики даних. - -[overview] == Огляд секції +[%collapsible] +._Встановлення типових розширень_ +==== +* [*] xref:registry-develop:bp-modeling/bp/element-templates/element-templates-install.adoc[] +==== + +[%collapsible] +._Каталог типових розширень_ +==== * [*] xref:registry-develop:bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc[Типові розширення для користувацьких задач (User task templates)] * [*] xref:bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc[Типові розширення для сервісних задач (Service task templates)] * [*] xref:bp-modeling/bp/element-templates/call-activities/call-activities-overview.adoc[] -* [*] xref:bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc[Типові розширення для інтеграції з іншими реєстрами на Платформі] \ No newline at end of file +* [*] xref:bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc[Типові розширення для інтеграції з іншими реєстрами на Платформі] +==== + diff --git a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc index b008dd7de7..d0330eba3b 100644 --- a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc +++ b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc @@ -1,5 +1,4 @@ -:toc-title: ЗМІСТ -:toc: auto += Типові розширення для інтеграції з іншими реєстрами на Платформі :toclevels: 5 :experimental: :important-caption: ВАЖЛИВО @@ -7,25 +6,18 @@ :tip-caption: ПІДКАЗКА :warning-caption: ПОПЕРЕДЖЕННЯ :caution-caption: УВАГА -:example-caption: Приклад -:figure-caption: Зображення -:table-caption: Таблиця -:appendix-caption: Додаток -:sectnums: -:sectnumlevels: 5 :sectanchors: :sectlinks: -:partnums: -= Типові розширення для інтеграції з іншими реєстрами на Платформі +include::platform:ROOT:partial$admonitions/language-ua.adoc[] В рамках REST-взаємодії з іншими реєстрами на Платформі та бізнес-процесами, що змодельовані всередині регламентів таких реєстрів, імплементовано додаткові розширення-конектори (делегати) для передачі або отримання даних до/з цих реєстрів. На сьогодні Платформа підтримує 2 таких делегати: :: -* xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/start-bp-another-registry.adoc[Start business process in another registry] -- делегат для ініціювання бізнес-процесу, що змодельований в рамках регламенту іншого реєстру на Платформі. +* *Start business process in another registry* -- делегат для ініціювання бізнес-процесу, що змодельований в рамках регламенту іншого реєстру на Платформі. -* xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/search-for-entities-another-registry.adoc[Search for entities in another registry data factory] -- делегат для отримання даних сутностей (таблиць) у базі даних іншого реєстру, що розгорнутий на Платформі. +* *Search for entities in another registry data factory* -- делегат для отримання даних сутностей (таблиць) у базі даних іншого реєстру, що розгорнутий на Платформі. [CAUTION] ==== @@ -36,4 +28,10 @@ * Відкрити доступ до такого реєстру в адмін-консолі для керування реєстрами Control Plane (_детальну інструкцію ви можете переглянути на сторінці xref:admin:registry-management/control-plane-registry-grant-access.adoc[]_). * Надати доступ до відповідних представлень та REST API реєстру на рівні моделі даних (_детальну інструкцію ви можете переглянути на сторінці xref:data-modeling/data/physical-model/rest-api-view-access-to-registry.adoc[]_). -==== \ No newline at end of file +==== + +== Огляд секції + +* xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/start-bp-another-registry.adoc[] + +* xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/search-for-entities-another-registry.adoc[] \ No newline at end of file diff --git a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc index 13716bf876..b120bf6868 100644 --- a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc +++ b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc @@ -1 +1,46 @@ -= Типові розширення для сервісних задач \ No newline at end of file += Типові розширення для сервісних задач +:toclevels: 5 +:experimental: +:important-caption: ВАЖЛИВО +:note-caption: ПРИМІТКА +:tip-caption: ПІДКАЗКА +:warning-caption: ПОПЕРЕДЖЕННЯ +:caution-caption: УВАГА +:sectanchors: +:sectlinks: + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] + +== Огляд секції + +****** Керування користувачами та ролями +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/add-role-to-keycloak-user.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/save-user-roles.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/get-roles-from-keycloak.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/keycloak-get-officer-users-by-attributes-equals-start-with.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/remove-role-from-keycloak-user.adoc[] +****** Керування налаштування користувача +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/read-user-settings.adoc[] +****** Створення сутностей +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/create-entity.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/create-nested-entities.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/batch-creation-entities.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/batch-creation-entities-v2.adoc[] +****** Читання та пошук сутностей +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/read-entity.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/batch-read-entities-from-data-factory.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/search-entities-in-data-factory.adoc[] +****** Оновлення сутностей +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/update-entity-in-data-factory.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/update-entity-in-data-factory-partially.adoc[] +****** Видалення сутностей +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/delete-entity.adoc[] +****** Моделювання цифрових підписів +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/digital-signature-by-dso-service.adoc[] +****** Інтеграція зовнішніх систем +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/connect-to-external-system-v2.adoc[] +****** Моделювання помилок у бізнес-процесі +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/throw-system-error.adoc[] +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/throw-validation-error.adoc[] +****** Моделювання статусів +******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/define-bp-status.adoc[] \ No newline at end of file diff --git a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc index e04b11b059..a6a6aef8c2 100644 --- a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc +++ b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc @@ -1,4 +1,14 @@ = Типові розширення для користувацьких задач (User task templates) +:toclevels: 5 +:experimental: +:important-caption: ВАЖЛИВО +:note-caption: ПРИМІТКА +:tip-caption: ПІДКАЗКА +:warning-caption: ПОПЕРЕДЖЕННЯ +:caution-caption: УВАГА +:sectanchors: +:sectlinks: + include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Огляд секції @@ -7,29 +17,3 @@ include::platform:ROOT:partial$admonitions/language-ua.adoc[] * xref:bp-modeling/bp/element-templates/user-task-templates/officer-sign-task.adoc[] * xref:bp-modeling/bp/element-templates/user-task-templates/user-form.adoc[] - - -//// -[#business-process-modeler-extensions-configuration] -== Налаштування типових розширень до бізнес-процесів - -Цей розділ описує налаштування типових розширень для бізнес-процесів -- **Element Templates**. - -Типи задач для застосування розширень :: - -Типові розширення **Element Templates** можуть бути застосовані до різних типів задач, наприклад: - -* xref:#element-temp-user-task[] -* xref:#element-temp-service-task[] -* xref:#element-temp-call-activity[] -* xref:#element-temp-send-task[] -* xref:#extensions-integrate-bp-another-registries[] - -[CAUTION] -==== -Налаштування типових розширень-конекторів відбувається у застосунку *Camunda Modeler*. - -Перед початком роботи переконайтеся, що виконано всі передумови, описані у розділі xref:business-process-modeler-extensions-installation[Встановлення каталогу типових розширень до бізнес-процесів]. -==== -//// - diff --git a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/rest-connector.adoc b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/rest-connector.adoc index f27fbb9f13..337abbc8fd 100644 --- a/docs/ua/modules/registry-develop/pages/bp-modeling/bp/rest-connector.adoc +++ b/docs/ua/modules/registry-develop/pages/bp-modeling/bp/rest-connector.adoc @@ -1,35 +1,7 @@ -// use these attributes to translate captions and labels to the document's language -// more information: https://asciidoctor.org/docs/user-manual/#customizing-labels -// table of contents title -:toc-title: ЗМІСТ -:toc: -:experimental: -:example-caption: Приклад -:important-caption: ВАЖЛИВО -:note-caption: ПРИМІТКА -:tip-caption: ПІДКАЗКА -:warning-caption: ПОПЕРЕДЖЕННЯ -:caution-caption: УВАГА -// captions for specific blocks -:figure-caption: Figure -:table-caption: Table -// caption for the appendix -:appendix-caption: Appendix -// how many headline levels to display in table of contents? -:toclevels: 5 -// https://asciidoctor.org/docs/user-manual/#sections-summary -// turn numbering on or off (:sectnums!:) -:sectnums: -// enumerate how many section levels? -:sectnumlevels: 5 -// show anchors when hovering over section headers -:sectanchors: -// render section headings as self referencing links -:sectlinks: -// number parts of a book -:partnums: - = Інтеграція із зовнішніми сервісами за допомогою REST-конектора +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] `REST Connector` -- це конектор для підключення до зовнішніх захищених сервісів/систем поза кластером Платформи. diff --git a/docs/ua/modules/registry-develop/pages/bp-modeling/external-integration/api-call/connectors-external-registry.adoc b/docs/ua/modules/registry-develop/pages/bp-modeling/external-integration/api-call/connectors-external-registry.adoc index 6b9faed8aa..5d91d29d5e 100644 --- a/docs/ua/modules/registry-develop/pages/bp-modeling/external-integration/api-call/connectors-external-registry.adoc +++ b/docs/ua/modules/registry-develop/pages/bp-modeling/external-integration/api-call/connectors-external-registry.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: - = Типові інтеграційні SOAP-конектори до інших реєстрів +include::platform:ROOT:partial$templates/document-attributes/default-set-ua.adoc[] + +include::platform:ROOT:partial$admonitions/language-ua.adoc[] == Загальний опис @@ -40,7 +24,7 @@ _Детальніше про налаштування інтеграцій че == Встановлення типових розширень-конекторів -Налаштування розширень-конекторів відбувається у застосунку **Camunda Modeler**. Перед початком роботи переконайтеся, що виконано всі передумови, описані у розділі xref:bp-modeling/bp/element-templates/bp-element-templates-installation-configuration.adoc#business-process-modeler-extensions-installation[Встановлення каталогу типових розширень до бізнес-процесів]. +Налаштування розширень-конекторів відбувається у застосунку **Camunda Modeler**. Перед початком роботи переконайтеся, що виконано всі передумови, описані у розділі xref:bp-modeling/bp/element-templates/element-templates-install.adoc[]. [#edr] == Розширення-конектори для отримання даних з ЄДР @@ -753,7 +737,7 @@ NOTE: Функція *`S(edrResponseBody, 'application/xml')`* повертає . Введіть назву задачі. Наприклад, `Переглянути дані з ЄДР`. . У полі `*ID*` введіть ідентифікатор задачі (`activity_id`). Наприклад, `*writeResultForm*`. -. У полі `*Form key*` введіть службову назву UI-форми вводу даних. Наприклад, `*soap-http-connector-edrpou-edr-result-view*`. +. У полі `*Form key*` введіть службову назву UI-форми перегляду отриманих даних. Наприклад, `*soap-http-connector-edrpou-edr-result-view*`. . У полі `Assignee` введіть токен ініціатора процесу -- `${initiator}`. . У полі `*Form data pre-population*` вкажіть як змінну об'єкт із параметрами, які необхідно передати на форму, -- `*${payload}*`. + diff --git a/docs/ua/modules/registry-develop/partials/nav.adoc b/docs/ua/modules/registry-develop/partials/nav.adoc index 0b2359e155..579b0308a0 100644 --- a/docs/ua/modules/registry-develop/partials/nav.adoc +++ b/docs/ua/modules/registry-develop/partials/nav.adoc @@ -176,7 +176,7 @@ **** xref:registry-develop:bp-modeling/bp/what-is-bp.adoc[Що таке бізнес-процеси: аналіз, структура і типи операцій] **** xref:registry-develop:bp-modeling/bp/bp-modeling-instruction.adoc[] **** xref:registry-develop:bp-modeling/bp/element-templates/element-templates-overview.adoc[] -//***** xref:registry-develop:bp-modeling/bp/element-templates/bp-element-templates-installation-configuration.adoc[] +***** xref:registry-develop:bp-modeling/bp/element-templates/element-templates-install.adoc[Встановлення типових розширень до бізнес-процесів (_для локальної розробки_)] ***** xref:registry-develop:bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc[] ****** xref:registry-develop:bp-modeling/bp/element-templates/user-task-templates/user-form.adoc[] ****** xref:registry-develop:bp-modeling/bp/element-templates/user-task-templates/officer-sign-task.adoc[]