Skip to content

Commit

Permalink
Merge branch '2024.3' into patch-16
Browse files Browse the repository at this point in the history
  • Loading branch information
marcobonita authored Jun 26, 2024
2 parents 7aa43d6 + ace43d0 commit 31596f9
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 19 deletions.
1 change: 1 addition & 0 deletions modules/ROOT/pages/release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Available in all Scale subscription and as a payable add-on in Convert subscript
=== Application Links

You can now use application links. See xref:applications:bonita-ui-builder.adoc[Applications with Bonita UI Builder] for more details. Community users can also integrate their own links for applications developed with other tools.
See xref:applications:faq.adoc[FAQ] for common problems and solutions (e.g. if you use a customized or an old layout).

xref:api:engine-api-overview.adoc[Engine APIs] that allowed applications manipulation still work with legacy applications and have been deprecated in favor of new APIs that manipulate both application links and legacy applications.

Expand Down
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.
Binary file not shown.
20 changes: 18 additions & 2 deletions modules/applications/pages/faq.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,23 @@
= FAQ
:description:
:description:Find here the answers to the frenquently asked questions about Bonita UI Builder and Application Links.

== My application link is incorrect when accessing the Application Directory from my custom application.

image::images/app-link/incorrectAppLink.gif[Application has incorrect Link]

If you have customized e.g. the Bonita User Application, you may be using an old version of the layout.

image::images/app-link/issueOldLayout.png[Application with old layout]

In that case, the Application Directory opened from that application only will not display Application Links correctly, but the same way as Legacy Applications. +
Fix this by using `custompage_layoutBonita` as the layout value, which will automatically migrate to the latest layout.

You may also encounter this issue if you use a xref:applications:customize-layouts.adoc[customized layout] instead of the official one. In that case, update your application's layout by re-applying your modifications to the latest layout version that implements the improvements for Application Links.

The same applies to the Application directory page that is used in the default application directory app: if you use a customized version of it, you need to re-apply your changes on the latest version packaged with Bonita runtime.


[NOTE]
====
For Subscription editions only.
Bonita UI Builder is for Subscription editions only.
====
28 changes: 11 additions & 17 deletions modules/applications/pages/interact-with-your-bonita-process.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,24 @@
{description}


== Pre-requisites
== Pre-requisites
* Bonita UI Builder downloaded and launched
* Bonita Studio version {bonitaVersion} or any later version
* A running Bonita project with a defined process diagram, BDM, and contract. Follow the xref:getting-started:getting-started-index.adoc[Getting Started tutorial] if you need any help


== Create a Bonita datasource
From a page in edit mode, click the `Data` icon from the left panel then click the `+` button to add a datasource in the workspace.

You get the list of the provided datasources. On 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:download-and-launch.adoc[Download and launch] step.

Then, click on the `Save` button to save the datasource.

image::images/interact-with-your-bonita-process/create-datasource.gif[create-datasource]

== Interact with Bonita API
You can interact with the Bonita runtime using the xref:api:rest-api-overview.adoc[REST APIs] through the default "Bonita API" datasource.

== Create Bonita API requests
Once the datasource is saved, you can create API requests and interact with the Bonita runtime with the xref:api:rest-api-overview.adoc[REST APIs].

You can create API requests and interact with the Bonita runtime with the xref:api:rest-api-overview.adoc[REST APIs].
We will describe below how you can for example get a list of Bonita processes, and instantiate one of them.

=== Get a list of processes
To get the list of the processeses deployed on the Bonita runtime (first 10): click the `Editor` icon from the left panel, click the `Queries` tab, then click the `new query / API` button and select the Bonita datasource created previously.
To get the list of the processeses deployed on the Bonita runtime (first 10): click the `Editor` icon from the left panel, click the `Queries` tab, then click the `new query / API` button and select the Bonita datasource created previously.
Enter the following configuration:

* `Name`: getProcess
* `Method`: GET
* `URL`: /bonita/API/bpm/process
* `Params`:
Expand All @@ -47,11 +40,12 @@ image::images/interact-with-your-bonita-process/get-process.gif[get-process]
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.

=== Instantiate a process
Now, we will instantiate one of the processes with what the user typed in the form we created xref:create-an-interface.adoc[previously].
Now, we will instantiate one of the processes with what the user typed in the form we created xref:create-an-interface.adoc[previously].

Click the `Editor` icon from the left panel, click the `Queries` tab, then click the `new query / API` button and select the Bonita datasource created previously.
Click the `Editor` icon from the left panel, click the `Queries` tab, then click the `new query / API` button and select the Bonita datasource created previously.
Enter the following configuration:

* `Name`: instantiateProcess
Expand All @@ -62,7 +56,7 @@ Enter the following configuration:
- `Value`: 0
- `Key`: c
- `Value`: 10
* `Body`:
* `Body`:
[source, JSON]
----
{{
Expand All @@ -75,7 +69,7 @@ Enter the following configuration:
----


This API will instantiate the first process returned by `getProcess` with the `body` 's content.
This API will instantiate the first process returned by `getProcess` with the `body` 's content.

[NOTE]
====
Expand Down

0 comments on commit 31596f9

Please sign in to comment.