> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arc.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AMQP Connector Setup

> Connect Arc to an AMQP broker to produce and consume messages using the Advanced Message Queuing Protocol.

export const CommonProxySettings = () => <>
    <p>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 <a href="/26.2/self-hosted/en/getting-started/administration/settings/proxy-settings">Proxy Settings</a> portion of the <a href="/26.2/self-hosted/en/getting-started/administration/settings/security">Security Settings</a> page. Clear the checkbox to supply settings specific to your connector.</p>
    <table>
      <thead>
        <tr><th>Setting</th><th>Description</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Proxy Type</strong></td>
          <td>The protocol used by a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Proxy Host</strong></td>
          <td>The name or IP address of a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Proxy Port</strong></td>
          <td>The TCP port for a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Proxy User</strong></td>
          <td>The user name to use to authenticate with a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Proxy Password</strong></td>
          <td>A password used to authenticate to a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Authentication Scheme</strong></td>
          <td>Leave the default <strong>None</strong> or choose from one of the following authentication schemes: <strong>Basic</strong>, <strong>Digest</strong>, <strong>Proprietary</strong>, or <strong>NTLM</strong>.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const SlasTab = ({siteName = "CData Arc"}) => <>
    <p><em>Settings related to configuring Service Level Agreements (SLAs).</em></p>
    <p>
      SLAs enable you to configure the volume you expect connectors in your flow to send or receive, and to set the time frame in which you expect that volume to be met. {siteName} sends emails to warn the user when an SLA is not met, and marks the SLA as <em>At Risk</em>, which means that if the SLA is not met soon, it will be marked as <em>Violated</em>. This gives the user an opportunity to step in and determine the reasons the SLA is not being met, and to take appropriate actions. If the SLA is still not met at the end of the at-risk time period, the SLA is marked as violated, and the user is notified again.
    </p>
    <p>
      To define an SLA, toggle <strong>Expected Volume</strong> on, then click the <strong>Settings</strong> tab.
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>If your connector has separate send and receive actions, use the radio buttons to specify which direction the SLA pertains to.</li>
      <li>In the <strong>Expect at least</strong> portion of the window:
        <ul>
          <li>Set the minimum number of transactions you expect to be processed (the volume)</li>
          <li>Use the <strong>Every</strong> fields to specify the time frame</li>
          <li>Indicate when the SLA should go into effect. If you choose <strong>Starting on</strong>, complete the date and time fields.</li>
          <li>Check the boxes for the days of the week that you want the SLA to be in effect. Use the dropdown to choose <strong>Everyday</strong> if necessary.</li>
        </ul>
      </li>
      <li>In the <strong>Set status to 'At Risk'</strong> portion of the window, specify when the SLA should be marked as at risk.
        <ul>
          <li>By default, notifications are not sent until an SLA is in violation. To change that, check <strong>Send an 'At Risk' notification</strong>.</li>
        </ul>
      </li>
    </ul>
    <p>
      The following example shows an SLA configured for a connector that expects to receive 1000 files every day Monday-Friday. An at-risk notification is sent 1 hour before the end of the time period if the 1000 files have not been received.
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      You can turn off SLA alerts if necessary. This can be useful during maintenance windows. Click <strong>Settings</strong> on the navbar, then navigate to <strong>Alerts &gt; General Alerts</strong>. Click the tablet and pencil icon to edit, and uncheck the <strong>SLA Alerts</strong> setting.
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "Arc"}) => <>
    <p><em>Settings related to configuring alerts.</em></p>
    <p>
      Before you can execute Service Level Agreements (SLAs), you need to set up email alerts for notifications. By default, {siteNameShort} uses the global settings on the <a href="/26.2/self-hosted/en/getting-started/administration/settings/alerts">Alerts</a> tab. To use other settings for this connector, toggle <strong>Override global setting</strong> on.
    </p>
    <p>
      By default, error alerts are enabled, which means that emails are sent whenever there is an error. To turn them off, uncheck the <strong>Enable</strong> checkbox.
    </p>
    <p>
      Enter a <strong>Subject</strong> (mandatory), then optionally enter a comma-separated list of <strong>Recipient</strong> emails.
    </p>
  </>;

