Skip to content

Commit c3d2adb

Browse files
committed
Merge branch '9.1.1' of https://github.com/IBM/bamoe-docs into 9.1.1
2 parents 13bf229 + 5db9e29 commit c3d2adb

31 files changed

+132
-145
lines changed

editing/authoring-scesim.adoc

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Authoring Scenario Simulations
1+
= Authoring test scenarios
22
include::../partials/attributes.adoc[]
33

44
As a developer of business decisions, you can use test scenarios in {PRODUCT} to test the decision logic in your {PRODUCT} decision services. Test scenarios enable you to ensure that your {PRODUCT} decision services are functioning properly and as expected as you develop your {PRODUCT} project.
@@ -29,15 +29,12 @@ NOTE: All the DMN-based scesim assets created prior to version {VERSION} will re
2929

3030
NOTE: All the DMN-based scesim assets are compatible only with DMN 1.2 models. Due to this, use DMN Classic Editor instead of DMN New Editor to create DMN models, that will be tested using `.scesim` file.
3131

32-
=== Prerequisites
33-
* {PRODUCT_SHORT} {VERSION_910}
34-
* {DEV_TOOLS} {VERSION_910}
35-
* VSCode (1.66.0+)
36-
* Optional: Language Support for Java(TM) by Red Hat (1.32+) VSCode extension
37-
3832
=== Project Setup
33+
34+
To run this scenario, you must have set up {PRODUCT_SHORT} and Developer Tools for VS Code. See xref:../installation/installation.adoc[Installing]. Optionally, you can use Language Support for Java(TM).
35+
3936
==== Cloning the Example Project
40-
If you are a new {PRODUCT_SHORT} user and you don't have any project to set up yet, or you prefer having an out-of-the-box project to deal with, you can use the previously mentioned example in the `incubator-kie-kogito-examples` repository.
37+
If you are a new {PRODUCT_SHORT} user and you do not have any project to set up yet, or you prefer having an out-of-the-box project to deal with, you can use the previously mentioned example in the `incubator-kie-kogito-examples` repository.
4138

4239
1. Clone the `incubator-kie-kogito-examples` repository.
4340
2. Open VSCode and navigate to `incubator-kie-kogito-examples/kogito-quarkus-examples/dmn-quarkus-example`.

