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

# AMQP 端口

> 将知行之桥连接到 AMQP 代理，以使用高级消息队列协议生产和消费消息。

export const CommonProxySettings = () => <>
    <p>这是一组用于识别连接所经代理并对其进行身份验证的设置。默认情况下，本节使用 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/security">安全设置</a> 页面的 <a href="/26.2/self-hosted/zh/getting-started/administration/settings/proxy-settings">代理设置</a> 部分中的全局设置。清除此复选框可为您的端口提供特定的设置。</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>基于代理的防火墙的名称或 IP 地址。</td>
        </tr>
        <tr>
          <td><strong>代理端口</strong></td>
          <td>基于代理的防火墙的 TCP 端口。</td>
        </tr>
        <tr>
          <td><strong>代理用户</strong></td>
          <td>用于通过基于代理的防火墙进行身份验证的用户名。</td>
        </tr>
        <tr>
          <td><strong>代理密码</strong></td>
          <td>用于对基于代理的防火墙进行身份验证的密码。</td>
        </tr>
        <tr>
          <td><strong>身份验证方案</strong></td>
          <td>保留默认值 <strong>None</strong> 或选择以下身份验证方案之一：<strong>Basic</strong>、<strong>Digest</strong>、<strong>Proprietary</strong> 或 <strong>NTLM</strong>。</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 = "知行之桥";

export const datasource = "AMQP";

高级消息队列协议（{datasource}）端口允许通过对数据执行 Produce 和 Consume 操作，将 {datasource} 集成到数据流中。

## 核心功能

* 具有生产和消费操作的双向消息队列
* 支持多种身份验证方案（None、SASL Anonymous、SASL Plain）
* 支持安全连接的 TLS 加密
* 灵活的消息值类型，包括对 JSON 复合数据的支持

按照以下步骤将 {siteName} 连接到 {datasource}。

## 建立连接

必须首先通过以下两种方法之一建立到 {datasource} 的连接：

* 将 {datasource} 端口添加到工作流。然后，在设置面板中，单击连接下拉列表旁边的 **创建**。
* 打开 {siteName} **系统设置** 页面，然后打开 **连接** 选项卡。点击 **添加**，选择 **{datasource}**，然后点击 **下一步**。

<Note>
  - 仅在第一次创建连接时才需要登录过程。
  - 与 {datasource} 的连接可以跨多个 {datasource} 端口重复使用。
</Note>

打开连接对话框后，按照以下步骤操作：

1. 输入连接信息：

   * **名称** — 连接的静态名称。

   * **类型** — 始终设置为 {datasource}。

   * **远程主机地址** — {datasource} 远程主机的主机名或 IP 地址。

   * **远程主机端口** — 远程主机连接的端口。

   * **使用 TLS** — 是否使用 TLS 加密连接。根据 {datasource} 配置进行设置。

   * **容器 Id** —（可选）要访问的 {datasource} 连接中容器的 ID 值。

   * **认证方式** — 用于连接的身份验证方案。选项有 **None**、**SASL Anonymous** 和 **SASL Plain**。

   如果选择 **SASL Anonymous** 或 **SASL Plain** 身份验证，请输入以下信息：

   * **User** — 连接到 {datasource} 时使用的用户名。

   * **Password** — 用户的密码。

2. 点击 **测试连接** 以确保 {siteNameShort} 可以使用提供的信息连接到 {datasource}。如果发生错误，请检查所有字段并重试。

3. 点击 **添加连接** 以完成连接。

## 端口配置

此部分包含所有可配置的端口属性。

### 设置选项卡

#### 配置

