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

# HL7 MLLP 端口

> 知行之桥HL7 MLLP 端口的配置与使用指南。

Health Level-7 是一套医院和其他医疗保健提供者使用的临床数据传输标准。HL7 MLLP 端口支持与 MLLP 作为传输协议结合生成和解析 HL7 文档。

## 核心功能

* 使用基于 MLLP（最小低层协议）传输的 HL7 进行医疗数据交换
* 内置 MLLP 服务端功能，支持 SSL/TLS 加密
* 提供 HL7 与 XML 格式之间的双向 HL7 文档转换
* 支持 MSH 报文头验证，具备可配置的应用程序和设施标识符
* 自动回执处理，具备重试和重发功能以确保可靠交付

## 总览

HL7 MLLP 端口提供两组功能：

* 通过 MLLP 传输协议进行文件传输
* 根据 HL7 EDI 标准解析并生成 EDI 文档

HL7 MLLP 连接在两个位置进行配置。使用将 知行之桥 标识为 HL7 和 MLLP 实体的设置来配置 HL7 MLLP [个人设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/profiles.md)。然后使用每个贸易伙伴的 HL7 和 MLLP 详细信息配置单独的 HL7 MLLP 端口。

当 HL7 MLLP 端口收到来自贸易伙伴的入站消息时，它会验证 HL7 标识详细信息，以确认文档是从预期各方发送的或发送到预期各方的。然后，它将文档转换为 XML，以便在 知行之桥 流程中进一步处理。

当 HL7 MLLP 端口向贸易伙伴发送文件时：

* XML 文件在发送之前被转换为 HL7
* HL7 文件按原样发送

