Skip to content

Commit

Permalink
refactor: move images of the "runtime" module
Browse files Browse the repository at this point in the history
The images were stored in the Antora legacy folder (assets/images) and included an extra "images" sub-folder.
All images are now in the "images" folder of the module, which is the standard Antora folder.

Covers bonitasoft/bonita-documentation-site#620
  • Loading branch information
benjaminParisel committed Nov 29, 2024
1 parent 3b06a7c commit e278211
Show file tree
Hide file tree
Showing 69 changed files with 55 additions and 55 deletions.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion modules/runtime/pages/admin-application-groups-list.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ To easily manipulate users with the same rights, it is possible to group them to
Groups can be defined in the organization, users can then be added to groups, and groups can be used to map actors or profiles or other permissions in Bonita.

Here is a view of this page:
image:images/UI2021.1/admin-application-groups-list.png[Group list in Bonita Administrator Application]
image:UI2021.1/admin-application-groups-list.png[Group list in Bonita Administrator Application]

On this page, an Administrator can:

Expand Down
2 changes: 1 addition & 1 deletion modules/runtime/pages/admin-application-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Creating your adminstrator application based on Bonita Administrator Application

From Bonita Studio *Welcome page* _Resources_ tile, click on "Import Bonita Admin Application".

image::images/UI2021.1/studio-get-application.png[Get application from Studio]
image::UI2021.1/studio-get-application.png[Get application from Studio]

You can also get it from our https://github.com/bonitasoft/bonita-admin-application/[Admin Application GitHub repository]. +
There are two ways to get the .bos file. You can either get it from the _Releases_ on the right or by cloning the repository of your choice and building it using maven. +
Expand Down
2 changes: 1 addition & 1 deletion modules/runtime/pages/admin-application-process-list.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Those users can: install, enable and edit processes, categories, forms, entities

Here is a view of the Process list page:

image:images/UI2021.1/admin-application-process-list.png[Bonita Administrator Application Process list]
image:UI2021.1/admin-application-process-list.png[Bonita Administrator Application Process list]

== Install a new process

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This page defines the term "Resources" and explains what a user with the _Admini
_Administrators_ can view a list of the resources filtered by type, search a resource by its name, install new resources, update existing resources, or delete resources.

Here is a view of the page:
image:images/UI2021.1/admin-application-resources-list.png[Administrator Resources]
image:UI2021.1/admin-application-resources-list.png[Administrator Resources]

== Resource definition