export const Message = () => <>
    <p><em>Message settings determine how the connector searches for messages and manages them after processing.</em></p>
    <table>
      <thead>
        <tr><th>Setting</th><th>Description</th></tr>
      </thead>
      <tbody>
        
          <tr>
            <td><strong>Save to Sent Folder</strong></td>
            <td>Check this to copy files processed by the connector to the Sent folder for the connector.</td>
          </tr>
        
        <tr>
          <td><strong>Sent Folder Scheme</strong></td>
          <td>Instructs the connector to group files in the <strong>Sent</strong> folder according to the selected interval. For example, the <strong>Weekly</strong> option instructs the connector to create a new subfolder each week and store all sent files for the week in that folder. The blank setting instructs the connector to save all files directly in the <strong>Sent</strong> folder. For connectors that process many transactions, using subfolders can help keep files organized and improve performance.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MiscConnector = () => <>
    <p><em>Miscellaneous settings are for specific use cases.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Other Settings</strong></td>
          <td>Enables you to configure hidden connector settings in a semicolon-separated list (for example, <code>setting1=value1;setting2=value2</code>). Normal connector use cases and functionality should not require the use of these settings.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Logging = () => <>
    <p><em>Settings that govern the creation and storage of logs.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Log Level</strong></td>
          <td>The verbosity of logs generated by the connector. When you request support, set this to <strong>Debug</strong>.</td>
        </tr>
        <tr>
          <td><strong>Log Subfolder Scheme</strong></td>
          <td>Instructs the connector to group files in the Logs folder according to the selected interval. The <strong>Weekly</strong> 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.</td>
        </tr>
        <tr>
          <td><strong>Log Messages</strong></td>
          <td>Check 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 <strong>Transactions</strong> tab.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      Some macros, such as %Ext% and %ShortDate%, do not require an argument, but others do. All
      macros that take an argument use the following syntax: <code>%Macro:argument%</code>
    </p>

    <p>Here are some examples of the macros that take an argument:</p>

    <ul>
      <li>%Header:headername%: Where <code>headername</code> is the name of a header on a message.</li>
      <li>%Header:mycustomheader% resolves to the value of the <code>mycustomheader</code> header set on the input message.</li>
      <li>%Header:ponum% resolves to the value of the <code>ponum</code> header set on the input message.</li>
      <li>%RegexFilename:pattern%: Where <code>pattern</code> is a regex pattern. For example, <code>%RegexFilename:^([\w][A-Za-z]+)%</code> matches and resolves to the first word in the filename and is case insensitive (<code>test_file.xml</code> resolves to <code>test</code>).</li>
      <li>%Vault:vaultitem%: Where <code>vaultitem</code> is the name of an item in the <a href="/26.2/self-hosted/en/getting-started/administration/settings/global-settings-vault">vault</a>. For example, <code>%Vault:companyname%</code> resolves to the value of the <code>companyname</code> item stored in the vault.</li>
      <li>%DateFormat:format%: Where <code>format</code> is an accepted date format (see <a href="/26.2/self-hosted/en/scripting/value-formatters/date-formatters#sample-date-formats">Sample Date Formats</a> for details). For example, <code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> resolves to the date and timestamp on the file.</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

    <p>You can also create more sophisticated macros, as shown in the following examples:</p>

    <ul>
      <li>Combining multiple macros in one filename: <code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%</code></li>
      <li>Including text outside of the macro: <code>MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code></li>
      <li>Including text within the macro: <code>%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%</code></li>
    </ul>
  </>;