知行软件 强烈建议将 HL7 MLLP 端口与 [XML Map 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/xml-map/xml-map.md) 结合使用，以确保输入和输出 XML 的格式正确。有关详细信息，请参阅[与 XML Map 端口一起使用](#与-xml-map-端口一起使用)。

## 个人设置

必须先配置 HL7 MLLP 配置文件，然后才能与各个 HL7 MLLP 端口建立连接。单击顶部菜单栏上的 **个人设置**，然后单击 **HL7 MLLP** 选项卡。

### HL7 MLLP 配置文件选项

#### 服务器配置

*托管本地 MLLP 服务器的设置。*

| 设置 | 描述 |
| - | - |
| **端口** | 监听传入 MLLP 连接的端口。 |
| **使用 SSL/TLS** | 是否要求传入连接将 SSL/TLS 加密用于传输安全。 |
| **TLS 服务器证书** | 用于验证 TLS/SSL 服务器身份的公钥证书。如果目标服务器使用 TLS/SSL，请将此字段设置为标识该服务器的证书。如果服务器的证书不可用，可以将此设置留空以允许底层 OS/JVM 执行证书验证，或将其设置为 `Any Certificate` 以隐式信任服务器的身份。（仅当选中 **使用 SSL/TLS** 时，才会显示此字段。） |

#### HL7 个人 ID

| 设置 | 描述 |
| - | - |
| **应用程序命名空间 ID（MSH3.1）** | 标识 HL7 协议交换的本地命名空间的应用程序 ID。 |
| **应用程序通用 ID（MSH3.2）** | HL7 协议交换的本地应用程序通用 ID。 |
| **应用程序通用 ID 类型（MSH3.3）** | 为本地应用程序通用 ID 提供上下文的类型限定符。 |
| **设施命名空间 ID（MSH4.1）** | 标识 HL7 协议交换的本地命名空间的设施 ID。 |
| **设施通用 ID（MSH4.2）** | HL7 协议交换的本地设施通用标识。 |
| **设施通用 ID 类型（MSH4.3）** | 一个类型限定符，用于为本地设施通用标识提供上下文。 |

#### 其他设置

*很少需要修改的设置。*

| 设置 | 描述 |
| - | - |
| **空闲超时** | 服务器允许客户端在连接终止之前保持非活动状态的时间（以秒为单位）。 |

#### 日志

*用于管理日志创建和存储的设置。*

<table><thead><tr><th>设置</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**日志级别**</td>
<td>端口生成的日志的详细程度。当请求支持时，请将其设置为 **Debug**。</td></tr>
<tr><td>**日志轮换间隔**</td>
<td>创建新日志文件之前等待的天数。</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>

## 端口配置

配置全局 HL7 MLLP 个人设置后，请在工作流页面上为每个贸易伙伴创建和配置单独的 HL7 MLLP 端口。

### 设置

#### 配置

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

##### 服务器状态

*端口底层服务的当前状态。可用状态如下：*

<table><thead><tr><th>状态</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**活动**</td>
<td>服务正在运行。</td></tr>
<tr><td>**非活动**</td>
<td>服务已配置，但当前未运行。</td></tr>
<tr><td>**未配置**</td>
<td>底层配置文件或服务尚未设置。</td></tr></tbody></table>

根据是否已创建 HL7 MLLP 配置文件，点击**配置 HL7 MLLP 配置文件**或**查看 HL7 MLLP 配置文件**链接，在新选项卡中打开该配置文件。

#### 端口设置

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

| 设置 | 描述 |
| - | - |
| **远程主机** | 远程主机的主机名或 IP 地址。 |
| **端口** | 用于侦听传入 MLLP 连接的端口。 |
| **版本** | 正在使用的 MLLP 版本。 |
| **连接超时** | 端口在抛出超时错误之前等待连接响应的时间长度（以秒为单位）。 |
| **使用 SSL/TLS** | 是否要求传入连接使用 SSL/TLS 加密以确保传输安全。 |

#### HL7 配置

*与消息头相关的设置。将 HL7 文档转换为 XML 时，将根据这些设置验证文档头；从 XML 生成 HL7 文档时，这些设置用于生成文档头。*

| 设置 | 描述 |
| - | - |
| **应用程序命名空间 ID（MSH5.1）** | 结合其他 5.X 元素，标识 HL7 交换机远程端的应用程序。 |
| **应用程序通用 ID（MSH5.2）** | 结合其他 5.X 元素，标识 HL7 交换机远程端的应用程序。 |
| **应用程序通用 ID 类型（MSH5.3）** | 结合其他 5.X 元素，标识 HL7 交换机远程端的应用程序。 |
| **设施命名空间 ID（MSH6.1）** | 结合其他 6.X 元素，标识 HL7 交换机远程端的设施。 |
| **设施通用 ID（MSH6.2）** | 结合其他 6.X 元素，标识 HL7 交换机远程端的设施。 |
| **设施通用 ID 类型（MSH6.3）** | 结合其他 6.X 元素，标识 HL7 交换机远程端的设施。 |

#### ACK

*与生成和请求 ACK 相关的设置。*

| 设置 | 描述 |
| - | - |
| **ACK 类型** | 确认是否应生成并请求。 |

### 样本文件选项卡

*上传示例文件可以方便地在任何连接的 CSV Map 或 XML Map 端口中进行映射。*

使用 **示例文件** 选项卡生成用于 [CSV Map](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/map.md) 或 [XML Map](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/xml-map/xml-map.md) 端口的源或目标 XML 模板。单击 **添加示例文件**。

1. 如果您已有反映数据预期格式和结构的示例文件，请选择 **文件上传** 并浏览到您的文件。或者，选择 **手动创建** 直接在应用程序中创建文件。如果您选择 **手动创建**，请为示例文件命名。单击 **下一步**。

2. 如果您浏览到现有文件，**查看文件** 选项卡将填充其内容。如果您选择手动创建文件，请在此选项卡上输入示例数据。单击 **下一步**。

3. **翻译和预览** 选项卡显示将示例数据转换为 XML 的预览。当您对示例满意时，单击 **添加**。

### 高级设置

#### EDI 分隔符

*指定用哪些字符分隔元素、段等。*

| 设置 | 描述 |
| - | - |
| **数据元素分隔符** | 分隔文档中各个数据元素的字符。 |
| **组件元素分隔符** | 分隔文档中复合数据结构内元素的字符。 |
| **段终止符** | 指示文档中段结尾的字符。 |
| **转义字符** | 释放（转义）下一个字符的字符，覆盖其通常的含义。只要前面有释放字符，允许保留字符在文档中显示为数据。 |
| **重复字符** | 表示元素值重复的字符。 |
| **后缀** | 附加到 **段终止符** 以区分段。 |

#### 代理设置

这是一组用于识别连接所经代理并对其进行身份验证的设置。默认情况下，本节使用 [安全设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/security.md) 页面的 [代理设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/proxy-settings.md) 部分中的全局设置。清除此复选框可为您的端口提供特定的设置。

<table><thead><tr><th>设置</th><th>描述</th></tr></thead>
<tbody><tr><td>**代理类型**</td>
<td>基于代理的防火墙使用的协议。</td></tr>
<tr><td>**代理主机**</td>
<td>基于代理的防火墙的名称或 IP 地址。</td></tr>
<tr><td>**代理端口**</td>
<td>基于代理的防火墙的 TCP 端口。</td></tr>
<tr><td>**代理用户**</td>
<td>用于通过基于代理的防火墙进行身份验证的用户名。</td></tr>
<tr><td>**代理密码**</td>
<td>用于对基于代理的防火墙进行身份验证的密码。</td></tr>
<tr><td>**身份验证方案**</td>
<td>保留默认值 **None** 或选择以下身份验证方案之一：**Basic**、**Digest**、**Proprietary** 或 **NTLM**。</td></tr></tbody></table>

#### 高级设置

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

| 设置 | 描述 |
| - | - |
| **将描述生成为** | 将 HL7 转换为 XML 时，可以提供 HL7 段和元素的描述作为 HL7 数据的上下文。使用此下拉列表可以选择是否将此上下文添加为 XML 注释或 XML 属性。 |
| **处理延迟** | 放置在 **交易** 选项卡中的文件处理延迟的时间量（以秒为单位）。这是一个旧版设置。最佳实践是[使用文件端口](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/designing-a-flow.md#与本地文件系统交互)来管理本地文件系统，而不是此设置。 |
| **严格模式验证** | 检测到以下情况时，端口是否提示应忽略、警告或失败：重复计数超过允许的数目，缺少必需的元素或段，限定符和代码值无效，不允许的元素长度以及无效的元素值。 |
| **本地文件命名方案** | 为端口输出消息分配文件名的方案。可以在文件名中使用宏来动态包含标识符和时间戳等信息。更多信息，请参阅[宏](#宏)。 |
| **TLS 已启用协议** | 建立传出连接时支持的 TLS/SSL 协议列表。最佳实践是仅使用 TLS 协议。SSL v2 和 SSL v3 被认为存在漏洞，只有在贸易伙伴不支持更高版本时才应使用。请注意，TLS v1.3 尚未被普遍采用，如果目标服务器不支持它，可能会被拒绝。 |
| **验证标识符** | 选中后，端口将确保已翻译文档中的标识符与端口配置中指定的标识符匹配。 |
| **重复文件操作** | 当端口收到控制号已见过的消息（重复）时应如何处理。设置为 `Ignore` 时，端口静默跳过重复并继续处理。设置为 `Warn` 时，端口处理文件但返回警告。设置为 `Fail` 时，端口不接受文件并返回错误。 |
| **上传 Schema** | 使用此选项上传 schema 并将其安装在端口的 Schema 文件夹中。如果 schema 已存在，系统会询问是否要覆盖。 |
| **重置状态** | EDI 端口跟踪已使用的控制号并递增该数字，以确保将来的运行不会重复数据。使用此按钮将计数器重置为初始状态，而不更改任何已配置的设置。 |

#### 消息

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

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

### 自动化

#### 自动化设置

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

| 设置 | 描述 |
| - | - |
| **发送** | 到达端口的文件是否自动作为 HL7 或 XML 消息发送。 |
| **重试间隔** | 重试失败发送之前的分钟数。当服务器没有响应发送尝试，或者做出否定响应以表明未收到文件时，将触发重试。 |
| **最大尝试次数** | 端口处理输入文件的最大次数。成功取决于服务器成功确认和验证收据（同步请求时）。如果将此设置为 0，端口将无限期地重试该文件。 |
| **重新发送间隔** | 重新发送未确认消息之前的分钟数。当服务器收到文件但未在预期时间范围内提供异步 MDN 回执时，会触发重新发送。 |
| **最大尝试次数（异步）** | 当请求异步收据时，端口处理输入文件的最大次数。成功取决于服务器成功确认后在 **重新发送间隔** 内返回的异步收据。如果未返回成功的服务器确认，则会应用 **最大尝试次数**。如果将此设置为 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 通知** 设置。

## 生成 HL7 文档

从 XML 生成 HL7 文件时，端口根据 HL7 MLLP 配置文件选项卡上的 [HL7 个人 ID](#hl7-个人-id) 以及端口中的 [HL7 配置](#hl7-配置)应用事务消息头。其余数据来自 XML 输入文件。有关生成适当的 XML 输入文件的详细信息，请参阅[与 XML Map 端口一起使用](#与-xml-map-端口一起使用)。

到达端口 **交易** 选项卡的文件将打包成 HL7 文档并通过 MLLP 发送出去。文件可以通过将文件直接拖放到磁盘上的文件夹路径中或通过将另一个 知行之桥 端口连接到流程中的 HL7 MLLP 端口来到达 **交易** 选项卡。

## HL7 转换为 XML

将 HL7 文档转换为 XML 时，应用程序会根据 HL7 MLLP 配置文件选项卡上的 [HL7 个人 ID](#hl7-个人-id) 和端口中的 [HL7 配置](#hl7-配置)验证入站文档中的交换标题。从 HL7 文档生成的 XML 放置在 **交易** 选项卡中，以便在流程中传递以进行进一步处理。有关处理翻译后的 XML 的详细信息，请参阅[与 XML Map 端口一起使用](#与-xml-map-端口一起使用)。

## 与 XML Map 端口一起使用

HL7 MLLP 端口执行两项操作之一：接收 XML 输入或生成 XML 输出。为确保输入和输出文件具有正确的 XML 结构，我们强烈建议在生成出站 HL7 MLLP 文档时将 [XML Map 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/xml-map/xml-map.md) 用作流程中的上一步，或在接收入站 HL7 MLLP 文档时将其用作流程中的下一步。下面描述的 **上传测试文件** 功能使 XML Map 端口和 HL7 MLLP 端口之间的交互变得简单。

### 上传测试文件

按照以下步骤生成输入文件的 XML 模板：

1. 在端口的 **交易** 选项卡中，单击 **更多** 下拉菜单，然后单击 **上传测试文件**。

2. 导航到磁盘上要建模为 XML 的文件，选择它，然后单击 **OK**。

3. 将 HL7 MLLP 端口连接到流中的 XML Map 端口。此连接可以在任一方向进行——入站到 XML Map 端口，或从 XML Map 端口出站。

XML Map 端口会自动检测测试文件的结构。根据您放置 HL7 MLLP 端口的位置，该文件将出现在 XML Map 端口的 **源文件** 或 **目标文件** 下拉菜单中。

> [!NOTE]
>
> XML Map 端口需要源模板和目标模板，因此必须根据数据来源结构或应转换为的结构来设置剩余模板。例如，如果需要将 HL7 文档中的数据插入数据库，则 XML Map 端口中的另一个模板将是数据库插入的 XML 模型。有关在两个模板文件之间创建映射的更多信息，请参阅 XML Map 端口的 [使用映射编辑器](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/xml-map/xml-map-designer.md)。

## 宏

在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。

知行之桥 支持这些宏，它们都使用以下语法：`%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.
设置	描述
日志级别	端口生成的日志的详细程度。当请求支持时，请将其设置为 Debug。
日志轮换间隔	创建新日志文件之前等待的天数。
日志删除间隔	删除旧日志文件之前等待的天数。
设置	描述
端口 Id	端口的静态、唯一标识符。
端口类型	显示端口类型及其用途的描述。
端口描述	一个可选字段，用于提供端口及其在流中的角色的自由格式描述。
状态	描述
活动	服务正在运行。
非活动	服务已配置，但当前未运行。
未配置	底层配置文件或服务尚未设置。
设置	描述
代理类型	基于代理的防火墙使用的协议。
代理主机	基于代理的防火墙的名称或 IP 地址。
代理端口	基于代理的防火墙的 TCP 端口。
代理用户	用于通过基于代理的防火墙进行身份验证的用户名。
代理密码	用于对基于代理的防火墙进行身份验证的密码。
身份验证方案	保留默认值 None 或选择以下身份验证方案之一：Basic、Digest、Proprietary 或 NTLM。
设置	描述
保存到已发送文件夹（已弃用）	将端口处理的文件复制到 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) 部分的默认设置。
宏	描述
ConnectorID	替换为端口的 ConnectorID。
ConnectorName	替换为端口名称。可用于在文件名或路径中包含连接名称，例如按生成备份文件的数据库连接标记文件。
Ext	替换为端口当前正在处理的文件的文件扩展名。
Filename	替换为端口当前正在处理的文件的文件名（包括扩展名）。
FilenameNoExt	替换为端口当前正在处理的文件的文件名（不带扩展名）。
MessageId	计算端口输出的消息的 MessageId。
RegexFilename:pattern	将正则表达式模式应用于端口当前正在处理的文件的文件名。
Header:headername	替换为端口正在处理的当前消息的目标消息头（`headername`）的值。
LongDate	以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。
ShortDate	以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。
DateFormat:format	以指定格式（`format`）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 [示例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#date-formats-with-literal-characters)。
Vault:vaultitem	计算指定保管库项目的值。