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