export const MacrosTable = ({siteName = "CData Arc", extraMacros = []}) => <>
    <p>
      Using macros in file naming strategies can enhance organizational efficiency and contextual
      understanding of data. By incorporating macros into filenames, you can dynamically include
      relevant information such as identifiers, timestamps, and header information, providing
      valuable context to each file.
    </p>

    <p>{siteName} supports these macros, which all use the following syntax: <code>%Macro%</code>.</p>

    <table>
      <thead>
        <tr><th>Macro</th><th>Description</th></tr>
      </thead>
      <tbody>
        <tr><td>ConnectorID</td><td>Evaluates to the ConnectorID of the connector.</td></tr>
        <tr><td>Ext</td><td>Evaluates to the file extension of the file currently being processed by the connector.</td></tr>
        <tr><td>Filename</td><td>Evaluates to the filename (extension included) of the file currently being processed by the connector.</td></tr>
        <tr><td>FilenameNoExt</td><td>Evaluates to the filename (without the extension) of the file currently being processed by the connector.</td></tr>
        <tr><td>MessageId</td><td>Evaluates to the MessageId of the message being output by the connector.</td></tr>
        <tr><td>RegexFilename:<em>pattern</em></td><td>Applies a RegEx pattern to the filename of the file currently being processed by the connector.</td></tr>
        <tr><td>Header:<em>headername</em></td><td>Evaluates to the value of a targeted header (<code>headername</code>) on the current message being processed by the connector.</td></tr>
        <tr><td>LongDate</td><td>Evaluates to the current datetime of the system in long-handed format (for example, Wednesday, January 24, 2024).</td></tr>
        <tr><td>ShortDate</td><td>Evaluates to the current datetime of the system in a yyyy-MM-dd format (for example, 2024-01-24).</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>Evaluates to the current datetime of the system in the specified format (<code>format</code>). See <a href="/26.2/self-hosted/en/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">Sample Date Formats</a> for the available datetime formats.</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>Evaluates to the value of the specified vault item.</td></tr>
        {extraMacros.map(item => <tr key={item.name}>
            <td>{item.name}</td>
            <td>{item.description}</td>
          </tr>)}
      </tbody>
    </table>
  </>;

export const Performance = () => <>
    <p><em>Settings related to the allocation of resources to the connector.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Max Workers</strong></td>
          <td>The maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the <a href="/26.2/self-hosted/en/getting-started/administration/settings/performance-settings">Performance Settings</a> portion of the <a href="/26.2/self-hosted/en/getting-started/administration/settings/advanced-settings">Advanced Settings</a> page.</td>
        </tr>
        <tr>
          <td><strong>Max Files</strong></td>
          <td>The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the <a href="/26.2/self-hosted/en/getting-started/administration/settings/performance-settings">Performance Settings</a> portion of the <a href="/26.2/self-hosted/en/getting-started/administration/settings/advanced-settings">Advanced Settings</a> page.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const siteNameShort = "Arc";

export const siteName = "CData Arc";

export const datasource = "AMQP";

The Advanced Message Queueing Protocol ({datasource}) connector allows you to integrate {datasource} 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 {siteName} to {datasource}.

## Establish a Connection

You must first establish a connection to {datasource} through one of these two methods:

* Add a {datasource} connector to your flow. Then, in the settings pane, click **Create** next to the Connection drop-down list.
* Open the {siteName} **Settings** page, then open the **Connections** tab. Click **Add**, select **{datasource}**, and click **Next**.

<Note>
  - The login process is only required the first time the connection is created.
  - Connections to {datasource} can be re-used across multiple {datasource} connectors.
</Note>

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 {datasource}.

   * **Remote Host** — the hostname or IP address of your {datasource} 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 {datasource} configuration.

   * **Container Id** — (optional) the ID value for the container in your {datasource} 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 {datasource}.

   * **Password** — the password for the user.

2. Click **Test Connection** to ensure that {siteNameShort} can connect to {datasource} 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

| 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](#produce) action, supply the address of the node that should act as the receiver. For the [Consume](#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](#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:

```json theme={null}
{
"type": "typename",
"value": value
}
```

The following table provides a complete list of valid typenames, and describes how the associated values should be represented:

| 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 |

<Note>Typenames must be lowercase in order to be parsed correctly.</Note>

### 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](#macros). |

#### Proxy Settings

<CommonProxySettings />

#### Message

<Message />

#### Logging

<Logging />

#### Miscellaneous

<MiscConnector />

### 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. |

#### Performance

<Performance />

### Alerts Tab

<AlertsTab />

### SLAs Tab

<SlasTab />

## Select an Action

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

| Action              | Description                                                                                               | Position in Flow |
| ------------------- | --------------------------------------------------------------------------------------------------------- | ---------------- |
| [Produce](#produce) | Accepts input data from a file or another connector and sends it to your {datasource} connection.         | End              |
| [Consume](#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 {datasource} connection. This data can come from other connectors or from files that you manually upload to the **Transactions** tab of the {datasource} connector.

In some {datasource} 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 {datasource} queue. Data processed through the **Consume** connector goes to the **Transactions** tab and travels down to the next steps of the {siteNameShort} flow.

In some {datasource} 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

<MacrosTable />

### Examples

<MacrosExamples />