Skip to main content
The Advanced Message Queueing Protocol (AMQP) connector allows you to integrate AMQP 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 CData Arc to AMQP.

Establish a Connection

You must first establish a connection to AMQP through one of these two methods:
  • Add a AMQP connector to your flow. Then, in the settings pane, click Create next to the Connection drop-down list.
  • Open the CData Arc Settings page, then open the Connections tab. Click Add, select AMQP, and click Next.
  • The login process is only required the first time the connection is created.
  • Connections to AMQP can be re-used across multiple AMQP connectors.
After opening the connection dialogue, follow these steps:
  1. Enter the connection information:
    • Name — the static name of the connection.
    • Type — this is always set to AMQP.
    • Remote Host — the hostname or IP address of your AMQP 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 AMQP configuration.
    • Container Id — (optional) the ID value for the container in your AMQP 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 AMQP.
    • Password — the password for the user.
  2. Click Test Connection to ensure that Arc can connect to AMQP with the provided information. If an error occurs, check all fields and try again.
  3. Click Add Connection to finalize the connection.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Configuration

AMQP Message

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:
The following table provides a complete list of valid typenames, and describes how the associated values should be represented:
Typenames must be lowercase in order to be parsed correctly.

Advanced Tab

Other Settings

Proxy Settings

These are a collection of settings that identify and authenticate to the proxy through which the connection should be routed. By default, this section uses the global settings on the Proxy Settings portion of the Security Settings page. Clear the checkbox to supply settings specific to your connector.

SettingDescription
Proxy TypeThe protocol used by a proxy-based firewall.
Proxy HostThe name or IP address of a proxy-based firewall.
Proxy PortThe TCP port for a proxy-based firewall.
Proxy UserThe user name to use to authenticate with a proxy-based firewall.
Proxy PasswordA password used to authenticate to a proxy-based firewall.
Authentication SchemeLeave the default None or choose from one of the following authentication schemes: Basic, Digest, Proprietary, or NTLM.

Message

Message settings determine how the connector searches for messages and manages them after processing.

Note: The settings below are deprecated and hidden by default. They appear only on connectors where they were previously enabled or configured to a non-default value. To retain copies of successfully processed files, right-click the connector in the flow, choose Show Success Path, and connect the success path to a File connector.

SettingDescription
Save to Sent Folder (Deprecated)Copies files processed by the connector to the Sent folder. Disabled by default. Files saved to the Sent folder are not covered by Encryption at Rest.
Sent Folder Scheme (Deprecated)Groups files in the Sent folder by the selected time interval. Only relevant when Save to Sent Folder is enabled.

Logging

Settings that govern the creation and storage of logs.

SettingDescription
Log LevelThe verbosity of logs generated by the connector. When you request support, set this to Debug.
Log Subfolder SchemeInstructs the connector to group files in the Logs folder according to the selected interval. The Weekly option (which is the default) instructs the connector to create a new subfolder each week and store all logs for the week in that folder. Leaving this setting blank tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.
Log MessagesCheck this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Transactions tab.

Miscellaneous

Miscellaneous settings are for specific use cases.

SettingDescription
Other SettingsEnables you to configure hidden connector settings in a semicolon-separated list (for example, setting1=value1;setting2=value2). Normal connector use cases and functionality should not require the use of these settings.

Automation Tab

Automation Settings

Settings related to the automatic processing of files by the connector.

Performance

Settings related to the allocation of resources to the connector.

SettingDescription
Max WorkersThe maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the Performance Settings portion of the Advanced Settings page.
Max FilesThe maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the Performance Settings portion of the Advanced Settings page.

Alerts Tab

SLAs Tab

Logs Tab

The Logs tab lists the service logs generated by this connector. Each row represents a log file and shows its date modified, file name, size, and status. Use the search bar or the status filter to find a specific log, click a file name to preview or download it, or click Download All Logs to download all of them as a single zip file.

Select an Action

After establishing a connection to AMQP, you must choose the action that the AMQP connector will perform. The table below outlines each action and where it belongs in a CData Arc flow:

Produce

The Produce action sends input data to your AMQP connection. This data can come from other connectors or from files that you manually upload to the Transactions tab of the AMQP connector. In some AMQP 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 AMQP queue. Data processed through the Consume connector goes to the Transactions tab and travels down to the next steps of the Arc flow. In some AMQP 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