From b5848e336cb2945240a739d6ff2e681c233f99e5 Mon Sep 17 00:00:00 2001 From: Adrien Date: Wed, 2 Mar 2022 15:03:19 +0100 Subject: [PATCH] fix(build): clean adoc errors (#1958) --- .../ROOT/pages/BonitaBPM_platform_setup.adoc | 4 +- modules/ROOT/pages/api-extensions.adoc | 10 +-- modules/ROOT/pages/api-glossary.adoc | 2 +- modules/ROOT/pages/application-api.adoc | 4 +- modules/ROOT/pages/applications.adoc | 2 +- modules/ROOT/pages/bdm-in-rest-api.adoc | 4 +- modules/ROOT/pages/bonita-bpm-overview.adoc | 2 +- modules/ROOT/pages/bpm-api.adoc | 78 ++++++++--------- ...uilding-community-edition-from-source.adoc | 4 +- .../pages/cache-configuration-and-policy.adoc | 4 +- .../ROOT/pages/comparison-of-7-x-and-6-x.adoc | 2 +- .../pages/connector-development-toolkit.adoc | 3 +- modules/ROOT/pages/connectors-overview.adoc | 2 +- .../pages/create-administration-tools.adoc | 2 +- modules/ROOT/pages/csrf-security.adoc | 6 +- .../ROOT/pages/data-handling-overview.adoc | 2 +- .../ROOT/pages/database-configuration.adoc | 2 +- modules/ROOT/pages/deploy-bundle.adoc | 8 +- .../ROOT/pages/first-steps-after-setup.adoc | 2 +- modules/ROOT/pages/form-api.adoc | 2 +- modules/ROOT/pages/identity-api.adoc | 8 +- .../pages/install-a-bonita-bpm-cluster.adoc | 20 ++--- modules/ROOT/pages/licenses.adoc | 10 +-- modules/ROOT/pages/maintenance-operation.adoc | 9 +- modules/ROOT/pages/manage-the-platform.adoc | 2 +- ...from-an-earlier-version-of-bonita-bpm.adoc | 24 +++--- .../ROOT/pages/optimize-user-tasklist.adoc | 2 +- .../overview-of-bonita-bpm-in-a-cluster.adoc | 2 +- modules/ROOT/pages/pages.adoc | 2 +- modules/ROOT/pages/portal-api.adoc | 8 +- modules/ROOT/pages/release-notes.adoc | 2 +- modules/ROOT/pages/resource-management.adoc | 2 +- modules/ROOT/pages/rest-api-extensions.adoc | 4 +- modules/ROOT/pages/rest-api-overview.adoc | 8 +- modules/ROOT/pages/rta-mail-template.adoc | 5 +- modules/ROOT/pages/set-up-kpis.adoc | 2 +- .../ROOT/pages/single-sign-on-with-saml.adoc | 2 +- .../ROOT/pages/software-extensibility.adoc | 2 +- modules/ROOT/pages/system-api.adoc | 4 +- modules/ROOT/pages/tomcat-bundle.adoc | 16 ++-- ...m-community-to-a-subscription-edition.adoc | 4 +- modules/ROOT/pages/variables.adoc | 2 +- modules/ROOT/pages/wildfly-bundle.adoc | 18 ++-- modules/ROOT/taxonomy.adoc | 86 +++++++++---------- 44 files changed, 189 insertions(+), 200 deletions(-) diff --git a/modules/ROOT/pages/BonitaBPM_platform_setup.adoc b/modules/ROOT/pages/BonitaBPM_platform_setup.adoc index de91cffdac..1a3143357c 100644 --- a/modules/ROOT/pages/BonitaBPM_platform_setup.adoc +++ b/modules/ROOT/pages/BonitaBPM_platform_setup.adoc @@ -139,7 +139,7 @@ Before running it, make sure the setup tool is configured to point to the databa [NOTE] ==== -If you have already run `start-bonita` script inside a xref:tomcat-bundle.adoc]#configuration[Tomcat bundle] or a xref:wildfly-bundle.adoc]]#configuration[WildFly bundle], those steps are already done. +If you have already run `start-bonita` script inside a xref:tomcat-bundle.adoc#configuration[Tomcat bundle] or a xref:wildfly-bundle.adoc#configuration[WildFly bundle], those steps are already done. ==== Here is how to do so: @@ -147,7 +147,7 @@ Here is how to do so: . Create the database . Customize it so it works with Bonita . Modify the `database.properties` file: Set the right db vendor and change connection url, user credentials, database name and so on. -. If you are using an Oracle or Microsoft SQL Server database, add the related xref:database-configuration.adoc]#proprietary_jdbc_drivers[JDBC driver] in the `lib` folder. +. If you are using an Oracle or Microsoft SQL Server database, add the related xref:database-configuration.adoc#proprietary_jdbc_drivers[JDBC driver] in the `lib` folder. [#advanced_use] diff --git a/modules/ROOT/pages/api-extensions.adoc b/modules/ROOT/pages/api-extensions.adoc index 6d55576c62..82c6eccb3b 100644 --- a/modules/ROOT/pages/api-extensions.adoc +++ b/modules/ROOT/pages/api-extensions.adoc @@ -23,7 +23,7 @@ REST API Extensions use the same authorization mechanism as the standard Bonita [NOTE] ==== -It is also possible to deploy a REST API Extensions using xref:portal-api.adoc]#page[REST portal API / "page" resource]. +It is also possible to deploy a REST API Extensions using xref:portal-api.adoc#page[REST portal API / "page" resource]. ==== [NOTE] @@ -41,7 +41,7 @@ If you are running Bonita in a cluster, after you import a REST API Extensions, [WARNING] ==== -As the deployment of the REST API Extensions automatically creates the appropriate resource permission mapping, be careful not to xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[push a configuration] that does not contain the latest permissions updates. This would overwrite the deployed configuration. To avoid doing so, pull the latest configuration, edit the needed elements and push it back to the Bonita runtime in a pretty short amount of time. +As the deployment of the REST API Extensions automatically creates the appropriate resource permission mapping, be careful not to xref:BonitaBPM_platform_setup.adoc#update_platform_conf[push a configuration] that does not contain the latest permissions updates. This would overwrite the deployed configuration. To avoid doing so, pull the latest configuration, edit the needed elements and push it back to the Bonita runtime in a pretty short amount of time. ==== [#usage] @@ -59,7 +59,7 @@ resources=[GET|extension/demoHeaders,POST|extension/demoXml,PUT|extension/putRes If the page declares its resources correctly, then every user being able to access this page (because it is part of a custom profile or Living Application they have access to) will also be automatically granted the necessary permissions to call the REST API Extensions. This works the same way as with the other resources of the REST API. + -However, if you need to grant access to this REST API Extensions to some users regardless of the pages they have access to, then you need to add xref:rest-api-authorization.adoc]#custom-permissions-mapping[custom permissions] for these users. + +However, if you need to grant access to this REST API Extensions to some users regardless of the pages they have access to, then you need to add xref:rest-api-authorization.adoc#custom-permissions-mapping[custom permissions] for these users. + In order to do so, edit `custom-permissions-mapping.properties` to give the permissions (value of the property `apiExtension.permissions`) declared in the page.properties of the REST API Extensions to the required profiles or users. [NOTE] @@ -79,11 +79,11 @@ If you want to disable the debug mode, you need to use the setup tool provided i A REST API Extensions example resource and API extension viewer page are provided in administrator portal. They are located in administrator portal. -To use the examples, define a xref:rest-api-authorization.adoc]#custom-permissions-mapping[custom permissions] mapping for `demoPermission`: +To use the examples, define a xref:rest-api-authorization.adoc#custom-permissions-mapping[custom permissions] mapping for `demoPermission`: In a Tomcat / WildFly bundle: -* Retrieve platform configuration using the xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[setup tool]. +* Retrieve platform configuration using the xref:BonitaBPM_platform_setup.adoc#update_platform_conf[setup tool]. * Edit `platform_conf/current/tenants//tenant_portal/custom-permissions-mapping.properties`. * Add the following line: `profile|User=[demoPermission]`. * Push the changed platform configuration into database using the _setup tool_. diff --git a/modules/ROOT/pages/api-glossary.adoc b/modules/ROOT/pages/api-glossary.adoc index fead4639c1..0f6ccdacf5 100644 --- a/modules/ROOT/pages/api-glossary.adoc +++ b/modules/ROOT/pages/api-glossary.adoc @@ -59,4 +59,4 @@ Use to represent an instance of a none start event, user task, call activity, mu For a complete description of the different elements, check out the following pages: * on the engine side, the http://documentation.bonitasoft.com/javadoc/api/{varVersion}/index.html[Javadoc] page -* on the web site, the xref:_rest-api.adoc[REST API page] page +* on the web site, the xref:rest-api-overview.adoc[REST API page] diff --git a/modules/ROOT/pages/application-api.adoc b/modules/ROOT/pages/application-api.adoc index 739e03c977..673556b11b 100644 --- a/modules/ROOT/pages/application-api.adoc +++ b/modules/ROOT/pages/application-api.adoc @@ -170,7 +170,7 @@ _Example_: /API/living/application?f=token%3dmyapp&d=createdBy * *Method* + `GET` * *URL Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available to search form mappings. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available to search form mappings. + *Required* ** c: number of result per page to retrieve ** p: page number to retrieve @@ -425,7 +425,7 @@ _Example_: `http://../API/living/application-menu?p=0&c=2&f=applicationId%3d1` * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available to search form mappings. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available to search form mappings. ** c: number of result per page ** p: page number ** o: can order on "id", "displayName", "applicationId", "applicationPageId", "index", "parentId" diff --git a/modules/ROOT/pages/applications.adoc b/modules/ROOT/pages/applications.adoc index b0059ac575..7bf716f534 100644 --- a/modules/ROOT/pages/applications.adoc +++ b/modules/ROOT/pages/applications.adoc @@ -223,7 +223,7 @@ There are two aspects to updating an application: changing the application defin . Click the Edit icon (...) for the application you want to edit. The application details page is displayed. From this page, you can edit the application metadata, layout, theme, pages, and navigation. ** To edit the metadata, click the Edit button. In the popup, modify the information about the application, then click *_Save_*. ** To edit the layout, see <>. - ** To edit the theme, see <>. Note that the end user will see this modification with a delay (due to the xref:cache-configuration-and-policy.adoc]#portal_and_mobile[cache policy]) + ** To edit the theme, see <>. Note that the end user will see this modification with a delay (due to the xref:cache-configuration-and-policy.adoc#portal_and_mobile[cache policy]) ** To edit the pages, go to the Pages zone. You can add a page by clicking *_Add_*. You can remove a page by clicking the trashcan icon for that page. Note that if you remove a page, the related menu items are automatically removed from the navigation. ** To edit the navigation, go to the Navigation zone. You can add a menu or menu item by clicking *_Add_*. You can remove a menu or menu item by clicking the trashcan icon for that page. diff --git a/modules/ROOT/pages/bdm-in-rest-api.adoc b/modules/ROOT/pages/bdm-in-rest-api.adoc index 19739830e0..340fa876d2 100644 --- a/modules/ROOT/pages/bdm-in-rest-api.adoc +++ b/modules/ROOT/pages/bdm-in-rest-api.adoc @@ -10,7 +10,7 @@ Image below shows the BDM model used for the first use-case: image::images/bdm_model_for_rest_api_01.png[BDM model used] -Note that the relationships from car to wheel1, wheel2, wheel3, wheel4 are *xref:define-and-deploy-the-bdm.adoc]#lazy_eager_loading[lazy] loaded* (in the Studio, it is +Note that the relationships from car to wheel1, wheel2, wheel3, wheel4 are *xref:define-and-deploy-the-bdm.adoc#lazy_eager_loading[lazy] loaded* (in the Studio, it is configured by selecting the `Only load related objects when needed` radio button). == Groovy code sample @@ -23,7 +23,7 @@ Below is an example of a REST API extension groovy script that accesses the Busi *Good practices* are: * If lazy loaded objects are not necessary in the response, ONLY extract the information needed. This avoids costly loading of unnecessary objects. -* If lazy loaded objects should always be returned in the response, consider changing the relation from xref:define-and-deploy-the-bdm.adoc]#lazy_eager_loading['lazy' to 'eager'] +* If lazy loaded objects should always be returned in the response, consider changing the relation from xref:define-and-deploy-the-bdm.adoc#lazy_eager_loading['lazy' to 'eager'] in the model. ==== diff --git a/modules/ROOT/pages/bonita-bpm-overview.adoc b/modules/ROOT/pages/bonita-bpm-overview.adoc index 6afead1ad9..0d543ed747 100644 --- a/modules/ROOT/pages/bonita-bpm-overview.adoc +++ b/modules/ROOT/pages/bonita-bpm-overview.adoc @@ -33,7 +33,7 @@ As mentioned before, xref:bonita-bpm-portal-interface-overview.adoc[Bonita Porta But Bonita Portal is also the tool used by the tenant administrator to xref:processes.adoc[install, deploy and manage processes] and to xref:applications.adoc[build applications]. We use the word "tenant" here, in case the platform would be made of xref:multi-tenancy-and-tenant-configuration.adoc[several tenants]. -To install Bonita Engine and Bonita Portal in a qualification or production environment, xref:bonita-bpm-installation-overview.adoc]#platform[install Bonita Platform]. +To install Bonita Engine and Bonita Portal in a qualification or production environment, xref:bonita-bpm-installation-overview.adoc#platform[install Bonita Platform]. In Bonita Studio, once a process is ready, you can xref:build-a-process-for-deployment.adoc[build] it and deploy it on your Bonita qualification or production platform. diff --git a/modules/ROOT/pages/bpm-api.adoc b/modules/ROOT/pages/bpm-api.adoc index bbbbe51f6c..84b4a53aec 100644 --- a/modules/ROOT/pages/bpm-api.adoc +++ b/modules/ROOT/pages/bpm-api.adoc @@ -90,7 +90,7 @@ The methods used for this resource are: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * processId * caseId @@ -347,7 +347,7 @@ The methods used for this resource are: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * processId: the id of the process that is associated with the activity * caseId: the id of the case that is associated with the activity @@ -455,7 +455,7 @@ The methods used for this resource are: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * processId: the id of the process that is associated with the activity * caseId: the id of the case that is associated with the activity @@ -516,7 +516,7 @@ _Example_: Get the human tasks that have been skipped. `/API/bpm/humanTask?p=0&c * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available: +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available: ** d: extend resource response parameters of <> are available. ** o: name, priority, dueDate, state, userId, groupId, roleId, processDefinitionId, processInstanceId, parentActivityInstanceId, assigneeId, parentContainerId, displayName, reachedStateDate @@ -751,7 +751,7 @@ Use a GET method with filters and search terms to search for subtasks. * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + You can filter on: ** `+assigned_id={user_id}+`: retrieve only the manual tasks assigned to the specified user. For example, retrieve the manual tasks assigned to user with id 1: `/API/bpm/manualTask?p=0&c=10&f=assigned_id%3d1`. ** `state=skipped | ready | completed | failed` : retrieve only the manual tasks with the specified state. For example, retrieve the ready tasks: `/API/bpm/manualTask?p=0&c=10&f=state%3dready`. @@ -816,7 +816,7 @@ The methods used for this resource are: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * processId: the id of the process that is associated with the activity * caseId: the id of the case that is associated with the activity @@ -1003,7 +1003,7 @@ The methods used for this resource are: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * processId: the id of the process that is associated with the activity * caseId: the id of the case that is associated with the activity @@ -1287,7 +1287,7 @@ _Example_: Get the human tasks assigned to the user with id 2. `/API/bpm/archive * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + You can filter on: ** `+assigned_id={user_id}+`: retrieve only the human tasks assigned to the specified ID. For example, retrieve the human tasks assigned to user with id 2: `/API/bpm/archivedHumanTask?p=0&c=10&f=assigned_id%3d2` ** `state=`: retrieve only the archived user tasks with the specified state. For example, retrieve the skipped tasks: `/API/bpm/archivedHumanTask?p=0&c=10&f=state=skipped` @@ -1445,7 +1445,7 @@ Use a GET method with filters and search terms to search for subtasks. * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + You can filter on: ** `+assigned_id={user_id}+`: retrieve only the manual tasks assigned to the specified user. For example, retrieve the manual tasks assigned to user with id 1: `/API/bpm/archivedManualTask?p=0&c=10&f=assigned_id%3d10` ** {blank} @@ -1519,7 +1519,7 @@ The methods used for this resource are: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * processId: the id of the process that is associated with the activity * caseId: the id of the case that is associated with the activity @@ -1579,7 +1579,7 @@ _Example_: Search ten first archived task of process 8410739119827826184 order b * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. ** Accepted sort values `+o={value}+` : caseId, name, displayName, processId, state, type, archivedDate, reached_state_date, assigned_id ** Accepted filters `+f={filter}=value+` : caseId, name, displayName, processId, state, type, archivedDate, reached_state_date, assigned_id, isTerminal ** d: extend resource response parameters of <> are available. @@ -1693,7 +1693,7 @@ The methods used for this resource are: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * processId: the id of the process that is associated with the activity * caseId: the id of the case that is associated with the activity @@ -1754,7 +1754,7 @@ _Example_: Get the user tasks assigned to the user with id 2:``/API/bpm/archived * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + You can filter on: @@ -1969,7 +1969,7 @@ _Example_: `/API/bpm/caseVariable?p=0&c=10&f=case\_id%3d11754` * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + `f = case_id%3d[caseId]` to indicate that you want to add a filter on 'case_id' with value [caseId] (%3d is the URL-encoded '=' (equals) sign) * *Success Response* + A representation of a list of case variables @@ -2234,7 +2234,7 @@ Find all documents with with any of the searchable fields starting with "doc". ` * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + It is possible to filter on three parameters: submittedBy, name and description. ** `submittedBy="id"`: search for documents that were submitted by the user with the specified identifier. ** `name="string"`: search for documents with names that contain _string_. @@ -2352,7 +2352,7 @@ Response payload * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + It is possible to filter on the following parameters: sourceObjectId, caseId, archivedCaseId, submittedBy, name, description. ** `sourceObjectId="id"`: search for documents by specifying the original document id. This is useful if you know the id of a caseDocument and you wish to retrieve all its previous versions.. @@ -2499,7 +2499,7 @@ _Example_: Count the actor members of actors of the process with id 4758765 `/AP * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. * *Success Response* ** *Code*: 200 ** *Payload*: @@ -2634,7 +2634,7 @@ _Example_: `` * *Method* + `` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + There is a mandatory filter on: ** `actor\_id` For example, retrieve the actorMembers related to the specified actor_id. http://localhost:8080/bonita/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1 @@ -2712,7 +2712,7 @@ ID of the Object: a long value ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * `started_by` * `startedBySubstitute` @@ -2814,7 +2814,7 @@ _Example_: list active cases for process definition with ID 1234 `/API/bpm/case * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. ** f: filter of the search. Available filters are : *** `processDefinitionId`: The process derfinition ID *** `name`: the process name @@ -3158,7 +3158,7 @@ The methods used for this resource are: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * `started_by` * `startedBySubstitute` @@ -3213,7 +3213,7 @@ You can search cases. * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. ** o (order): available values are `id`, `processDefinitionId`, `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`, `sourceObjectId` ** f: filter of the search. Available filters are : @@ -3452,7 +3452,7 @@ The method used for this resource is: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * `userId` @@ -3513,7 +3513,7 @@ _Example_: `/API/bpm/comment?p=0&c=10&o=postDate%20DESC&f=processInstanceId%3d1& * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. ** o: you can sort on the `postDate` ** f: filter of the search. Available filters are : *** `supervisor_id` @@ -3592,7 +3592,7 @@ The method used for this resource is: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * `userId` @@ -3619,7 +3619,7 @@ _Example_: `/API/bpm/archivedComment?p=0&c=10&o=postDate%20DESC&f=processInstanc * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. ** o: you can sort on the `postDate` and `archivedDate` ** f: filter of the search. Available filters are : *** `supervisor_id` @@ -3716,7 +3716,7 @@ The methods used for this resource are: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * `deployedBy` @@ -3870,7 +3870,7 @@ _Example_: * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. ** s: search on "name", "displayName" or "version" ** o: can order by "name", "version", "deploymentDate", "deployedBy", "activationState", "configurationState", "processId", "displayName", "lastUpdateDate", "categoryId", "label". By default sort order is ASC (`%20asc` added to order). You can sort in reverse order by adding `%20desc` to order. Example: `/API/bpm/process?f=name=MyProcess&p=0&c=1&o=version%20desc&f=activationState=ENABLED` ** f: can filter on "name", "version", "deploymentDate", "deployedBy", "activationState" with the value DISABLED or ENABLED, "configurationState" with the value UNRESOLVED, or RESOLVED, "processId", "displayName", "lastUpdateDate", "categoryId", "label", "supervisor_id" @@ -4120,7 +4120,7 @@ _Example_: `/API/bpm/processParameter?p=0&c=10&o=name%20ASC&f=process\_id%3d4880 * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. * *Success Response* + A array of process parameters ** *Code*: 200 @@ -4195,7 +4195,7 @@ _Example_: `/API/bpm/processResolutionProblem?p=0&c=100&f=process\_id%3d88028384 * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + Filtering on the process definition ID is mandatory. ** `f=process_id=`: this filter is used to indicate the target process * *Success Response* + @@ -4254,7 +4254,7 @@ A compound identifier constructed from process_id/user_id/role_id/group_id where ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * `role_id` * `group_id` @@ -4268,7 +4268,7 @@ _Example_: Get the supervisors of type `User` for the process 804090185767475454 * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. ** f: filter of the search, you need to specify the process_id, and then the user_id, group_id and role_id with one of them (two if you want to filter on group and role) set to `>0` and the other ones set to `-1`. E.g.: `f=process_id%3D8040901857674754544&f=user_id%3D>0&f=group_id%3D-1&f=role_id%3D-1` ** d: extend resource response parameters of <> are available. * *Success Response* + @@ -4464,7 +4464,7 @@ _Example_: Get connector dependencies of the email connector (version 1.0.0) of * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + Mandatory filters: connector_process_id, connector_name, connector_version * *Success Response* ** *Code*: 200 @@ -4578,7 +4578,7 @@ _Example_: * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. ** `+f=containerId%3d{id}+`. The container ID of the process or flow node. * *Success Response* + A list of connector details @@ -4668,7 +4668,7 @@ _Example_: Get information about archived instances sort by containerId DESC Req * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. * *Success Response* + A list of connector details ** *Code*: 200 @@ -4755,7 +4755,7 @@ The methods used for this resource are: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * processId: the id of the process that is associated with the activity * caseId: the id of the case that is associated with the activity @@ -4821,7 +4821,7 @@ _Example_: Get all the active flow nodes named "Escalate", ordering the results `GET` [#flownode-search-data-params] * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + The following parameters are available: ** o: *** name @@ -4917,7 +4917,7 @@ The methods used for this resource are: ==== Response object extension (deploy query parameter) -The `d` (deploy) used to xref:rest-api-overview.adoc]#extend-resource[extend response object] can be used with : +The `d` (deploy) used to xref:rest-api-overview.adoc#extend-resource[extend response object] can be used with : * processId: the id of the process that is associated with the activity * caseId: the id of the case that is associated with the activity @@ -4951,7 +4951,7 @@ Search for flow nodes using given parameters. Flow nodes in state completed, can * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + The following parameters are available: ** o: *** name diff --git a/modules/ROOT/pages/building-community-edition-from-source.adoc b/modules/ROOT/pages/building-community-edition-from-source.adoc index 5749b4e2e7..1c7ea6d2b4 100644 --- a/modules/ROOT/pages/building-community-edition-from-source.adoc +++ b/modules/ROOT/pages/building-community-edition-from-source.adoc @@ -5,7 +5,7 @@ Bonita is an opensource Digital Process Automation platform, you can therefore build Bonita Community edition from the source. -= Prerequisites +== Prerequisites All source code of Bonita solution is available from the https://github.com/bonitasoft[Bonitasoft GitHub organization]. Each component of the solution has a dedicated repository (e.g. https://github.com/bonitasoft/bonita-engine[Engine repository]). @@ -35,7 +35,7 @@ BS-8375 Note that you can run Bonita on Windows but you cannot build Bonita on Windows (known limitation). ==== -= Building Bonita +== Building Bonita In order to build Bonita you need to use the script provided in https://github.com/Bonitasoft-Community/Build-Bonita[Build Bonita] GitHub project. Use the branch of the project that match the version you want to build. diff --git a/modules/ROOT/pages/cache-configuration-and-policy.adoc b/modules/ROOT/pages/cache-configuration-and-policy.adoc index 459ba044ef..4526dc78a0 100644 --- a/modules/ROOT/pages/cache-configuration-and-policy.adoc +++ b/modules/ROOT/pages/cache-configuration-and-policy.adoc @@ -25,7 +25,7 @@ Note that in every cases, custom pages and forms take advantage of the cache mec By default cache is disable for the web server embedded by Bonita studio, as it is more comfortable to realise development without cache. But you can decide to activate cache, to be closer to the production display time. To do this, -see xref:bonita-bpm-studio-installation.adoc]#enable_cache[Cache configuration] documentation. +see xref:bonita-bpm-studio-installation.adoc#enable_cache[Cache configuration] documentation. [#portal_and_mobile] @@ -44,7 +44,7 @@ To fit your needs, you can change this duration into your server configuration, == Living application and custom pages -As the pages generated by the UI Designer take advantage of a xref:live-update.adoc]#cache_busting[cache busting] mechanism, we can set the +As the pages generated by the UI Designer take advantage of a xref:live-update.adoc#cache_busting[cache busting] mechanism, we can set the cache duration to 6 months. To fit your needs, you can change this duration into your server configuration, by following those steps: diff --git a/modules/ROOT/pages/comparison-of-7-x-and-6-x.adoc b/modules/ROOT/pages/comparison-of-7-x-and-6-x.adoc index fcae43b6eb..a47940a60a 100644 --- a/modules/ROOT/pages/comparison-of-7-x-and-6-x.adoc +++ b/modules/ROOT/pages/comparison-of-7-x-and-6-x.adoc @@ -146,6 +146,6 @@ See the xref:bonita-bpm-installation-overview.adoc[Installation overview]. | bonita_home | A separate bonita_home for each edition and for cluster -| A common bonita_home used for all editions, simplifying download and installation. Improved structure for bonita_home/server that is easier to maintain and customize. See xref:bonita-home.adoc[Bonita Home] +| A common bonita_home used for all editions, simplifying download and installation. Improved structure for bonita_home/server that is easier to maintain and customize. | No more bonita_home. See xref:BonitaBPM_platform_setup.adoc[platform setup] |=== diff --git a/modules/ROOT/pages/connector-development-toolkit.adoc b/modules/ROOT/pages/connector-development-toolkit.adoc index 87b166bbe0..5ea5954b47 100644 --- a/modules/ROOT/pages/connector-development-toolkit.adoc +++ b/modules/ROOT/pages/connector-development-toolkit.adoc @@ -73,5 +73,4 @@ Before running the command, update the following parameter values: | Maven project version and Bonita connector definition version. |=== -. Run the command. This generates a new folder named `artifactId` containing the connector definition project files, as follows: -```++++++/ src/main/resources/ category-icon.png connector_definition.xml connector-icon.png pom.xml ``` 4. Configure the `src/main/resources/connector_definition.xml` file to define the connector wizard pages with their inputs, widgets,and outputs (see [Connector widget reference](#widgetTypeReference) for details). 5. Optionally, change the icons for the connector and the connector category in the `src/main/resources` folder. ## Creating a new connector implementation A connector definition can hold multiple implementations so the steps described in this section can be repeated. All implementations will be stored under the definition project folder. **Caution:** Connector implementations that are not located under the definition project folder will not compile. 1. Open a command window and navigate to the folder that contains the connector definition project. 2. Prepare to run the following command (Windows users: remove the trailing slashes and edit the content to have everything on a single line): ```bash mvn archetype:generate \ -DinteractiveMode=false \ -DarchetypeGroupId=com.bonitasoft.connector.implementation \ -DarchetypeArtifactId=bonita-connector-implementation-archetype \ -DarchetypeVersion=1.0 \ -DgroupId=com.mycompany.connectors \ -DartifactId=myFirstConnectorImpl \ -Dversion=1.0.0 \ -DdefinitionId=myFirstConnector \ -DdefinitionVersion=1.0.0 ``` Before running the command, update the following parameter values: | Parameter | Description | |-----------|-------------| | archetypeVersion | This should match the version of the toolkit | | groupId | Maven project group id and Java package for the Bonita connector implementation | | artifactId | Maven artifact id and Bonita connector implementation id | | version | Maven version id and Bonita connector implementation version | | definitionId | This should match the connector definition artifactId | | definitionVersion | This should match the connector definition version | 3. Run the command. This generates a new folder named `artifactId` containing the connector implementation project. 4. In the connector implementation project folder, run the following command : ```bash mvn bonita-connector-definition:generate ``` This generates the connector abstract definition class based on the definition configuration: `++++++/src/main/java/++++++/Abstract++++++.java` **Note:** If you subsequently change the connector definition configuration, run this command again to apply your changes. This will regenerate the abstract definition class, overwriting the previous version. 5. In the connector implementation project folder, run the following command : `mvn bonita-connector-implementation:generate` This generates a stub of the connector implementation and test classes: ``` src/main/java/++++++/++++++.java src/test/java/++++++/++++++Tests.java ``` *Caution:** Do not run this command again at a later stage, because it resets your implementation and test classes. 6. Complete your connector implementation and test classes. 7. When you are ready to package the connector, run this command in the implementation project folder: `mvn package` This will produce a connector zip file that can be imported in Bonita Studio: `/target/++++++-++++++-dist.zip` ++++++++++++ ## Widget types and parameters The following widget types are supported in connectors: | Widget | Description | | ------ | ----------- | | Text | Text field | | Password | Text field with obfuscated characters | | TextArea | Multi-line text field | | Checkbox | Single checkbox | | RadioGroup | Group of radio buttons | | Select | Drop down | | Array | Editable table with user customizable rows and columns | | ScriptEditor | Multi-line text zone for entering a script | | List | List in which user can add/remove elements | | Group | Collapsile zone that contains one or more widgets | This is the same as the set of connector widgets available in Bonita Studio. A widget is configured by setting parameters. Some [mandatory parameters](#mandatory-common) and [optional parameters](#optional-common) are common to all types of widget. There are also some specific widget properties for some types of widget, which are listed later in this page. ++++++++++++ ### Mandatory common widget parameters | Parameter | Description | | --------- | ----------- | | id | Unique widget identifier. | | label | Text displayed beside the widget. | | widgetType | Type of the widget. Set this to Text, Password, TextArea, Checkbox, RadioGroup, Select, Array, ScriptEditor, List, or Group. | | javaType | Java type used to assign the value of this widget. This is not supported for Group widgets. | ++++++++++++ ### Optional common widget parameters | Parameter | Description | Default value | | --------- | ----------- | ------------- | | mandatory | Boolean flag that indicates whether or not this widget can be left empty. | true | | defaultValue | Default value assigned to this widget. | n/a | | description | Mouseover text displayed by the 'information' icon beside the widget. If there is no description, the icon is not displayed. | n/a | The following example is the configuration for a Text widget: ```xml ++++++++++++firstName++++++ ++++++ ++++++Text++++++ ++++++java.lang.String++++++ ++++++true++++++ ++++++John++++++ ++++++Your first name++++++++++++ ``` ### RadioGroup widget parameters | Parameter | Mandatory | Description | Default value | | --------- | ----------- | ------------- | --------- | | choices | yes | List of values for the radio button group. Each value is specified in a "choice" tag. | n/a | | orientation | no | Alignment of the widget values. One of: HORIZONTAL or VERTICAL. | VERTICAL | The following example is the configuration for a RadioGroup widget with three choices: ```xml ++++++++++++radioGroup++++++ ++++++ ++++++java.lang.String++++++ ++++++RadioGroup++++++ ++++++++++++Choice1++++++ ++++++Choice2++++++ ++++++Choice3++++++++++++ ++++++VERTICAL++++++++++++ ``` ### Select widget parameters | Parameter | Mandatory | Description | Default value | |:-|:-|:-|:-| | items | yes | List of values for the widget. Each value is specified in an "item" tag. | n/a | The following example is the configuration for a Select widget with three choices: ```xml ++++++++++++select++++++ ++++++ ++++++java.lang.String++++++ ++++++Select++++++ ++++++++++++Item1++++++ ++++++Item2++++++ ++++++Item3++++++++++++++++++ ``` ### Array widget specific parameters All Array widget specific parameters are mandatory and must be placed under a single parent "arrayOptions" tag. | Parameter | Description | | --------- | ----------- | | cols | Initial number of columns in the table. | | rows | Initial number of rows in the table. A value of -1 indicates a table with no row (only the column headers are displayed). | | fixedCols | Boolean flag that indicates whether the number of table columns can be modified by the end user. If set to "true", the user cannot add or remove columns. | | fixedRows | Boolean flag that indicates whether the number of table rows can be modified by the end user. If set to "true", the user cannot add or remove rows. | | colsCaption | List of captions for the column headers. Each caption is specified in a "colsCaption" tag. | The following example is the configuration for an Array widget two columns and any number of rows: ```xml ++++++++++++array++++++ ++++++ ++++++java.util.List++++++ ++++++Array++++++ ++++++++++++2++++++ ++++++-1++++++ ++++++true++++++ ++++++false++++++ ++++++++++++Header 1++++++ ++++++Header 2++++++++++++++++++++++++ ``` ### List widget specific parameters | Parameter | Mandatory | Description | Default value | | --------- | ----------- | ------------- | --------- | | showDocuments | no | Boolean flag that indicates whether the end user can select Bonita documents in the list of values. | false | The following example is the configuration for a List widget: ``` ++++++++++++list++++++ ++++++ ++++++java.util.List++++++ ++++++List++++++ ++++++true++++++++++++ ``` ### Group widget parameters **Note:** A Group widget does not support the common "javaType" parameter. | Parameter | Description | | --------- | ----------- | | collapsed | Boolean flag that indicates whether the group is collapsed by default. | | widgets | Specifies the list of widgets contained in the group. | The following example is the configuration for a Group widget that contains two other widgets: ```xml ++++++++++++credentials++++++ ++++++Group++++++ ++++++ ++++++true++++++ ++++++++++++++++++login++++++ ++++++java.lang.String++++++ ++++++true++++++ ++++++Text++++++ ++++++++++++ ++++++++++++password++++++ ++++++java.lang.String++++++ ++++++true++++++ ++++++Password++++++ ++++++++++++++++++++++++ ```++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +. Run the command. This generates a new folder named `artifactId` containing the connector definition project files. diff --git a/modules/ROOT/pages/connectors-overview.adoc b/modules/ROOT/pages/connectors-overview.adoc index b5d8d9eb76..5b7a4fa1fa 100644 --- a/modules/ROOT/pages/connectors-overview.adoc +++ b/modules/ROOT/pages/connectors-overview.adoc @@ -3,7 +3,7 @@ Description of the structure, definition, implementation and test of custom connectors in Bonita. -A connector is an element in a process that accesses an external system to read or write information. If the xref:_connectivity.adoc[default connectors in Bonita] are not suitable, you can implement your own connector. +A connector is an element in a process that accesses an external system to read or write information. If the xref:connectivity-overview.adoc[default connectors in Bonita] are not suitable, you can implement your own connector. In the Bonita Performance, Efficiency, and Teamwork editions, you are recommended to use the xref:connector-development-toolkit.adoc[connector development toolkit] to create new connectors. Otherwise, you can define a new connector definition or implementation in Bonita Studio, using the wizards started from the *Development* menu, *Connectors* submenu. diff --git a/modules/ROOT/pages/create-administration-tools.adoc b/modules/ROOT/pages/create-administration-tools.adoc index 8f924b923f..a82d3c164f 100644 --- a/modules/ROOT/pages/create-administration-tools.adoc +++ b/modules/ROOT/pages/create-administration-tools.adoc @@ -8,7 +8,7 @@ Discover how to create tools to administer your Bonita system using Maven and Ja The example proposes to list the failed tasks, and is wrapped in a script so that it can be executed in an environment with no window manager. You need to be familiar with building a Maven project with Bonita as a dependency. You also need to be familiar with using the Bonita Engine APIs. -If this is not the case, follow this xref:engine-api-overview.adoc]#getting-started-engine-apis[tutorial]. +If this is not the case, follow this xref:engine-api-overview.adoc#getting-started-engine-apis[tutorial]. The xref:engine-api-overview.adoc[Engine API overview] contains a list of the APIs with a short description of each one. For details of the methods available in the Bonita Engine APIs, see the http://documentation.bonitasoft.com/javadoc/api/{varVersion}/index.html[Javadoc]. This example uses the Bonita Engine Java APIs but there is also a xref:rest-api-overview.adoc[REST API]. diff --git a/modules/ROOT/pages/csrf-security.adoc b/modules/ROOT/pages/csrf-security.adoc index 5ef44becd1..b520dc4912 100644 --- a/modules/ROOT/pages/csrf-security.adoc +++ b/modules/ROOT/pages/csrf-security.adoc @@ -78,9 +78,9 @@ To use a UI page or form that was created in lower version than 7.4, you need to Follow this few steps to update your page or form: In UI designer: -1) xref:create-or-modify-a-page.adoc]#import[*Import*] the page from 7.3.X or lower version. -1) xref:create-or-modify-a-page.adoc]#export[*Export*] the page you previously imported. +1) xref:create-or-modify-a-page.adoc#import[*Import*] the page from 7.3.X or lower version. +1) xref:create-or-modify-a-page.adoc#export[*Export*] the page you previously imported. In the portal as Administrator: 1) Go on Resources entry. -1) xref:resource-management.adoc]#modify[Edit the existing page] by uploading the new one. +1) xref:resource-management.adoc#modify[Edit the existing page] by uploading the new one. diff --git a/modules/ROOT/pages/data-handling-overview.adoc b/modules/ROOT/pages/data-handling-overview.adoc index c3ca4d3b78..3e2bb56831 100644 --- a/modules/ROOT/pages/data-handling-overview.adoc +++ b/modules/ROOT/pages/data-handling-overview.adoc @@ -34,5 +34,5 @@ An application page accesses business data using the xref:bdm-api.adoc[bdm REST The data that is passed from a form to a process is defined using a xref:contracts-and-contexts.adoc[contract]. Define a contract for process instantiation and for each human task. These contracts are part of the process definition. -A form has access to business data and documents using the xref:contracts-and-contexts.adoc[context] and the xref:_rest-api.adoc[REST API]. +A form has access to business data and documents using the xref:contracts-and-contexts.adoc[context] and the xref:rest-api-overview.adoc[REST API]. A form also contains form xref:variables.adoc[variables], which have no meaning outside the form. diff --git a/modules/ROOT/pages/database-configuration.adoc b/modules/ROOT/pages/database-configuration.adoc index c8e2d21659..efe411af97 100644 --- a/modules/ROOT/pages/database-configuration.adoc +++ b/modules/ROOT/pages/database-configuration.adoc @@ -25,7 +25,7 @@ However, H2 is only suitable for testing purposes. When building a production en ==== Please note this procedure cannot be performed using the Bonita Studio. The Bonita Studio can run only on the H2 Database. -To use Bonita on another RDBMS, please use a xref:_basic-bonita-platform-installation.adoc[bundle] or set up a xref:deploy-bundle.adoc[standalone server]. +To use Bonita on another RDBMS, please use a xref:BonitaBPM_platform_setup.adoc[bundle] or set up a xref:deploy-bundle.adoc[standalone server]. ==== Here are the steps to follow. They are the same for the engine database and the business data database: diff --git a/modules/ROOT/pages/deploy-bundle.adoc b/modules/ROOT/pages/deploy-bundle.adoc index fc6e86d51a..2d11db5351 100644 --- a/modules/ROOT/pages/deploy-bundle.adoc +++ b/modules/ROOT/pages/deploy-bundle.adoc @@ -97,7 +97,7 @@ JTA data source (managed by Bitronix) You need to add your jdbc driver in TOMCAT_HOME/lib. MySQL and PostgreSQL drivers can be found in deploy bundle under DEPLOY_ZIP_HOME/setup/lib directory. For other RDBMS, -use the xref:database-configuration.adoc]#proprietary_jdbc_drivers[jdbc driver] provided by your RDBMS vendor +use the xref:database-configuration.adoc#proprietary_jdbc_drivers[jdbc driver] provided by your RDBMS vendor [#wildfly-installation] @@ -160,12 +160,12 @@ When you receive your license, copy the file to the `DEPLOY_ZIP_HOME/setup/platf == Database initialization -We assume here that the database has already been xref:database-configuration.adoc]#database_creation[created and configured for Bonita]. +We assume here that the database has already been xref:database-configuration.adoc#database_creation[created and configured for Bonita]. Once created and configured you need to initialize it using the setup tool provided in the deploy bundle archive. This will create database schema and initial values. -. In DEPLOY_ZIP_HOME/setup folder, edit the file database.properties with properties matching your rdbms. Beware of xref:BonitaBPM_platform_setup.adoc]#backslash_support[backslash characters]. -. In DEPLOY_ZIP_HOME/setup/lib add your jdbc driver if needed (only for Microsoft SQL Server or Oracle, see xref:database-configuration.adoc]#proprietary_jdbc_drivers[proprietary jdbc drivers]) +. In DEPLOY_ZIP_HOME/setup folder, edit the file database.properties with properties matching your rdbms. Beware of xref:BonitaBPM_platform_setup.adoc#backslash_support[backslash characters]. +. In DEPLOY_ZIP_HOME/setup/lib add your jdbc driver if needed (only for Microsoft SQL Server or Oracle, see xref:database-configuration.adoc#proprietary_jdbc_drivers[proprietary jdbc drivers]) . In DEPLOY_ZIP_HOME/setup folder, run `setup.(sh|bat) init` == Next steps diff --git a/modules/ROOT/pages/first-steps-after-setup.adoc b/modules/ROOT/pages/first-steps-after-setup.adoc index e47c9b6622..b6fbc6bc57 100644 --- a/modules/ROOT/pages/first-steps-after-setup.adoc +++ b/modules/ROOT/pages/first-steps-after-setup.adoc @@ -57,7 +57,7 @@ Authentication is the process of verification that an individual, entity or webs Input validation is performed to ensure only properly formed data is entering the workflow in an information system, preventing malformed data from persisting in the database and triggering malfunction of various downstream components.If you use BonitaStudio for developing your forms, then define authorized min and max values, max length and type for input fields. -For more information, please take look at the xref:rest-api-authorization.adoc[REST API authorization] and the other features relating to xref:_security-and-authentication.adoc[security and authentication] that are available in Bonita and in your operating system, and update your platform as required for your production environment. +For more information, please take look at the xref:rest-api-authorization.adoc[REST API authorization] and the other features relating to security and authentication that are available in Bonita and in your operating system, and update your platform as required for your production environment. == Create a Bonita Portal administrator diff --git a/modules/ROOT/pages/form-api.adoc b/modules/ROOT/pages/form-api.adoc index 42473575fb..aa50678d51 100644 --- a/modules/ROOT/pages/form-api.adoc +++ b/modules/ROOT/pages/form-api.adoc @@ -56,7 +56,7 @@ _Example_: `/API/form/mapping?p=0&c=10&f=processDefinitionId=7281286536417002543 * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available to search form mappings. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available to search form mappings. + The following filters can be applied while searching form mappings: ** `+f=processDefinitionId={long}+` - get form mappings of a specific process definition ** `f=type=PROCESS_START` - get the process start form mapping. Example: `+http://localhost:8080/bonita/API/form/mapping?c=1&p=0&f=processDefinitionId=123456&f=type=PROCESS_START+` diff --git a/modules/ROOT/pages/identity-api.adoc b/modules/ROOT/pages/identity-api.adoc index 0477d47eaa..880eeac425 100644 --- a/modules/ROOT/pages/identity-api.adoc +++ b/modules/ROOT/pages/identity-api.adoc @@ -273,7 +273,7 @@ _Example_: `/API/identity/group?p=0&c=100&f=parent_path%3d/acme&d=parent_group_i * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available to search form mappings. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available to search form mappings. + It is possible to filter on the following attributes: ** `name=` ** `displayName=` @@ -456,7 +456,7 @@ This action search memberships of a user. * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + *Required* ** filter is mandatory: `user_id=` @@ -841,7 +841,7 @@ _Example_: Get details of a specified user including professional and manager i * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. ** `d=professional_data` - include professionnal data in response ** `d=manager_id` - include details of user's manager in response * *Success Response* + @@ -907,7 +907,7 @@ _Example_: Search for users with names that contain "will", filter to keep only * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. ** `d=professional_data - include professionnal data in response ** `d=manager_id - include details of user's manager in response * *Success Response* + diff --git a/modules/ROOT/pages/install-a-bonita-bpm-cluster.adoc b/modules/ROOT/pages/install-a-bonita-bpm-cluster.adoc index b30e3078e1..bf275353e8 100644 --- a/modules/ROOT/pages/install-a-bonita-bpm-cluster.adoc +++ b/modules/ROOT/pages/install-a-bonita-bpm-cluster.adoc @@ -50,10 +50,10 @@ In this step you will create and initialize the database for the Bonita Platform When done you will have a database with all tables created and with a table `CONFIGURATION` containing all configuration required for the cluster to start. . Ensure that you meet the xref:hardware-and-software-requirements.adoc[requirements]. -. xref:database-configuration.adoc]#database_creation[Create the database]. -. In case you use xref:define-and-deploy-the-bdm.adoc[Business data], xref:database-configuration.adoc]#database_creation[create a database for the Business Data]. +. xref:database-configuration.adoc#database_creation[Create the database]. +. In case you use xref:define-and-deploy-the-bdm.adoc[Business data], xref:database-configuration.adoc#database_creation[create a database for the Business Data]. . Download a Bonita xref:tomcat-bundle.adoc[Tomcat bundle] or a Bonita xref:wildfly-bundle.adoc[WildFly bundle], and unzip it at some place of your choice. -. Edit file *`setup/database.properties`* and modify the properties to suit your databases (Bonita internal database & Business Data database). Beware of xref:BonitaBPM_platform_setup.adoc]#backslash_support[backslash characters]. +. Edit file *`setup/database.properties`* and modify the properties to suit your databases (Bonita internal database & Business Data database). Beware of xref:BonitaBPM_platform_setup.adoc#backslash_support[backslash characters]. In the following steps, you will update the configuration files that are in the `setup/platform_conf/initial` folder of the platform setup tool. @@ -79,21 +79,21 @@ IMPORTANT: If you don't use `bonita.platform.cluster.hazelcast.multicast.enabled For more information on this take a look at the http://docs.hazelcast.org/docs/3.4/manual/html-single/hazelcast-documentation.html#hazelcast-cluster-discovery[Hazelcast Documentation]. . Copy licenses of all your nodes in `setup/platform_conf/licenses`. -. Run `setup.sh init` or `setup.bat init` as described in the xref:BonitaBPM_platform_setup.adoc]#init_platform_conf[platform setup tool page]. +. Run `setup.sh init` or `setup.bat init` as described in the xref:BonitaBPM_platform_setup.adoc#init_platform_conf[platform setup tool page]. At the end of the script, you should see the following line: "Initial configuration files successfully pushed to database". This creates the database tables needed by Bonita platform, stores the configuration into this database, and stores the license files for all your cluster nodes into the database. -If later you need to change the configuration of the node discovery or add new licenses to the Bonita Platform configuration, you can update the configuration by following this xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[guide]. +If later you need to change the configuration of the node discovery or add new licenses to the Bonita Platform configuration, you can update the configuration by following this xref:BonitaBPM_platform_setup.adoc#update_platform_conf[guide]. [#install_first_node] === Install a first node -. Once you have done all the steps from section *Create and initialize the database for Bonita Platform* above, run `setup.sh configure` or `setup.bat configure` as described in the xref:BonitaBPM_platform_setup.adoc]#run_bundle_configure[Bundle configuration] to have your Tomcat / WildFly bundle configured to point to the right database. +. Once you have done all the steps from section *Create and initialize the database for Bonita Platform* above, run `setup.sh configure` or `setup.bat configure` as described in the xref:BonitaBPM_platform_setup.adoc#run_bundle_configure[Bundle configuration] to have your Tomcat / WildFly bundle configured to point to the right database. . Once the bundle is configured, and to avoid unsynchronized versions of the configuration files between several nodes, you are advised to delete the folder `[TOMCAT_DIRECTORY]/setup` and its entire content. Note: if you want to keep it for future configuration changes, just move the folder `[TOMCAT_DIRECTORY]/setup` and its entire content outside the `[TOMCAT_DIRECTORY]` -to use it as your main xref:BonitaBPM_platform_setup.adoc]#init_platform_conf[platform setup tool]. +to use it as your main xref:BonitaBPM_platform_setup.adoc#init_platform_conf[platform setup tool]. . If your Bonita installation is behind a proxy or is installed inside a Docker container (mainly in TcpIp or Aws discovery modes), you must declare its public address by adding the following property: `-Dhazelcast.local.publicAddress=*publicaddress*`, this property should be added in the `[TOMCAT_DIRECTORY]/setup/tomcat-templates/setenv.sh` or `[TOMCAT_DIRECTORY]/setup/tomcat-templates/setenv.bat` @@ -213,9 +213,9 @@ To dismantle a cluster: . When all nodes have been stopped, update the load balancer to remove the cluster. The individual nodes can now be used as standalone Bonita server, provided the following change in the configuration is done: -Update file `bonita-platform-sp-custom.properties` located in the `platform_engine` folder of the configuration, use the xref:BonitaBPM_platform_setup.adoc]#configuration_files[platform setup tool] to update it and set back the *`bonita.cluster`* property to *`false`*. +Update file `bonita-platform-sp-custom.properties` located in the `platform_engine` folder of the configuration, use the xref:BonitaBPM_platform_setup.adoc#configuration_files[platform setup tool] to update it and set back the *`bonita.cluster`* property to *`false`*. -See xref:BonitaBPM_platform_setup.adoc]#updating_configuration[How to update a Bonita Tomcat Bundle configuration] for more details on updating the configuration. +See xref:BonitaBPM_platform_setup.adoc#updating_configuration[How to update a Bonita Tomcat Bundle configuration] for more details on updating the configuration. === Managing the cluster with Hazelcast @@ -227,7 +227,7 @@ If you are using multicast, you must ensure that your production environment is This is to ensure the nodes do not discover each other on the network, if they are not supposed to run inside the same cluster. 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:BonitaBPM_platform_setup.adoc]#configuration_files[platform setup tool] to update it. +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:BonitaBPM_platform_setup.adoc#configuration_files[platform setup tool] to update it. == FAQ diff --git a/modules/ROOT/pages/licenses.adoc b/modules/ROOT/pages/licenses.adoc index 0c797de85f..d5b4b2e8c3 100644 --- a/modules/ROOT/pages/licenses.adoc +++ b/modules/ROOT/pages/licenses.adoc @@ -23,7 +23,7 @@ Each time a case starts, the case counter is increased by one. + Case-counter licenses are available for development and for production. A development license must not be used for production, and typically has a lower case limit than a production license. + The maximum number of cases is defined in your commercial contract, in discussion with your sales person. -You can monitor the case counter using Bonita Portal _License_ page in the Administrator profile, or using the xref:platform-api.adoc]#license[REST API] to create a custom monitoring / alerting tool. + +You can monitor the case counter using Bonita Portal _License_ page in the Administrator profile, or using the xref:platform-api.adoc#license[REST API] to create a custom monitoring / alerting tool. + Those two means also allow you to check the expiration date of the license. When the case counter reaches the limit set in the license, no more cases can be started. Active cases continue to completion. + @@ -34,7 +34,7 @@ If a user tries to submit an instantiation form after the case counter maximum l Your contract with Bonitasoft specifies the details of the subscription you have purchased, including the edition, and case limit for case-counter licensing. A license matching the subscription details is generated on request. -If this is a license renewal, you can find your request key in the Bonita Portal _License_ menu of the Administrator profile or using the xref:platform-api.adoc]#license[platform REST API]. + +If this is a license renewal, you can find your request key in the Bonita Portal _License_ menu of the Administrator profile or using the xref:platform-api.adoc#license[platform REST API]. + A request key looks like this: `(CIVpYDRB8bhouXdWadLY1M9TVctwYUYuv7ou7sqeIrSUSuCqUIkjQAs0ZGgzbtqv3gguFOHlyMZkyvwdr4HLgg==)`. If this is the first time you generate a license, you need to generate a request key. @@ -59,15 +59,15 @@ The license file will be sent to you by email. When you receive the license file (`.lic` file extension): * If this is the first time you start the bundle, copy the file to the``/setup/platform_conf/licenses`` folder or `/setup/platform_conf/licenses/` folder before starting the bundle. -* If the bundle has already been started, xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[you need to use the Platform setup tool] to push your license file to database. +* If the bundle has already been started, xref:BonitaBPM_platform_setup.adoc#update_platform_conf[you need to use the Platform setup tool] to push your license file to database. Don't forget to restart your application server after pushing the license to the database. == License renewal scheduling If you are still within the Subscription period when you approach the license expiration date, request a new license that starts on the last day of your current license. + -xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[Use the Platform setup tool] to pull the existing configuration from the database. +xref:BonitaBPM_platform_setup.adoc#update_platform_conf[Use the Platform setup tool] to pull the existing configuration from the database. Put the license you receive in the license folder alongside the existing license. -xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[Use the Platform setup tool] to push your license file to database. +xref:BonitaBPM_platform_setup.adoc#update_platform_conf[Use the Platform setup tool] to push your license file to database. Don't forget to restart your application server after pushing the license to the database. When you reach the "changeover" date for the licenses, Bonita Engine switches automatically from the expired license to the valid one. diff --git a/modules/ROOT/pages/maintenance-operation.adoc b/modules/ROOT/pages/maintenance-operation.adoc index ba3ac3cd64..66cd39efd2 100644 --- a/modules/ROOT/pages/maintenance-operation.adoc +++ b/modules/ROOT/pages/maintenance-operation.adoc @@ -1,11 +1,8 @@ = Bonita Platform Maintenance Operation -:description: :doctype: book - -:doctype: book Learn how maintenance operations can help reducing disk space used by the Bonita Platform. -= Purge archive tables +== Purge archive tables Archive tables contain the execution history of the Bonita Platform. Some of these tables can be purged to reduce size on disk. @@ -19,8 +16,6 @@ These section will describe how to purge the `archive_contract_data` table, depe [WARNING] ==== - - _This operation is destructive, data will be not usable for audit or analytic purpose. It is highly recommended to backup data before the purge._ ==== @@ -34,8 +29,6 @@ To delete all rows from the `arch_contract_data`, you can use the `TRUNCATE TABL [NOTE] ==== - - After a migration to the bonita 7.7 version, the data of the `archive_contract_data` table has been moved to the new `arch_contract_data_backup` table for migration purpose. In that case, If the `live-migration` tool was not executed (please see [Bonita migration steps]|migrate-from-an-earlier-version-of-bonita-bpm.md), you will also need to drop the table `arch_contract_data_backup`: diff --git a/modules/ROOT/pages/manage-the-platform.adoc b/modules/ROOT/pages/manage-the-platform.adoc index fa01434f7e..c5d0710f0e 100644 --- a/modules/ROOT/pages/manage-the-platform.adoc +++ b/modules/ROOT/pages/manage-the-platform.adoc @@ -42,7 +42,7 @@ platformAPI.initializePlatform(); No users are created by default and the default username/password for the technical user to connect to Bonita Engine can be retrieved in the file `setup/platform_conf/current/tenants/[tenant_id]/tenant_engine/bonita-tenant-community-custom.properties` using the xref:BonitaBPM_platform_setup.adoc[plaform setup tool] (`[tenant_id]` being the default tenant ID, that is to say `1` when using the default configuration on a fresh installation). -Once you retrieved the default configuration using the xref:BonitaBPM_platform_setup.adoc[plaform setup tool], you can change this username/password by editing the file `bonita-tenant-community-custom.properties` and use the tool again to xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[push the configuration to database]. +Once you retrieved the default configuration using the xref:BonitaBPM_platform_setup.adoc[plaform setup tool], you can change this username/password by editing the file `bonita-tenant-community-custom.properties` and use the tool again to xref:BonitaBPM_platform_setup.adoc#update_platform_conf[push the configuration to database]. . *Start Bonita engine* diff --git a/modules/ROOT/pages/migrate-from-an-earlier-version-of-bonita-bpm.adoc b/modules/ROOT/pages/migrate-from-an-earlier-version-of-bonita-bpm.adoc index 8acf044532..bbf52e36ad 100644 --- a/modules/ROOT/pages/migrate-from-an-earlier-version-of-bonita-bpm.adoc +++ b/modules/ROOT/pages/migrate-from-an-earlier-version-of-bonita-bpm.adoc @@ -42,9 +42,9 @@ The version targeted may not support the version of the database that is being m * Please check the xref:hardware-and-software-requirements.adoc[database requirements]. * If you need to upgrade your database: - ** Please make sure to apply all the xref:database-configuration.adoc]#specific_database_configuration[RDBMS customisations required by Bonita] when setting up the new version. - ** Please make sure to use the xref:database-configuration.adoc]#proprietary_jdbc_drivers[appropriate JDBC driver] - ** WARNING: *Oracle database* requires to use the official driver for each specific version. Make sure your driver's checksum matches the Oracle official one for your xref:database-configuration.adoc]#proprietary_jdbc_drivers[database version] + ** Please make sure to apply all the xref:database-configuration.adoc#specific_database_configuration[RDBMS customisations required by Bonita] when setting up the new version. + ** Please make sure to use the xref:database-configuration.adoc#proprietary_jdbc_drivers[appropriate JDBC driver] + ** WARNING: *Oracle database* requires to use the official driver for each specific version. Make sure your driver's checksum matches the Oracle official one for your xref:database-configuration.adoc#proprietary_jdbc_drivers[database version] ==== *Community/Subscription edition:* @@ -58,7 +58,7 @@ The tool migrates your platform (_bonita_home_ folder and the database). You can Starting from version 7.3 there is no more _bonita home_ folder. This means that, if your installation does not have any custom change, then you do not need to configure the bundle any further for an installation migrated in 7.3 or above. -On the other hand, if you have customized your configuration, you will have to use the xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[platform setup tool] to send your customized configuration files to the database where configuration is stored, for versions 7.3 and above. +On the other hand, if you have customized your configuration, you will have to use the xref:BonitaBPM_platform_setup.adoc#update_platform_conf[platform setup tool] to send your customized configuration files to the database where configuration is stored, for versions 7.3 and above. ==== image::images/images-6_0/migration_bigsteps.png[Migration steps] @@ -82,7 +82,7 @@ The migration script migrates the following: The following are not migrated automatically: -* Configuration of the platform: Before 7.3 in the _Bonita Home_ folder and after 7.3 in database. Reapply your customizations manually after the migration script has finished (using xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[platform setup tool] if migrated to 7.3.0+). +* Configuration of the platform: Before 7.3 in the _Bonita Home_ folder and after 7.3 in database. Reapply your customizations manually after the migration script has finished (using xref:BonitaBPM_platform_setup.adoc#update_platform_conf[platform setup tool] if migrated to 7.3.0+). * Deployed process definitions: The processes will continue to run using the definition created in the previous version of Bonita. * Process definition sources (`.bos` files): Migrate these by importing them into the new version of Bonita Studio. * ++++++++++++Business data model, and the business data database: if the migration path include version `7.0.0`,`7.2.0` or `7.2.4`, the Business data model must be redeployed after migration, using link:define-and-deploy-the-bdm[Define and deploy the BDM]). Otherwise, no action is required. @@ -112,7 +112,7 @@ Then xref:managing-look-feel.adoc[import] your updated custom Look & Feel into B *Important:* + The migration operation resets the Bonita configuration files to default version for new settings to be applied (from the _$BONITA_HOME_ folder in <7.3.0 version or inside database in >=7.3.0). -Therefore, you must do a xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[backup of your configuration files] before starting the migration. + +Therefore, you must do a xref:BonitaBPM_platform_setup.adoc#update_platform_conf[backup of your configuration files] before starting the migration. + You will need to merge custom properties and configurations to the migrated environment. Furthermore, from the database point of view, as any operations on a production system, a migration is not a zero risk operation. + @@ -148,7 +148,7 @@ or from the https://customer.bonitasoft.com/download/request[Customer Portal] fo . Check your current RDBMS version is compliant with the versions supported by the target version of Bonita (see <>) . Unzip the migration tool zip file into a directory. In the steps below, this directory is called `bonita-migration`. . If you use Oracle or Microsoft SQL Server, add the JDBC driver for your database type to `bonita-migration/lib`. This is the same driver as you have installed in -your web server `lib` directory. *Warning*: For Oracle, make sure you double check that you use the official driver version that match your Database version. The correct driver is mandatory for a smooth migration: xref:database-configuration.adoc]#proprietary_jdbc_drivers[Follow instructions for Oracle driver download.] +your web server `lib` directory. *Warning*: For Oracle, make sure you double check that you use the official driver version that match your Database version. The correct driver is mandatory for a smooth migration: xref:database-configuration.adoc#proprietary_jdbc_drivers[Follow instructions for Oracle driver download.] . Configure the database properties needed by the migration script, by editing `bonita-migration/Config.properties`. Specify the following information: + @@ -234,7 +234,7 @@ There is below a Linux example: ---- + You must reapply the configuration that had been done on the original instance'sbonita_homein the `bonita-target-version/setup/platform_conf/current` -Please refer to the guide on updating the configurationfile using the xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[platform setup tool] +Please refer to the guide on updating the configurationfile using the xref:BonitaBPM_platform_setup.adoc#update_platform_conf[platform setup tool] + When done, push the updated configuration into the database: + @@ -244,15 +244,15 @@ When done, push the updated configuration into the database: . If you have done specific configuration and customization in your server original version, re-do it by configuring the application server at `bonita-target-version/server` (or `bonita-target-version` if target version is 7.3.n): customization, libs etc. . *If your Bonita version is 7.4 or above before migrating, you can skip this point.* ++++++++++++ -In the case where deployed resources have required dedicated xref:resource-management.adoc]#permissions[authorizations to use the REST API], these authorizations are not automatically migrated. -Some manual operations have to be done on files that are located in the extracted `platform_conf/current` folder (see xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[Update Bonita Platform configuration] for more information). You need to: +In the case where deployed resources have required dedicated xref:resource-management.adoc#permissions[authorizations to use the REST API], these authorizations are not automatically migrated. +Some manual operations have to be done on files that are located in the extracted `platform_conf/current` folder (see xref:BonitaBPM_platform_setup.adoc#update_platform_conf[Update Bonita Platform configuration] for more information). You need to: ** Perform a diff between the version before migration and the version after migration of `tenants/[TENANT_ID]/conf/compound-permissions-mapping.properties` and put the additional lines into the file `tenants/[TENANT_ID]/conf/compound-permissions-mapping-custom.properties` ** Perform a diff between the version before migration and the version after migration of `tenants/[TENANT_ID]/conf/resources-permissions-mapping.properties` and put the additional lines into the file `tenants/[TENANT_ID]/conf/resources-permissions-mapping-custom.properties` ** Perform a diff between the version before migration and the version after migration of `tenants/[TENANT_ID]/conf/dynamic-permissions-checks.properties` and put the additional lines into the file `tenants/[TENANT_ID]/conf/dynamic-permissions-checks-custom.properties` ** Report all the content of the version before migration of``tenants/[TENANT_ID]/conf/custom-permissions-mapping.properties`` into the new version. . Configure License: + -you need to put a new license in the database: see xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[Platform configuration] for further details. +you need to put a new license in the database: see xref:BonitaBPM_platform_setup.adoc#update_platform_conf[Platform configuration] for further details. There is below a Linux example: + ---- @@ -265,7 +265,7 @@ you need to put a new license in the database: see xref:BonitaBPM_platform_setup If there is no valid license in the `./platform_conf/licenses/`, these 2 pages will help you to request and install a new one: ** https://documentation.bonitasoft.com/?page=licenses[Licenses] - ** xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[Platform configuration] + ** xref:BonitaBPM_platform_setup.adoc#update_platform_conf[Platform configuration] + Install the new license: diff --git a/modules/ROOT/pages/optimize-user-tasklist.adoc b/modules/ROOT/pages/optimize-user-tasklist.adoc index 084db7ad36..3ba30d5b3b 100644 --- a/modules/ROOT/pages/optimize-user-tasklist.adoc +++ b/modules/ROOT/pages/optimize-user-tasklist.adoc @@ -229,7 +229,7 @@ Unlike the "technical" name and description of a task in the Studio, which are u Another feature you can use to improve end users efficiency and satisfaction is _word-based search_: + To allow users to efficiently search by task name, you can configure the search option: from _starts by_ (the beginning of the whole task name string), you can switch to _word-based search_ (the beginning of every word in the task name). -To do so, go to xref:using-list-and-search-methods.adoc]#word_based_search[word-based search]. +To do so, go to xref:using-list-and-search-methods.adoc#word_based_search[word-based search]. [NOTE] ==== diff --git a/modules/ROOT/pages/overview-of-bonita-bpm-in-a-cluster.adoc b/modules/ROOT/pages/overview-of-bonita-bpm-in-a-cluster.adoc index f785cdb528..a44882eacb 100644 --- a/modules/ROOT/pages/overview-of-bonita-bpm-in-a-cluster.adoc +++ b/modules/ROOT/pages/overview-of-bonita-bpm-in-a-cluster.adoc @@ -85,7 +85,7 @@ The nodes must all be in the same datacenter, to keep latency of updates to shar All nodes must run the same software configuration (same versions on Bonita and application server). -The xref:install-a-bonita-bpm-cluster.adoc]#disable-hibernate-cache[Hibernate cache must be disabled]. +The xref:install-a-bonita-bpm-cluster.adoc#disable-hibernate-cache[Hibernate cache must be disabled]. The load balancer must be configured to use sticky sessions (this is needed to manage sessions created when users log in to the Portal). diff --git a/modules/ROOT/pages/pages.adoc b/modules/ROOT/pages/pages.adoc index a05a981ec2..3c416e82f6 100644 --- a/modules/ROOT/pages/pages.adoc +++ b/modules/ROOT/pages/pages.adoc @@ -78,7 +78,7 @@ Two custom page examples are available in the Bonita Portal. Both examples show *HTML example page* defines a custom page using only HTML. In practice, you will probably use a combination of Groovy and HTML to create your custom pages. -To view an example page, publish the page to a xref:custom-profiles.adoc[custom profile] or an xref:applications.adoc[application] so that you can view it in the portal. To view the source of an example, xref:resource-management.adoc]#export[export the custom page]. +To view an example page, publish the page to a xref:custom-profiles.adoc[custom profile] or an xref:applications.adoc[application] so that you can view it in the portal. To view the source of an example, xref:resource-management.adoc#export[export the custom page]. On the https://customer.bonitasoft.com/[Customer Portal], there is also an example in the form of a seed project for creating custom pages using AngularJS and a customizable example task list page. diff --git a/modules/ROOT/pages/portal-api.adoc b/modules/ROOT/pages/portal-api.adoc index fb1a5fa73c..b70436c3e8 100644 --- a/modules/ROOT/pages/portal-api.adoc +++ b/modules/ROOT/pages/portal-api.adoc @@ -150,7 +150,7 @@ Use a GET method with filters and search terms to search for custom pages. * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + You can filter on: ** `+createdBy={user_id}+`: retrieve only the pages created by the specified user ID. For example, to retrieve the custom pages created by the user with id 1: `+http://localhost:8080/bonita/API/portal/page?p=0&c=10&f=createdBy%3d1+`. @@ -316,7 +316,7 @@ Use a GET method with filters and search terms to search for profiles. * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + You can filter on: ** `+name={exact_profile_name}+`: retrieve only the profiles with the specified name. For example, retrieve the profile with `name=Administrator`: `/API/portal/profile?p=0&c=10&f=name%3dAdministrator` ** `hasNavigation={true|false}`: retrieve the profiles with (or without) attached navigation pages (profile entries): `/API/portal/profile?p=0&c=10&f=hasNavigation=true` @@ -524,7 +524,7 @@ Use a GET method with filters and search terms to search for profileEntry items. * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + You can filter on: ** `+page={exact_pageToken}+`: retrieve only the profileEntry items with the specified tokenName. For example, retrieve the profileEntry with page name = tasklistinguser: `/API/portal/profileEntry?p=0&c=10&f=page%3dtasklistinguser`. ** `+name={exact_page_name}+`: retrieve only the profileEntry items with the specified pageName. For example, retrieve the profileEntry with page name = Tasks: `/API/portal/profileEntry?p=0&c=10&f=name%3dTasks`. @@ -657,7 +657,7 @@ Use a GET method with filters and search terms to search for profileMembers. * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + There is a mandatory filter on: ** `member_type=`. For example, retrieve the profileMembers of type user: `/API/portal/profileMember?p=0&c=10&f=member_type%3duser` diff --git a/modules/ROOT/pages/release-notes.adoc b/modules/ROOT/pages/release-notes.adoc index 5d0b2eff01..6beccdc706 100644 --- a/modules/ROOT/pages/release-notes.adoc +++ b/modules/ROOT/pages/release-notes.adoc @@ -45,7 +45,7 @@ Reminder: such edited JavaScript won't be readable back to the UI Designer, and The exported .zip still contains the JSON file, and this is the file used by the UI Designer. * Living Application layout doesn't reload when user selects another menu option As a consequence, the new content is displayed faster. -Attention: if your applications layout is based on the default layout, see how to xref:customize-living-application-layout.adoc]#improve-navigation[update your custom layout] to take advantage of this improvement. +Attention: if your applications layout is based on the default layout, see how to xref:customize-living-application-layout.adoc#improve-navigation[update your custom layout] to take advantage of this improvement. * If your pages call REST API extensions on BDM data, a new documentation page has been created to help you make them as efficient as possible. Performances on realistic pages show a 20% improvement with an Ethernet connection, and a 40% improvement on 3G. diff --git a/modules/ROOT/pages/resource-management.adoc b/modules/ROOT/pages/resource-management.adoc index 72990d70ac..ed9e33e042 100644 --- a/modules/ROOT/pages/resource-management.adoc +++ b/modules/ROOT/pages/resource-management.adoc @@ -80,7 +80,7 @@ After a resource is added to the portal, it can be used in an xref:applications. [WARNING] ==== -As the deployment of resources automatically creates the appropriate resource permissions mapping, be careful not to xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[push a configuration] that does not contain the latest permissions updates. This would overwrite the deployed configuration. To avoid doing so, pull the latest configuration, edit the needed elements and push it back to the Bonita runtime in a pretty short amount of time. +As the deployment of resources automatically creates the appropriate resource permissions mapping, be careful not to xref:BonitaBPM_platform_setup.adoc#update_platform_conf[push a configuration] that does not contain the latest permissions updates. This would overwrite the deployed configuration. To avoid doing so, pull the latest configuration, edit the needed elements and push it back to the Bonita runtime in a pretty short amount of time. ==== [#modify] diff --git a/modules/ROOT/pages/rest-api-extensions.adoc b/modules/ROOT/pages/rest-api-extensions.adoc index 03e2f46c62..693d6a36bb 100644 --- a/modules/ROOT/pages/rest-api-extensions.adoc +++ b/modules/ROOT/pages/rest-api-extensions.adoc @@ -221,7 +221,7 @@ Without this exclusion, the REST API Extension build fails because of some missi . Click *Next*. . Enter the *pathTemplate* for this REST API extension, for example _userInformation_. This will be the access point of the API, and follows this pattern: `+{bonita_portal_context}/API/extension/userInformation+`. . As this REST API extension does not access business data you can safely uncheck "Add BDM dependencies" check box. -. Define a *Permission* name for the extension (replace the default one), for example _read_user_information_. This is the name of the permission the users should have to be granted access to the extension (see xref:api-extensions.adoc]#usage[REST API extensions usage] +. Define a *Permission* name for the extension (replace the default one), for example _read_user_information_. This is the name of the permission the users should have to be granted access to the extension (see xref:api-extensions.adoc#usage[REST API extensions usage] . Click *Next* . This screen defines *URL parameters* that will be passed to the API. By default, _p_ and _c_ parameters are defined to enables paged result, it applies well in our examples as we want to return a list of users. . Click *Create*. @@ -442,5 +442,5 @@ return buildResponse(responseBuilder, HttpServletResponse.SC_OK,new JsonBuilder( We do not recommend to manage time zone at the Rest API level, as the local of the Rest API server, the Bonita Engine server, and the End User machine could be different. So we encourage you to manipulate UTC dates only server-side. -You can see how we xref:datetimes-management-tutorial.adoc]#toc2[manage the time zone using the date time picker]. This time zone should only be managed in the end user interface. +You can see how we xref:datetimes-management-tutorial.adoc#toc2[manage the time zone using the date time picker]. This time zone should only be managed in the end user interface. ==== diff --git a/modules/ROOT/pages/rest-api-overview.adoc b/modules/ROOT/pages/rest-api-overview.adoc index fde568c9e3..c489006d21 100644 --- a/modules/ROOT/pages/rest-api-overview.adoc +++ b/modules/ROOT/pages/rest-api-overview.adoc @@ -33,12 +33,12 @@ Make sure your application has authentified your user before calling other APIs After the application is connected to the Bonita Engine, you can start calling API methods. The following is a typical scenario for an end user. -. xref:bpm-api.adoc]#case[Start a new case with variables]: Provide a form for the user to enter initial data. Then call the method to start a new case using the values entered by the user to initialize some variables. The engine will start the execution of the process. Depending on the design of your process, there might then be some human tasks available for the end user. -. xref:bpm-api.adoc]#human-task[List the pending tasks for a user]: Retrieve a list of available human tasks for the logged in user. When the user selects a task to do, you can display the corresponding form. It can be an external form or a Bonita form that can be accessed by url. -. xref:bpm-api.adoc]#activity[Update variables and execute a task]: If your application is using an external form, update the values of the variables in your process. +. xref:bpm-api.adoc#case[Start a new case with variables]: Provide a form for the user to enter initial data. Then call the method to start a new case using the values entered by the user to initialize some variables. The engine will start the execution of the process. Depending on the design of your process, there might then be some human tasks available for the end user. +. xref:bpm-api.adoc#human-task[List the pending tasks for a user]: Retrieve a list of available human tasks for the logged in user. When the user selects a task to do, you can display the corresponding form. It can be an external form or a Bonita form that can be accessed by url. +. xref:bpm-api.adoc#activity[Update variables and execute a task]: If your application is using an external form, update the values of the variables in your process. You can use a method to update process or activity variables with values coming from your application. When the user submits the external form, you can call a method to execute a task. The engine will then continue the execution of the workflow as designed. -. xref:bpm-api.adoc]#connector-instance[Handle tasks in error]: Get a list of tasks that are in the failed state, and then replay each task by doing three steps: get the list of failed connectors, reset the state of failed connectors and replay the failed task. +. xref:bpm-api.adoc#connector-instance[Handle tasks in error]: Get a list of tasks that are in the failed state, and then replay each task by doing three steps: get the list of failed connectors, reset the state of failed connectors and replay the failed task. === Logout from Bonita diff --git a/modules/ROOT/pages/rta-mail-template.adoc b/modules/ROOT/pages/rta-mail-template.adoc index e52c753ff2..eb05269892 100644 --- a/modules/ROOT/pages/rta-mail-template.adoc +++ b/modules/ROOT/pages/rta-mail-template.adoc @@ -1,7 +1,4 @@ = How to use the rich textarea widget in a mail template -:description: :doctype: book - -:doctype: book :experimental: Learn how to use a mail template in a form with the rich textarea widget: the leave request management process example. @@ -136,7 +133,7 @@ Once this task is completed, a new _Check email content_ human task is available Here, the out of office mail message has been validated and the way the mail server handle the out of office mail configuration for a given user depends on the mail server provider and will not be detailed here. + It will use a connector that will send the appropriate information via an external API. -= Form for 'Check Email content' task +== Form for 'Check Email content' task On 'Check Email content' task, in the menu:Execution[Form] pane, use the pencil :fa-pencil: icon to generate a default form from the contract. + It will look like this: diff --git a/modules/ROOT/pages/set-up-kpis.adoc b/modules/ROOT/pages/set-up-kpis.adoc index 9dba9a234a..b1d9fbde06 100644 --- a/modules/ROOT/pages/set-up-kpis.adoc +++ b/modules/ROOT/pages/set-up-kpis.adoc @@ -101,6 +101,6 @@ This implementation option is better for performance and flexibility reasons: The disadvantage with this implementation option is that it requires basic SQL knowledge because you have to write insertion queries manually. -To configure this option, use a xref:_database.adoc[database connector] to insert a row in the reporting database. +To configure this option, use a xref:list-of-database-connectors.adoc[database connector] to insert a row in the reporting database. Use the datasource database connector with connection pooling for improved performance. diff --git a/modules/ROOT/pages/single-sign-on-with-saml.adoc b/modules/ROOT/pages/single-sign-on-with-saml.adoc index fa8972597f..7071a35485 100644 --- a/modules/ROOT/pages/single-sign-on-with-saml.adoc +++ b/modules/ROOT/pages/single-sign-on-with-saml.adoc @@ -435,4 +435,4 @@ Here is the subset of pages filtered by the SAML filter: REST API are not part of them, but if an http session already exists thanks to cookies, REST API can be used. -The recommended way to authenticate to Bonita Portal to use the REST API is to use the xref:rest-api-overview.adoc]#bonita-authentication[login service].. +The recommended way to authenticate to Bonita Portal to use the REST API is to use the xref:rest-api-overview.adoc#bonita-authentication[login service].. diff --git a/modules/ROOT/pages/software-extensibility.adoc b/modules/ROOT/pages/software-extensibility.adoc index f68b251540..51b5de7a35 100644 --- a/modules/ROOT/pages/software-extensibility.adoc +++ b/modules/ROOT/pages/software-extensibility.adoc @@ -18,7 +18,7 @@ These extension points are guaranteed to be stable across versions of Bonita 6: In Community, Teamwork, Efficiency, and Performance editions -Bonita comes with more than 80 xref:_connectivity.adoc[standard connectors] to the major information system components: major databases (Oracle, Microsoft, Postgres, etc.), SOAP Webservice, Salesforce, Email, etc. +Bonita comes with more than 80 xref:connectivity-overview.adoc[standard connectors] to the major information system components: major databases (Oracle, Microsoft, Postgres, etc.), SOAP Webservice, Salesforce, Email, etc. A new connector enables you to provide new connectivity capabilities for processes. To xref:connectors-overview.adoc[implement a new connector], you need to provide some XML description files and a Java class respecting the http://documentation.bonitasoft.com/javadoc/api/{varVersion}/index.html[Connector interface]. diff --git a/modules/ROOT/pages/system-api.adoc b/modules/ROOT/pages/system-api.adoc index e53853e864..ad7a4b3985 100644 --- a/modules/ROOT/pages/system-api.adoc +++ b/modules/ROOT/pages/system-api.adoc @@ -36,7 +36,7 @@ The methods used for this resource are: * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. * *Success Response* + The list of locales as JSON ** *Code*: 200 @@ -95,7 +95,7 @@ Returns all translations of the product. If a locale is specified in the filter, * *Method* + `GET` * *Data Params* + -xref:rest-api-overview.adoc]#resource_search[Standard search parameters] are available. + +xref:rest-api-overview.adoc#resource_search[Standard search parameters] are available. + _Example_: `/API/system/i18ntranslation?p=0&c=2&f=locale%3dde` * *Success Response* + The list of translations as JSON diff --git a/modules/ROOT/pages/tomcat-bundle.adoc b/modules/ROOT/pages/tomcat-bundle.adoc index 1fd4d8de14..c6b3efcbb9 100644 --- a/modules/ROOT/pages/tomcat-bundle.adoc +++ b/modules/ROOT/pages/tomcat-bundle.adoc @@ -3,7 +3,7 @@ You will find here the mandatory and optional steps needed to install and configure the Tomcat bundle to run the Bonita platform. -The Tomcat bundle is a .zip archive that contains the Apache Tomcat Java EE application server prepackaged along with Bonita and xref:BonitaBPM_platform_setup.adoc]#platform_setup_tool[Bonita platform setup tool]. +The Tomcat bundle is a .zip archive that contains the Apache Tomcat Java EE application server prepackaged along with Bonita and xref:BonitaBPM_platform_setup.adoc#platform_setup_tool[Bonita platform setup tool]. The Tomcat bundle is a regular .zip archive based on Tomcat zip distribution. [WARNING] @@ -150,9 +150,9 @@ If you just want to try Bonita Platform with the embedded H2 database (only for For production, you are recommended to use one of the supported databases, with the following steps. ==== -. Make sure xref:database-configuration.adoc]#database_creation[your databases are created] and xref:database-configuration.adoc]]#specific_database_configuration[customized to work with Bonita]. -. Edit file `/setup/database.properties` and modify the properties to suit your databases (Bonita internal database & Business Data database). Beware of xref:BonitaBPM_platform_setup.adoc]#backslash_support[backslash characters]. -. If you use *Microsoft SQL Server* or *Oracle* database, copy your xref:database-configuration.adoc]#proprietary_jdbc_drivers[jdbc driver] in `/setup/lib/` folder. +. Make sure xref:database-configuration.adoc#database_creation[your databases are created] and xref:database-configuration.adoc#specific_database_configuration[customized to work with Bonita]. +. Edit file `/setup/database.properties` and modify the properties to suit your databases (Bonita internal database & Business Data database). Beware of xref:BonitaBPM_platform_setup.adoc#backslash_support[backslash characters]. +. If you use *Microsoft SQL Server* or *Oracle* database, copy your xref:database-configuration.adoc#proprietary_jdbc_drivers[jdbc driver] in `/setup/lib/` folder. . Run `\setup\start-bonita.bat` (Windows system) or `/setup/start-bonita.sh` (Unix system) to run Bonita Tomcat bundle (see <>) [NOTE] @@ -171,7 +171,7 @@ The *start-bonita* script does the following: .. copies your database vendor-specific drivers from `/setup/lib` to `/setup/server/lib/bonita` . Starts the Tomcat bundle -For advanced server configuration needs: check out xref:BonitaBPM_platform_setup.adoc]#run_bundle_configure[Bundle configuration] to finely tune your Tomcat bundle, using templates used by Bonita. +For advanced server configuration needs: check out xref:BonitaBPM_platform_setup.adoc#run_bundle_configure[Bundle configuration] to finely tune your Tomcat bundle, using templates used by Bonita. ==== [#start] @@ -206,19 +206,19 @@ Once you have your Tomcat bundle up and running, complete these xref:first-steps === Configuration update -To update Bonita configuration after the first run, take a look at the xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[platform setup tool] +To update Bonita configuration after the first run, take a look at the xref:BonitaBPM_platform_setup.adoc#update_platform_conf[platform setup tool] [NOTE] ==== -* The file `database.properties` is the entry point to configure the xref:BonitaBPM_platform_setup.adoc]#run_bundle_configure[Tomcat environment] and the xref:BonitaBPM_platform_setup.adoc]]#configure_tool[Bonita Platform configuration]. +* The file `database.properties` is the entry point to configure the xref:BonitaBPM_platform_setup.adoc#run_bundle_configure[Tomcat environment] and the xref:BonitaBPM_platform_setup.adoc#configure_tool[Bonita Platform configuration]. * You can use command line arguments to specify database properties directly from the command line. Use `/setup/setup.sh --help` on Linux or `\setup\setup.bat --help` on Windows to have a list of available options. ==== === License update -To update the licenses after the first run, take a look at the xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[platform setup tool] +To update the licenses after the first run, take a look at the xref:BonitaBPM_platform_setup.adoc#update_platform_conf[platform setup tool] == Troubleshooting diff --git a/modules/ROOT/pages/upgrade-from-community-to-a-subscription-edition.adoc b/modules/ROOT/pages/upgrade-from-community-to-a-subscription-edition.adoc index 9f501c11a7..449fa79d61 100644 --- a/modules/ROOT/pages/upgrade-from-community-to-a-subscription-edition.adoc +++ b/modules/ROOT/pages/upgrade-from-community-to-a-subscription-edition.adoc @@ -41,11 +41,11 @@ A Bonita platform upgrade can only be performed on the same database type. To upgrade a Bonita platform from Community edition to a Subscription edition, follow these steps: . xref:bonita-bpm-installation-overview.adoc[Install the Subscription Bundle] but do not start it. We will call this installation folder `bonita-subscription`. -. Configure the Subscription installation to use your existing database editing the file `/setup/database.properties`. Beware of xref:BonitaBPM_platform_setup.adoc]#backslash_support[backslash characters]. +. Configure the Subscription installation to use your existing database editing the file `/setup/database.properties`. Beware of xref:BonitaBPM_platform_setup.adoc#backslash_support[backslash characters]. . Shut down the Community server being migrated using the `stop-bonita` script, we will call this installation folder `bonita-community`. . Run `/setup/setup(.sh/.bat) pull` to fetch your current Community configuration in `/setup/platform_conf/current` and copy this last in a different folder, we will call this new folder `bonita-community-configuration`. . xref:back-up-bonita-bpm-platform.adoc[Backup your Bonita platform and databases]. -. Update the configuration using the xref:BonitaBPM_platform_setup.adoc]#configure_tool[Platform setup tool] in `bonita-subscription`: +. Update the configuration using the xref:BonitaBPM_platform_setup.adoc#configure_tool[Platform setup tool] in `bonita-subscription`: .. Create the folder `/setup/platform_conf/current`, we will call it `bonita-subscription-configuration`. .. Copy the content of the `/setup/platform_conf/initial` to `bonita-subscription-configuration`. .. In the `bonita-subscription-configuration`, reapply the modifications for all the folders but the one named `tenants` (use `bonita-community-configuration` as a reference). diff --git a/modules/ROOT/pages/variables.adoc b/modules/ROOT/pages/variables.adoc index f09075d2d2..1828e11d2f 100644 --- a/modules/ROOT/pages/variables.adoc +++ b/modules/ROOT/pages/variables.adoc @@ -23,7 +23,7 @@ Expression, external API and URL parameter variables are evaluated every time so === External API -External API variables are used to fetch data from outside the page. These are typically used for REST API calls using HTTP GET requests. The response is stored in the page data model. You can parameterize the URL construction with other data using `+{{variableName}}+` syntax. You can retrieve information using the xref:rest-api.adoc[Bonita REST APIs]. +External API variables are used to fetch data from outside the page. These are typically used for REST API calls using HTTP GET requests. The response is stored in the page data model. You can parameterize the URL construction with other data using `+{{variableName}}+` syntax. You can retrieve information using the xref:rest-api-overview.adoc[Bonita REST APIs]. Here are some examples: diff --git a/modules/ROOT/pages/wildfly-bundle.adoc b/modules/ROOT/pages/wildfly-bundle.adoc index 41dfa7823b..8284a81ca5 100644 --- a/modules/ROOT/pages/wildfly-bundle.adoc +++ b/modules/ROOT/pages/wildfly-bundle.adoc @@ -3,7 +3,7 @@ You will find here the mandatory and optional steps needed to install and configure the WildFly bundle to run the Bonita platform. -The WildFly bundle is a zip archive that contains the Red Hat WildFly Java EE application server packaged with Bonita and xref:BonitaBPM_platform_setup.adoc]#platform_setup_tool[Bonita platform setup tool]. +The WildFly bundle is a zip archive that contains the Red Hat WildFly Java EE application server packaged with Bonita and xref:BonitaBPM_platform_setup.adoc#platform_setup_tool[Bonita platform setup tool]. The WildFly bundle is a regular zip archive based on the WildFly zip distribution. == Installation of the WildFly bundle @@ -81,7 +81,7 @@ The license file will be sent to you by email. When you receive your license: If this is your first installation, copy the file to the `/setup/platform_conf/licenses` folder before starting the bundle. -If this is a license update, use xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[the _Platform setup tool_]. +If this is a license update, use xref:BonitaBPM_platform_setup.adoc#update_platform_conf[the _Platform setup tool_]. === Change the default credentials (optional, recommended for production) @@ -127,9 +127,9 @@ If you just want to try Bonita Platform with the embedded H2 database (only for For production, you are recommended to use one of the supported databases, with the following steps. ==== -. Make sure xref:database-configuration.adoc]#database_creation[your databases are created] and xref:database-configuration.adoc]]#specific_database_configuration[customized to work with Bonita]. -. Edit file `/setup/database.properties` and modify the properties to suit your databases (Bonita internal database & Business Data database). Beware of xref:BonitaBPM_platform_setup.adoc]#backslash_support[backslash characters]. -. If you use *Microsoft SQL Server* or *Oracle* database, copy your xref:database-configuration.adoc]#proprietary_jdbc_drivers[jdbc driver] in `/setup/lib` folder. +. Make sure xref:database-configuration.adoc#database_creation[your databases are created] and xref:database-configuration.adoc#specific_database_configuration[customized to work with Bonita]. +. Edit file `/setup/database.properties` and modify the properties to suit your databases (Bonita internal database & Business Data database). Beware of xref:BonitaBPM_platform_setup.adoc#backslash_support[backslash characters]. +. If you use *Microsoft SQL Server* or *Oracle* database, copy your xref:database-configuration.adoc#proprietary_jdbc_drivers[jdbc driver] in `/setup/lib` folder. . Run `\start-bonita.bat` (Windows system) or `/start-bonita.sh (Unix system)` to run Bonita WildFly bundle (see <>) [NOTE] @@ -147,7 +147,7 @@ The *start-bonita* script does the following: .. copies your database vendor-specific drivers into `+/server/modules/**/main/+` folders . Starts the WildFly bundle -For advanced server configuration needs: check out xref:BonitaBPM_platform_setup.adoc]#run_bundle_configure[Bundle configuration] to finely tune your WildFly bundle, using templates used by Bonita. +For advanced server configuration needs: check out xref:BonitaBPM_platform_setup.adoc#run_bundle_configure[Bundle configuration] to finely tune your WildFly bundle, using templates used by Bonita. ==== [#start] @@ -180,18 +180,18 @@ Once you have your WildFly bundle up and running, complete these xref:first-step === Configuration update -To update the configuration after the first run please take a look at the xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[_Platform setup tool_] +To update the configuration after the first run please take a look at the xref:BonitaBPM_platform_setup.adoc#update_platform_conf[_Platform setup tool_] [NOTE] ==== File `database.properties` is the only entry point to configure the WildFly environment and the -xref:BonitaBPM_platform_setup.adoc]#configure_tool[Bonita Platform configuration] +xref:BonitaBPM_platform_setup.adoc#configure_tool[Bonita Platform configuration] ==== === License update -To update the licenses after the first run, take a look at the xref:BonitaBPM_platform_setup.adoc]#update_platform_conf[platform setup tool] +To update the licenses after the first run, take a look at the xref:BonitaBPM_platform_setup.adoc#update_platform_conf[platform setup tool] == Troubleshooting diff --git a/modules/ROOT/taxonomy.adoc b/modules/ROOT/taxonomy.adoc index 93a4496fc7..0780038a7c 100644 --- a/modules/ROOT/taxonomy.adoc +++ b/modules/ROOT/taxonomy.adoc @@ -1,8 +1,8 @@ * xref:release-notes.adoc[Release notes] * xref:migration-tool.adoc[Migration tool change log] -* xref:_application-and-process-design.adoc[Application and Process Design] +* Application and Process Design ** xref:bonita-bpm-overview.adoc[Bonita overview] - ** xref:_application-and-process-design-overview.adoc[Application and process design overview] + ** Application and process design overview *** xref:getting-started-tutorial.adoc[Getting started tutorial] *** xref:key-concepts.adoc[Key concepts] *** xref:comparison-of-7-x-and-6-x.adoc[Comparison of 7.x and 6.x] @@ -10,17 +10,17 @@ *** xref:design-methodology.adoc[Design methodology] ** xref:bonita-bpm-studio-preferences.adoc[Bonita Studio preferences] ** xref:bonita-bpm-studio-hints-and-tips.adoc[Bonita Studio hints and tips] - ** xref:_organization.adoc[Organization] + ** Organization *** xref:organization-overview.adoc[Organization overview] *** xref:approaches-to-managing-organizations-and-actor-mapping.adoc[Approaches to managing organizations and actor mapping] *** xref:organization-management-in-bonita-bpm-studio.adoc[Organization management in Bonita Studio] *** xref:custom-user-information-in-bonita-bpm-studio.adoc[Custom User Information in Bonita Studio] *** xref:ldap-synchronizer.adoc[LDAP synchronizer] - ** xref:_profiles.adoc[Profiles] + ** Profiles *** xref:profiles-overview.adoc[Profiles overview] **** xref:profileCreation.adoc[Profiles editor] - ** xref:_process-modeling.adoc[Process modeling] - *** xref:_diagrams.adoc[Diagrams] + ** Process modeling + *** Diagrams **** xref:diagram-overview.adoc[Diagram overview] **** xref:pools-and-lanes.adoc[Pools and lanes] **** xref:diagram-tasks.adoc[Tasks] @@ -37,7 +37,7 @@ *** xref:actors.adoc[Actors] *** xref:actor-filtering.adoc[Actor filters] *** xref:iteration.adoc[Iteration] - ** xref:_data.adoc[Data] + ** Data *** xref:data-handling-overview.adoc[Data handling overview] *** xref:define-and-deploy-the-bdm.adoc[Define and deploy the BDM] *** xref:specify-data-in-a-process-definition.adoc[Specify data in a process definition] @@ -48,14 +48,14 @@ *** xref:define-a-search-index.adoc[Search keys] *** xref:expressions-and-scripts.adoc[Expressions and scripts] *** xref:operations.adoc[Operations] - ** xref:_page-and-form-development.adoc[Page and form development] + ** Page and form development *** xref:page-and-form-development-overview.adoc[Page and form development overview] - *** xref:_using-the-ui-designer.adoc[UI Designer] + *** UI Designer **** xref:ui-designer-overview.adoc[UI Designer overview] **** xref:create-or-modify-a-page.adoc[Create or modify UI artifacts] **** xref:widgets.adoc[Widgets] **** xref:widget-properties.adoc[Widget properties] - **** xref:_widget-use-examples.adoc[Widget use examples] + **** Widget use examples ***** xref:repeat-a-container-for-a-collection-of-data.adoc[Repeat a container for a collection of data] **** xref:fragments.adoc[Fragments] **** xref:custom-widgets.adoc[Custom widgets] @@ -67,11 +67,11 @@ *** xref:6-x-legacy-forms.adoc[6.x legacy forms] *** xref:cache-configuration-and-policy.adoc[Cache configuration and policy] ** xref:applicationCreation.adoc[Application descriptor] - ** xref:_connectivity.adoc[Connectivity] + ** Connectivity *** xref:connectivity-overview.adoc[Connectivity overview] *** xref:alfresco.adoc[Alfresco] *** xref:cmis.adoc[CMIS] - *** xref:_database.adoc[Database] + *** Database **** xref:list-of-database-connectors.adoc[List of database connectors] **** xref:database-connector-configuration.adoc[Database connector configuration] **** xref:graphical-query-builder.adoc[Graphical query builder] @@ -87,32 +87,32 @@ *** xref:sap-jco-3.adoc[SAP JCo 3] *** xref:script.adoc[Script] *** xref:twitter.adoc[Twitter] - *** xref:_web-service.adoc[Web service] + *** Web service **** xref:web-service-connector-overview.adoc[Web service connector overview] **** xref:web-service-tutorial.adoc[Web service connector tutorial] - ** xref:_reporting.adoc[Reporting] + ** Reporting *** xref:reporting-overview.adoc[Reporting overview] *** xref:set-up-a-reporting-database.adoc[Set up a reporting database] *** xref:set-up-kpis.adoc[Set up KPIs] *** xref:create-a-report.adoc[Create a report] ** xref:import-and-export-a-process.adoc[Import and export a process] - ** xref:_process-configuration.adoc[Process configuration] + ** Process configuration *** xref:process-configuration-overview.adoc[Process configuration overview] *** xref:environments.adoc[Environments] *** xref:configuring-a-process.adoc[Configure a process] *** xref:manage-jar-files.adoc[Manage JAR files] *** xref:managing-dependencies.adoc[Manage dependencies] - ** xref:_process-testing.adoc[Process testing] + ** Process testing *** xref:process-testing-overview.adoc[Process testing overview] *** xref:configure-a-test-organization.adoc[Configure a test organization] *** xref:run-a-process-from-bonita-bpm-studio-for-testing.adoc[Run a process from Bonita Studio for testing] *** xref:log-files.adoc[Log files] ** xref:build-a-process-for-deployment.adoc[Build a process for deployment] ** xref:workspaces-and-repositories.adoc[Workspaces and repositories] -* xref:_installation.adoc[Installation] +* Installation ** xref:bonita-bpm-installation-overview.adoc[Bonita installation overview] ** xref:bonita-bpm-studio-installation.adoc[Bonita Studio installation] - ** xref:_basic-bonita-platform-installation.adoc[Basic Bonita Platform installation] + ** Basic Bonita Platform installation *** xref:hardware-and-software-requirements.adoc[Hardware and software requirements] *** xref:tomcat-bundle.adoc[Tomcat bundle] *** xref:wildfly-bundle.adoc[WildFly bundle] @@ -121,8 +121,8 @@ *** xref:database-configuration.adoc[Database creation and customization to work with Bonita] *** xref:first-steps-after-setup.adoc[First steps after setup] *** xref:licenses.adoc[Licenses] - ** xref:_advanced-bonita-platform-installation.adoc[Advanced Bonita Platform installation] - *** xref:_security-and-authentication.adoc[Security and authentication] + ** Advanced Bonita Platform installation + *** Security and authentication **** xref:user-authentication-overview.adoc[User authentication overview] **** xref:active-directory-or-ldap-authentication.adoc[Active Directory or LDAP authentication] **** xref:single-sign-on-with-cas.adoc[Single sign-on with CAS] @@ -138,28 +138,28 @@ *** xref:performance-tuning.adoc[Performance tuning] *** xref:performance-troubleshooting.adoc[Performance troubleshooting] *** xref:use-gzip-compression.adoc[Use gzip compression] - *** xref:_bonita-in-a-cluster.adoc[Bonita in a cluster] + *** Bonita in a cluster **** xref:overview-of-bonita-bpm-in-a-cluster.adoc[Overview of Bonita in a cluster] **** xref:install-a-bonita-bpm-cluster.adoc[Install a Bonita cluster] **** xref:cluster-administration.adoc[Cluster administration] *** xref:multi-tenancy-and-tenant-configuration.adoc[Multi-tenancy and tenant configuration] - ** xref:_platform-installation-examples.adoc[Platform installation examples] + ** Platform installation examples *** xref:ubuntu-openjdk-tomcat-postgresql.adoc[Ubuntu + OpenJDK + Tomcat + PostgreSQL] *** xref:bonita-as-windows-service.adoc[Install Tomcat with Bonita as a service in Windows] ** xref:back-up-bonita-bpm-platform.adoc[Back up Bonita Platform] - ** xref:_migration.adoc[Migration] + ** Migration *** xref:migration-overview.adoc[Migration overview] *** xref:migrate-from-an-earlier-version-of-bonita-bpm.adoc[Migrate from an earlier version of Bonita] ** xref:upgrade-from-community-to-a-subscription-edition.adoc[Community to Subscription upgrade] -* xref:_bonita-portal-administration.adoc[Bonita Portal Administration] - ** xref:_bonita-portal-interface.adoc[Bonita Portal interface] +* Bonita Portal Administration + ** Bonita Portal interface *** xref:bonita-bpm-portal-interface-overview.adoc[Bonita Portal overview] *** xref:user-task-list.adoc[User task list] *** xref:languages.adoc[Languages] *** xref:log-in-and-log-out.adoc[Log in and log out] *** xref:about.adoc[About Bonita Portal] ** xref:mobile-portal.adoc[Mobile Portal] - ** xref:_process-maintenance.adoc[Process maintenance] + ** Process maintenance *** xref:processes.adoc[Processes] *** xref:cases.adoc[Cases] *** xref:tasks.adoc[Tasks] @@ -168,7 +168,7 @@ *** xref:pause-and-resume-bpm-services.adoc[Pause and resume services] *** xref:bdm-management-in-bonita-bpm-portal.adoc[BDM Management in Bonita Portal] ** xref:applications.adoc[Applications] - ** xref:_resources.adoc[Resources] + ** Resources *** xref:resource-management.adoc[Resource management] *** xref:pages.adoc[Pages] *** xref:forms.adoc[Forms] @@ -176,36 +176,36 @@ *** xref:themes.adoc[Themes] *** xref:api-extensions.adoc[REST API extensions] ** xref:live-update.adoc[Live update] - ** xref:_organization-in-bonita-portal.adoc[Organization in Bonita Portal] + ** Organization in Bonita Portal *** xref:organization-in-bonita-bpm-portal-overview.adoc[Organization in Bonita Portal overview] - *** xref:_organization-maintenance.adoc[Organization maintenance] + *** Organization maintenance **** xref:import-export-an-organization.adoc[Import/export an organization] **** xref:group.adoc[Manage groups] **** xref:role.adoc[Manage roles] - **** xref:_user.adoc[Manage users] + **** Manage users ***** xref:manage-a-user.adoc[Manage a user] ***** xref:deactivate-a-user.adoc[Deactivate a user] **** xref:custom-user-information-in-bonita-bpm-portal.adoc[Custom User Information in Bonita Portal] ** xref:analytics.adoc[Analytics] - ** xref:_user-profiles.adoc[User profiles] + ** User profiles *** xref:administrator-rights.adoc[Administrator rights] *** xref:process-manager.adoc[Process manager] *** xref:custom-profiles.adoc[Custom profiles] *** xref:deploying-profiles-with-export-and-import.adoc[Deploy profiles with export and import] - ** xref:_look-feel.adoc[Look & Feel] + ** Look & Feel *** xref:managing-look-feel.adoc[Manage Look & Feel] *** xref:creating-a-new-look-feel.adoc[Create a new Look & Feel] ** xref:search-index.adoc[Search keys] * xref:maintenance-operation.adoc[Bonita Platform Maintenance Operations] -* xref:_development.adoc[Development] +* Development ** xref:software-extensibility.adoc[Software extensibility] - ** xref:_bonita-artifacts.adoc[Bonita artifacts] - *** xref:_connectors.adoc[Connectors] + ** Bonita artifacts + *** Connectors **** xref:connectors-overview.adoc[Connectors overview] **** xref:connector-development-toolkit.adoc[Connector development toolkit] *** xref:creating-an-actor-filter.adoc[Create an actor filter] ** xref:api-glossary.adoc[API glossary] - ** xref:_rest-api.adoc[REST API] + ** REST API *** xref:rest-api-overview.adoc[REST API overview] *** xref:rest-api-authentication.adoc[REST Authentication] *** xref:application-api.adoc[application API] @@ -219,12 +219,12 @@ *** xref:system-api.adoc[system API] *** xref:rest-api-extensions.adoc[REST API extensions] *** xref:manage-files-using-upload-servlet-and-rest-api.adoc[Manage files using upload servlet and REST API] - ** xref:_engine-api.adoc[Engine API] + ** Engine API *** xref:engine-api-overview.adoc[Engine API overview] *** xref:create-your-first-project-with-the-engine-apis-and-maven.adoc[Create your first project with the Engine APIs and Maven] *** xref:configure-client-of-bonita-bpm-engine.adoc[Configure connection to Bonita Engine] *** http://documentation.bonitasoft.com/javadoc/api/{varVersion}/index.html[Javadoc] - *** xref:_examples.adoc[Examples] + *** Examples **** xref:manage-a-process.adoc[Manage a process] **** xref:handle-a-failed-activity.adoc[Handle a failed activity] **** xref:manage-an-organization.adoc[Manage an organization] @@ -236,21 +236,21 @@ *** xref:using-list-and-search-methods.adoc[List and search methods] *** xref:log-in-with-cas.adoc[Log in with CAS] ** xref:bonita-bpm-portal-urls.adoc[Bonita Portal URLs] - ** xref:_engine-architecture.adoc[Bonita Engine architecture] + ** Bonita Engine architecture *** xref:engine-architecture-overview.adoc[Bonita Engine architecture overview] - *** xref:_services.adoc[Services] + *** Services **** xref:event-handlers.adoc[Event handlers] **** xref:queriable-logging.adoc[Queriable logger] *** xref:execution-sequence-states-and-transactions.adoc[BPM process / task execution sequence] - ** xref:_living-application.adoc[Living application] + ** Living application *** xref:customize-living-application-layout.adoc[Customize living application layout] ** xref:logging.adoc[Logs] ** xref:preloading-the-forms-cache.adoc[Preload the forms cache] ** xref:building-community-edition-from-source.adoc[Build Bonita Community edition from source files] - ** xref:_continuous-integration.adoc[Continuous integration] + ** Continuous integration *** xref:automating-builds.adoc[Automate builds] *** xref:set-up-continuous-integration.adoc[Set up continuous integration] -* xref:_howtos.adoc[Howtos] +* Howtos ** xref:uid-modal-tutorial.adoc[Create a modal window using CSS] ** xref:uid-case-overview-tutorial.adoc[Create a case overview page using the UI Designer] ** xref:optimize-user-tasklist.adoc[Create unique task names for the user task list]