Apache Kafka Producer Adapter
The Designer allows to write synchronous messages to an Apache Kafka event topic. The access to Kafka can be configured statically by an alias - dynamic access is not available. The Kafka Producer supports SSL but no Kerberos authentication.
To use the Apache Kafka Producer adapter, you need basic knowledge of Apache Kafka. Refer to the Apache Kafka Documentation for any deeper insights.
You can find all data types and operations of the Kafka Producer adapter in the service panel at Base Types/Bridge Base/Base Components/Add Ons/Kafka.
The Apache Kafka documentation speaks of events that contain a message, or of records in more technical parts of the documentation. This documentation summarizes all under the term "message".
Adding a Kafka Producer Adapter Operation to a Diagram
Expand the path to the Kafka Producer adapter in the service panel (Base Types/Bridge Base/Base Components/Add Ons/Kafka):
You can drag out operations from the data model to any diagram:
The example shows how to add a Kafka Producer adapter operation to a BPMN execution diagram:
Configuring the Kafka Producer Adapter Operation
Once an operation has been added to a diagram, it needs to be configured as a Kafka Producer adapter.
Select the newly added Kafka Producer adapter operation and switch to the Attributes panel:
Depending on the diagram type you can see the following information (example BPMN execution diagram):
Attribute | Description | Allowed Values / Examples |
---|---|---|
Name | The name of the Kafka Producer adapter operation. | produce |
Symbol Type | Operations added to an execution diagram are execution steps. | Execution Step |
All this is predefined and cannot be changed.
Click Add Stereotype to define the selected operation as to be a Kafka Producer adapter:
Select Kafka Producer Adapter from the list of available adapter stereotypes. Click Save:
The Attributes panel shows the added adapter stereotype. Now you still need to configure the adapter. Expand the stereotype by clicking the arrow on the right:
To configure a Kafka Producer adapter, you have the following options:
alias: A Kafka Producer adapter is configured via its alias.
You can select an existing alias from a drop-down list by clicking the text Select alias. If you want to remove an added alias, click the corresponding Minus option on the right side or select None from the drop-down list:
You can also create and add a new alias by clicking the corresponding Plus option:
Refer to Aliases for more information on how to create a new alias.
In the following dialog, name and configure the new alias. Refer to Apache Kafka Producer Reference for more information on the configuration options of this adapter.
Click Save to create and add the new alias:
Related Documentation: