Skip to main content

RabbitMQ

Consume from, or publish to, a RabbitMQ queue or exchange.

Messaging↓ Inbound↑ Outbound
Type codeRABBITMQ
Camel componentcamel-spring-rabbitmq
Formats carried
HL7 v2FHIR R4JSONXMLCSV
Terms used on this page

AMQP - Advanced Message Queuing Protocol - the protocol RabbitMQ speaks

See the Glossary for every term.

The queue must already exist

For an inbound connection the engine reads the queue named here but never creates one. Create the queue on the RabbitMQ broker first, then enter its name.

Give the queue a dead-letter exchange

This keeps messages that are not orders instead of losing them.

Worked example​

Results queue (RabbitMQ) · Outbound · HL7 v2 · Test passes on any engine: No - placeholder values

Placeholder host on example.com - replace with the partner's RabbitMQ host, queue and login.

Values entered by Fill example
{
"direction": "Outbound",
"format": "HL7 v2",
"settings": {
"host": "mq.partner.example.com",
"port": "5672",
"virtualHost": "/",
"queue": "lab-results"
}
}
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
host
Host
textYes—Required: the broker's address, e.g. rabbit.lab.local.
port
Port
numberYes5672Required: 5672, or 5671 with TLS.
virtualHost
Virtual host
textNo/The virtual host, e.g. / (the default) or /lab.
queue
Queue or exchange
textYes—Inbound: the queue to read - it must already exist; the engine never creates one. Give the queue a dead-letter exchange to keep messages that are not orders.
username
Username
textNo—The broker account, e.g. xellabs.
password
Password
passwordNo—🔒 secret. That account's password. Stored encrypted.

What "Test connection" checks​

The host answers as an AMQP server. Signing in 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.