> ## 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 代理，使用消息队列遥测传输协议发布消息并订阅主题。

export const TlsClientAuthentication = () => <>
    <p><em>与需要双向 TLS 身份验证时的客户端身份验证相关的设置。</em></p>

    <table>
      <thead>
        <tr><th>设置</th><th>描述</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>私有证书</strong></td>
          <td>TLS 客户端身份验证期间提供的私有证书。</td>
        </tr>
        <tr>
          <td><strong>证书密码</strong></td>
          <td>访问 TLS 客户端证书所需的密码。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const SlasTab = ({siteName = "知行之桥"}) => <>
    <p><em>与配置服务级别协议 (SLA) 相关的设置。</em></p>
    <p>
      SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，{siteName} 会发送电子邮件警告用户，并将 SLA 标记为 <em>存在风险</em>，这意味着如果 SLA 未能尽快达到，则会被标记为 <em>已违反</em>。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为已违反，并再次通知用户。
    </p>
    <p>
      要定义 SLA，请启用 <strong>预期数据量</strong>，然后点击 <strong>设置</strong> 选项卡。
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。</li>
      <li>在窗口的 <strong>预计至少</strong> 部分中：
        <ul>
          <li>设置预计处理的最小事务数量（交易量）</li>
          <li>使用 <strong>每个</strong> 字段指定时间范围</li>
          <li>指示 SLA 生效的时间。如果选择 <strong>开始于</strong>，请填写日期和时间字段。</li>
          <li>勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择 <strong>每天</strong>。</li>
        </ul>
      </li>
      <li>在窗口的 <strong>将状态设置为“有风险”</strong> 部分中，指定应将 SLA 标记为有风险的时间。
        <ul>
          <li>默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选 <strong>发送“有风险”通知</strong>。</li>
        </ul>
      </li>
    </ul>
    <p>
      以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的 <strong>设置</strong>，然后跳转到 <strong>通知 &gt; 通用通知</strong>。点击平板和铅笔图标进行编辑，并取消勾选 <strong>SLA 通知</strong> 设置。
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "知行之桥"}) => <>
    <p><em>与配置通知相关的设置。</em></p>
    <p>
      在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，{siteNameShort} 使用 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/alerts">通知</a> 选项卡上的全局设置。要为此端口使用其他设置，请启用 <strong>覆盖全局设置</strong>。
    </p>
    <p>
      默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中 <strong>启用</strong> 复选框。
    </p>
    <p>
      输入 <strong>主题</strong>（必填），然后（可选）输入以逗号分隔的 <strong>收件人</strong> 电子邮件列表。
    </p>
  </>;

export const Message = () => <>
    <p><em>消息设置确定端口如何搜索消息并在处理后管理它们。</em></p>
    <table>
      <thead>
        <tr><th>设置</th><th>描述</th></tr>
      </thead>
      <tbody>
        
          <tr>
            <td><strong>保存到已发送文件夹</strong></td>
            <td>选中此项可将端口处理的文件复制到该端口的“已发送”文件夹中。</td>
          </tr>
        
        <tr>
          <td><strong>已发送文件夹方案</strong></td>
          <td>端口根据选定的时间间隔对 <strong>已发送</strong> 文件夹中的文件进行分组。例如，<strong>Weekly</strong> 选项指示端口每周创建一个新的子文件夹，并将本周发送的所有文件存储在该文件夹中。空白设置告诉端口将所有文件直接保存在 <strong>已发送</strong> 文件夹中。对于处理许多事务的端口，使用子文件夹可以帮助保持文件有序并提高性能。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MiscConnector = () => <>
    <p><em>特殊设置适用于特定用例。</em></p>
    <table>
      <thead>
        <tr>
          <th>设置</th>
          <th>描述</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>其他设置</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>日志级别</strong></td>
          <td>指定要记录在端口日志目录中的信息类型：
            <ul>
              <li><b>None</b> - 不创建任何日志。</li>
              <li><b>Error</b> - 仅当端口遇到错误时才创建日志。</li>
              <li><b>Warning</b> - 仅当端口发出警告时才创建日志。</li>
              <li><b>Info</b> - 记录工作流的一般信息，包括任何错误和警告（如果适用）。</li>
              <li><b>Debug</b> - 记录成功和失败工作流的详细调试信息。</li>
              <li><b>Trace</b> - 记录成功和失败工作流的详细跟踪信息。</li>
            </ul>
            <strong>请注意：</strong><strong>Debug</strong> 和 <strong>Trace</strong> 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。</td>
        </tr>
        <tr>
          <td><strong>日志文件夹结构</strong></td>
          <td>指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，<strong>Weekly</strong> 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。</td>
        </tr>
        <tr>
          <td><strong>保留消息副本</strong></td>
          <td>指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。</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.2/self-hosted/zh/getting-started/administration/settings/global-settings-vault">vault</a> 中项目的名称。例如，<code>%Vault:companyname%</code> 解析为存储在保管库中的 <code>companyname</code> 项的值。</li>
      <li>%DateFormat:format%：其中 <code>format</code> 是可接受的日期格式（有关详细信息，请参阅 <a href="/26.2/self-hosted/zh/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>将多个宏组合在一个文件名中：<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 = "知行之桥", 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>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>以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。</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.2/self-hosted/zh/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">示例日期格式</a>。</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>计算指定保管库项目的值。</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>最大工作线程数</strong></td>
          <td>此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/advanced-settings">高级设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/performance-settings">性能设置</a> 部分的默认设置。</td>
        </tr>
        <tr>
          <td><strong>最大文件数</strong></td>
          <td>分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/advanced-settings">高级设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/performance-settings">性能设置</a> 部分的默认设置。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const siteNameShort = "知行之桥";

