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

fix(2022.2): fix broken external links and broken anchors #2953

Open
wants to merge 47 commits into
base: 2022.2
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
1e0e413
START fix: fix broken external links and broken anchors
tbouffard Jan 8, 2025
377c5df
release-notes.adoc: fix broken anchors after move of API page to the …
tbouffard Jan 8, 2025
7503644
single-sign-on-with-oidc.adoc: do not generate url for host:port plac…
tbouffard Jan 8, 2025
e208a41
single-sign-on-with-saml.adoc: do not generate url for host:port plac…
tbouffard Jan 8, 2025
8f12d79
identity pages: fix broken links to keycloak documentation
tbouffard Jan 8, 2025
f15f574
custom-applications-index.adoc: fix broken anchor
tbouffard Jan 8, 2025
351b8c7
cmis.adoc: escape localhost URL
tbouffard Jan 8, 2025
5aba755
project-structure.adoc: use fixed anchor to connector-archetype-tutor…
tbouffard Jan 8, 2025
9932770
create-or-modify-a-page.adoc: use fixed anchors
tbouffard Jan 8, 2025
9a3f4ff
user-application-index.adoc: fix broken anchor
tbouffard Jan 8, 2025
3d320d9
use-gzip-compression.adoc: escape URL
tbouffard Jan 8, 2025
bc08aa5
shared-project.adoc: fix link to git book
tbouffard Jan 9, 2025
d1b11f7
fix link to git downloads
tbouffard Jan 9, 2025
339e85c
custom-library-development.adoc: fix anchor usage (use fixed value)
tbouffard Jan 9, 2025
2a8a87f
guest-user.adoc: escape example of URL that is not browsable
tbouffard Jan 9, 2025
9a04c76
ldap-synchronizer.adoc: escape example of URL that is not browsable
tbouffard Jan 9, 2025
a2c7743
single-sign-on-with-cas.adoc: escape example of URL that is not brows…
tbouffard Jan 9, 2025
5ff464d
single-sign-on-with-cas.adoc: fix URL to "CAS SSO RESTful API"
tbouffard Jan 9, 2025
d7f7994
fix link to auth api sources on GitHub
tbouffard Jan 9, 2025
ab49a07
fix link to loging api sources on GitHub
tbouffard Jan 9, 2025
f24feee
fix link to session api sources on GitHub
tbouffard Jan 9, 2025
2feee38
fix link to session api sources on GitHub
tbouffard Jan 9, 2025
df0fad8
fix link to session api sources on GitHub
tbouffard Jan 9, 2025
38a3d81
fix anchor to the languages.adoc page
tbouffard Jan 9, 2025
2be0f9f
enforce-password-policy.adoc: fix link to the github bonita-web repos…
tbouffard Jan 9, 2025
e988c34
how-a-bdm-is-deployed.adoc: fix link to javadoc
tbouffard Jan 9, 2025
60fb2d5
log-in-and-log-out.adoc: escape example of URL that is not browsable
tbouffard Jan 9, 2025
78f75d2
tomcat-bundle.adoc: fix bad anchors
tbouffard Jan 9, 2025
5754b61
custom-deployment.adoc: fix bad anchors
tbouffard Jan 9, 2025
466bbe8
connector-migration.adoc: fix bad anchors
tbouffard Jan 9, 2025
f92b8fe
using-list-and-search-methods.adoc: add missing anchor declaration
tbouffard Jan 9, 2025
ac58d87
cases.adoc: fix broken anchors
tbouffard Jan 9, 2025
265b1d6
healthcheck-mechanism.adoc: escape example of URL that is not browsable
tbouffard Jan 9, 2025
b7333c7
install-a-bonita-bpm-cluster.adoc: fix broken anchor
tbouffard Jan 9, 2025
d050fd5
install-a-bonita-bpm-cluster.adoc: fix broken anchors
tbouffard Jan 9, 2025
4ad63f3
Fix links to community Q&A home page
tbouffard Jan 9, 2025
7abc929
Fix links to community "projects" home page
tbouffard Jan 9, 2025
7fff96d
event-handlers.adoc: in the pom, remove the extra maven repo
tbouffard Jan 9, 2025
4684df3
reverse-proxy-configuration.adoc: add image to replace a broken remot…
tbouffard Jan 9, 2025
c18d3b1
database-configuration.adoc: fix URL to download MSSQL JDBC driver
tbouffard Jan 9, 2025
a4e7500
fix links to javadoc
tbouffard Jan 9, 2025
fe8024f
portal-removal.adoc: update links to the specific 2021.2 release note…
tbouffard Jan 9, 2025
40b701a
Optimised images with calibre/image-actions
github-actions[bot] Jan 9, 2025
232b15f
first-steps-after-setup.adoc: escape example of URL that is not brows…
tbouffard Jan 9, 2025
053cf9e
Do not use the "Bonita BPM" wording which is forbidden!
tbouffard Jan 9, 2025
da02bad
Merge branch '2022.2' into fix/2022.2_broken_links
tbouffard Jan 9, 2025
d46c01c
escape example of URLs that are not browsable
tbouffard Jan 9, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions modules/ROOT/pages/release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,14 @@ With the previous versions, creating a new environment required to set up the wh

