Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(uib): Add Interact with Bonita page #2724

Merged
merged 10 commits into from
Jun 11, 2024
4 changes: 4 additions & 0 deletions modules/applications/pages/bonita-ui-builder.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]#]
jeromecambon marked this conversation as resolved.
Show resolved Hide resolved
--

[.card-section]
== How-tos
Expand Down
1 change: 1 addition & 0 deletions modules/applications/pages/download-and-launch.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Download and launch Documentation
:page-aliases: ROOT:download-and-launch.adoc
jeromecambon marked this conversation as resolved.
Show resolved Hide resolved
:description:

[NOTE]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,41 @@
= Interact with your Bonita process
:description:
:page-aliases: ROOT:interact-with-your-bonita-process.adoc
jeromecambon marked this conversation as resolved.
Show resolved Hide resolved
:description: Defines how to interact with a Bonita runtime using the REST APIs..

[NOTE]
====
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`. 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.
jeromecambon marked this conversation as resolved.
Show resolved Hide resolved

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].

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.