From 19b9db1051a6d5bb2da28477d986830e1059067f Mon Sep 17 00:00:00 2001 From: Jerome Cambon Date: Mon, 10 Jun 2024 17:58:11 +0200 Subject: [PATCH 1/8] feat(uib): Add Interact with Bonita page --- .../interact-with-your-bonita-process.adoc | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/modules/applications/pages/interact-with-your-bonita-process.adoc b/modules/applications/pages/interact-with-your-bonita-process.adoc index 2077fa6052..cc015a4914 100644 --- a/modules/applications/pages/interact-with-your-bonita-process.adoc +++ b/modules/applications/pages/interact-with-your-bonita-process.adoc @@ -5,3 +5,36 @@ ==== For Subscription editions only. ==== + +== Create a Bonita datasource +From a page in edit mode, click the `Data` icon from the left panel. +Then, you get the list of the provided datasources. + +From the `APIs` section, click on the `Bonita API`: + +- The `Default` mode allows to connect to the Bonita runtime running on the local machine +- The `Advanced` mode allows to connect to a remote Bonita runtime + +== Create a Bonita API +Once the datasource is saved, you can create a new API, and interact with the Bonita runtime with the xref:api:rest-api-overview.adoc[REST APIs]. + +For instance, to get the list of the processes deployed on the Bonita runtime (first 10), you can create a new API with the following configuration: + +* `Method`: GET +* `URL`: /bonita/API/bpm/process +* `Params`: + - `Key`: p + - `Value`: 0 + - `Key`: c + - `Value`: 10 + +Then, click on `Run` to test the API and see the result in the `Response` tab. + +[NOTE] +==== +The authentication to the Bonita runtime is automatically handled by the Bonita datasource. +==== + +Then, you can use the `Table` widget to display the list of the processes in your application. + + From e412df5f092a2c70f63487953be6e08b740c2207 Mon Sep 17 00:00:00 2001 From: Jerome Cambon Date: Mon, 10 Jun 2024 18:07:13 +0200 Subject: [PATCH 2/8] Provide more info for datasource creation --- .../pages/interact-with-your-bonita-process.adoc | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/modules/applications/pages/interact-with-your-bonita-process.adoc b/modules/applications/pages/interact-with-your-bonita-process.adoc index cc015a4914..ff98f4bc1c 100644 --- a/modules/applications/pages/interact-with-your-bonita-process.adoc +++ b/modules/applications/pages/interact-with-your-bonita-process.adoc @@ -12,8 +12,12 @@ Then, you get the list of the provided datasources. From the `APIs` section, click on the `Bonita API`: -- The `Default` mode allows to connect to the Bonita runtime running on the local machine -- The `Advanced` mode allows to connect to a remote Bonita runtime +* The `Default` mode allows to connect to the Bonita runtime running on the local machine + - No need to provide any information +* The `Advanced` mode allows to connect to a remote Bonita runtime + - You need to provide the `URL`, `Username` and `Password` of the Bonita runtime + +Then, click on the `Save` button to save the datasource. == Create a Bonita API Once the datasource is saved, you can create a new API, and interact with the Bonita runtime with the xref:api:rest-api-overview.adoc[REST APIs]. From 3db32ddf3c37b9e187848decc46ac492265e128f Mon Sep 17 00:00:00 2001 From: Jerome Cambon Date: Mon, 10 Jun 2024 18:19:20 +0200 Subject: [PATCH 3/8] Adding card --- modules/applications/pages/bonita-ui-builder.adoc | 4 ++++ .../applications/pages/interact-with-your-bonita-process.adoc | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/modules/applications/pages/bonita-ui-builder.adoc b/modules/applications/pages/bonita-ui-builder.adoc index 7eb73e3fdc..c564fe8d03 100644 --- a/modules/applications/pages/bonita-ui-builder.adoc +++ b/modules/applications/pages/bonita-ui-builder.adoc @@ -13,6 +13,10 @@ They are not anymore standalone elements (such as pages and forms) in a process xref:ROOT:builder-declare-interface-in-bonita.adoc[[.card-title]#Declare the interface in Bonita# [.card-body.card-content-overflow]#pass:q[Steps to declare your interface and display it in Bonita]#] -- +[.card.card-index] +-- +xref:ROOT:interact-with-your-bonita-process.adoc[[.card-title]#Interact with your Bonita process# [.card-body.card-content-overflow]#pass:q[Steps to interact with your Bonita process]#] +-- [.card-section] == How-tos diff --git a/modules/applications/pages/interact-with-your-bonita-process.adoc b/modules/applications/pages/interact-with-your-bonita-process.adoc index ff98f4bc1c..051ccff85c 100644 --- a/modules/applications/pages/interact-with-your-bonita-process.adoc +++ b/modules/applications/pages/interact-with-your-bonita-process.adoc @@ -1,5 +1,6 @@ = Interact with your Bonita process -:description: +:page-aliases: ROOT:interact-with-your-bonita-process.adoc +:description: Defines how to interact with a Bonita runtime using the REST APIs.. [NOTE] ==== From 5bb295f699e2518084288c37acf6844289f86aaa Mon Sep 17 00:00:00 2001 From: Jerome Cambon Date: Tue, 11 Jun 2024 10:13:58 +0200 Subject: [PATCH 4/8] Remove Advanced mode --- modules/applications/pages/download-and-launch.adoc | 1 + .../pages/interact-with-your-bonita-process.adoc | 8 ++------ 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/modules/applications/pages/download-and-launch.adoc b/modules/applications/pages/download-and-launch.adoc index 1109093037..b3f463137c 100644 --- a/modules/applications/pages/download-and-launch.adoc +++ b/modules/applications/pages/download-and-launch.adoc @@ -1,4 +1,5 @@ = Download and launch Documentation +:page-aliases: ROOT:download-and-launch.adoc :description: [NOTE] diff --git a/modules/applications/pages/interact-with-your-bonita-process.adoc b/modules/applications/pages/interact-with-your-bonita-process.adoc index 051ccff85c..fce26bb9f2 100644 --- a/modules/applications/pages/interact-with-your-bonita-process.adoc +++ b/modules/applications/pages/interact-with-your-bonita-process.adoc @@ -11,12 +11,8 @@ For Subscription editions only. From a page in edit mode, click the `Data` icon from the left panel. Then, you get the list of the provided datasources. -From the `APIs` section, click on the `Bonita API`: - -* The `Default` mode allows to connect to the Bonita runtime running on the local machine - - No need to provide any information -* The `Advanced` mode allows to connect to a remote Bonita runtime - - You need to provide the `URL`, `Username` and `Password` of the Bonita runtime +From the `APIs` section, click on the `Bonita API`. By default, it will connect to the Bonita runtime running on the local machine. No need to provide any credential information, +since they are already provided at the xref:ROOT:download-and-launch.adoc[Download and launch] step. Then, click on the `Save` button to save the datasource. From 860aa4ef920b1a67e08b79e2e25fbc7f041c279c Mon Sep 17 00:00:00 2001 From: jeromecambon Date: Tue, 11 Jun 2024 16:26:10 +0200 Subject: [PATCH 5/8] Update modules/applications/pages/download-and-launch.adoc Co-authored-by: Benjamin Parisel --- modules/applications/pages/download-and-launch.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/applications/pages/download-and-launch.adoc b/modules/applications/pages/download-and-launch.adoc index b3f463137c..1109093037 100644 --- a/modules/applications/pages/download-and-launch.adoc +++ b/modules/applications/pages/download-and-launch.adoc @@ -1,5 +1,4 @@ = Download and launch Documentation -:page-aliases: ROOT:download-and-launch.adoc :description: [NOTE] From 75ff2e30dff12ff24858d23890409f00041a7765 Mon Sep 17 00:00:00 2001 From: jeromecambon Date: Tue, 11 Jun 2024 16:26:35 +0200 Subject: [PATCH 6/8] Update modules/applications/pages/interact-with-your-bonita-process.adoc Co-authored-by: Benjamin Parisel --- .../applications/pages/interact-with-your-bonita-process.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/applications/pages/interact-with-your-bonita-process.adoc b/modules/applications/pages/interact-with-your-bonita-process.adoc index fce26bb9f2..b278e210b3 100644 --- a/modules/applications/pages/interact-with-your-bonita-process.adoc +++ b/modules/applications/pages/interact-with-your-bonita-process.adoc @@ -1,5 +1,4 @@ = Interact with your Bonita process -:page-aliases: ROOT:interact-with-your-bonita-process.adoc :description: Defines how to interact with a Bonita runtime using the REST APIs.. [NOTE] From f0441208e66b8d4b83024661a91bc8d595966226 Mon Sep 17 00:00:00 2001 From: Jerome Cambon Date: Tue, 11 Jun 2024 16:28:40 +0200 Subject: [PATCH 7/8] Fix reference --- .../applications/pages/interact-with-your-bonita-process.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/applications/pages/interact-with-your-bonita-process.adoc b/modules/applications/pages/interact-with-your-bonita-process.adoc index b278e210b3..971474b375 100644 --- a/modules/applications/pages/interact-with-your-bonita-process.adoc +++ b/modules/applications/pages/interact-with-your-bonita-process.adoc @@ -11,7 +11,7 @@ From a page in edit mode, click the `Data` icon from the left panel. Then, you get the list of the provided datasources. From the `APIs` section, click on the `Bonita API`. By default, it will connect to the Bonita runtime running on the local machine. No need to provide any credential information, -since they are already provided at the xref:ROOT:download-and-launch.adoc[Download and launch] step. +since they are already provided at the xref:download-and-launch.adoc[Download and launch] step. Then, click on the `Save` button to save the datasource. From 70490cd82346c5a082b724ff6fde143db184cd4c Mon Sep 17 00:00:00 2001 From: Jerome Cambon Date: Tue, 11 Jun 2024 16:50:18 +0200 Subject: [PATCH 8/8] Fix reference --- modules/applications/pages/bonita-ui-builder.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/applications/pages/bonita-ui-builder.adoc b/modules/applications/pages/bonita-ui-builder.adoc index c564fe8d03..8a242e5cb1 100644 --- a/modules/applications/pages/bonita-ui-builder.adoc +++ b/modules/applications/pages/bonita-ui-builder.adoc @@ -15,7 +15,7 @@ xref:ROOT:builder-declare-interface-in-bonita.adoc[[.card-title]#Declare the int [.card.card-index] -- -xref:ROOT:interact-with-your-bonita-process.adoc[[.card-title]#Interact with your Bonita process# [.card-body.card-content-overflow]#pass:q[Steps to interact with your Bonita process]#] +xref:interact-with-your-bonita-process.adoc[[.card-title]#Interact with your Bonita process# [.card-body.card-content-overflow]#pass:q[Steps to interact with your Bonita process]#] -- [.card-section]