export const siteName = "知行之桥";

OASIS Message Queuing Telemetry Transport (MQTT) 端口支持发布 MQTT 消息和订阅 MQTT 主题。

## 核心功能

* 双向 IoT 消息队列，支持多个服务质量（QoS）级别
* 支持 TLS 加密和客户端证书身份验证，并具备可配置的心跳（Keep-alive）间隔
* 基于主题（Topic）的过滤，支持通配符及遗嘱（Last Will）消息处理

## 概述

通过 MQTT 端口发送数据会将数据发布到配置的主题，并且在端口订阅的任何主题上接收的消息将放置在**交易**选项卡中。

## 端口配置

本节包含所有可配置的端口属性。

### 设置选项卡

#### 主机配置

*与远程MQTT服务器连接相关的设置。*

| 设置         | 描述                        |
| ---------- | ------------------------- |
| **端口 ID**  | 端口的静态唯一标识符。               |
| **端口类型**   | 显示端口名称及其功能描述。             |
| **端口描述**   | 可选字段，提供端口及其在流程中角色的自由文本描述。 |
| **远程主机地址** | 远程 MQTT 服务器的主机名或 IP 地址。   |
| **远程主机端口** | 连接到远程 MQTT 服务器的端口。        |

#### 客户端身份验证

*与对远程 MQTT 服务器进行身份验证相关的设置。*

| 设置      | 描述              |
| ------- | --------------- |
| **用户名** | 用于进行身份验证的用户名凭据。 |
| **密码**  | 指定用户名的密码。       |

#### TLS 设置

*与通过 TLS 建立安全连接相关的设置。*

| 设置             | 描述                                                           |
| -------------- | ------------------------------------------------------------ |
| **使用 TLS/SSL** | 端口在连接到远程服务器时是否会协商 TLS。                                       |
| **TLS 服务器证书**  | 用于在建立 TLS 连接时验证远程服务器身份的公共证书。可以将此设置设置为**任何证书**以无条件信任目标服务器的身份。 |

#### 发布

*与发布MQTT消息相关的设置。*

