Chapter 26. Configuring the KIE Server to send information to ElasticSearch when a transaction is committed
You can configure the KIE Server to send information to ElasticSearch about every event when a process, case, or task is modified. The KIE Server sends the information when it commits transactions.
You can use this functionality with any business process or case. You do not need to change anything in the process design.
This configuration is also available if you run your process service using Spring Boot.
The KIE Server serializes the process, case, and task information as JSON documents. It uses the following ElasticSearch indexes:
-
processesfor process information -
casesfor case information -
tasksfor task information
Prerequisites
- You created a business process or a case. For more information about creating a business process or case, see Developing process services in Red Hat Process Automation Manager.
Procedure
To enable sending information to ElasticSearch, complete one of the following steps:
If you deployed the KIE Server on Red Hat JBoss EAP or another application server:
-
Download the
rhpam-7.11.0-maven-repository.zipproduct deliverable file from the Software Downloads page of the Red Hat Customer Portal. - Extract the contents of the file.
-
Copy the
maven-repository/org/jbpm/jbpm-event-emitters-elasticsearch/7.52.0.Final-redhat-00007/jbpm-event-emitters-elasticsearch-7.52.0.Final-redhat-00007.jarfile into thedeployments/kie-server.war/WEB-INF/libsubdirectory of the application server.
-
Download the
If you deployed the application using Spring Boot, add the following lines to the
<dependencies>list in thepom.xmlfile of your service:<dependency> <groupId>org.jbpm</groupId> <artifactId>jbpm-event-emitters-elasticsearch</artifactId> <version>${version.org.kie}</version> </dependency><dependency> <groupId>org.jbpm</groupId> <artifactId>jbpm-event-emitters-elasticsearch</artifactId> <version>${version.org.kie}</version> </dependency>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Configure any of the following system properties for the KIE Server as necessary:
-
org.jbpm.event.emitters.elasticsearch.url: The URL of the ElasticSearch server. The default value ishttp://localhost:9200. -
org.jbpm.event.emitters.elasticsearch.date_format: The timestamp format for the information. The default value isyyyy-MM-dd’T’HH:mm:ss.SSSZ. -
org.jbpm.event.emitters.elasticsearch.user: The user name for authenticating to the ElasticSearch server. -
org.jbpm.event.emitters.elasticsearch.password: The password for authenticating the user to the ElasticSearch server.
-