The Advanced Message Queueing Protocol () connector allows you to integrate into your data flow by performing Produce and Consume actions on your data.
Key Capabilities
- Bidirectional message queueing with produce and consume actions
- Support for multiple authentication schemes (None, SASL Anonymous, SASL Plain)
- TLS encryption support for secure connections
- Flexible message value types including JSON composite data support
Follow the steps below to connect to .
Establish a Connection
You must first establish a connection to through one of these two methods:
- Add a connector to your flow. Then, in the settings pane, click Create next to the Connection drop-down list.
- Open the Settings page, then open the Connections tab. Click Add, select , and click Next.
- The login process is only required the first time the connection is created.
- Connections to can be re-used across multiple connectors.
-
Enter the connection information:
-
Name — the static name of the connection.
-
Type — this is always set to .
-
Remote Host — the hostname or IP address of your remote host.
-
Remote Port — the port for your remote host connection.
-
Use TLS — whether to use TLS to encrypt the connection. Set this according to your configuration.
-
Container Id — (optional) the ID value for the container in your connection that you want to access.
-
Auth Scheme — the authentication scheme to use for the connection. Options are None, SASL Anonymous, and SASL Plain.
If you select SASL Anonymous or SASL Plain authentication, enter the following information:
-
User — the username to use when connecting to .
-
Password — the password for the user.
-
Click Test Connection to ensure that can connect to with the provided information. If an error occurs, check all fields and try again.
-
Click Add Connection to finalize the connection.
Connector Configuration
This section contains all of the configurable connector properties.
Settings Tab
Configuration
| Setting | Description |
|---|
| Connector Id | The static, unique identifier for the connector. |
| Connector Type | Displays the connector name and a description of what it does. |
| Connector Description | An optional field to provide a free-form description of the connector and its role in the flow. |
| Connection | Select the connection you created in the previous steps. |
| Target | (Optional) For the Produce action, supply the address of the node that should act as the receiver. For the Consume action, supply the address of the node that the connector should receive data from. |
| Action | The action that the connector should perform. See Select an Action for more information. |
AMQP Message
| Setting | Description |
|---|
| Value Type | The default value type for messages produced by the connector. Including a message header called AMQP-ValueType on input messages overrides this selection. |
JSON Composite Data Value Type
One Value Type option is JSON (Composite Data). The composite data JSON schema consists of type-value objects, which hold an AMQP typename and a value. The syntax for a type-value object is:
{
"type": "typename",
"value": value
}
| Typename | Description | Value Format |
|---|
| null | Null | null |
| boolean | Boolean | true or false |
| ubyte | Unsigned byte | 0 to 255 |
| ushort | Unsigned short | 0 to 65535 |
| uint | Unsigned integer | 0 to 4294967295 |
| ulong | Unsigned long | 0 to 18446744073709551615 |
| byte | Byte | -128 to 127 |
| short | Short | -32768 to 32767 |
| int | Integer | -2147483648 to 2147483647 |
| long | Long | -9223372036854775808 to 9223372036854775807 |
| float | Float | [IEEE 754 32-bit floating point number] |
| double | Double | [IEEE 754 64-bit floating point number] |
| decimal | Decimal | Hex-encoded byte string like “0A1B2C3D” |
| char | Char | ”c” |
| timestamp | Timestamp | [Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC)] |
| uuid | UUID | Hex-encoded UUID string like “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX” (hyphens optional, case-insensitive) |
| binary | Binary data | Hex-encoded byte string like “0A1B2C3D” |
| string | String | ”UTF-8 string (correctly escaped for JSON)“ |
| symbol | Symbolic value | ”ASCII string” |
| array | AMQP array | JSON array with zero or more type-value objects of the same type |
| list | AMQP list | JSON array with zero or more type-value objects |
| map | AMQP map | JSON array with even number of type-value objects representing keys and values; no duplicate keys allowed |
Typenames must be lowercase in order to be parsed correctly.
Advanced Tab
Other Settings
| Setting | Description |
|---|
| Local File Scheme | A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see Macros. |
Proxy Settings
Logging
Miscellaneous
Automation Tab
Automation Settings
Settings related to the automatic processing of files by the connector.
| Setting | Description |
|---|
| Send | A toggle that instructs the connector to automatically send files when they are ready. |
| Retry Interval | The interval the connector waits before retrying a failed send. |
| Max Attempts | The number of attempts the connector makes to send the message. Setting this value to 1 instructs the connector to only make the initial send attempt without retrying. The connector waits the duration specified by Retry Interval between each attempt. |
Alerts Tab
SLAs Tab
Select an Action
After establishing a connection to , you must choose the action that the connector will perform. The table below outlines each action and where it belongs in a flow:
| Action | Description | Position in Flow |
|---|
| Produce | Accepts input data from a file or another connector and sends it to your connection. | End |
| Consume | Listens for messages coming into the queue and sends incoming data down the flow through the Output path. | Beginning |
Produce
The Produce action sends input data to your connection. This data can come from other connectors or from files that you manually upload to the Transactions tab of the connector.
In some configurations, you can set the value of the Target field to the address of the node that should act as the receiver. This might not be necessary in all configurations.
Consume
The Consume action checks for messages in the queue. Data processed through the Consume connector goes to the Transactions tab and travels down to the next steps of the flow.
In some configurations, you can set the value of the Target field to the address of the node that the connector should receive data from. This might not be necessary in all configurations.
Macros
Examples