| 设置            | 描述                                                      |
| ------------- | ------------------------------------------------------- |
| **主题**        | 要发布的消息的主题。                                              |
| **服务质量（QoS）** | 消息传递的服务级别。选项有：*最多一次*、*至少一次*或*恰好一次*。有关详细信息，请参阅[发布](#发布)。 |

#### 订阅

*订阅MQTT消息相关的设置。*

| 设置             | 描述                          |
| -------------- | --------------------------- |
| **启用 MQTT 订阅** | 端口是否应接收 MQTT 消息。            |
| **主题过滤**       | 一个逗号分隔的主题列表，供端口订阅。          |
| **服务质量（QoS）**  | 消息的传递应该是非保证的、有保证的还是保证没有重复的。 |

### 高级选项卡

#### TLS 客户端身份验证

<TlsClientAuthentication />

#### 高级设置

*未包含在先前类别中的设置。*

| 设置           | 描述                                                            |
| ------------ | ------------------------------------------------------------- |
| **保持活动时间间隔** | 端口在发送保活数据包之前允许的最长时间不活动。                                       |
| **遗愿消息**     | 服务器在异常断开连接的情况下应发布的消息。                                         |
| **遗愿主题**     | 最后遗嘱消息的主题。                                                    |
| **重新发布间隔**   | 端口在重新发布未确认消息之前等待的时间间隔（秒）。                                     |
| **超时时长**     | 端口在抛出超时错误之前等待连接响应的持续时间（秒）。                                    |
| **本地文件名格式**  | 为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏来包含标识符和时间戳等信息。有关更多信息，请参阅[宏](#宏)。 |

#### 消息

<Message />

#### 日志

<Logging />

#### 其他

<MiscConnector />

### 自动化选项卡

#### 自动化设置

*与端口自动处理文件相关的设置。*

| 设置         | 描述                                                    |
| ---------- | ----------------------------------------------------- |
| **发送**     | 到达端口的文件是否会自动作为消息发送到 MQTT 服务器。                         |
| **重试间隔**   | 重试失败发送之前的分钟数。                                         |
| **最大尝试次数** | 端口处理文件的最大次数。成功是根据成功的服务器确认来衡量的。如果将此设置为 0，端口将无限期地重试该文件。 |

#### 性能

<Performance />

### 通知选项卡

<AlertsTab />

### SLA 选项卡

<SlasTab />

## 建立连接

至少将[设置选项卡](#设置选项卡)上的**远程主机**设置为MQTT服务器的域名或IP地址。如果使用非标准端口，请设置**远程端口**。如果需要认证，请设置**用户名**和**密码**。

如果需要安全连接，请选中 **使用 TLS**，并可选择将 **TLS 服务器证书** 设置为服务器的公共证书，或选择\_任何证书\_ 接受服务器提供的任何证书。如果该字段使用不当，则会产生安全风险。设置此字段时要格外小心。

## 发布

为了发布数据，将[发布](#发布)部分中的 **主题** 设置为端口应该发布消息的主题。**服务质量（QoS）** 取值范围为 0 到 2，含义如下：

* 0 - 最多一次 - 发布的消息发送一次，如果没有到达则丢失。
* 1 - 至少一次 - 保证发布的消息到达，但可能有重复。
* 2 - 正好一次 - 保证发布消息到达并且没有重复。

在高级选项卡的[高级设置](#高级设置)部分，**重新发布间隔** 可以设置为端口等待对需要它们的消息的确认的秒数。如果这段时间过去了而没有收到确认，端口将重新发布消息。重新发布的消息重用原始消息中的数据包 ID，并将自动在消息上设置重复标志。为 **重新发布间隔** 指定值 0 将阻止端口自动重新发布消息。

## 订阅

在设置页面的[订阅](#订阅)部分，可以选中 **启用 MQTT 订阅** 选项以指示端口也应该接收数据。选中时，端口将订阅在后台线程上指定的主题，传入的消息将自动放置在**交易**选项卡中，根据高级选项卡中 **本地文件名格式** 中指定的值命名。默认情况下，端口将使用消息的主题和数据包 ID 命名文件，使用 `%topic%_%packetid%.data` 作为 **本地文件名格式** 的值。

**主题过滤** 可以设置为端口应订阅的主题过滤器的逗号分隔列表。某些字符在主题过滤器中具有特殊含义：

* / - 主题级别分隔符
* \# - 多级通配符（零级或多级）
* \+ - 单级通配符（正好是一级）
* Leading \$ - 表示"系统主题"

在高级选项卡中，**遗愿信息** 和 **遗愿主题** 可以分别设置为服务器应该发布的消息，以及它应该发布该消息的主题，以防万一断开。

## 宏

<MacrosTable />

### 示例

<MacrosExamples />