Skip to main content

Apache Kafka

Consume from, or publish to, a Kafka topic.

Messaging↓ Inbound↑ Outbound
Type codeKAFKA
Camel componentcamel-kafka
Formats carried
HL7 v2FHIR R4JSONXMLCSV
Test connection checks the brokers only

It confirms every broker in the list accepts a connection. Topic access is not checked yet (see Stage 2).

Keep the consumer group the same

A restart then continues where it stopped. SASL_SSL needs the username and password.

Worked example​

Hospital order events (Kafka) · Inbound · JSON · Test passes on any engine: No - placeholder values

Placeholder brokers on example.com - replace with the hospital's brokers and topic.

Values entered by Fill example
{
"direction": "Inbound",
"format": "JSON",
"settings": {
"brokers": "kafka.hospital.example.com:9092",
"topic": "lab-orders",
"groupId": "xellabs-integration-engine",
"security": "PLAINTEXT"
}
}
Placeholder values

The addresses above are placeholders on example.com. Replace them with your partner's real details before running Test connection.

This is what the console's Fill example button enters. Secrets are never part of an example. Every setting is explained below.

Settings​

Required fields are marked Yes. Fields marked 🔒 (password) are stored encrypted and never sent back to the browser - the console only shows Set / Not set. A field marked inbound only or outbound only appears just for that direction.

SettingTypeRequiredDefaultWhat to enter
brokers
Bootstrap servers
textYes—Required: host:port of one or more brokers, comma-separated, e.g. kafka1:9092,kafka2:9092.
topic
Topic
textYes—Required: the topic to read or write, e.g. lab.orders.
groupId
Consumer group
textNoxellabs-integration-engineinbound only. The consumer group, e.g. xellabs-integration-engine. Keep it the same so a restart continues where it stopped.
security
Security
selectYesPLAINTEXTPLAINTEXT on a closed network; SSL or SASL_SSL otherwise. SASL_SSL needs the username and password. Options: PLAINTEXT, SSL, SASL_SSL.
username
SASL username
textNo—Required for SASL_SSL: the SASL account.
password
SASL password
passwordNo—🔒 secret. Required for SASL_SSL: the SASL password. Stored encrypted.

What "Test connection" checks​

Every broker in the list accepts a connection. Topic access is checked in Stage 2.

Test connection is read-only and says how far it got: verified, reached, checked or failed. See Testing a connection, and Troubleshooting if it fails.