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

# Branch 端口

> 根据可配置条件将消息路由到不同流程路径，支持文件名、消息头、XPath 和 EDI 元数据比较。

Branch 端口在工作流中起着分叉作用。文件会根据端口中指定的条件是否为真，沿流程中的不同路径发送。

## 核心功能

* **基于可配置条件的智能流程路由**：支持根据文件名、消息头、XPath 和 EDI 元数据进行跳转。
* **支持多种数据类型**：支持字符串 (String)、数字 (Number)、日期时间 (DateTime) 等类型，并配有灵活的比较操作符。
* **高级 XPath 评估**：支持针对 XML 文档路由的复杂 XPath 解析。
* **EDI 特定元数据分支**：可根据文档类型进行 EDI 元数据分支。

## 概览

分支条件可以检查以下不同类型的值：

* 文件名
* 消息上的消息头
* 所有匹配的 XPath
* 第一个匹配的 XPath
* 一个或多个匹配的 XPath
* [EDI](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/edi-connectors.md) 元数据

**注意**：

* 要使用 XPath 选项，正在评估的文件必须是 XML 文件。
* EDI 元数据分支只能用于 EDI 文档。

Branch 端口配置确定要查找的值以及要比较的\_目标\_值。如果传入值与目标值匹配，则消息会沿蓝色虚线流程路径传递。可以有多个目标值，每个目标值会将消息沿不同流程路径发送。如果这些值与任何条件都不匹配，则消息会沿灰色虚线路径传递。

