A quickstart project that processes deals for travellers. It utilizes process composition to split the work of
At the same time shows a simplified version of an approval process that waits for a human actor to provide a review.
This example shows:
Note: The use of this example shows that the data sent to PostgreSQL is saved. You can shut down the application and restart it, and as long as PostgreSQL is running after you restart you should still see the data.
It utilizes PostgreSQL server as the backend store.
This quickstart requires a PostgreSQL server to be available with a database, a user and credentials already created , these configurations should then be set in the data source URL parameter in applications.properties file with the key quarkus.datasource.jdbc.url, i.e quarkus.datasource.jdbc.url=postgresql://localhost:5432/kogito.
You must set the property kogito.persistence.type=postgresql to enable PostgreSQL persistence. There is also a configuration to allow the application to run DDL scripts during the initialization, which you can enable with the property kogito.persistence.auto.ddl=true. For more details you can check applications.properties.
Optionally and for convenience, a docker-compose configuration file is provided in the path docker-compose/, where you can just run the command from there:
docker compose up
In this way a container for PostgreSQL running on port 5432, along with PgAdmin, running on port 8055 to allow the database management.
The default admin user for PostgreSQL is postgres with password pass, for PgAdmin the default user created is user@user.org with password pass, the database connection could be set in PgAdmin using the hostname postgres-container for the PostgreSQL server, details defined in configuration file, an initializer script is executed to create the kogito database and kogito-user.
You will need:
When using native image compilation, you will also need:
mvn clean compile quarkus:dev
NOTE: 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.jar
or on windows
mvn clean package java -jar target\quarkus-app\quarkus-run.jar
Note that the following configuration property needs to be added to application.properties in order to enable automatic registration of META-INF/services entries required by the workflow engine:
quarkus.native.auto-service-loader-registration=true
Note that this requires GRAALVM_HOME to point to a valid GraalVM installation
mvn clean package -Pnative
To run the generated native executable, generated in target/, execute
./target/process-postgresql-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" : "jon.doe@example.com", "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" : "jon.doe@example.com", "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 with.
You can display all active reviews of deals by:
curl http://localhost:8080/usertasks/instance?user=john
Last but not least, you can complete the review user task by:
curl -X POST "http://localhost:8080/usertasks/instance/{taskId}/transition?user=john" -H "content-type: application/json" -d '{"transitionId": "complete","data": {"review" : "very good work", "approve": true}}'
Where {taskId} is the id of the user task you want to complete.
The review Log should look similar to:
Review of the deal very good work for traveller Doe