Skip to content

Commit

Permalink
last fixes, links,...
Browse files Browse the repository at this point in the history
  • Loading branch information
justlmills committed Jun 13, 2024
1 parent aebc362 commit b93ef86
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 26 deletions.
12 changes: 6 additions & 6 deletions getting-started/orchestrating.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ include::../partials/attributes.adoc[]

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.

NOTE: {PRODUCT} 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.
NOTE: {PRODUCT} supports Straight-Through-Processing (STP) and stateful processing is provided as a technology preview (xref:../workflow/overview.adoc[Stateful processs overview]), where processes are integrating decisions without any safe points and without persistence. For more {PRODUCT} examples that use process capabilities, see the references below.

The following diagram illustrates how decisions are integrated with processes:

Expand Down Expand Up @@ -187,9 +187,9 @@ Then you can check the application Swagger UI at `http://localhost:8080/q/swagge

=== Other examples

For more {PRODUCT} examples that use decisions orchestrated by processes, see the following example applications:
For more {PRODUCT} examples that use decisions orchestrated by processes, see the following example applications which are included in the xref:../getting-started/examples.adoc[examples package]:

* xref:../getting-started/examples.adoc[`process-business-rules-quarkus`]: An example project that shows the use of business rules and processes
* xref:../getting-started/examples.adoc[`process-decisions-rest-quarkus`]: An example project that shows the usage of decisions within processes. The project focuses on how to integrate decisions in a remote way using REST APIs where they can be deployed and decoupled from the process service.
* xref:../getting-started/examples.adoc[`process-decisions-rules-quarkus`]: An example project that shows the usage of decisions within processes. The project focuses on integrating decisions in an embedded way using Business Rule Tasks where they must be deployed together with the process.
* xref:../getting-started/examples.adoc[`process-error-handling`]: A usage scenario of the Error Handling Strategy
* `process-business-rules-quarkus`: An example project that shows the use of business rules and processes
* `process-decisions-rest-quarkus`: An example project that shows the usage of decisions within processes. The project focuses on how to integrate decisions in a remote way using REST APIs where they can be deployed and decoupled from the process service.
* `process-decisions-rules-quarkus`: An example project that shows the usage of decisions within processes. The project focuses on integrating decisions in an embedded way using Business Rule Tasks where they must be deployed together with the process.
`process-error-handling`: A usage scenario of the Error Handling Strategy
4 changes: 2 additions & 2 deletions getting-started/project-setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ include::../partials/attributes.adoc[]

//tag::maven-setup[]
== Requirements
Set up your Maven environment, following these instructions for doing so xref:../installation/gav-mapping-rules.adoc[Configuring Maven with BAMOE binaries].
Set up your Maven environment, following these instructions for doing so xref:../installation/configure-maven.adoc[Configuring Maven with BAMOE binaries].

== Project Setup Options
With the migration of the BAMOE product to Quarkus 3 the instructions on how to generate a new Maven project have changed. You now have these options:

* Create a project manually
* xref:../installation/configure-maven.adoc[Use BAMOE Canvas] to create a new project using the {CANVAS} accelerator functionality.
* Create a new project using the {CANVAS} accelerator functionality.


== Creating a BAMOE Project Manually
Expand Down
2 changes: 1 addition & 1 deletion installation/canvas.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ For other customization options of {CANVAS}, please refer to the image's https:/

== Other installation methods

{CANVAS} can also be deployed via Docker Compose, check out our tutorial here: xref:docker-compose.adoc[Docker Compose].
{CANVAS} can also be deployed via xref:docker-compose.adoc[Docker Compose] or using xref:kie-helm-charts.adoc[Helm Charts].

== Securing your Installation

Expand Down
11 changes: 7 additions & 4 deletions installation/configure-maven.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ Choose between using the
The provided container images are created for Linux execution, running on a different architecture beside Linux x86_64 architecture, there may be a warning similar to: "WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (...) and no specific platform was requested"
====

==== bamoe-9.1.0-maven-repository-image.tar.gz
*Using bamoe-9.1.0-maven-repository-image.tar.gz*

Enable the OpenShift registry and log into it using Docker:

[source,shell,subs="attributes+"]
Expand All @@ -61,7 +62,8 @@ Set an env var with the image name
export BAMOE_MAVEN_REPOSITORY_IMAGE=maven-repository:{IMAGE_VERSION_910}
----

==== quay.io/bamoe/maven-repository:{IMAGE_VERSION_910}
*Using quay.io/bamoe/maven-repository:{IMAGE_VERSION_910}*

In this case, not much needs to be done, just set an env var with the image URL

[source,shell,subs="attributes+"]
Expand Down Expand Up @@ -104,7 +106,7 @@ Choose between using
* bamoe-9.1.0-maven-repository-image.tar.gz
* the hosted quay.io/bamoe/maven-repository:{IMAGE_VERSION_910} image

==== bamoe-9.1.0-maven-repository-image.tar.gz
*Using bamoe-9.1.0-maven-repository-image.tar.gz*

This step varies depending on your cluster configuration, but it may involve setting up (or using an already set up) image registry, loading and re-tagging the docker image, and then pushing it to the registry with the new tag.

Expand All @@ -125,7 +127,8 @@ export BAMOE_MAVEN_REPOSITORY_IMAGE=maven-repository:{IMAGE_VERSION_910}
# For Kind and Minikube use the original quay.io URL for this variable
----

==== **quay.io/bamoe/maven-repository:{IMAGE_VERSION_910}**
*Using quay.io/bamoe/maven-repository:{IMAGE_VERSION_910}*

In this case, not much needs to be done, just set an env var with the image URL

[source,shell,subs="attributes+"]
Expand Down
2 changes: 1 addition & 1 deletion introduction/components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ When designing an automation service, each capability has a set of required and
* Jobs and asynchronous services execution
* Observability with metrics decision and process services

For more information, see xref:.../workflow/overview.adoc[Overview stateful process] and xref:../runtime-services-modeling/runtime-services-modeling.html[Service monitoring with Prometheus and Grafana].
For more information, see xref:../workflow/overview.adoc[Overview stateful process] and xref:../runtime-services-modeling/runtime-services-modeling.adoc[Service monitoring with Prometheus and Grafana].
8 changes: 4 additions & 4 deletions nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@
//**
* xref:migration-guide/migration-guide.html[Migration guide]
** xref:https://access.redhat.com/documentation/en-us/red_hat_process_automation_manager/7.0/html/migrating_from_red_hat_jboss_bpm_suite_6.4_to_red_hat_process_automation_manager_7.0/migration-overview-con.html[Red Hat v6 to v7]
** xref:migration-guide/redhat-to-ibm.html[Red Hat v7 to BAMOE v8]
** xref:migration-guide/now-to-next.html[BAMOE v8 to v9]
** xref:migration-guide/90x-to-91x.html[BAMOE v9.0 to v9.1]
** xref:https://access.redhat.com/documentation/en-us/red_hat_process_automation_manager/7.0/html/migrating_from_red_hat_jboss_bpm_suite_6.4_to_red_hat_process_automation_manager_7.0/migration-overview-con.html[Red Hat version 6 to 7]
** xref:migration-guide/redhat-to-ibm.html[Red Hat version 7 to BAMOE 8.0]
** xref:migration-guide/now-to-next.html[BAMOE version 8.0 to 9.0]
** xref:migration-guide/90x-to-91x.html[BAMOE version 9.0 to 9.1]
** xref:migration-guide/business-central.html[Business Central]
//** xref:migration-guide/drl.html[Drools Rule Language]
Expand Down
4 changes: 3 additions & 1 deletion runtime-services-modeling/runtime-services-modeling.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ These sections contain more in-depth information on the different aspects of bui

* xref:../runtime-services-modeling/building-decision-services.adoc[Building decision services]
* xref:../runtime-services-modeling/services-execution.adoc[Service execution]
* xref:../runtime-services-modeling/monitoring-services.adoc[Service Monitoring ]
* xref:../runtime-services-modeling/monitoring-services.adoc[Service Monitoring ]
* xref:../runtime-services-modeling/dmn-decisions-embedded-java-mode.adoc[DMN decisions execution in embedded Java mode]
* xref:../runtime-services-modeling/drl-rules-embedded-java-mode.adoc[DRL rule execution in embedded Java mode]
12 changes: 8 additions & 4 deletions workflow/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,19 @@ image::../images/wf-compact-arch.png[]

The following table shows the mandatory components in the subsystem of the compact architecture to implement a stateful workflow.

[%header,cols="4"]
|===
^|Subsystem
^|Type
^|Stateful process (compact)
^|Stateless (STP)

|===
|Subsystem | Type | Stateful process (compact) | Stateless (STP)
|Workflow engine | System | mandatory | mandatory
|Jobs | Addon | mandatory | N/A
|Human task | Addon | mandatory | N/A
|Storage/persistence | System | mandatory | N/A
|Data index | Addon | optional | N/A
|Data audit | Addon | optional | N/A
|Jobs | Addon | mandatory | N/A
|Human task | Addon | mandatory | N/A
|===

== Component description
Expand Down
10 changes: 7 additions & 3 deletions workflow/workflow-with-bpmn.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,12 @@ This section lists the newly supported Business Process Model And Notation (BPMN
== Supported BPMN process elements
As this technology preview provides persistence to support stateful process execution, all BPMN elements that go through an idle state are supported.

|===
|Element | Type | Description
[%header,cols="3"]
|===
^|Element
^|Type
^|SDescription

|Intermediate Message | Event | Causes idle time till a message is provided
|Intermediate Signal | Event | Causes idle time till a signal is provided
|Intermediate Timer | Event | Causes idle time till timer times out
Expand Down Expand Up @@ -63,7 +67,7 @@ Open the “Properties” panel using the first icon at the “Side panel strip
There, you can change the "Rule language" to "DMN". Select the file you want and the Decision inside it.
Here's an example:

.Implementation/Execution section of the Properties panel for a Business Rule Task inside a Workflow invoking a Decision on {CANVAS}
.Implementation/Execution section of the Properties panel for a Business Rule Task inside a Workflow
image::tools/image23.png[]

When your Workflow executes, this Decision will be invoked with the inputs being passed to the Business Rule task.
Expand Down

0 comments on commit b93ef86

Please sign in to comment.