A quickstart project that processes deals for travellers. It utilizes process composition to split the work of
At the same time shows simplified version of a approval process that waits for human actor to provide review.
This example shows
Note: The use of this example shows that the data sent to mongodb is saved, you can shut down the application and restart it and as long as mongodb is running after you restart you should still see the data
It utilizes MongoDB server as the backend store.
This quickstart requires an MongoDB server to be available and by default expects it to be on default port (27017) and localhost. The default database is “kogito” or you can provide the database name using property - spring.data.mongodb.database. You must set property - kogito.persistence.type=mongodb For more details you can check applications.properties.
You will need:
By default, MongoDB configuration properties are commented, due to conflict if configuration is coming from outside the code.
You should uncomment the commented spring.data.mongodb
variables from properties file.
mvn clean package spring-boot:run
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 build this project with -PpersistenceWithLock profile to run with persistence and lock on.
mvn clean package
To run the generated native executable, generated in target/
, execute
java -jar target/process-mongodb-persistence-springboot.jar
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.
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.
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 of the deal very good work for traveller Doe
You can also query the process instance information and model variables from the database and review the same using tools like MongoDB Compass, download community version from below link https://www.mongodb.com/try/download/compass