=== Process and Case info REST API resources - *Subscription editions*

It is now possible to retrieve the tasks execution data of all open cases of a process by using the xref:api:actors-process-connectors-api.adoc#_processinfo_subscription_editions_only[`bpm/processInfo` REST API resource]. It returns counters for each flow node in the process, showing the number of flow node instances that are in executing, ready, or failed state.
It is now possible to retrieve the tasks execution data of all open cases of a process by using the xref:api:rest-api-overview.adoc[`bpm/processInfo` REST API resource]. It returns counters for each flow node in the process, showing the number of flow node instances that are in executing, ready, or failed state.

The REST API resource xref:api:cases-process-instance-api.adoc#_caseinfo_subscription_editions_only[Case info `bpm/caseInfo`] which is used for case visualization is now available in subscription editions only.
The REST API resource xref:api:rest-api-overview.adoc[Case info `bpm/caseInfo`] which is used for case visualization is now available in subscription editions only.
For Community users who update to 2022.2, if you have this business need, you can create a REST API extension that leverages Bonita Engine java API to get the same functionality as in Bonita 2022.2 - Subscription version.

=== Human task REST API resource

It is now possible to retrieve the tasks - pending or already assigned - for which a user is a potential candidate by combining the filters `user_id` and `show_assigned_to_others` of xref:api:activities-tasks-flow-nodes-api.adoc#_search_for_a_humantask[`bpm/humanTask` REST API resource].
It is now possible to retrieve the tasks - pending or already assigned - for which a user is a potential candidate by combining the filters `user_id` and `show_assigned_to_others` of xref:api:rest-api-overview.adoc[`bpm/humanTask` REST API resource].

== Technical updates

Expand Down Expand Up @@ -140,7 +140,7 @@ The detailed list is available in the "What’s new in Bonita 2022.1" page, in t

==== Fixes in Bonita Studio including Bonita UI Designer

* STUDIO-4515 - NPE generated during project migration
* STUDIO-4515 - NPE generated during project migration

=== Fixes in Bonita 2022.2-u9 (2024-04-18)

Expand Down Expand Up @@ -188,7 +188,7 @@ _We would like to thank both Tomas Castro Rojas and Mohammad A’mir for reporti
* STUDIO-4483 - BonitaMarketplace: NPE generated in the log file when the HTTP response's entity-body is empty
* STUDIO-4490 - Exception at runtime: the Call activity is wrong in the process-design.xml generated
* UID-723 - Update to 7.15: Web browser's disk and memory caches break the product and custom pages
* CVE-50 - Removing from the packaged maven repository an old vulnerable log4j library which wasn't executed
* CVE-50 - Removing from the packaged maven repository an old vulnerable log4j library which wasn't executed

==== Fixes in Bonita Runtime including Bonita Applications

Expand Down Expand Up @@ -306,7 +306,7 @@ Please note that, due to an https://github.com/hazelcast/hazelcast/issues/24688[
* RUNTIME-1477 - [admin-case-details] improve display of Started by information
* RUNTIME-1478 - [admin-task-details] improve display of Executed by information
* RUNTIME-1485 - Fix [SSO] Allow the usage of any claim of the ID token for the OIDC adapter to fetch the username value from
* RUNTIME-1486 - Fix [Rest API Extension][Java] Archetype generating bad InputStream management code
* RUNTIME-1486 - Fix [Rest API Extension][Java] Archetype generating bad InputStream management code
* RUNTIME-1489 - [Security] Version update of several dependencies for 2022.2-u1 (7.15.1)
* RUNTIME-1527 - Fix Platform API resources access should not need an API session along with the platform session
* RUNTIME-1545 - Fix [SSO] OIDC auto detect bearer only option breaking json requests
Expand Down
4 changes: 2 additions & 2 deletions modules/applications/pages/custom-applications-index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ It is created and operated within Bonita Platform: created with Bonita Studio an
Its purpose is to display and structure the right information and provide the right controls at the right time to the profiles, so they can efficiently perform their tasks. +

