Kafka Delivery Method

The Kafka Delivery method enables a STEP platform integrated with Apache Kafka, which is an open-source distributed event-streaming data platform, to utilize a Kafka queue.

Prerequisites

Before setting up a Kafka Delivery, read the Considerations for Setting up Kafka Receiver or Delivery (here) topic in this documentation.

Prior to configuration, clicking the Server dropdown parameter displays the required server name. Provide a selection for the dropdown parameter via the sharedconfig.properties file on the STEP application server using the case-sensitive Kafka.Server configuration property. If connecting to a cluster, use a comma-separated list.

The following example shows two Kafka server configurations where the first server is a cluster:
```
Kafka.Server.1=mybroker1a:9094,mybroker1b:9094
```
```
Kafka.Server.2=mybroker2a:9094
```
Prior to configuration, clicking the Topic dropdown parameter displays the available topics. Provide a selection for the dropdown parameter via the sharedconfig.properties file on the STEP application server using the case-sensitive Kafka.Server configuration property. For example:
```
Kafka.Topic.1 = sample4
```
For multiple Kafka server configurations, add 'Kafka.Server.2,' etc
Prior to configuration, clicking the KeystoreLocation dropdown parameter displays the required property name. Provide a selection for the dropdown parameter via the sharedconfig.properties file on the STEP application server using the case-sensitive Kafka.SSLKeyStoreLocation property. For example:
```
Kafka.SSLKeyStoreLocation.1=[/[path]/key_store.jks].
```
Prior to configuration, clicking the Truststore Location dropdown parameter displays the required property name. Provide a selection for the dropdown parameter via the sharedconfig.properties file on the STEP application server using the case-sensitive Kafka.SSLTrustStoreLocation property. For example:
```
 Kafka.SSLTrustStoreLocation.1=[/[path]/trust_store.jks].
```

Configuration

The Kafka Delivery option is available when configuring an outbound integration endpoint (OIEP).

On the OIEP select 'Edit Delivery,' and then provide the following information:

For Delivery, choose Kafka Delivery.
For the Server, select the server(s) where the Kafka broker instances used by the endpoint are running.
In Topic, select the topic used by this endpoint.
For Max Events To Read Per Poll, enter the maximum number of events to read out of Kafka per invocation.

Note: Setting this too high can require allocating additional memory in the system.
In Decompress Message Content, optionally select a decompression option:

None - message content will remain compressed.
LZ4 - lossless data compression algorithm. Search the web for more information.

In Kafka Message Key Template, enter the desired key template. Viable templates include: ${endpointId}, ${nodeType}, and ${nodeId}.
In Keystore Location, if SSL encryption is required, select an SSL encrypted connection to Kafka. Otherwise, leave this parameter blank.
In Keystore Password, enter the password for keystore if required.
In Keystore PrivateKey Password, enter the password of the private key in the keystore file, if needed.
In Truststore Location, if SSL encryption is required, select an SSL encrypted connection to the Kafka. Otherwise, leave this parameter blank.
In Truststore Password, enter the password for truststore if required.
Click the Next button to continue with the IIEP - Configure Endpoint step (here), or the Finish button to close the wizard.