Expand Down
2 changes: 1 addition & 1 deletion modules/runtime/pages/admin-application-task-list.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A flow node is an element of a process. It defines an action to be performed (au
Those users can view the list of flow nodes in error, pending tasks, done tasks, assign and unassign a task, do a task for someone else, skip a failed flow node, replay a failed flow node, and write a comment about the case.

Here is a view of the task list:
image:images/UI2021.1/admin-application-task-list.png[Task list Administrator Application]
image:UI2021.1/admin-application-task-list.png[Task list Administrator Application]

== View tasks and flow nodes

Expand Down
2 changes: 1 addition & 1 deletion modules/runtime/pages/admin-application-users-list.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
This page explains what a user with the _Administrator_ profile can see and do about the users (of the organization) in xref:admin-application-overview.adoc[Bonita Administrator Application].

Here is a view of this page:
image:images/UI2021.1/admin-application-users-list.png[Administrator user list Portal]
image:UI2021.1/admin-application-users-list.png[Administrator user list Portal]

== View user's detailed information

Expand Down
4 changes: 2 additions & 2 deletions modules/runtime/pages/applications.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
{description} +

Here is a view of the page:
image:images/UI2021.1/admin_applications.png[Administrator Applications]
image:UI2021.1/admin_applications.png[Administrator Applications]

== Application definition

Expand Down Expand Up @@ -124,7 +124,7 @@ To update the navigation:
. Click the _Edit_ icon for the application you want to edit. The application details page is displayed.
. In the _Navigation_ zone, at top level, you can define one-page menus that point directly to pages (like Home in the illustration), or multi-page menus (like Holidays).

image::images/images-6_0/living_app_navigation.png[Specifying application navigation]
image:images-6_0/living_app_navigation.png[Specifying application navigation]

If you define a multi-page menu, you can add menu items (like Trekking and Safari).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Processes using Business Objects with persisted data need to run with a Business
On top of that, it is possible to define access rights on some attributes of business objects based on the user profile. This file is also managed in the Bonita Super Administrator Application.

Here is a view of the page:
image:images/UI2021.1/bdm-management.png[BDM in UI]
image:UI2021.1/bdm-management.png[BDM in UI]

== Manage the BDM

Expand Down
10 changes: 5 additions & 5 deletions modules/runtime/pages/bonita-as-windows-service.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Choose the "32-bit/64-bit Windows Service Installer" installation.
* *_Install_* apache-tomcat-x.y.exe. From now on we'll call the installation path as %TOMCAT_INSTALL_FOLDER%
* *_Verify_* that Tomcat is well installed browsing the following URL: http://localhost:8080

image::images/bonita-as-windows-service/tomcatHome.png[Tomcat home page]
image::bonita-as-windows-service/tomcatHome.png[Tomcat home page]

* *_Download_* the bundle BonitaSubscription-VERSION.zip (or BonitaCommunity-VERSION.zip for the community edition)
* *_Unzip_* the bundle in a folder that we'll call: %TOMCAT_BUNDLE%
Expand All @@ -43,12 +43,12 @@ image::images/bonita-as-windows-service/tomcatHome.png[Tomcat home page]
* Follow the documentation xref:ROOT:database-configuration.adoc#postgres_setup[here] to correctly prepare the PostgreSQL database
* *_Configure_* the file `%TOMCAT_BUNDLE%/setup/database.properties` to point towards the suited database (engine and BDM)

image::images/bonita-as-windows-service/databaseProperties.png[database-properties file]
image::bonita-as-windows-service/databaseProperties.png[database-properties file]

* *_Execute_* the command "%TOMCAT_BUNDLE%/setup/setup.bat init" in order to initialize the Bonita database with the default configuration.
* *_Verify_* that setup tool properly created the tables in the engine database.

image::images/bonita-as-windows-service/postgresTables.png[database tables]
image::bonita-as-windows-service/postgresTables.png[database tables]

* *_Execute_* the command "%TOMCAT_BUNDLE%/setup/setup.bat configure" in order to configure file in the %TOMCAT_BUNDLE%.
Those files will be copied to the tomcat installation.
Expand Down Expand Up @@ -119,14 +119,14 @@ Then for example

is correct

image::images/bonita-as-windows-service/tomcatw.png[tomcatw configuration]
image::bonita-as-windows-service/tomcatw.png[tomcatw configuration]

* Setup `+%TOMCAT_INSTALL_FOLDER%/bin/Tomcat9w.exe -> Java+` \-> "Initial memory" with a proper value based on your hardware and project requirements.
* Do the same with "Maximum Memory pool" property.
As an example, if your Operating system has 8 GB of ram you could setup Initial Memory Pool = Maximum Memory Pool = 4096.
* Verify that in the Startup tab the "Mode" property is set to "Jvm".

image::images/bonita-as-windows-service/tomcatWStartup.png[tomcatw startup tab]
image::bonita-as-windows-service/tomcatWStartup.png[tomcatw startup tab]

== System restart and test

Expand Down
2 changes: 1 addition & 1 deletion modules/runtime/pages/cases.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Those users can view a list of open or archived cases, as well as cases with fai
NOTE: Starting with Bonita 2022.2, bpmn-visualization library of https://process-analytics.dev/[Bonita's Process Analytics project] has been integrated in process and case visualization diagram.

Here is a view of the page:
image:images/UI2021.1/admin-case-list.png[Admin Case list]
image:UI2021.1/admin-case-list.png[Admin Case list]

== View the status of cases

Expand Down
4 changes: 2 additions & 2 deletions modules/runtime/pages/connectors-execution.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Connectors are extension points that can be added to a process to extend Bonita

Connectors execution are triggered by a `Work` and are executed in their own thread pool.

image::images/connector_execution.png[Connector execution]
image::connector_execution.png[Connector execution]

=== Connector timeout

Expand All @@ -28,7 +28,7 @@ If the code executing in the thread cannot be interrupted, the thread will not s
In practice, it means that in this case, the connector will timeout, releasing the execution of the task that called it, but the connector executor will still try to finish executing the connector's code, and will not be available to execute another connector.
A typical example of this is if the custom code in a groovy connector falls into an infinite loop : the connector will timeout, but the connector executor will be running forever.

image::images/connector_execution_timeout.png[Connector execution with timeout]
image::connector_execution_timeout.png[Connector execution with timeout]

=== Connector failure handling

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This page explains what a user with the _Administrator_ profile in Bonita Portal
Administrators can view and update Custom User Information.

Here is a view of this page:
image:images/UI2021.1/custom-user-info.png[Custom User Information UI]
image:UI2021.1/custom-user-info.png[Custom User Information UI]
// {.img-responsive}

== Overview
Expand Down
2 changes: 1 addition & 1 deletion modules/runtime/pages/embed-engine.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

[WARNING]
====
image:images/bonita-lab-icon.png[] This is a Lab feature and is subject to change without warning in any version. It is not recommended for production.
image:bonita-lab-icon.png[] This is a Lab feature and is subject to change without warning in any version. It is not recommended for production.
====

Starting from version 7.9.0, new artifacts allow to start an embedded engine in your application.
Expand Down
2 changes: 1 addition & 1 deletion modules/runtime/pages/engine-architecture-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

The Bonita Engine is the runtime processor at the core of Bonita. It executes processes, handling actions related to tasks, such as database access, and housekeeping actions such as logging. The Engine is composed of a number of services and APIs. The services are either BPM services or generic services.

image::images/images-6_0/dev_arch_engine_architecture_simple.png[engine architecture diagram]
image::images-6_0/dev_arch_engine_architecture_simple.png[engine architecture diagram]

The Bonita Engine component services are completely configurable using the xref:runtime:bonita-platform-setup.adoc[plaform setup tool] to retrieve the current configuration and update it.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ If so, the next state is executed, in another background task (if terminal or no

=== Work service mechanism

image::images/images-6_0/user_task_details.png[Diagram of the details of user task execution]
image::images-6_0/user_task_details.png[Diagram of the details of user task execution]

. Bonita Engine commits the transaction and then submits a work to execute the connectors asynchronously. The connectors are executed outside any transaction and thus are not a problem for the data integrity if the execution takes too long
. As soon as there is a free slot in the Work Service, it executes the work, which is in fact the connector execution
Expand Down Expand Up @@ -139,11 +139,11 @@ The first state is _initializing_: it is automatically executed and the flow nod

*In the first diagram, the task contains connectors*

image::images/images-6_0/user_task_execution_with_connector.png[Diagram of the states and transactions when a user task with connectors is executed]
image::images-6_0/user_task_execution_with_connector.png[Diagram of the states and transactions when a user task with connectors is executed]

*In the second diagram, there are no connectors in the task*

image::images/images-6_0/user_task_execution_without_connector.png[Diagram of the states and transactions when a user task with connectors is executed]
image::images-6_0/user_task_execution_without_connector.png[Diagram of the states and transactions when a user task with connectors is executed]

As you can see in these illustrations, there is a non-negligible cost when adding some connectors on an activity: +

Expand Down
2 changes: 1 addition & 1 deletion modules/runtime/pages/import-export-an-organization.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
{description}

Here is a view of this page:
image:images/UI2021.1/install-export.png[Install export organization]
image:UI2021.1/install-export.png[Install export organization]

== How to install an organization

Expand Down
2 changes: 1 addition & 1 deletion modules/runtime/pages/install-a-bonita-bpm-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ This is to ensure the nodes do not discover each other on the network, if they a
It is possible to have more than one cluster on the same network. In this case, you must configure the cluster names to be sure that it is clear which node belongs to which cluster.
You can configure the cluster name through Hazelcast or by updating `bonita-platform-sp-custom.properties` located in the `platform_engine` folder of the configuration, use the xref:runtime:bonita-platform-setup.adoc#configuration_files[platform setup tool] to update it.

== image:images/troubleshooting.png[troubleshooting-icon] Troubleshooting
== image:troubleshooting.png[troubleshooting-icon] Troubleshooting

*Symptom*: I regularly get this warning message when 2 or more nodes are started in cluster:

Expand Down
2 changes: 1 addition & 1 deletion modules/runtime/pages/log-in-and-log-out.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For an application:
. Click on the _first name last name_ or _avatar_ in the application header
. Click on *Sign out*

image:images/UI2021.1/sign-out.png[Sign out]
image:UI2021.1/sign-out.png[Sign out]
// {.img-responsive}

[NOTE]
Expand Down
2 changes: 1 addition & 1 deletion modules/runtime/pages/monitoring.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Starting with Bonita 2022.2, bpmn-visualization library of https://process-analy
====

Here is a view of the Monitoring page
image:images/UI2021.1/monitoring.png[Monitoring]
image:UI2021.1/monitoring.png[Monitoring]

Go to _BPM_> _Monitoring_ for Administrator and _Monitoring_ for Process Manager.
The *Monitor open cases* page is displayed, with the following summary information:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Assumptions: We assume that Ubuntu Linux is used as the operating system for Bon

=== Cluster structure diagram

image::images/images-6_0/cluster_structure.png[Cluster structure diagram]
image::images-6_0/cluster_structure.png[Cluster structure diagram]

=== Definitions:

Expand Down
2 changes: 1 addition & 1 deletion modules/runtime/pages/performance-troubleshooting.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= image:images/troubleshooting.png[troubleshooting-icon] Performance troubleshooting
= image:troubleshooting.png[troubleshooting-icon] Performance troubleshooting
:page-aliases: ROOT:performance-troubleshooting.adoc
:description: Learn how to monitor your Bonita Platform and troubleshoot performance issues.

Expand Down
28 changes: 14 additions & 14 deletions modules/runtime/pages/reporting-app.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
= Bonita Reporting Application

:description: An application for analytics and reporting.
:description: An application for analytics and reporting.

{description}
{description}

Bonita Reporting app will enable you to view statistics and to extract process execution reports with meaningful data from Bonita, for process performance analysis and for pinpointing areas of improvement.

Expand All @@ -18,31 +18,31 @@ Bonita Reporting App is available for download on the Customer Portal/Customer S
A customer account is required for downloading the .jar , that contains “Process Historical Data” report and “Human tasks historical data”.
====

== Overview
== Overview

The bonita-dashboard-app-1.1.1.jar, contains two reports “Process Historical Data” and “Human tasks historical data”.
The bonita-dashboard-app-1.1.1.jar, contains two reports “Process Historical Data” and “Human tasks historical data”.

First, you will have to choose the process which you want to analyse. From the list of processes responding to selection criteria, select the one you want to analyze. After that you will get redirected to the reporting pages.
First, you will have to choose the process which you want to analyse. From the list of processes responding to selection criteria, select the one you want to analyze. After that you will get redirected to the reporting pages.

image:images/reporting-app-process-selection-page.png[Process selection]
image:reporting-app-process-selection-page.png[Process selection]

=== Process historical data

On report’s page, based on *cases execution data in a defined period of time analysis*, you’ll have the possibility to generate the graph with cases average time and/or download the file with detailed archived cases data in .csv format inside a zip. This enables you to analyse it your chosen analytics tool.
On report’s page, based on *cases execution data in a defined period of time analysis*, you’ll have the possibility to generate the graph with cases average time and/or download the file with detailed archived cases data in .csv format inside a zip. This enables you to analyse it your chosen analytics tool.

image:images/reporting-app-process-historical-data-page.png[Process historical data]
image:reporting-app-process-historical-data-page.png[Process historical data]

=== Human tasks historical data

On report’s page, based on *human actions in cases during a defined period of time*, you’ll have the possibility to generate the graph showing tasks average handling time and/or download detailed archived human tasks data, packaged in a .csv format file inside a zip. This enables you to analyse it your chosen analytics tool.
On report’s page, based on *human actions in cases during a defined period of time*, you’ll have the possibility to generate the graph showing tasks average handling time and/or download detailed archived human tasks data, packaged in a .csv format file inside a zip. This enables you to analyse it your chosen analytics tool.

image:images/reporting-app-human-tasks-page.png[Human tasks data]
image:reporting-app-human-tasks-page.png[Human tasks data]

== Advantages
== Advantages

. Reporting App is a Bonita application, hence it is compatible with Bonita ressources. For exemple, Organization Management can be used to have the application available to specific users.
. The reports are a combination of the already known reports in Jasper and customer feedback, along with an improved performance.
. New user interface
. Reporting App is a Bonita application, hence it is compatible with Bonita ressources. For exemple, Organization Management can be used to have the application available to specific users.
. The reports are a combination of the already known reports in Jasper and customer feedback, along with an improved performance.
. New user interface



8 changes: 4 additions & 4 deletions modules/runtime/pages/user-application-case-list.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ It features:
* Displayed process version in the process filter, to make a more accurate choice in case several versions of a process must be distinguished
Here is a view of the User Case list
image:images/UI2021.1/user-case-list-app.png[User Case list in Bonita Application]
image:UI2021.1/user-case-list-app.png[User Case list in Bonita Application]

== Cases listed

Expand Down Expand Up @@ -104,7 +104,7 @@ Technically, cases change their Id when going from _open_ to _archived_ status.
=== Sorting options

Here are the Application sorting options. +
image:images/UI2021.1/user-case-sort-App.png[User Case sorting options - Application]
image:UI2021.1/user-case-sort-App.png[User Case sorting options - Application]

The list can be sorted by:

Expand All @@ -126,7 +126,7 @@ The "Load more cases" link cannot be clicked anymore.

This page has also been re-created with the UI Designer. It is responsive and customizable.
Here is an example of a case details page.
image:images/UI2021.1/user-case-details-App.png[User Case case details - Application]
image:UI2021.1/user-case-details-App.png[User Case case details - Application]

This page displays:

Expand All @@ -150,6 +150,6 @@ It displays:
* A bottom-up chronology of some events that happened in the case: case start and human tasks executed, each one with a timestamp and actor.

Here is an example of the case overview provided by Bonita.
image:images/UI2021.1/case-overview.png[Case Overview]
image:UI2021.1/case-overview.png[Case Overview]

To know more about the customization of the case overview, go to the xref:ROOT:uid-case-overview-tutorial.adoc[Case overview] page.
2 changes: 1 addition & 1 deletion modules/runtime/pages/user-application-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Creating your user application based on Bonita User Application means that you c

From Bonita Studio *Welcome page* _Resources_ tile, click on "Import Bonita User Application".

image::images/UI2021.1/studio-get-application.png[Get application from Studio]
image::UI2021.1/studio-get-application.png[Get application from Studio]

You can also get it from our https://github.com/bonitasoft/bonita-admin-application/[Admin Application GitHub repository]. +
There are two ways to get the .bos file. You can either get it from the _Releases_ on the right or by cloning the repository of your choice and building it using maven. +
Expand Down
Loading

0 comments on commit e278211

Please sign in to comment.