| 设置        | 说明                                                                                         |
| --------- | ------------------------------------------------------------------------------------------ |
| **端口 Id** | 端口的静态唯一标识符。                                                                                |
| **端口类型**  | 显示端口名称及其功能说明。                                                                              |
| **端口描述**  | 可选字段，用于以自由文本形式描述端口及其在工作流中的角色。                                                              |
| **连接**    | 选择在前面步骤中创建的连接。                                                                             |
| **目标**    | （可选）对于 [Produce](#produce) 操作，提供应充当接收者的节点的地址。对于 [Consume](#consume) 操作，请提供端口应从中接收数据的节点的地址。 |
| **操作**    | 端口应执行的操作。有关详细信息，请参阅[选择操作](#选择操作)。                                                          |

#### AMQP 消息

| 设置      | 说明                                                    |
| ------- | ----------------------------------------------------- |
| **值类型** | 端口生成的消息的默认值类型。在输入消息中包含名为 *AMQP-ValueType* 的消息头将覆盖此选择。 |

##### JSON 复合数据值类型

**值类型** 选项之一是 **JSON（复合数据）**。复合数据 JSON 架构由 `type-value` 对象组成，其中包含 AMQP 类型名称和值。`type-value` 对象的语法为：

```json theme={null}
{
"type": "typename",
"value": value
}
```

下表提供了有效类型名称的完整列表，并描述了相关值的表示方式：

| 类型名称      | 描述               | 值格式                                                                     |
| --------- | ---------------- | ----------------------------------------------------------------------- |
| null      | Null             | null                                                                    |
| boolean   | Boolean          | true 或 false                                                            |
| ubyte     | Unsigned byte    | 0 到 255                                                                 |
| ushort    | Unsigned short   | 0 到 65535                                                               |
| uint      | Unsigned integer | 0 到 4294967295                                                          |
| ulong     | Unsigned long    | 0 到 18446744073709551615                                                |
| byte      | Byte             | -128 到 127                                                              |
| short     | Short            | -32768 到 32767                                                          |
| int       | Integer          | -2147483648 到 2147483647                                                |
| long      | Long             | -9223372036854775808 到 9223372036854775807                              |
| float     | Float            | \[IEEE 754 32 位浮点数]                                                     |
| double    | Double           | \[IEEE 754 64 位浮点数]                                                     |
| decimal   | Decimal          | 十六进制编码的字节字符串，如 "0A1B2C3D"                                               |
| char      | Char             | "c"                                                                     |
| timestamp | Timestamp        | \[自 Unix 纪元（1970 年 1 月 1 日 00:00:00 UTC）以来的毫秒数]                         |
| uuid      | UUID             | 十六进制编码的 UUID 字符串，如 "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"（连字符可选，不区分大小写） |
| binary    | Binary data      | 十六进制编码的字节字符串，如 "0A1B2C3D"                                               |
| string    | String           | "UTF-8 字符串（正确转义为 JSON）"                                                 |
| symbol    | Symbolic value   | "ASCII 字符串"                                                             |
| array     | AMQP array       | 具有零个或多个相同类型的 type-value 对象的 JSON 数组                                     |
| list      | AMQP list        | 具有零个或多个 type-value 对象的 JSON 数组                                          |
| map       | AMQP map         | 具有偶数个表示键和值的 type-value 对象的 JSON 数组；不允许重复的键                              |

<Note>类型名称必须是小写才能正确解析。</Note>

### 高级选项卡

#### 其他设置

| 设置         | 说明                                                               |
| ---------- | ---------------------------------------------------------------- |
| **本地文件方案** | 用于为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏，以包含标识符和时间戳等信息。有关更多信息，请参阅[宏](#宏)。 |

#### 代理设置

<CommonProxySettings />

#### 消息

<Message />

#### 日志

<Logging />

#### 其他

<MiscConnector />

### 自动化选项卡

#### 自动化设置

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

| 设置         | 说明                                                                    |
| ---------- | --------------------------------------------------------------------- |
| **发送**     | 用于指示端口在文件准备就绪时自动发送文件的开关。                                              |
| **重试间隔**   | 端口在失败发送后等待重试的时间间隔。                                                    |
| **最大尝试次数** | 端口尝试发送消息的次数。将此值设置为 *1* 表示端口只进行初始发送尝试而不重试。端口会在每次尝试之间等待 **重试间隔** 指定的时长。 |

#### 性能

<Performance />

### 警报选项卡

<AlertsTab />

### SLA 选项卡

<SlasTab />

## 选择操作

与 {datasource} 建立连接后，必须选择 {datasource} 端口将执行的操作。下表概述了每个操作及其在 {siteName} 工作流中的位置：

| 操作                  | 描述                                      | 工作流中的位置 |
| ------------------- | --------------------------------------- | ------- |
| [Produce](#produce) | 接受来自文件或其他端口的输入数据并将其发送到 {datasource} 连接。 | 结束      |
| [Consume](#consume) | 侦听进入队列的消息，并通过输出路径沿工作流向下发送传入数据。          | 开始      |

### Produce

**Produce** 操作将输入数据发送到 {datasource} 连接。此数据可能来自其他端口，也可能来自你手动上传到 {datasource} 端口 **交易** 选项卡的文件。

在某些 {datasource} 配置中，可以将 **目标** 字段的值设置为应充当接收者的节点的地址。并非所有配置都需要此项。

### Consume

**Consume** 操作检查 {datasource} 队列中的消息。通过 **Consume** 端口处理的数据会进入 **交易** 选项卡，并向下传递到 {siteNameShort} 工作流的后续步骤。

在某些 {datasource} 配置中，可以将 **目标** 字段的值设置为端口应从中接收数据的节点的地址。并非所有配置都需要此项。

## 宏

<MacrosTable />

### 示例

<MacrosExamples />