_Graphically_, an application is made of a navigation menu and a set of pages. In some of the pages, some controls, like -"Validate" or "Reject" buttons- are directly linked to processes and execute tasks in the background. Others -like "New request" or "Add additional information"- open forms that, once submitted start a new process instance, or execute a task. +
Bonita allows you to create xref:ROOT:bonita-purpose.adoc#_what_can_i_do_with_bonita[different types of applications]. +
Bonita allows you to create xref:ROOT:bonita-purpose.adoc[different types of applications]. +

_Structurally_, an application is made of various xref:ROOT:project-structure.adoc[elements]. Some are directly linked to the application (name, token, navigation), others are referenced (layout, pages, profiles, theme). They are all assembled in the application descriptor. +

Bonita comes with four xref:ROOT:bonita-applications-interface-overview.adoc[Bonita Applications]. +

We encourage our users to create their own *custom applications* so as to create the best user experience for their specific use-cases. +
We encourage our users to create their own *custom applications* to create the best user experience for their specific use-cases. +
The application can be put together by the citizen developer or a professional developer. +
You just need to make sure that all the elements have been developed before you can use them in the application descriptor. +
For testing purposes, Bonita provides a layout and several themes, before you create your own.
Expand Down
10 changes: 5 additions & 5 deletions modules/bonita-overview/pages/project-structure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ image:bonita-project-elements.png[]

[NOTE]
====
Using all the concepts in a projet allows to take the full advantage of the Bonita platform.
Using all the concepts in a project allows to take the full advantage of the Bonita platform.
However, it is not required to use all the concepts to create a valid Bonita Automation project.
====

Expand All @@ -35,7 +35,7 @@ However, it is not required to use all the concepts to create a valid Bonita Aut

|xref:process:actor-filtering.adoc[Actor filter]
|Filters users that can access a human task in a process
|A couple are provided in the Marketplace and you can create custom actor filters
|A couple is provided in the Marketplace and you can create custom actor filters
|Studio or xref:ROOT:actor-filter-archetype.adoc[Dedicated SDK] (custom actor filters)
|-

Expand All @@ -57,7 +57,7 @@ However, it is not required to use all the concepts to create a valid Bonita Aut
|Structure of the business data used by your processes
|Create
|Studio
|External data base w/ provided connector
|External database w/ provided connector

|===

Expand Down Expand Up @@ -111,7 +111,7 @@ Bonita Automation project can be extended by creating custom components. These a

Some extensions are used to add elements to those provided while others are used to enforce the Bonita platform possibilities.

Extensions can be developed outside of the Studio with your favorite IDE.
Extensions can be developed outside the Studio with your favorite IDE.

