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

# MQTT

> 將知行之橋連線到 MQTT 代理，使用訊息佇列遙測傳輸協議釋出訊息並訂閱主題。

OASIS Message Queuing Telemetry Transport (MQTT) 端口支援釋出 MQTT 訊息和訂閱 MQTT 主題。

## 核心功能

* 雙向 IoT 訊息佇列，支援多個服務質量（QoS）級別
* 支援 TLS 加密和用戶端憑證身分驗證，並具備可配置的心跳（Keep-alive）間隔
* 基於主題（Topic）的過濾，支援萬用字元及遺囑（Last Will）訊息處理

## 概觀

透過 MQTT 端口傳送資料會將資料釋出到配置的主題，並且在端口訂閱的任何主題上接收的訊息將放置在**交易**索引標籤中。

## 端口配置

本節包含所有可配置的端口屬性。

### 設定索引標籤

#### 主機配置

*與遠端MQTT伺服器連線相關的設定。*

| 設定 | 描述 |
| - | - |
| **端口 ID** | 端口的靜態唯一識別碼。 |
| **端口型別** | 顯示端口名稱及其功能描述。 |
| **端口描述** | 可選欄位，提供端口及其在流程中角色的自由文字描述。 |
| **連線** | 可用連線的清單。選擇現有連線，或點選**建立**新增新連線。 |
| **操作** | 選擇將訊息[釋出](#釋出)到 MQTT 代理的主題，或[訂閱](#訂閱)一個或多個 MQTT 主題篩選器以接收訊息。 |
| **伺服器狀態** | （僅當**操作**為**訂閱**時適用）端口伺服器的狀態：**活動**（伺服器正在執行；點選**停止伺服器**可將其停止）或**非活動**（伺服器未執行；點選**啟動伺服器**可將其啟動）。要檢視伺服器執行期間生成的日誌，請參閱[日誌索引標籤](#日誌索引標籤)。 |

#### 用戶端身分驗證

*與對遠端 MQTT 伺服器進行身分驗證相關的設定。*

| 設定 | 描述 |
| - | - |
| **使用者名稱** | 用於進行身分驗證的使用者名稱憑據。 |
| **密碼** | 指定使用者名稱的密碼。 |

#### TLS 設定

*與透過 TLS 建立安全連線相關的設定。*

| 設定 | 描述 |
| - | - |
| **使用 TLS/SSL** | 端口在連線到遠端伺服器時是否會協商 TLS。 |
| **TLS 伺服器憑證** | 用於在建立 TLS 連線時驗證遠端伺服器身份的公共憑證。可以將此設定設定為**任何憑證**以無條件信任目標伺服器的身份。 |

#### 釋出

*與釋出MQTT訊息相關的設定。*

| 設定 | 描述 |
| - | - |
| **主題** | 要釋出的訊息的主題。 |
| **服務質量（QoS）** | 訊息傳遞的服務級別。選項有：*最多一次*、*至少一次*或*恰好一次*。有關詳細資訊，請參閱[釋出](#釋出)。 |

#### 訂閱

*訂閱MQTT訊息相關的設定。*

| 設定 | 描述 |
| - | - |
| **啟用 MQTT 訂閱** | 端口是否應接收 MQTT 訊息。 |
| **主題過濾** | 一個逗號分隔的主題清單，供端口訂閱。 |
| **服務質量（QoS）** | 訊息的傳遞應該是非保證的、有保證的還是保證沒有重複的。 |

### 進階選項卡

#### TLS 用戶端身分驗證

*與需要雙向 TLS 身分驗證時的用戶端身分驗證相關的設定。*

<table><thead><tr><th>設定</th><th>描述</th></tr></thead>
<tbody><tr><td>**私有憑證**</td>
<td>TLS 用戶端身分驗證期間提供的私有憑證。</td></tr>
<tr><td>**憑證密碼**</td>
<td>存取 TLS 用戶端憑證所需的密碼。</td></tr></tbody></table>

#### 進階設定

*未包含在先前類別中的設定。*

| 設定 | 描述 |
| - | - |
| **保持活動時間間隔** | 端口在傳送保活資料包之前允許的最長時間不活動。 |
| **遺願訊息** | 伺服器在例外斷開連線的情況下應釋出的訊息。 |
| **遺願主題** | 最後遺囑訊息的主題。 |
| **重新發布間隔** | 端口在重新發布未確認訊息之前等待的時間間隔（秒）。 |
| **逾時時長** | 端口在擲回逾時錯誤之前等待連線回應的持續時間（秒）。 |
| **本地檔名格式** | 為端口輸出的訊息分配檔名的方案。可以在檔名中動態使用宏來包含識別碼和時間戳等資訊。有關更多資訊，請參閱[宏](#宏)。 |

#### 訊息

*訊息設定確定端口如何搜尋訊息並在處理後管理它們。*

**注意：**以下設定已棄用，預設處於隱藏狀態。只有先前已啟用這些設定或將其配置為非預設值的端口才會顯示它們。若要保留成功處理的檔案副本，請在工作流程中右鍵單擊該端口，選擇**顯示成功路徑**，然後將成功路徑連線到 [File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/file.md)。

<table><thead><tr><th>設定</th><th>描述</th></tr></thead>
<tbody><tr><td>**儲存到已傳送資料夾**（已棄用）</td>
<td>將端口處理的檔案複製到 Sent 資料夾。預設停用。儲存到 Sent 資料夾中的檔案不受[靜態加密](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/encryption-at-rest.md)保護。</td></tr>
<tr><td>**已傳送資料夾方案**（已棄用）</td>
<td>按所選時間間隔對 **Sent** 資料夾中的檔案進行分組。僅在啟用**儲存到已傳送資料夾**時適用。</td></tr></tbody></table>

#### 日誌

*用於管理日誌建立和儲存的設定。*

<table><thead><tr><th>設定</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**日誌級別**</td>
<td>指定要記錄在端口日誌目錄中的資訊型別：
<ul><li>**None** - 不建立任何日誌。</li>
<li>**Error** - 僅當端口遇到錯誤時才建立日誌。</li>
<li>**Warning** - 僅當端口發出警告時才建立日誌。</li>
<li>**Info** - 記錄工作流程的一般資訊，包括任何錯誤和警告（如果適用）。</li>
<li>**Debug** - 記錄成功和失敗工作流程的詳細偵錯資訊。</li>
<li>**Trace** - 記錄成功和失敗工作流程的詳細跟蹤資訊。</li></ul>
\*\*請注意：\*\***Debug** 和 **Trace** 級別的日誌可能會記錄敏感資訊，包括訊息內容和 SSL 憑證。儘管連線屬性（例如密碼）被遮蔽了，但在與您的組織外部共享它們之前，請檢視此級別的日誌以避免洩漏敏感資訊。</td></tr>
<tr><td>**日誌資料夾結構**</td>
<td>指示端口根據選定的時間間隔將日誌資料夾中的檔案分組。例如，**Weekly** 選項指示端口每週建立一個新的子資料夾，並將該周的所有日誌儲存在該資料夾中。空白設定告訴端口將所有日誌直接儲存在日誌資料夾中。對於處理許多交易的端口，使用子資料夾有助於保持日誌的有序性並提高效能。</td></tr>
<tr><td>**保留訊息副本**</td>
<td>指示端口在日誌目錄中儲存最新訊息副本的切換。請注意，端口每個子資料夾只保留一個訊息，並且端口在再次執行時會覆蓋以前儲存的訊息。</td></tr></tbody></table>

#### 其他

*特殊設定適用於特定用例。*

<table><thead><tr><th>設定</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**其他設定**</td>
<td>允許在以分號分隔的清單中配置隱藏的端口設定，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用這些設定。</td></tr></tbody></table>

### 自動化索引標籤

#### 自動化設定

*與端口自動處理檔案相關的設定。*

| 設定 | 描述 |
| - | - |
| **傳送** | 到達端口的檔案是否會自動作為訊息傳送到 MQTT 伺服器。 |
| **重試間隔** | 重試失敗傳送之前的分鐘數。 |
| **最大嘗試次數** | 端口處理檔案的最大次數。成功是根據成功的伺服器確認來衡量的。如果將此設定為 0，端口將無限期地重試該檔案。 |

#### 效能

*與端口資源分配相關的設定。*

<table><thead><tr><th>設定</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**最大工作執行緒數**</td>
<td>此端口上處理檔案時從執行緒池中消耗的最大工作執行緒數。如果設定，則會覆蓋 [進階設定](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/advanced-settings.md) 頁面的 [效能設定](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/performance-settings.md) 部分的預設設定。</td></tr>
<tr><td>**最大檔案數**</td>
<td>分配給端口的每個執行緒傳送的最大檔案數。如果設定，則會覆蓋 [進階設定](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/advanced-settings.md) 頁面的 [效能設定](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/performance-settings.md) 部分的預設設定。</td></tr></tbody></table>

### 通知索引標籤

*與配置通知相關的設定。*

在執行服務級別協議 (SLA) 之前，需要設定電子郵件通知以接收通知。預設情況下，知行之桥 使用 [通知](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/alerts.md) 索引標籤上的全域設定。要為此端口使用其他設定，請啟用 **覆蓋全域設定**。

預設情況下，錯誤通知處於啟用狀態，這意味著每當出現錯誤時都會傳送電子郵件。要關閉錯誤通知，請取消選中 **啟用** 核取方塊。

輸入 **主題**（必填）。勾選**允許在主題中使用 ArcScript**，即可在**主題**欄位中使用 ArcScript。選中後會顯示 **ArcScript 編輯器**按鈕（![ArcScript 編輯器按鈕](https://docs.kasoftware.com/26.4/images/rest_arcscript_editor.png)）。

（可選）輸入以逗號分隔的**收件人**電子郵件地址清單。

### SLA 索引標籤

*與配置服務級別協議 (SLA) 相關的設定。*

SLA 允許配置預期流程中端口傳送或接收的資料量，並設定預期達到該資料量的時間範圍。當 SLA 未達到時，知行之桥 會傳送電子郵件警告使用者，並將 SLA 標記為 *存在風險*，這意味著如果 SLA 未能儘快達到，則會被標記為 *已違反*。這讓使用者有機會介入並確定 SLA 未達到的原因，並採取適當的措施。如果在風險時間段結束時仍未達到 SLA，則會將 SLA 標記為已違反，並再次通知使用者。

SLA 轉換為 *存在風險* 或 *已違反* 狀態時，也會寫入[應用程式日誌](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/activity.md#应用程序日志)，這意味著應用程式效能監控 (APM) 和日誌擷取工具也可以針對這些狀態發出警示。

要定義 SLA，請啟用 **預期資料量**，然後點選 **設定** 索引標籤。

![SLA Empty](https://docs.kasoftware.com/26.4/images/sla_empty.png)
<ul><li>如果端口具有單獨的傳送和接收操作，請使用選項按鈕指定 SLA 適用的方向。</li>
<li>在視窗的 **預計至少** 部分中：
<ul><li>設定預計處理的最小交易數量（交易量）</li>
<li>使用 **每個** 欄位指定時間範圍</li>
<li>指示 SLA 生效的時間。如果選擇 **開始於**，請填寫日期和時間欄位。</li>
<li>勾選希望 SLA 生效的星期幾對應的核取方塊。如有必要，請使用下拉功能表選擇 **每天**。</li></ul></li>
<li>在視窗的 **將狀態設定為“有風險”** 部分中，指定應將 SLA 標記為有風險的時間。
<ul><li>預設情況下，只有在違反 SLA 的情況下才會傳送通知。要更改此設定，請勾選 **傳送“有風險”通知**。</li></ul></li></ul>

以下範例顯示了為端口配置的 SLA，該端口預計在週一至週五每天接收 1000 個檔案。如果尚未收到 1000 個檔案，則會在時間段結束前 1 小時傳送風險通知。

![SLA Configuration Example](https://docs.kasoftware.com/26.4/images/sla_defined.png)

> [!NOTE]
>
> 如果有必要，可以關閉 SLA 通知。這在維護視窗期間非常有用。點選導覽列上的 **設定**，然後跳轉到 **通知 > 通用通知**。點選平板和鉛筆圖示進行編輯，並取消勾選 **SLA 通知** 設定。

### 日誌索引標籤

**日誌**索引標籤列出該端口生成的服務日誌。每一行代表一個日誌檔案，並顯示修改日期、檔名、大小和狀態。可以使用搜尋欄或狀態篩選器查詢特定日誌，點選檔名進行預覽或下載，或點選**下載全部日誌**將所有日誌下載為一個 zip 檔案。

## 建立連線

至少將[設定索引標籤](#設定索引標籤)上的**遠端主機**設定為MQTT伺服器的域名或IP地址。如果使用非標準端口，請設定**遠端端口**。如果需要認證，請設定**使用者名稱**和**密碼**。

如果需要安全連線，請選中 **使用 TLS**，並可選擇將 **TLS 伺服器憑證** 設定為伺服器的公共憑證，或選擇\_任何憑證\_ 接受伺服器提供的任何憑證。如果該欄位使用不當，則會產生安全風險。設定此欄位時要格外小心。

## 釋出

為了釋出資料，將[釋出](#釋出)部分中的 **主題** 設定為端口應該釋出訊息的主題。**服務質量（QoS）** 取值範圍為 0 到 2，含義如下：

* 0 - 最多一次 - 釋出的訊息傳送一次，如果沒有到達則丟失。
* 1 - 至少一次 - 保證釋出的訊息到達，但可能有重複。
* 2 - 正好一次 - 保證釋出訊息到達並且沒有重複。

在進階選項卡的[進階設定](#進階設定)部分，**重新發布間隔** 可以設定為端口等待對需要它們的訊息的確認的秒數。如果這段時間過去了而沒有收到確認，端口將重新發布訊息。重新發布的訊息重用原始訊息中的資料包 ID，並將自動在訊息上設定重複標誌。為 **重新發布間隔** 指定值 0 將阻止端口自動重新發布訊息。

## 訂閱

在設定頁面的[訂閱](#訂閱)部分，可以選中 **啟用 MQTT 訂閱** 選項以指示端口也應該接收資料。選中時，端口將訂閱在後臺執行緒上指定的主題，傳入的訊息將自動放置在**交易**索引標籤中，根據進階選項卡中 **本地檔名格式** 中指定的值命名。預設情況下，端口將使用訊息的主題和資料包 ID 命名檔案，使用 `%topic%_%packetid%.data` 作為 **本地檔名格式** 的值。

**主題過濾** 可以設定為端口應訂閱的主題過濾器的逗號分隔清單。某些字元在主題過濾器中具有特殊含義：

* / - 主題級別分隔符號
* \# - 多級萬用字元（零級或多級）
* \+ - 單級萬用字元（正好是一級）
* Leading \$ - 表示"系統主題"

在進階選項卡中，**遺願資訊** 和 **遺願主題** 可以分別設定為伺服器應該釋出的訊息，以及它應該釋出該訊息的主題，以防萬一斷開。

## 宏

在檔案命名策略中使用宏可以提高組織效率和對資料的上下文理解。透過將宏合併到檔名中，可以動態地包含相關資訊，例如識別碼、時間戳和訊息頭資訊，從而為每個檔案提供有價值的上下文。這有助於確保檔名反映對組織重要的詳細資訊。

知行之桥 支援這些宏，它們都使用以下語法：`%Macro%`。

<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:*pattern*</td><td>將規則運算式模式應用於端口當前正在處理的檔案的檔名。</td></tr>
<tr><td>Header:*headername*</td><td>替換為端口正在處理的當前訊息的目標訊息頭（`headername`）的值。</td></tr>
<tr><td>LongDate</td><td>以常規格式計算系統的當前日期時間（例如，2024 年 1 月 24 日星期三）。</td></tr>
<tr><td>ShortDate</td><td>以 yyyy-MM-dd 格式計算系統的當前日期時間（例如 2024-01-24）。</td></tr>
<tr><td>DateFormat:*format*</td><td>以指定格式（`format`）計算系統的當前日期時間。有關可用的日期時間格式，請參閱 [範例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#date-formats-with-literal-characters)。</td></tr>
<tr><td>Vault:*vaultitem*</td><td>計算指定保管庫專案的值。</td></tr></tbody></table>

### 範例

某些宏（例如 %Ext% 和 %ShortDate%）不需要參數，但其他宏則需要。所有帶有參數的宏都使用以下語法：`%Macro:argument%`

以下是帶有參數的宏的一些範例：

<ul><li>%Header:headername%：其中 `headername` 是訊息上訊息頭的名稱。</li>
<li>%Header:mycustomheader% 解析為輸入訊息上設定的 `mycustomheader` 訊息頭的值。</li>
<li>%Header:ponum% 解析為輸入訊息上設定的 `ponum` 訊息頭的值。</li>
<li>%RegexFilename:pattern%：其中 `pattern` 是規則運算式模式。例如，`%RegexFilename:^([\w][A-Za-z]+)%` 匹配並解析為檔名中的第一個單詞，並且不區分大小寫（`test_file.xml` 解析為 `test`）。</li>
<li>%Vault:vaultitem%：其中 `vaultitem` 是 [vault](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/global-settings-vault.md) 中專案的名稱。例如，`%Vault:companyname%` 解析為儲存在保管庫中的 `companyname` 項的值。</li>
<li>%DateFormat:format%：其中 `format` 是可接受的日期格式（有關詳細資訊，請參閱 [範例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#sample-date-formats)）。例如，`%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%` 解析為檔案上的日期和時間戳。</li></ul>

還可以建立更復雜的宏，如以下範例所示：

<ul><li>將多個宏組合在一個檔名中：`%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%`</li>
<li>包括宏之外的文字：`MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%`</li>
<li>在宏中包含文字：`%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%`</li></ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.