Skip to content

Commit

Permalink
[EDP-DDM-28658] github: updated bp-modeling section, added bp-element…
Browse files Browse the repository at this point in the history
…-temp-install.adoc, updated connectors-external-registry.adoc, added other fixes, aligned en-ua versions

Change-Id: I2bad9b17e96a44ab35044738d08f25321cd92e55
(cherry picked from commit f46a95932a827c249b79cdbf1d3d8f9a4e1da584)
  • Loading branch information
[email protected] committed Oct 10, 2023
1 parent 166687a commit 13029fc
Show file tree
Hide file tree
Showing 23 changed files with 557 additions and 1,274 deletions.
2 changes: 1 addition & 1 deletion docs/en/modules/ROOT/partials/admonitions/ua-specific.adoc
Original file line number Diff line number Diff line change
@@ -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.
Please consult the local guidelines or documentation if you are implementing this outside Ukraine.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -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[]
Original file line number Diff line number Diff line change
@@ -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]
[%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[Типові розширення для інтеграції з іншими реєстрами на Платформі]
====
Original file line number Diff line number Diff line change
@@ -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[].
====
====

== 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]
Original file line number Diff line number Diff line change
@@ -1 +1,42 @@
= Service task extensions
= 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[]



Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= User task extensions
:sectanchors:
:sectlinks:

include::platform:ROOT:partial$admonitions/language-en.adoc[]

== Section overview
Expand All @@ -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[Встановлення каталогу типових розширень до бізнес-процесів].
====
////

Loading

0 comments on commit 13029fc

Please sign in to comment.