[cols="1,1,1"]
|===
Expand Down Expand Up @@ -144,5 +144,5 @@ In the Studio, extensions are managed in a xref:managing-extension-studio.adoc[d
[NOTE]
====
Even if it is possible to manually import extensions in Bonita Studio, it is highly recommended to publish your extensions on public or private maven repositories.
xref:process:connector-archetype-tutorial.adoc#_6__publish_the_connector_on_github_packages[Here] is an example on how to deploy an extension on Github packages.
xref:process:connector-archetype-tutorial.adoc#publish_connector_to_gh_packages[Here] is an example on how to deploy an extension on Github packages.
====
6 changes: 3 additions & 3 deletions modules/identity/pages/single-sign-on-with-oidc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -237,11 +237,11 @@ NOTE: Activating this option means any user authorized by the IdP to access Boni
[NOTE]
====
More configuration options can be found in https://www.keycloak.org/docs/18.0/securing_apps/#_java_adapter_config[Keycloak official documentation]
More configuration options can be found in https://www.keycloak.org/docs/21.1.2/securing_apps/#_java_adapter_config[Keycloak official documentation]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought: decide if we introduce an AsciiDoc attribute to handle the base URL

====

Once your Identity Provider is correctly configured (see the section _Configure the Identity Provider_), try to access any Bonita Application page, an app page or a form URL (or just `http://<host>:<port>/bonita[?tenant=<tenantId>]`) and make sure that you are redirected to your Identity Provider to log in (unless you are already logged in). +
Note that if you try to access `http://<bundle host>:<port>/bonita/login.jsp`, then you won't be redirected to the OIDC provider's authentication end point since this page needs to be accessible for the tenant administrator (or another user if you set the property `oidc.auth.standard.allowed` to `true`) to be able to log in without an account on the Identity Provider.
Once your Identity Provider is correctly configured (see the section _Configure the Identity Provider_), try to access any Bonita Application page, an app page or a form URL (or just `+http://<host>:<port>/bonita[?tenant=<tenantId>]+`) and make sure that you are redirected to your Identity Provider to log in (unless you are already logged in). +
Note that if you try to access `+http://<host>:<port>/bonita/login.jsp+`, then you won't be redirected to the OIDC provider's authentication end point since this page needs to be accessible for the tenant administrator (or another user if you set the property `oidc.auth.standard.allowed` to `true`) to be able to log in without an account on the Identity Provider.

[WARNING]
====
Expand Down
6 changes: 3 additions & 3 deletions modules/identity/pages/single-sign-on-with-saml.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ If your IdP responses are not signed, you can remove the Keys node from the IDP

[NOTE]
====
More configuration options can be found in https://www.keycloak.org/docs/latest/securing_apps/index.html#_saml-general-config[Keycloak official documentation]
More configuration options can be found in https://www.keycloak.org/docs/21.1.2/securing_apps/index.html#_saml-general-config[Keycloak official documentation]
====

[source,xml]
Expand Down Expand Up @@ -272,8 +272,8 @@ More configuration options can be found in https://www.keycloak.org/docs/latest/
</keycloak-saml-adapter>
----

Once your Identity Provider is corectly configured (see the section _Configure the Identity Provider_), try to access any Bonita Application page, an app page or a form URL (or just `http://<host>:<port>/bonita[?tenant=<tenantId>]`) and make sure that you are redirected to your Identity Provider to log in (unless you are already logged in). +
Note that if you try to access `http://<bundle host>:<port>/bonita/login.jsp`, then you won't be redirected as this page still needs to be accessible in order for the tenant administrator (or another user if you set the property `saml.auth.standard.allowed` to true) to be able to log in without an account on the Identity Provider.
Once your Identity Provider is corectly configured (see the section _Configure the Identity Provider_), try to access any Bonita Application page, an app page or a form URL (or just `+http://<host>:<port>/bonita[?tenant=<tenantId>]+`) and make sure that you are redirected to your Identity Provider to log in (unless you are already logged in). +
Note that if you try to access `+http://<host>:<port>/bonita/login.jsp+`, then you won't be redirected as this page still needs to be accessible in order for the tenant administrator (or another user if you set the property `saml.auth.standard.allowed` to true) to be able to log in without an account on the Identity Provider.

[WARNING]
====
Expand Down
22 changes: 11 additions & 11 deletions modules/pages-and-forms/pages/create-or-modify-a-page.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
== User Interfaces development overview

Your automation project can use xref:ROOT:pages.adoc[pages] to display information and provide interaction controls to the end-users or administrators. +
It most of the times uses xref:forms.adoc[forms] to display and collect new or edited information. +
It most of the time uses xref:forms.adoc[forms] to display and collect new or edited information. +
Forms and pages are made of containers and widgets. +
Some containers and widgets can be grouped in xref:ROOT:fragments.adoc[fragments], in order to be reused in several pages or forms. +

Expand All @@ -21,7 +21,7 @@ Developers can xref:applications:customize-living-application-theme.adoc[create

Bonita UI Designer comes with a set of xref:ROOT:widgets.adoc[provided containers and widgets]. +
xref:custom-widgets.adoc[Custom widgets] can also be created to make the palette richer. +
Those are developped by professional developers, from scratch or from an https://community.bonitasoft.com/project[existing project] of the Community. +
Those are developed by professional developers, from scratch or from an https://community.bonitasoft.com/project[existing project] of the Community. +

The following chapters give more information on how to develop all the others elements in the UI Designer.

Expand All @@ -44,13 +44,13 @@ For more technical information about the forms, visit xref:ROOT:forms-developmen

== Create a page

xref:ROOT:pages.adoc[Pages] are created independently from the processes. They are used to display business information that group several processes and several instances of the processes in an efficient view, a list of requests, for example. +
xref:ROOT:pages.adoc[Pages] are created independently of the processes. They are used to display business information that group several processes and several instances of the processes in an efficient view, a list of requests, for example. +
The controls they embed (buttons, links) can call BPM APIs that will trigger the display of the process instantiation form, or the execution of a task.

=== From scratch
. From Bonita Studio coolbar, click on the *_UI Designer_* icon to open the UI Designer. +
. Click on the *_Create_* button
. In the pop up, choose the element to create
. In the pop-up, choose the element to create
. Give it a name
. Click on the *_Create_* button
. In the page editor, drag and drop the widgets, fragments, or BDM objects to create the right user interface
Expand All @@ -61,7 +61,7 @@ You can easily duplicate an exiting page just by saving it under a different nam
. From Bonita Studio coolbar, click on the *_UI Designer_* icon to open the UI Designer. +
. Open the page you want to duplicate
. Click on the *_Save_* button and select *_Save as_*
. In the pop up, choose the element to create (new page or form)
. In the pop-up, choose the element to create (new page or form)
. Give it a name
. Click on the *_Save_* button

Expand All @@ -72,14 +72,14 @@ Only Bonita pages created with the UI Designer can be customized in the UI Desig
To customize a page provided by Bonita:

. From Bonita Studio coolbar, click on the *_Applications_* icon, and open the *_Administrator Application_*
. Go to the *_Resources_* menu, find the page, and and check its description to make sure it is a page done with Bonita UI Designer
. Go to the *_Resources_* menu, find the page, and check its description to make sure it is a page done with Bonita UI Designer
. Export the page
. From Bonita Studio coolbar, click on the *_UI Designer_* icon to open Bonita UI Designer
. Import the page in the UI Designer

Note that by doing so, if the page embed fragments and custom widgets, they are also imported and added to the UI Designer palette.

You can find the list of pages ready for customization in a xref:ROOT:pages.adoc#_List_of_Bonita_Applications_customizable_pages[dedicated documentation page].
You can find the list of pages ready for customization in a xref:ROOT:pages.adoc#list_bonita_application_customizable_pages[dedicated documentation page].

For more technical information about the pages, visit xref:ROOT:pages-development.adoc[the dedicated documentation page].

Expand All @@ -101,7 +101,7 @@ For more technical information about the pages, visit xref:ROOT:pages-developmen

. In Bonita Studio, go to the _Project Explorer_
. Open the project, and the _Pages/Forms/Layouts_ section
. Double click on _Bonita layout_. This automatically opens the UI Designer with the layout ready to edit.
. Double-click on _Bonita layout_. This automatically opens the UI Designer with the layout ready to edit.
. Edit it and save it with another name

=== From scratch
Expand Down Expand Up @@ -135,7 +135,7 @@ You can display your page, layout, form or fragment with one of your theme appli

From the preview window, you can also expand the preview outside of current preview mechanism, with the *Expand Preview in new window* button. This allows you to set new URL parameters, play with dynamic browser sizing, and to reuse same url in another browser to see how your form or page behaves in your user default browser. +

You can use the a device types bar on the preview screen to choose the target device type. +
You can use the device types bar on the preview screen to choose the target device type. +
The preview displays the element as it would be displayed on the selected type of device. +

[#export]
Expand All @@ -147,7 +147,7 @@ You can export any element to import it into another UI Designer. +

To export an element, click the *_Export_* button image:images-6_0/pb-export.png[Export button] on the Page editor or the UI Designer home page. A zip file is downloaded to your computer. It contains a Bonita custom page, which is also suitable for import into another UI Designer. +

After export you can modify your page or layout code by directly editing the code located in _resources_ folder. Be aware that such a modification to the code will work when the page or layout is deployed in the Bonita Runtime, but it may be broken if you import the page into another UI Designer.
After export, you can modify your page or layout code by directly editing the code located in _resources_ folder. Be aware that such a modification to the code will work when the page or layout is deployed in the Bonita Runtime, but it may be broken if you import the page into another UI Designer.

To import elements in another Studio, you can export pages and forms in the process `.bos` file. In the list of elements to insert in the .bos file, forms are checked by default, but not pages. When you import this `.bos` file into another Bonita Studio, forms and pages that you have checked are available in the UI Designer of that Studio.

Expand All @@ -165,7 +165,7 @@ An element that has not been designed with the UI Designer cannot be imported in
== Pages and forms in .bos/.bar file

When you generate the `.bar` file of a process, the mapped forms created with the UI Designer are embedded in the file. +
Application pages are not embedded as they are independant from the process. +
Application pages are not embedded as they are independent of the process. +
When the .bar file is deployed, forms are deployed too. +

Applications and its elements must be deployed onto the target environment. This can be done manually from the Super Administrator or Administrator applications, in the *_Applications_* and *_Resources_* menu options. It can also be done automatically through the automation of the project builds and deployment.
Expand Down
Loading