RabbitMQConnector
Connects to an AMQP 0-9-1 broker. Supports sending (producing) and receiving (consuming) messages.
Typical Uses
- Producing messages to RabbitMQ
- Aggregation of data from RabbitMQ topics and other message streams
- Interoperability with Big Data analytics platforms
Configuration
Input Ports
This transformer accepts any feature.
Output Ports
The output of this transformer will vary depending on the action performed. Message data and metadata are presented as feature attributes.
- After a Receive action, output features represent messages received from the broker.
- After a Send action, output features represent messages sent to the broker.
- After a Count action, output the number of messages in a queue.
- After an Acknowledge action, set messages marked as acknowledged.
The incoming feature is output through this port.
Features that cause the operation to fail are output through this port. An fme_rejection_code attribute, having the value ERROR_DURING_PROCESSING, will be added, along with a more descriptive fme_rejection_message attribute which contains more specific details as to the reason for the failure.
Note: If a feature comes in to the RabbitMQConnector already having a value for fme_rejection_code, this value will be removed.
Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.
Parameters
Credential Source |
Using a web connection integrates best with FME, but in some cases, you may wish to use one of the other sources.
|
Account |
Available when the credential source is Web Connection. To create a RabbitMQ connection, click the Account drop-down box and select Add Web Connection.... The connection can then be managed via Tools > FME Options > Web Connections. |
Host |
The endpoint of the RabbitMQ broker. |
Broker Port |
The port to connect to the broker. Defaults:
|
Web Port |
The port to connect to the RabbitMQ HTTP API. This is the same port for the admin web GUI. Default – 15672 |
Enable SSL/TLS |
Whether to use a secure ssl connection when connecting to the broker. |
User Name, Password |
The username and password to use when connecting to the broker. |
Action |
The type of operation to perform. Choices are:
|
The remaining parameters available depend on the value of the Request > Action parameter. Parameters for each Action are detailed below.
Acknowledge Options
Receiving Connector Id |
The _connector_id attribute received from the Receive Action. Used for determining the message to acknowledge. |
Delivery Tag |
Attribute received from the Receive Action. Used for determining the message to acknowledge. |
Multiple Messages |
If Yes, acknowledge all messages prior to the current message. |
Count Messages Options
Queue |
The queue to count waiting messages. |
Routing
Exchange Type |
The exchange
|
Exchange |
The exchange name consists of a non-empty sequence of these characters: letters, digits, hyphen, underscore, period, or colon. |
Routing Key |
The name used to route messages from exchanges to queues. |
Queue |
The queue name. If empty, the broker will create a unique queue name. |
Receive Options
Receive Mode |
Two message receiving options are available:
|
Batch Size |
In Batch mode, specifies the number of messages to read per batch. |
Advanced Properties
Auto Acknowledge |
If Yes, the messages can be acknowledged in another transformer. The channel to the broker will stay open until the messages are acknowledged. Use the outputted _connector_id attribute in the acknowledgment transformer. |
Declare Exchange |
Whether to declare the exchange. |
Exchange Properties |
Properties to apply to the exchange
|
Queue Properties |
Properties to apply to the queue
For more information on RabbitMQ queues see: https://www.rabbitmq.com/queues.html |
Routing
Exchange Type |
The exchange
|
Exchange |
The exchange name consists of a non-empty sequence of these characters: letters, digits, hyphen, underscore, period, or colon. |
Routing Key |
The name used to route messages from exchanges to queues. |
Send Options
Payload |
The content of the message. This is often JSON, but can be any string, binary, integer or floating-point value. |
Delivery Mode |
|
Advanced Properties
Declare Exchange |
Whether to declare the exchange. |
Exchange Properties |
Properties to apply to the exchange
|
Declare Queue |
Whether to declare the queue. |
Queue |
The queue to use. |
Queue Properties |
Properties to apply to the queue
For more information on RabbitMQ queues, see: https://www.rabbitmq.com/queues.html |
Message Properties |
Additional message properties settable. The following keys are valid:
|
The following attributes can be selected for inclusion on the output features. Each output feature represents a message that was either sent or received.
_delivery_tag |
Used to identify the message for acknowledgement. |
_payload |
The message payload. UTF-8 string if possible to decode, otherwise binary or numeric. |
_consumer_tag |
Used to identify the consumer. |
_exchange |
The exchange that the message was routed through. |
_headers |
A list of name/value pairs of headers on the message. |
_properties |
A list of name/value pairs of additional message properties. |
_redelivered |
True if a message is delivered but not fully acknowledged and re-queued. |
_routing_key |
The routing key used to route the message. |
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
Defining Values
There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.
Using the Text Editor
The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.
Using the Arithmetic Editor
The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.
Conditional Values
Set values depending on one or more test conditions that either pass or fail.
Parameter Condition Definition Dialog
Content
Expressions and strings can include a number of functions, characters, parameters, and more.
When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.
These functions manipulate and format strings. | |
Special Characters |
A set of control characters is available in the Text Editor. |
Math functions are available in both editors. | |
Date/Time Functions | Date and time functions are available in the Text Editor. |
These operators are available in the Arithmetic Editor. | |
These return primarily feature-specific values. | |
FME and workspace-specific parameters may be used. | |
Creating and Modifying User Parameters | Create your own editable parameters. |
Dialog Options - Tables
Transformers with table-style parameters have additional tools for populating and manipulating values.
Row Reordering
|
Enabled once you have clicked on a row item. Choices include:
|
Cut, Copy, and Paste
|
Enabled once you have clicked on a row item. Choices include:
Cut, copy, and paste may be used within a transformer, or between transformers. |
Filter
|
Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output. |
Import
|
Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers. |
Reset/Refresh
|
Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers. |
Note: Not all tools are available in all transformers.
Reference
Processing Behavior |
|
Feature Holding |
No |
Dependencies | |
Aliases | |
History | Released FME 2019.0 |
FME Community
The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.
Search for all results about the RabbitMQConnector on the FME Community.
Examples may contain information licensed under the Open Government Licence – Vancouver and/or the Open Government Licence – Canada.