Chapter 22. Configuring KIE Server to send and receive Kafka messages from the process

Procedure

1. To enable integration with Red Hat AMQ Streams, set the following system properties according to your environment:

   • If you are using KIE Server on Red Hat JBoss EAP, set the org.kie.kafka.server.ext.disabled KIE Server system property of to false.
   • If you are using Spring Boot, set the kieserver.kafka.enabled system property to true.
2. To configure the connection to the Kafka broker, set the org.kie.server.jbpm-kafka.ext.bootstrap.servers system property to the host and port of the broker. The default value is localhost:9092. You can use a comma-separated list of multiple host:port pairs.

3. Optional: Set any of the following system properties related to both sending and receiving Kafka messages:

   Expand

   Table 22.1. Optional KIE Server system properties related to both sending and receiving Kafka messages

   Property	Description
   org.kie.server.jbpm-kafka.ext.client.id	An identifier string to pass to the broker when making requests. Red Hat AMQ Streams uses this string for logging.
   org.kie.server.jbpm-kafka.ext.topics.*	Mapping of message names to topic names. For example, if you want to send or receive a message in the ExampleTopic topic when ExampleName is the name of the message, set the org.kie.server.jbpm-kafka.ext.topics.ExampleName system property to ExampleTopic. You can set any number of such system properties. If a message name is not mapped using a system property, the process engine uses this name as the topic name.
   org.kie.server.jbpm-kafka.ext.property_name	Set any Red Hat AMQ Streams consumer or producer property by using the org.kie.server.jbpm-kafka.ext prefix. For example, to set a value for the buffer.memory producer property, set the org.kie.server.jbpm-kafka.ext.buffer.memory KIE Server system property. This setting applies to all processes that send or receive Kafka messages using events on this KIE Server. For a list of Red Hat AMQ Streams consumer and producer properties, see the Consumer configuration parameters and Producer configuration parameters appendixes in Using AMQ Streams on RHEL.

   Show more

4. Optional: Set any of the following system properties related to receiving Kafka messages:

   Expand

   Table 22.2. Optional KIE Server system properties related to receiving Kafka messages

   Property	Description	Default value
   org.kie.server.jbpm-kafka.ext.allow.auto.create.topics	Allow automatic topic creation.	true
   org.kie.server.jbpm-kafka.ext.group.id	A unique string that identifies the group to which this Kafka message consumer belongs.	jbpm-consumer.

   Show more

5. Optional: Set any of the following system properties related to sending Kafka messages:

   Expand

   Table 22.3. Optional KIE Server system properties related to sending Kafka messages

   Property	Description	Default value
   org.kie.server.jbpm-kafka.ext.acks	The number of acknowledgements that the Kafka leader must receive before marking the request as complete.	1. This value means the leader writes the record to its local log and then responds to the process engine, without waiting for full acknowledgement from all followers.
   org.kie.server.jbpm-kafka.ext.max.block.ms	The number of milliseconds for which the publish method blocks. After this time, the process engine can resume execution of the business process.	2000 (2 seconds).

   Show more