> ## 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>これらは、接続のルーティング先となるプロキシを識別し認証するための一連の設定です。デフォルトでは、このセクションは<a href="/26.3/cloud/ja/getting-started/administration/settings/security">Security Settings</a> ページの<a href="/26.3/cloud/ja/getting-started/administration/settings/proxy-settings">Proxy Settings</a> 部分にあるグローバル設定を使用します。チェックボックスをオフにすると、コネクタ固有の設定を指定できます。</p>
    <table>
      <thead>
        <tr><th>設定</th><th>説明</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Proxy Type</strong></td>
          <td>プロキシベースのファイアウォールで使用されるプロトコル。</td>
        </tr>
        <tr>
          <td><strong>Proxy Host</strong></td>
          <td>プロキシベースのファイアウォールの名前またはIP アドレス。</td>
        </tr>
        <tr>
          <td><strong>Proxy Port</strong></td>
          <td>プロキシベースのファイアウォールのTCP ポート。</td>
        </tr>
        <tr>
          <td><strong>Proxy User</strong></td>
          <td>プロキシベースのファイアウォールで認証するために使用するユーザー名。</td>
        </tr>
        <tr>
          <td><strong>Proxy Password</strong></td>
          <td>プロキシベースのファイアウォールで認証するために使用するパスワード。</td>
        </tr>
        <tr>
          <td><strong>Authentication Scheme</strong></td>
          <td>デフォルトの<strong>None</strong> のままにするか、次の認証スキームのいずれかを選択します：<strong>Basic</strong>、<strong>Digest</strong>、<strong>Proprietary</strong>、または<strong>NTLM</strong>。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const ServiceLogs = () => <p><strong>ログ</strong>タブには、このコネクタが生成したサービスログが一覧表示されます。各行はログファイルを表し、更新日時、ファイル名、サイズ、ステータスが表示されます。特定のログを検索するには検索バーまたはステータスフィルタを使用し、ファイル名をクリックしてプレビューまたはダウンロードするか、<strong>すべてのログをダウンロード</strong>をクリックしてすべてのログを単一のzipファイルとしてダウンロードします。</p>;

export const SlasTab = ({siteName = "CData Arc"}) => <>
    <p><em>サービスレベルアグリーメント（SLA）の設定に関する設定です。</em></p>
    <p>
      SLA を使用すると、フロー内のコネクタが送受信すると見込まれるボリュームを設定し、そのボリュームを達成すると見込まれる期間を設定できます。{siteName} は、SLA が達成されない場合にユーザーへ警告するメールを送信し、SLA を<em>At Risk</em> としてマークします。これは、SLA が間もなく達成されない場合に<em>Violated</em> としてマークされることを意味します。これにより、ユーザーは介入してSLA が達成されない理由を特定し、適切な対応を取る機会を得られます。At Risk 期間の終了時点でもSLA が達成されない場合、SLA はviolated としてマークされ、ユーザーに再度通知されます。
    </p>
    <p>
      SLA を定義するには、<strong>Expected Volume</strong> をオンに切り替え、<strong>Settings</strong> タブをクリックします。
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>コネクタに送信と受信の個別のアクションがある場合は、ラジオボタンを使用してSLA がどちらの方向に適用されるかを指定します。</li>
      <li>ウィンドウの<strong>Expect at least</strong> 部分で、次を設定します。
        <ul>
          <li>処理を見込む最小トランザクション数（ボリューム）を設定します。</li>
          <li><strong>Every</strong> フィールドを使用して期間を指定します。</li>
          <li>SLA を有効にするタイミングを指定します。<strong>Starting on</strong> を選択した場合は、日付および時刻フィールドを入力します。</li>
          <li>SLA を有効にしたい曜日のチェックボックスをオンにします。必要に応じて、ドロップダウンで<strong>Everyday</strong> を選択します。</li>
        </ul>
      </li>
      <li>ウィンドウの<strong>Set status to 'At Risk'</strong> 部分で、SLA をAt Risk としてマークするタイミングを指定します。
        <ul>
          <li>デフォルトでは、SLA が違反状態になるまで通知は送信されません。これを変更するには、<strong>Send an 'At Risk' notification</strong> をオンにします。</li>
        </ul>
      </li>
    </ul>
    <p>
      次の例は、月曜日から金曜日まで毎日1000 件のファイルを受信すると見込むコネクタ向けに設定されたSLA を示しています。1000 件のファイルが受信されていない場合、期間の終了の1時間前にAt Risk 通知が送信されます。
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      必要に応じてSLA アラートをオフにすることができます。これはメンテナンスウィンドウ中に役立ちます。navbar で<strong>Settings</strong> をクリックし、<strong>Alerts &gt; General Alerts</strong> に移動します。タブレットと鉛筆のアイコンをクリックして編集し、<strong>SLA Alerts</strong> 設定のチェックを外します。
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "Arc"}) => <>
    <p><em>アラートの設定に関する設定です。</em></p>
    <p>
      サービスレベルアグリーメント（SLA）を実行する前に、通知用のメールアラートをセットアップする必要があります。デフォルトでは、{siteNameShort} は<a href="/26.3/cloud/ja/getting-started/administration/settings/alerts">Alerts</a> タブのグローバル設定を使用します。このコネクタに別の設定を使用するには、<strong>Override global setting</strong> をオンに切り替えます。
    </p>
    <p>
      デフォルトではエラーアラートが有効になっており、エラーが発生するたびにメールが送信されます。これをオフにするには、<strong>Enable</strong> チェックボックスのチェックを外します。
    </p>
    <p>
      <strong>Subject</strong>（必須）を入力します。<strong>Allow {siteNameShort}Script in Subject</strong> をチェックすると、<strong>Subject</strong> フィールドで{siteNameShort}Script を使用できます。これを選択すると、<strong>{siteNameShort}Script エディタ</strong>ボタンが表示されます（<img src="/public/images/rest_arcscript_editor.png" alt="arcscript editor button" style={{
  display: 'inline',
  verticalAlign: 'middle',
  margin: 0
}} />）。
    </p>
    <p>
      必要に応じて<strong>Recipient</strong> のメールアドレスをカンマ区切りのリストで入力します。
    </p>
  </>;

