A quickstart project that processes deals for travellers. It utilizes process composition to split the work of:
- submitting a deal
- reviewing a deal
At the same time shows simplified version of an approval process that waits for a human actor to provide review.
This example shows
- exposing Submit Deal as public service
- each process instance is going to be evaluated and asks for review
- at any point in time service can be shutdown and when brought back it will keep the state of the instances
Note: The use of this example shows that the data sent to Infinispan is saved, you can shut down the application and restart it and as long as Infinispan is running after you restart you should still see the data
Note: The file META-INF/hotrot-client.properties contains a key that has to be removed when used in production. It's needed to run the example locally on docker running on macOS.
It utilizes Infinispan server as the backend store.
- Process (submitDeal.bpmn)
- Process Properties (top)
- Process Properties (bottom)
- Call a deal
- Call a deal (Assignments)
- Print review the Deal
- Subprocess (reviewDeal.bpmn)
- Deal Review (top)
- Deal Review (bottom)
- Review deal user task (top)
- Review deal user task (botom)
- Review deal user task (Assignments)
This quickstart requires an Infinispan server to be available and by default expects it to be on default port and localhost.
You can install Infinispan server by downloading version 12.x from the official website.
- Infinispan installed and running
You will need:
- Java 11+ installed
- Environment variable JAVA_HOME set accordingly
- Maven 3.8.6+ installed
When using native image compilation, you will also need:
- GraalVM 19.3+ installed
- Environment variable GRAALVM_HOME set accordingly
- GraalVM native image needs as well native-image extension: https://www.graalvm.org/reference-manual/native-image/
- Note that GraalVM native image compilation typically requires other packages (glibc-devel, zlib-devel and gcc) to be installed too, please refer to GraalVM installation documentation for more details.
mvn clean compile quarkus:devNOTE: With dev mode of Quarkus you can take advantage of hot reload for business assets like processes, rules, decision tables and java code. No need to redeploy or restart your running application.
Kogito runtimes need to be able to safely handle concurrent requests to shared instances such as process instances, tasks, etc. This feature is optional and can be pluggable with persistence using the following property and value to the src/main/resources/application.properties file.
kogito.persistence.optimistic.lock=true
Additionally, you can use below commands to set this property at runtime and build and run the application
mvn clean compile quarkus:dev -Dkogito.persistence.optimistic.lock=true
or
mvn clean package
java -Dkogito.persistence.optimistic.lock=true -jar target/quarkus-app/quarkus-run.jar
mvn clean package
java -jar target/quarkus-app/quarkus-run.jaror on windows
mvn clean package
java -jar target\quarkus-app\quarkus-run.jarNote that this requires GRAALVM_HOME to point to a valid GraalVM installation
mvn clean package -PnativeTo run the generated native executable, generated in target/, execute
./target/process-infinispan-persistence-quarkus-runner
You can take a look at the OpenAPI definition - automatically generated and included in this service - to determine all available operations exposed by this service. For easy readability you can visualize the OpenAPI definition file using a UI tool like for example available Swagger UI.
In addition, various clients to interact with this service can be easily generated using this OpenAPI definition.
When running in either Quarkus Development or Native mode, we also leverage the Quarkus OpenAPI extension that exposes Swagger UI that you can use to look at available REST endpoints and send test requests.
To make use of this application it is as simple as putting a sending request to http://localhost:8080/deals with following content
{
"name" : "my fancy deal",
"traveller" : {
"firstName" : "John",
"lastName" : "Doe",
"email" : "[email protected]",
"nationality" : "American",
"address" : {
"street" : "main street",
"city" : "Boston",
"zipCode" : "10005",
"country" : "US" }
}
}
Complete curl command can be found below:
curl -X POST -H 'Content-Type:application/json' -H 'Accept:application/json' -d '{"name" : "my fancy deal", "traveller" : { "firstName" : "John", "lastName" : "Doe", "email" : "[email protected]", "nationality" : "American","address" : { "street" : "main street", "city" : "Boston", "zipCode" : "10005", "country" : "US" }}}' http://localhost:8080/deals
this will then trigger the review user task that you can work.
First you can display all active reviews of deals
curl -H 'Content-Type:application/json' -H 'Accept:application/json' http://localhost:8080/dealreviews
based on the response you can select one of the reviews to see more details
curl -H 'Content-Type:application/json' -H 'Accept:application/json' http://localhost:8080/dealreviews/{uuid}/tasks?user=john
where uuid is the id of the deal review you want to work with.
Next you can get the details assigned to review user task by
curl -H 'Content-Type:application/json' -H 'Accept:application/json' http://localhost:8080/dealreviews/{uuid}/review/{tuuid}?user=john
where uuid is the id of the deal review and tuuid is the id of the user task you want to get
Last but not least you can complete review user task by
curl -X POST -H 'Content-Type:application/json' -H 'Accept:application/json' -d '{"review" : "very good work"}' http://localhost:8080/dealreviews/{uuid}/review/{tuuid}?user=john
where uuid is the id of the deal review and tuuid is the id of the user task you want to get
- Review Log should look similar to
Review of the deal very good work for traveller Doe
In the operator directory you'll find the custom resources needed to deploy this example on OpenShift with the Kogito Operator.