![](https://mintcdn.com/qiao/4hcVjuRd69QHuQ3V/26.4/images/branch_flow.png?fit=max\&auto=format\&n=4hcVjuRd69QHuQ3V\&q=85\&s=8deecbd208dd2cc98fa96c2ad9083e24)

有关上图的详细说明，请参阅[根据消息头进行分支](#根据消息头进行分支)。

## 端口配置

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

### Branch 配置选项卡

*与配置分支条件相关的设置。*

分支设置允许为单个源值指定多个条件来定义分支。

<table>
  <thead>
    <tr>
      <th>设置</th>
      <th>描述</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>**示例文件**</td>
      <td>如果上传示例 XML 文件，端口会在使用 XPath 进行比较时显示文档结构。示例如下。</td>
    </tr>

    <tr>
      <td>**如果**</td>
      <td>使用下拉列表指定接收消息时要比较的属性。选项包括：消息头、文件名、所有匹配的 XPath、第一个匹配的 XPath、一个或多个匹配的 XPath，或 EDI 元数据。做出选择后，请使用右侧字段进一步定义条件，如上方**示例文件**图所示。</td>
    </tr>

    <tr>
      <td>**数据类型**</td>
      <td>目标值是字符串、数字还是 DateTime。如果数据类型是 **String**，请使用 **Trim string** 和 **Ignore case** 复选框进一步细化比较。如果数据类型是 **DateTime**，请使用右侧字段指定 DateTime 值的结构。</td>
    </tr>

    <tr>
      <td>**修剪字符串**</td>
      <td>字符串比较是否应忽略空格。</td>
    </tr>

    <tr>
      <td>**忽略大小写**</td>

      <td>
        字符串比较是否应区分大小写。

        ![](https://mintcdn.com/qiao/4hcVjuRd69QHuQ3V/26.4/images/branch_sample_file.png?fit=max\&auto=format\&n=4hcVjuRd69QHuQ3V\&q=85\&s=7660fb84250a3f49b2117643bb2af4c7)

        分支设置部分的中心区域（如下图所示）允许根据需要设置任意数量的条件。将鼠标悬停在白色窗格上方或下方，然后选择 **Add Case** 以添加条件。

        ![](https://mintcdn.com/qiao/4hcVjuRd69QHuQ3V/26.4/images/branch_conditions.png?fit=max\&auto=format\&n=4hcVjuRd69QHuQ3V\&q=85\&s=7fb1950f4e94fa0e307d6614f5ff03df)

        每个条件由三个部分组成：

        <ul>
          <li>运算符（例如 *is equal to、contains、starts with* 或 *matches regex*）</li>
          <li>与文件中找到的值进行比较的值</li>
          <li>*Then output to* 组件</li>
        </ul>

        创建流程时，将不同端口连接到 Branch 端口中的每个 case 语句，以建立 *Then output to* 端口。最后，将不同端口连接到 **Else** 条件，以告诉 知行之桥 在其他条件均不满足时应执行什么操作。
      </td>
    </tr>

    <tr>
      <td>**忽略缺失值**</td>
      <td>是否将缺失的消息头或 XPath 视为空字符串（当 **如果** 选择为 *Filename* 时不适用）。这样可以避免缺少预期消息头或 XPath 时抛出错误，而是沿“does not match”流程路径传递消息。</td>
    </tr>
  </tbody>
</table>

### 设置

*与端口核心操作相关的设置。*

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**端口 Id**</td>
<td>端口的静态、唯一标识符。</td></tr>
<tr><td>**端口类型**</td>
<td>显示端口类型及其用途的描述。</td></tr>
<tr><td>**端口描述**</td>
<td>一个可选字段，用于提供端口及其在流中的角色的自由格式描述。</td></tr></tbody></table>

### 高级页面 (Advanced Tab)

#### 消息

*消息设置确定端口如何搜索消息并在处理后管理它们。*

**注意：**以下设置已弃用，默认处于隐藏状态。只有先前已启用这些设置或将其配置为非默认值的端口才会显示它们。若要保留成功处理的文件副本，请在工作流中右键单击该端口，选择**显示成功路径**，然后将成功路径连接到 [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>

#### 其他设置

| 设置 | 描述 |
| - | - |
| **处理延迟** | 对放置在**交易**选项卡中的文件延迟处理的时间（以秒为单位）。这是旧版设置。最佳实践是[使用 File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/designing-a-flow.md#与本地文件系统交互)管理本地文件系统，而不是使用此设置。 |

#### 其他设置

*特殊设置适用于特定用例。*

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**其他设置**</td>
<td>允许在以分号分隔的列表中配置隐藏的端口设置，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用这些设置。</td></tr></tbody></table>

### 自动化页面 (Automation Tab)

#### 自动化设置

| 设置 | 描述 |
| - | - |
| **发送** | 到达端口的消息是否自动进行处理。 |

#### 性能

*与端口资源分配相关的设置。*

<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 通知** 设置。

## 使用 Branch 端口的示例

以下示例描述了常见的 Branch 端口用例。

### 根据消息头进行分支

在此示例中，您的企业从交易伙伴处收到多种类型的 EDI 文档，并且需要对不同类型的文档进行不同处理。

![](https://mintcdn.com/qiao/4hcVjuRd69QHuQ3V/26.4/images/branch_flow_input.png?fit=max\&auto=format\&n=4hcVjuRd69QHuQ3V\&q=85\&s=b4c87493c41e4db8f57eef7fcdbbae8f)

上图展示了您向交易伙伴发送采购订单的情况。随后他们向您发送两种不同类型的 EDI 文档：一种是 855 采购订单确认，另一种是 810 发票。流程中 Branch 端口之前的 [X12 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/x12.md) 会将 **X12-TransactionCode** 附加到每个消息头。

![](https://mintcdn.com/qiao/4hcVjuRd69QHuQ3V/26.4/images/branch_flow.png?fit=max\&auto=format\&n=4hcVjuRd69QHuQ3V\&q=85\&s=8deecbd208dd2cc98fa96c2ad9083e24)

Branch 端口使用消息头中的交易代码来告诉 知行之桥 在收到 810 或 855 EDI 文档时要执行的操作，以及在收到不包含这两种交易代码的文档时要执行的操作。

* 收到 810 文档后，流程中的下一步会将其发送到后端系统的发票表（本例中为 PostgreSQL）。
* 收到 855 文档后，流程的下一步会将其发送到后端系统中的 PO 确认表。
* 收到任何其他类型的文档时，**Else** 条件会使用 [Notify 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/notify.md) 向管理员发送电子邮件以进行手动处理。

### 基于 EDI 元数据的分支

在此示例中，您的企业从多家公司接收 X12 文档，并且需要将两家公司的文档发送到特定[工作区](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/workspaces.md)进行进一步处理。

![](https://mintcdn.com/qiao/4hcVjuRd69QHuQ3V/26.4/images/branch_edimetadata.png?fit=max\&auto=format\&n=4hcVjuRd69QHuQ3V\&q=85\&s=41e8696824b9f2df0ba1ca6fd88b88cf)

上图展示了两家公司向您发送 X12 文档的情况。Branch 端口使用 X12 元数据 **InterchangeSenderId** 来指定文档的发送目的地。

* 收到来自 CompanyA 的文档时，流程的下一步会将其发送到 CompanyA 工作区。
* 收到来自 CompanyB 的文档时，流程的下一步会将其发送到 CompanyB 工作区。
* 收到任何其他类型的文档时，**Else** 条件会使用 [Notify 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/notify.md) 向管理员发送电子邮件，提醒他们传入的 X12 文档与两个预期公司之一不匹配。

公司特定的工作区随后可能包含一个用于接收传入文档的 [Workspace Receive](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/workspace-receive.md) 端口（由于 Branch 流程中使用了 [Workspace Send](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/workspace-send.md) 端口，因此必须包含），一个带有标识符、可将原始 X12 数据转换为 XML 的 [X12 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/x12.md)，一个用于将 XML 映射到目标的 [XML Map](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/xml-map/xml-map.md) 端口，最后是目标端口（下图中的 [PostgreSQL](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/postgresql/postgresql.md)）。

![](https://mintcdn.com/qiao/4hcVjuRd69QHuQ3V/26.4/images/branch_edimetadata_output.png?fit=max\&auto=format\&n=4hcVjuRd69QHuQ3V\&q=85\&s=232d2d21f9b3da0d487ef7acf500ca59)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.
设置	描述
示例文件	如果上传示例 XML 文件，端口会在使用 XPath 进行比较时显示文档结构。示例如下。
如果	使用下拉列表指定接收消息时要比较的属性。选项包括：消息头、文件名、所有匹配的 XPath、第一个匹配的 XPath、一个或多个匹配的 XPath，或 EDI 元数据。做出选择后，请使用右侧字段进一步定义条件，如上方示例文件图所示。
数据类型	目标值是字符串、数字还是 DateTime。如果数据类型是 String，请使用 Trim string 和 Ignore case 复选框进一步细化比较。如果数据类型是 DateTime，请使用右侧字段指定 DateTime 值的结构。
修剪字符串	字符串比较是否应忽略空格。
忽略大小写	字符串比较是否应区分大小写。 ![](https://mintcdn.com/qiao/4hcVjuRd69QHuQ3V/26.4/images/branch_sample_file.png?fit=max\&auto=format\&n=4hcVjuRd69QHuQ3V\&q=85\&s=7660fb84250a3f49b2117643bb2af4c7) 分支设置部分的中心区域（如下图所示）允许根据需要设置任意数量的条件。将鼠标悬停在白色窗格上方或下方，然后选择 Add Case 以添加条件。 ![](https://mintcdn.com/qiao/4hcVjuRd69QHuQ3V/26.4/images/branch_conditions.png?fit=max\&auto=format\&n=4hcVjuRd69QHuQ3V\&q=85\&s=7fb1950f4e94fa0e307d6614f5ff03df) 每个条件由三个部分组成：运算符（例如 is equal to、contains、starts with 或 matches regex）与文件中找到的值进行比较的值 Then output to 组件创建流程时，将不同端口连接到 Branch 端口中的每个 case 语句，以建立 Then output to 端口。最后，将不同端口连接到 Else 条件，以告诉知行之桥在其他条件均不满足时应执行什么操作。
忽略缺失值	是否将缺失的消息头或 XPath 视为空字符串（当如果选择为 Filename 时不适用）。这样可以避免缺少预期消息头或 XPath 时抛出错误，而是沿“does not match”流程路径传递消息。
设置	描述
端口 Id	端口的静态、唯一标识符。
端口类型	显示端口类型及其用途的描述。
端口描述	一个可选字段，用于提供端口及其在流中的角色的自由格式描述。
设置	描述
保存到已发送文件夹（已弃用）	将端口处理的文件复制到 Sent 文件夹。默认禁用。保存到 Sent 文件夹中的文件不受[静态加密](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/encryption-at-rest.md)保护。
已发送文件夹方案（已弃用）	按所选时间间隔对 Sent 文件夹中的文件进行分组。仅在启用保存到已发送文件夹时适用。
设置	描述
日志级别	指定要记录在端口日志目录中的信息类型： None - 不创建任何日志。 Error - 仅当端口遇到错误时才创建日志。 Warning - 仅当端口发出警告时才创建日志。 Info - 记录工作流的一般信息，包括任何错误和警告（如果适用）。 Debug - 记录成功和失败工作流的详细调试信息。 Trace - 记录成功和失败工作流的详细跟踪信息。 \\请注意：\\Debug 和 Trace 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。
日志文件夹结构	指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，Weekly 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。
保留消息副本	指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。
设置	描述
最大工作线程数	此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 [高级设置](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) 部分的默认设置。
最大文件数	分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 [高级设置](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) 部分的默认设置。