export const MiscConnector = () => <>
    <p><em>Miscellaneous 設定は、特定のユースケース向けの設定です。</em></p>
    <table>
      <thead>
        <tr>
          <th>設定</th>
          <th>説明</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Other Settings</strong></td>
          <td>非表示のコネクタ設定をセミコロン区切りのリストで設定できます（例：<code>setting1=value1;setting2=value2</code>）。通常のコネクタのユースケースや機能では、これらの設定の使用は必要ありません。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Logging = () => <>
    <p><em>ログの作成と保存を制御する設定です。</em></p>
    <table>
      <thead>
        <tr>
          <th>設定</th>
          <th>説明</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Log Level</strong></td>
          <td>コネクタが生成するログの詳細度です。サポートを依頼する際は、これを<strong>Debug</strong> に設定してください。</td>
        </tr>
        <tr>
          <td><strong>Log Subfolder Scheme</strong></td>
          <td>選択した間隔に従って、コネクタがLogs フォルダ内のファイルをグループ化するよう指示します。<strong>Weekly</strong> オプション（デフォルト）は、コネクタが毎週新しいサブフォルダを作成し、その週のすべてのログをそのフォルダに保存するよう指示します。この設定を空白のままにすると、コネクタはすべてのログをLogs フォルダに直接保存します。多数のトランザクションを処理するコネクタでは、サブフォルダを使用することでログを整理しやすくなり、パフォーマンスが向上します。</td>
        </tr>
        <tr>
          <td><strong>Log Messages</strong></td>
          <td>処理したファイルのログエントリにファイル自体のコピーを含めるには、これをオンにします。これを無効にすると、<strong>Transactions</strong> タブからファイルのコピーをダウンロードできなくなる場合があります。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      %Ext% や %ShortDate% などの一部のマクロは引数を必要としませんが、引数を必要とするものもあります。
      引数を取るすべてのマクロは次の構文を使用します。<code>%Macro:argument%</code>
    </p>

    <p>引数を取るマクロの例を次に示します。</p>

    <ul>
      <li>%Header:headername%：<code>headername</code> はメッセージ上のヘッダーの名前です。</li>
      <li>%Header:mycustomheader% は、入力メッセージに設定された<code>mycustomheader</code> ヘッダーの値に解決されます。</li>
      <li>%Header:ponum% は、入力メッセージに設定された<code>ponum</code> ヘッダーの値に解決されます。</li>
      <li>%RegexFilename:pattern%：<code>pattern</code> は正規表現パターンです。例えば、<code>%RegexFilename:^([\w][A-Za-z]+)%</code> は、ファイル名の最初の単語にマッチしてそれに解決され、大文字・小文字を区別しません（<code>test_file.xml</code> は<code>test</code> に解決されます）。</li>
      <li>%Vault:vaultitem%：<code>vaultitem</code> は<a href="/26.3/cloud/ja/getting-started/administration/settings/global-settings-vault">Vault</a> 内のアイテムの名前です。例えば、<code>%Vault:companyname%</code> は、Vault に保存された<code>companyname</code> アイテムの値に解決されます。</li>
      <li>%DateFormat:format%：<code>format</code> は許容される日付形式です（詳細は<a href="/26.3/cloud/ja/scripting/value-formatters/date-formatters#sample-date-formats">日付形式のサンプル</a>を参照してください）。例えば、<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> は、ファイルの日付とタイムスタンプに解決されます。</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

    <p>次の例に示すように、より高度なマクロを作成することもできます。</p>

    <ul>
      <li>1 つのファイル名で複数のマクロを組み合わせる：<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%</code></li>
      <li>マクロの外側にテキストを含める：<code>MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code></li>
      <li>マクロの内側にテキストを含める：<code>%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%</code></li>
    </ul>
  </>;