editing/creating-new-projects.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ image::tools/newProject/canvas-dmn-single-file-workspace-overview.png[Editor pag
4040
. *Kebab menu* → Additional operations.
4141
From here you can create a new commit in your project or delete your file.
4242
. *“Problems” tab* → Lets you see what's wrong with your file, both statically and when running it.
43-
More on running Decisions in the xref:../tools/running-decisions.adoc[Running Decisions] section.
43+
More on running Decisions in the xref:../editing/running-decisions.adoc[Running Decisions] section.
4444

4545
From here, you can make this currently one-file project into a more complex one.
4646
Let's do that by creating another file using the “New file menu”. You'll see that there are new controls available on the screen.
@@ -67,6 +67,6 @@ image::tools/newProject/canvas-multi-file-workspace-overview.png['Editor page on
6767
More on all of that at xref:../tools/working-with-git.adoc[Working with Git]. You can click this element to see all the changes you made to your repository since your last Commit and revert them all, if you want.
6868
To revert changes to individual files, use the “File switcher”.
6969

70-
Now that you're familiar with the elements of {CANVAS}, you can jump to xref:../tools/authoring-decisions.adoc[Authoring Decisions] or xref:../tools/authoring-workflows.adoc[Authoring Workflows] to start authoring Decisions and Workflows to create a Business Automation project. xref:../tools/applying-accelerators.adoc[Applying Accelerators] can also be interesting if you're starting a new project directly from BAMOE Canvas.
70+
Now that you're familiar with the elements of {CANVAS}, you can jump to xref:../editing/authoring-decisions.adoc[Authoring Decisions] or xref:../editing/authoring-workflows.adoc[Authoring Workflows] to start authoring Decisions and Workflows to create a Business Automation project. xref:../tools/applying-accelerators.adoc[Applying Accelerators] can also be interesting if you're starting a new project directly from BAMOE Canvas.
7171

7272

getting-started/orchestrating.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ include::../partials/attributes.adoc[]
33

44
The following example is a workflow scenario in {PRODUCT} that demonstrates how you can use process definitions to orchestrate your {PRODUCT} decision services. The example of a traffic violations project describes how to use decisions within the processes and how to integrate decisions in an embedded way using the business rule tasks, which must be deployed with a process in the same application.
55

6-
NOTE: {PRODUCT} fully supports Straight-Through-Processing (STP) where processes are integrating decisions without any safe points and without persistence. For more {PRODUCT} examples that use process capabilities, see the references below. Stateful processing is provided as a technology preview (xref:../workflow/overview.adoc[Stateful processs overview]) in the {VERSION_910}.
6+
NOTE: {PRODUCT} fully supports Straight-Through-Processing (STP) where processes are integrating decisions without any safe points and without persistence. For more {PRODUCT} examples that use process capabilities, see the references below. Stateful processing is provided as a technology preview (xref:../workflow/overview.adoc[Stateful processs overview]) in the {VERSION_910} and {VERSION_911}.
77

88
The following diagram illustrates how decisions are integrated with processes:
99

@@ -18,7 +18,7 @@ The tasks must be deployed with a process in the same application.
1818

1919
In Kogito, the decisions can be expressed in different domains or assets, such as DMN and DRL. All the assets, including BPMN, DMN, and DRL must be placed in the resources folder.
2020

21-
When the example application is running, there also must be different running processes, such as a process using a business rule task, containing the URL as `http://localhost:8080/traffic`.
21+
When the example application is running, there also must be different running processes, such as a process using a business rule task, containing the URL as `+http://localhost:8080/traffic+`.
2222

2323
== Traffic violations example for embedded method
2424

@@ -162,7 +162,7 @@ image::traffic-violation-dmn-businessrule.png[Image of traffic violation task (D
162162
The properties that are required to be set for the DMN service task include `Rule Language`, which must be set as `DMN`. Also, you must set the values for `Namespace` and DMN Model Name` properties as defined in the DMN model, such as `TrafficViolation.dmn`. For example, you can set the following values:
163163

164164
- Rule Language: `DMN`
165-
- Namespace: `https://github.com/kiegroup/drools/kie-dmn/_A4BCA8B8-CF08-433F-93B2-A2598F19ECFF`
165+
- Namespace: `+https://github.com/kiegroup/drools/kie-dmn/_A4BCA8B8-CF08-433F-93B2-A2598F19ECFF+`
166166
- DMN Model Name: `Traffic Violation`
167167

168168
The input for the traffic violation task includes `Driver` and `Violation` variables, and the output includes `Suspended` and `Fine` in the Data Assignment property.
@@ -182,7 +182,7 @@ You can start the Quarkus server with the following command in the project root:
182182
mvn quarkus:dev
183183
----
184184

185-
Then you can check the application Swagger UI at `http://localhost:8080/q/swagger-ui/#/`
185+
Then you can check the application Swagger UI at `+http://localhost:8080/q/swagger-ui/#/+`
186186

187187
=== Other examples
188188

installation/build-maven-repo.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Build and run your own BAMOE v9.1.x Maven Repository image on OpenShift
1+
= Build and run your own BAMOE version 9.1.x Maven Repository image on OpenShift
22
include::../partials/attributes.adoc[]
33

44
If you cannot run the container with elevated privileges, follow these instructions to build a version that does not require the elevated privileges.
@@ -76,7 +76,7 @@ spec:
7676
output:
7777
to:
7878
kind: ImageStreamTag
79-
name: bamoe-maven-repository-image:{IMAGE_VERSION_910}
79+
name: bamoe-maven-repository-image:{IMAGE_VERSION}
8080
strategy:
8181
dockerStrategy:
8282
dockerfilePath: Dockerfile
@@ -103,7 +103,7 @@ oc start-build --from-dir=. bamoe-maven-repository-image --follow
103103
+
104104
[source,shell,subs="attributes+"]
105105
----
106-
oc new-app --image-stream bamoe-maven-repository-image:{IMAGE_VERSION_910} --name bamoe-maven-repo
106+
oc new-app --image-stream bamoe-maven-repository-image:{IMAGE_VERSION} --name bamoe-maven-repo
107107
oc create route edge --service=bamoe-maven-repo
108108
----
109109

installation/canvas.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ It depends on two backend applications to provide full functionality:
1313
{CANVAS} and its two backend applications are available as container images.
1414
These images are published to Quay.io and can be used to run containers locally or with any cloud provider.
1515

16-
* Canvas → https://quay.io/repository/bamoe/canvas[https://quay.io/repository/bamoe/canvas] @ {IMAGE_VERSION_910}
17-
* Extended Services → https://quay.io/repository/bamoe/extended-services[https://quay.io/repository/bamoe/extended-services] @ {IMAGE_VERSION_910}
18-
* CORS Proxy → https://quay.io/repository/bamoe/cors-proxy[https://quay.io/repository/bamoe/cors-proxy] @ {IMAGE_VERSION_910}
16+
* Canvas → https://quay.io/repository/bamoe/canvas[https://quay.io/repository/bamoe/canvas] @ {IMAGE_VERSION}
17+
* Extended Services → https://quay.io/repository/bamoe/extended-services[https://quay.io/repository/bamoe/extended-services] @ {IMAGE_VERSION}
18+
* CORS Proxy → https://quay.io/repository/bamoe/cors-proxy[https://quay.io/repository/bamoe/cors-proxy] @ {IMAGE_VERSION}
1919
2020
NOTE: All three image versions must be the same for deployment to work.
2121

@@ -38,7 +38,7 @@ export APP_NAME_BAMOE_CANVAS=bamoe-canvas
3838
+
3939
[source,shell,subs="attributes+"]
4040
----
41-
oc new-app quay.io/bamoe/extended-services:{IMAGE_VERSION_910} --name=$APP_NAME_EXTENDED_SERVICES
41+
oc new-app quay.io/bamoe/extended-services:{IMAGE_VERSION} --name=$APP_NAME_EXTENDED_SERVICES
4242
oc create route edge --service=$APP_NAME_EXTENDED_SERVICES
4343
oc label services/$APP_NAME_EXTENDED_SERVICES app.kubernetes.io/part-of=$APP_PART_OF
4444
oc label routes/$APP_NAME_EXTENDED_SERVICES app.kubernetes.io/part-of=$APP_PART_OF
@@ -49,7 +49,7 @@ oc label deployments/$APP_NAME_EXTENDED_SERVICES app.openshift.io/runtime=golang
4949
+
5050
[source,shell,subs="attributes+"]
5151
----
52-
oc new-app quay.io/bamoe/cors-proxy:{IMAGE_VERSION_910} --name=$APP_NAME_CORS_PROXY
52+
oc new-app quay.io/bamoe/cors-proxy:{IMAGE_VERSION} --name=$APP_NAME_CORS_PROXY
5353
oc create route edge --service=$APP_NAME_CORS_PROXY
5454
oc label services/$APP_NAME_CORS_PROXY app.kubernetes.io/part-of=$APP_PART_OF
5555
oc label routes/$APP_NAME_CORS_PROXY app.kubernetes.io/part-of=$APP_PART_OF
@@ -60,7 +60,7 @@ oc label deployments/$APP_NAME_CORS_PROXY app.openshift.io/runtime=nodejs
6060
+
6161
[source,shell,subs="attributes+"]
6262
----
63-
oc new-app quay.io/bamoe/canvas:{IMAGE_VERSION_910} --name=$APP_NAME_BAMOE_CANVAS \
63+
oc new-app quay.io/bamoe/canvas:{IMAGE_VERSION} --name=$APP_NAME_BAMOE_CANVAS \
6464
-e KIE_SANDBOX_EXTENDED_SERVICES_URL=https://$(oc get route $APP_NAME_EXTENDED_SERVICES --output jsonpath={.spec.host}) \
6565
-e KIE_SANDBOX_CORS_PROXY_URL=https://$(oc get route $APP_NAME_CORS_PROXY --output jsonpath={.spec.host})
6666
oc create route edge --service=$APP_NAME_BAMOE_CANVAS
@@ -87,7 +87,7 @@ NOTE: All services will be available via `https`, which means that if you're dep
8787

8888
[source,shell,subs="attributes+"]
8989
----
90-
docker run -p 21345:21345 -it quay.io/bamoe/extended-services:{IMAGE_VERSION_910}
90+
docker run -p 21345:21345 -it quay.io/bamoe/extended-services:{IMAGE_VERSION}
9191
# Add the -d flag to run in detached mode.
9292
----
9393
Access the API through port 21345, no additional configuration is necessary.
@@ -97,7 +97,7 @@ Access the API through port 21345, no additional configuration is necessary.
9797

9898
[source,shell,subs="attributes+"]
9999
----
100-
docker run -p 8090:8080 -it quay.io/bamoe/cors-proxy:{IMAGE_VERSION_910}
100+
docker run -p 8090:8080 -it quay.io/bamoe/cors-proxy:{IMAGE_VERSION}
101101
# Add the -d flag to run in detached mode.
102102
----
103103
The API is accessible via port 8090 (8080 is reserved for the bamoe-canvas image). No additional configuration is necessary.
@@ -116,7 +116,7 @@ If you are running locally, following the previous steps, use this command to st
116116
docker run -p 8080:8080 -it \
117117
-e KIE_SANDBOX_EXTENDED_SERVICES_URL=http://localhost:21345 \
118118
-e KIE_SANDBOX_CORS_PROXY_URL=http://localhost:8090 \
119-
quay.io/bamoe/canvas:{IMAGE_VERSION_910}
119+
quay.io/bamoe/canvas:{IMAGE_VERSION}
120120
# Add the -d flag to run in detached mode.
121121
----
122122
The HTTP server is accessed via port 8080.

installation/configure-maven.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ docker run -d -p <PORT>:8080 quay.io/bamoe/maven-repository:{IMAGE_VERSION}
162162
----
163163
--
164164

165-
You can verify the repository is running by accessing the repository in your browser at http://localhost:<PORT>/com/ibm/bamoe.
165+
You can verify the repository is running by accessing the repository in your browser at `+http://localhost:<PORT>/com/ibm/bamoe+`.
166166

167167
=== Configure Maven with the container image URL:
168168
To configure Maven with a container image follow these steps:
@@ -223,7 +223,7 @@ To configure the {PRODUCT_SHORT} Maven repository locally follow these steps:
223223
. Extract the downloaded archive.
224224
. Go to the `~/.m2/` directory and open the Maven `settings.xml` file in a text editor or IDE.
225225
. Add the following lines to the `<profiles>` element of the Maven settings.xml file, where `<MAVEN_REPOSITORY>` is the path of the Maven repository that you downloaded.
226-
The format of `<MAVEN_REPOSITORY>` must be `file://$PATH`. For example, `file:///home/userX/bamoe-{VERSION}-maven-repository/:`.
226+
The format of `<MAVEN_REPOSITORY>` must be `+file://$PATH+`. For example, `+file:///home/userX/bamoe-{VERSION}-maven-repository/+`:
227227
+
228228
[source]
229229
----

installation/licensing.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ For both components, {PRODUCT_DM} and {PRODUCT_PAM}, clients can expect the foll
4747

4848
=== Licensing for Disaster Recovery or Backup
4949

50-
When considering backup installations, active licenses are required for backup copies that are running simultaneously with the primary installation. Inactive or idling backup copies typically don't need extra licenses. In-depth information can be found in the https://www.ibm.com/about/software-licensing/assets/guides_pdf/Backup.pdf[Backup and Disaster Recovery Licensing Guide].
50+
When considering backup installations, active licenses are required for backup copies that are running simultaneously with the primary installation. Inactive or idling backup copies typically do not need extra licenses. In-depth information can be found in the https://www.ibm.com/about/software-licensing/assets/guides_pdf/Backup.pdf[Backup and Disaster Recovery Licensing Guide].
5151

5252

5353
You can find the latest LI information for the available components, parts, and software versions in the https://www.ibm.com/about/software-licensing/us-en/product_search?search=5900-AR4&type=pid&platform=[License Information (LI) for {PRODUCT_LONG}].
@@ -86,9 +86,9 @@ In short, {PRODUCT_LONG} deployments are licensed by *Virtual Processor Core (VP
8686

8787
Regarding the usage of the product in association with the entitled number of VPCs:
8888

89-
** Active subscriptions allow product deployments into as many environments as clients choose, as long as they don’t exceed the total number of VPCs they have purchased.
89+
** Active subscriptions allow product deployments into as many environments as clients choose, as long as they do not exceed the total number of VPCs they have purchased.
9090
** The number of entitlements must cover the highest expected usage of VPCs during peak periods.
91-
** Clients are responsible for ensuring they don’t exceed their deployment entitlement.
91+
** Clients are responsible for ensuring they do not exceed their deployment entitlement.
9292

9393
Additional information, can be found at https://www.ibm.com/software/passportadvantage/about_software_licensing.html[IBM Licensing Metrics].
9494

installation/upgrading.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ You can use https://docs.openshift.com/container-platform/4.14/applications/depl
2020

2121
For the new DMN editor:
2222
After upgrade, the New DMN Editor will be opened automatically when you first access it in Canvas or Developer tools for VS Code.
23-
Existing DMN files (any version) can be opened directly in the editor. For more information, see xref:../tools/authoring-decisions.adoc[Authoring decisions]
23+
Existing DMN files (any version) can be opened directly in the editor. For more information, see xref:../editing/authoring-decisions.adoc[Authoring decisions]
2424

2525
== Maven libraries mapping guide
2626

27-
With the transition of the KIE projets to the Apache Software Foundation (ASF), it has become necessary to rename a number of Maven modules. The following table(s) describe the changes to the Maven GAV (GroupID/ArtifactID/Version) in {VERSION_910}:
27+
With the transition of the KIE projets to the Apache Software Foundation (ASF), it has become necessary to rename a number of Maven modules. The following table(s) describe the changes to the Maven GAV (GroupID/ArtifactID/Version) that happened in {VERSION_910}:
2828

2929
The general guidelines are:
3030

3131
* xref:../installation/gav-mapping-rules.adoc[Drools Maven mappings] for anything related to rules or decisions.
3232
* xref:../installation/gav-mapping-process.adoc[jBPM Maven mappings] for anything related to BPMN-based stateless/stateful processes.
3333
* xref:../installation/gav-mapping-kogito.adoc[Kogito Maven mappings] for anything related to infrastructure or extended services.
34-
* xref:../installation/gav-mapping-kie.adoc[KIE Maven mappings] for anything else that doesn't fall into the above categories.
34+
* xref:../installation/gav-mapping-kie.adoc[KIE Maven mappings] for anything else that does not fall into the above categories.

introduction/components.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ include::../partials/attributes.adoc[]
55
{PRODUCT_LONG} is a developer-first technology that offers a highly customizable set-up and solution. {PRODUCT_SHORT} is developed using well-known technologies, specifications, and open standards.
66

77
The design of an automation solution, including the components that are part of the application lifecycle, can be easily be adapted to different scenarios. The modular structure of the solution allows for custom, lightweight deployment units that efficiently use computational resources by including only what is needed.
8-
This approach is possible with {PRODUCT_SHORT} v9.1 through the architectural design of the solution, which allows the creation of solutions targeting the automation of decisions, business rules, straight-through processes, and long-running business processes.
8+
This approach is possible with {PRODUCT_SHORT} version 9.1 through the architectural design of the solution, which allows the creation of solutions targeting the automation of decisions, business rules, straight-through processes, and long-running business processes.
99

1010
Services designed to address particular domain business problems can improve team performance and simplify the application lifecycle from development to deployment.
1111
An automation solution with IBM BAMOE includes:
@@ -41,7 +41,7 @@ More complex scenarios can be implemented through the orchestration of business
4141
4242
[IMPORTANT]
4343
====
44-
The stateful process automation feature is a technology preview in IBM {PRODUCT_SHORT} v9.1.0. For more information, see xref:../workflow/overview.html[Stateful processs overview].
44+
The stateful process automation feature is a technology preview in IBM {PRODUCT_SHORT} version {VERSION_910} and {VERSION_911}. For more information, see xref:../workflow/overview.html[Stateful processs overview].
4545
====
4646

4747
== Components overview

introduction/release-notes/release-notes-main.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
= Release notes
22
include::../../partials/attributes.adoc[]
33

4-
The release notes contain information that is important for the successful installation and use of {PRODUCT_LONG} {VERSION_911} and its product modules and components.
4+
The release notes contain information that is important for the successful installation and use of {PRODUCT_LONG} {VERSION_91X} and its product modules and components.
55

66
- xref:whats-new-9-1-1.adoc[What's new in 9.1.1]
7-
- xref:whats-new-9-1-1.adoc[What's new in 9.1.0]
8-
- xref:version-mapping-9-1-1.adoc[Version mapping in 9.1.1]
9-
- xref:supported-environments.adoc[Suported Environments]
7+
- xref:whats-new-9-1-0.adoc[What's new in 9.1.0]
8+
- xref:version-mapping-9-1-1.adoc[Version mapping]
9+
- xref:supported-environments.adoc[Supported Environments]
1010
- xref:fix-list.adoc[Fix List]
1111
- xref:known-limitations.adoc[Known Limitations]
1212

0 commit comments

Comments
 (0)