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

# MQTT

> Connect Arc to an MQTT broker to publish messages and subscribe to topics using the Message Queuing Telemetry Transport protocol.

export const TlsClientAuthentication = () => <>
    <p><em>双方向TLS 認証が必要な場合のクライアント認証に関する設定です。</em></p>

    <table>
      <thead>
        <tr><th>設定</th><th>説明</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Private Certificate</strong></td>
          <td>TLS クライアント認証時に提示されるプライベート証明書です。</td>
        </tr>
        <tr>
          <td><strong>Certificate Password</strong></td>
          <td>TLS クライアント証明書にアクセスするために必要なパスワードです。</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";

The OASIS Message Queuing Telemetry Transport (MQTT) connector supports publishing MQTT messages and subscribing to MQTT topics.

## Key Capabilities

* Bidirectional IoT message queuing with multiple QoS levels
* TLS encryption and client certificate authentication with configurable keep-alive intervals
* Topic-based filtering with wildcard support and Last Will message handling

## Overview

Sending data through an MQTT connector publishes the data to the configured topic, and messages that are received on any of the topics that the connector is subscribed to are placed in the **Transactions** tab.

## Connector Configuration

This section contains all of the configurable connector properties.

### Settings Tab

#### Host Configuration

*Settings related to the remote MQTT server connection.*

| 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**            | 利用可能な接続の一覧。既存の接続を選択するか、**作成**をクリックして新しい接続を追加します。                                                                                                                                                |
| **Action**                | MQTT ブローカーのトピックにメッセージを[パブリッシュ](#publishing)するか、1つ以上のMQTT トピックフィルタからメッセージを受信するため[サブスクライブ](#subscribing)するかを選択します。                                                                                |
| **サーバーステータス**             | (**アクション**が**Subscribe** の場合のみ適用) コネクタのサーバーの状態：**アクティブ**（サーバーが実行中。**サーバーを停止**をクリックして停止します）、**非アクティブ**（サーバーが実行されていません。**サーバーを起動**をクリックして起動します）。サーバーの実行中に生成されたログを確認するには、[ログタブ](#logs-tab)をご覧ください。 |

#### Client Authentication

*Settings related to authenticating against the remote MQTT server.*

| Setting      | Description                                         |
| ------------ | --------------------------------------------------- |
| **Username** | The username credential with which to authenticate. |
| **Password** | The password for the specified username.            |

#### TLS Settings

*Settings related to establishing a secure connection via TLS.*

| Setting                    | Description                                                                                                                                                                        |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Use TLS**                | Whether the connector should negotiate TLS when connecting to the remote server.                                                                                                   |
| **TLS Server Certificate** | The public certificate used to verify the identity of the remote server when establishing a TLS connection. Set this to **Any Certificate** to implicitly trust the target server. |

#### Publish

*Settings related to publishing MQTT messages.*

| Setting   | Description                                                                                                                                                  |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Topic** | The topic for the message to publish.                                                                                                                        |
| **QoS**   | The service level for message delivery. Options are: *at most once*, *at least once*, or *exactly once*. See [Publishing](#publishing) for more information. |

#### Subscribe

*Settings related to subscribing to MQTT messages.*

| Setting                  | Description                                                                                                                                                  |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Enable MQTT Receiver** | Whether the connector should receive MQTT messages.                                                                                                          |
| **Topic Filters**        | A comma-separated list of topics for the connector to subscribe to.                                                                                          |
| **QoS**                  | The service level for message delivery. Options are: *at most once*, *at least once*, or *exactly once*. See [Publishing](#publishing) for more information. |

### Advanced Tab

#### TLS Client Authentication

<TlsClientAuthentication />

#### Advanced Settings

*Settings not included in the previous categories.*

| Setting                 | Description                                                                                                                                                                                                                             |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Keep Alive Interval** | The maximum period of inactivity the connector allows before sending a keep-alive packet.                                                                                                                                               |
| **Last Will Message**   | The message that the server should publish in the event of an ungraceful disconnection.                                                                                                                                                 |
| **Last Will Topic**     | The topic of the Last Will Message.                                                                                                                                                                                                     |
| **Republish Interval**  | The number of seconds that the connector waits before republishing unacknowledged messages.                                                                                                                                             |
| **Timeout**             | The length of time (in seconds) the connector waits for a connection response before throwing a timeout error.                                                                                                                          |
| **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). |

#### Logging

<Logging />

#### Miscellaneous

<MiscConnector />

### Automation Tab

#### Automation Settings

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

| Setting            | Description                                                                                                                                                                                        |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Send**           | Whether files arriving at the connector are automatically sent as messages to the MQTT server.                                                                                                     |
| **Retry Interval** | The number of minutes before a failed send is retried.                                                                                                                                             |
| **Max Attempts**   | The maximum number of times the connector processes the file. Success is measured based on a successful server acknowledgement. If you set this to 0, the connector retries the file indefinitely. |

#### Performance

<Performance />

### Alerts Tab

<AlertsTab />

### SLAs Tab

<SlasTab />

### ログタブ

<ServiceLogs />

## Establishing a Connection

At a minimum, set **Remote Host** on the [Settings tab](#settings-tab) to the domain name or IP address of the MQTT server. If you are using a non-standard port, set **Remote Port**. If authentication is required, set **Username** and **Password**.

If you require a secure connection, check **Use TLS**, and optionally set the **TLS Server Certificate** to the server's public certificate, or choose *Any Certificate* to accept any certificate presented by the server. If this field is used improperly, it creates a security risk. Use extreme caution when setting this field.

## Publishing

To publish data, set **Topic** in the [Publish](#publish) section to the topic where the connector should publish messages. **QoS** values range from 0 to 2 and have the following meanings:

* 0 — At most once. The published message is sent once, and if it does not arrive it is lost.
* 1 — At least once. Guarantees that the published message arrives, but there might be duplicates.
* 2 — Exactly once. Guarantees that the published message arrives and that there are no duplicates.

In the [Advanced Settings](#advanced-settings) portion of the Advanced tab, you can set **Republish Interval** to the number of seconds that you want the connector to wait for acknowledgements to messages that require them. If this time elapses without receiving an acknowledgement, the connector republishes the message. Republished messages reuse the packet Id from the original message, and automatically set the Duplicate flag on the message. Specifying a value of 0 for **Republish Interval** prevents the connector from automatically republishing messages.

## Subscribing

In the [Subscribe](#subscribe) section of the settings page, you can check **Enable MQTT Receiver** to indicate that the connector should also receive data. When checked, the connector subscribes to the topics you specify in **Topic Filters**, and incoming messages are automatically placed on the **Transactions** tab, named based on the value specified in **Local File Scheme** in the [Advanced Settings](#advanced-settings) portion of the Advanced tab. By default, the connector names files with the topic and packet Id of the message, using `%topic%_%packetid%.data` as the **Local File Scheme** value.

You can supply a comma-separated list of topic filters that the connector should subscribe to in **Topic Filters**. The following characters have special meanings in a topic filter:

* / — The topic level separator
* \# — The multi-level wildcard (zero or more levels)
* \+ — The single-level wildcard (exactly one level)
* Leading \$ — Denotes a "system topic"

You can use **Last Will Message** and **Last Will Topic** on the Advanced tab to specify the message that the server should publish, and the topic it should publish that message to, in the event of an ungraceful disconnection.

## Macros

<MacrosTable />

### Examples

<MacrosExamples />