export const MacrosTable = ({siteName = "CData Arc", extraMacros = []}) => <>
    <p>
      ファイル命名戦略でマクロを使用すると、データの整理効率と文脈の理解を高めることができます。
      ファイル名にマクロを組み込むことで、識別子、タイムスタンプ、ヘッダー情報などの関連情報を
      動的に含めることができ、各ファイルに有用な文脈を提供します。
    </p>

    <p>{siteName} は次のマクロをサポートしています。これらはすべて次の構文を使用します。<code>%Macro%</code></p>

    <table>
      <thead>
        <tr><th>マクロ</th><th>説明</th></tr>
      </thead>
      <tbody>
        <tr><td>ConnectorID</td><td>コネクタのConnectorID に評価されます。</td></tr>
        <tr><td>ConnectorName</td><td>コネクタの名前に評価されます。ファイル名やパスに接続名を含めることができます。例えば、どのデータベース接続が生成したかによってバックアップファイルにタグを付けるために使用できます。</td></tr>
        <tr><td>Ext</td><td>コネクタが現在処理しているファイルの拡張子に評価されます。</td></tr>
        <tr><td>Filename</td><td>コネクタが現在処理しているファイルのファイル名（拡張子を含む）に評価されます。</td></tr>
        <tr><td>FilenameNoExt</td><td>コネクタが現在処理しているファイルのファイル名（拡張子を除く）に評価されます。</td></tr>
        <tr><td>MessageId</td><td>コネクタが出力しているメッセージのMessageId に評価されます。</td></tr>
        <tr><td>RegexFilename:<em>pattern</em></td><td>コネクタが現在処理しているファイルのファイル名に正規表現パターンを適用します。</td></tr>
        <tr><td>Header:<em>headername</em></td><td>コネクタが現在処理しているメッセージ上の対象ヘッダー（<code>headername</code>）の値に評価されます。</td></tr>
        <tr><td>LongDate</td><td>システムの現在の日時を長い形式（例：Wednesday, January 24, 2024）で評価します。</td></tr>
        <tr><td>ShortDate</td><td>システムの現在の日時をyyyy-MM-dd 形式（例：2024-01-24）で評価します。</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>システムの現在の日時を指定された形式（<code>format</code>）で評価します。利用可能な日時形式については、<a href="/26.3/cloud/ja/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">日付形式のサンプル</a>を参照してください。</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>指定されたVault アイテムの値に評価されます。</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>コネクタへのリソースの割り当てに関する設定です。</em></p>
    <table>
      <thead>
        <tr>
          <th>設定</th>
          <th>説明</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Max Workers</strong></td>
          <td>このコネクタでファイルを処理するためにスレッドプールから消費されるワーカースレッドの最大数です。設定すると、<a href="/26.3/cloud/ja/getting-started/administration/settings/advanced-settings">Advanced Settings</a> ページの<a href="/26.3/cloud/ja/getting-started/administration/settings/performance-settings">Performance Settings</a> 部分にあるデフォルト設定が上書きされます。</td>
        </tr>
        <tr>
          <td><strong>Max Files</strong></td>
          <td>コネクタに割り当てられた各スレッドが送信するファイルの最大数です。設定すると、<a href="/26.3/cloud/ja/getting-started/administration/settings/advanced-settings">Advanced Settings</a> ページの<a href="/26.3/cloud/ja/getting-started/administration/settings/performance-settings">Performance Settings</a> 部分にあるデフォルト設定が上書きされます。</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.                                                                                                                  |
| **サーバーステータス**             | (**アクション**が**Consume** の場合のみ適用) コネクタのサーバーの状態：**アクティブ**（サーバーが実行中。**サーバーを停止**をクリックして停止します）、**非アクティブ**（サーバーが実行されていません。**サーバーを起動**をクリックして起動します）。サーバーの実行中に生成されたログを確認するには、[ログタブ](#logs-tab)をご覧ください。                                  |

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

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

### ログタブ

<ServiceLogs />

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