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

# RosettaNet 端口

> 知行之桥RosettaNet 端口的配置和使用指南。

RosettaNet 端口按照 RosettaNet Implementation Framework (RNIF) 标准发送和接收消息。

## 核心功能

* 支持 RNIF 1.1 和 2.0，用于 B2B 文档交换
* 支持按伙伴配置自动路由消息，并提供灵活的加密/签名选项
* 基于证书的安全性，支持同步/异步确认处理

## 概述

RosettaNet 连接需要在两个位置配置。首先在 RosettaNet [个人设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/profiles.md)页面中配置本地 RosettaNet 标识符和私有证书。然后为每个交易伙伴配置单独的 RosettaNet 端口及其连接设置。当 RosettaNet 端口处理输入文件时，该文件会被打包并发送给指定的交易伙伴。

当 知行之桥 通过 RosettaNet 接收到文件时，会尝试将该文件路由到特定的 RosettaNet 端口。应用程序使用 RosettaNet 消息中的 RosettaNet 标识符来确定哪个 RosettaNet 端口应接收该文件。当文件被路由到 RosettaNet 端口时，该文件会放入端口的**交易**选项卡，或传递给工作流中的下一个端口。

## 个人设置配置

必须先配置 RosettaNet 个人设置，才能与各个 RosettaNet 端口建立连接。单击导航栏上的**个人设置**，然后单击 **RosettaNet** 选项卡。

### RosettaNet 个人设置选项卡

#### 个人信息

*用于标识本地个人设置的设置。*

| 设置 | 说明 |
| - | - |
| **业务标识符** | 你的标识符。知行之桥 发送的消息会在传出消息中包含此值以标识发送方。传入消息必须发送到此标识符。标识符区分大小写。 |
| **业务位置** | 描述传入消息接收方的位置。此值不是地址，但可以是城市名称。 |

#### 个人证书

*与私有解密和签名证书相关的设置。*

| 设置 | 说明 |
| - | - |
| **私有证书** | 用于解密传入消息并签署传出消息的证书。切勿与外部方共享此证书。单击**创建证书**按钮可生成可在 RosettaNet 交易中直接使用的自签名证书：系统也会生成同名且扩展名为 `.cer` 的对应公钥。 |
| **证书密码** | 访问**私有证书**所需的密码。 |

#### 应用程序 URL

*与从公共 Web 访问 知行之桥 相关的设置和显示值。*

| 设置 | 说明 |
| - | - |
| **接收 URL** | 知行之桥 监听传入 RosettaNet 消息的 URL。请将此 URL 分享给所有交易伙伴。 |

#### 其他设置

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

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

## 端口配置

配置全局 RosettaNet 个人设置后，在[工作流](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/flows.md)页面为每个交易伙伴创建并配置单独的 RosettaNet 端口。

### 设置选项卡

#### 配置

\_用于标识和连接到特定 RosettaNet 交易伙伴的设置。

| 设置 | 说明 |
| - | - |
| **端口 ID** | 端口的静态唯一标识符。 |
| **端口类型** | 显示端口名称及其功能说明。 |
| **端口说明** | 可选字段，用于自由描述端口及其在工作流中的角色。 |
| **业务标识符** | 目标交易伙伴的特定标识符。此值包含在传出消息的标头中，也用于将传入消息路由到相应的 RosettaNet 端口。 |
| **业务位置** | 传出消息接收方的位置。 |
| **伙伴 URL** | 应将传出消息发送到的交易伙伴公共端点。 |

#### 连接信息

*与指定交易伙伴的连接参数相关的设置。*

| 设置 | 说明 |
| - | - |
| **RNIF 版本** | 生成 RosettaNet 消息时使用的协议版本。 |
| **加密类型** | 加密有效负载、有效负载和标头，还是都不加密。 |
| **数据签名** | 是否签署传出消息。 |
| **接收消息安全性** | 是否要求传入消息包含签名和加密。如果收到的消息缺少必需的安全参数，则会引发错误。 |
| **连接超时** | 端口在抛出超时错误之前等待连接响应的时长（秒）。 |
| **测试指示器** | 控制前导标头中的 `GlobalUsageCode`。勾选此项可将代码设置为 `Test`。如果未勾选，代码为 `Production`。仅当 **RNIF 版本**为 1.1 时需要。 |

#### 确认

*与 RosettaNet 确认相关的设置。*

| 设置 | 说明 |
| - | - |
| **自动确认** | 是否应自动发送确认来响应传入的 RosettaNet 消息。 |
| **自动异常** | 是否应自动发送异常来响应失败消息。 |
| **需要确认** | 是否应返回确认来响应传出的 RosettaNet 消息。 |
| **安全性** | 确认是否应包含签名块，以验证消息完整性和接收方身份。 |
| **传递** | 确认应作为传出 RosettaNet 消息的直接响应返回（同步），还是稍后作为单独连接的一部分返回（异步）。建议使用同步回执，除非 RosettaNet 消息非常大（50MB 是常见阈值），这种情况下处理消息并传递同步回执可能会超过连接超时时长。 |

#### 交易伙伴证书

*与交易伙伴提供的公钥证书相关的设置。*

| 设置 | 说明 |
| - | - |
| **加密证书** | 发送消息时用于 RosettaNet 加密的公钥证书。此证书必须与交易伙伴的私有解密证书配对，交易伙伴在共享 RosettaNet 配置详细信息时应提供此公钥证书。 |
| **验证证书** | 接收消息时用于验证 RosettaNet 签名的公钥证书。此字段通常不需要；大多数 RosettaNet 参与方使用同一个私有证书进行签名和解密。如果未指定此字段，应用程序会使用**加密证书**验证签名。 |
| **TLS 服务器证书** | 用于验证 TLS/SSL 服务器身份的公钥证书。仅当伙伴的 RosettaNet 系统要求 HTTPS 而非 HTTP 时才需要。如果交易伙伴未提供 TLS 服务器证书，可以将此设置留空，以允许底层 OS/JVM 执行证书验证，或将其设置为 `Any Certificate` 以无条件信任目标服务器的身份。 |

### 高级选项卡

#### 备用本地个人设置

*覆盖此特定 RosettaNet 端口在**个人设置**页面上的配置。设置备用本地个人设置可让你为某些交易伙伴使用不同的本地证书和标识符。*

| 设置 | 说明 |
| - | - |
| **本地业务位置** | 你的位置。覆盖个人设置页面上的**业务位置**。 |
| **本地业务标识符** | 你的标识符。覆盖个人设置页面上的**业务标识符**。 |
| **私有证书** | 用于解密传入消息并签署传出消息的证书。覆盖个人设置页面上的**私有证书**。 |
| **证书密码** | 访问本地私有证书所需的密码。 |

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

*与需要双向 TLS 身份验证时的客户端身份验证相关的设置。*

| 设置 | 说明 |
| - | - |
| **使用个人设置** | 是否使用个人设置页面上配置的**私有证书**作为客户端身份验证的 TLS 证书。 |
| **私有证书** | TLS 客户端身份验证期间提供的私有证书。仅当未使用个人设置页面上的私有证书时适用。 |
| **证书密码** | 访问 TLS 客户端证书所需的密码。 |

#### HTTP 身份验证

*与 HTTP 客户端身份验证相关的设置。*

| 设置 | 说明 |
| - | - |
| **HTTP 身份验证** | 是否使用客户端 HTTP 身份验证。 |
| **HTTP 身份验证类型** | 以加密格式 (Digest) 还是纯文本 (Basic) 提供 HTTP 身份验证凭据。仅当连接为 HTTPS 连接（而非 HTTP）时才使用 Basic 身份验证。 |
| **用户** | HTTP 客户端身份验证的用户凭据。 |
| **密码** | HTTP 客户端身份验证的密码凭据。 |

#### 高级设置

\_不属于前述类别的设置。

| 设置 | 说明 |
| - | - |
| **处理延迟** | 放入**交易**选项卡的文件延迟处理的时长（秒）。这是一个旧版设置。最佳实践是[使用 File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/designing-a-flow.md#与本地文件系统交互)管理本地文件系统，而不是使用此设置。 |
| **RNIF 调试模式** | RosettaNet 接收方是否应返回与 PIP 验证或发送方身份验证相关的通信错误。必须在传输双方启用此设置，才能返回异常。 |
| **签名算法** | 签署传出消息时使用的算法。 |
| **启用的 TLS 协议** | 建立出站连接时支持的 TLS/SSL 协议列表。最佳实践是仅使用 TLS 协议。SSL v2 和 SSL v3 被认为存在漏洞，只有当伙伴不支持更高版本时才应使用。请注意，TLS v1.3 尚未普遍采用，如果目标服务器不支持，可能会被拒绝。 |
| **安全传输** | 勾选此项以要求转发消息时使用安全性。 |
| **本地文件方案** | 为端口输出的消息分配文件名的方案。可以在文件名中使用宏，动态包含标识符和时间戳等信息。有关更多信息，请参见[宏](#宏)。 |

#### 代理设置

这是一组用于识别连接所经代理并对其进行身份验证的设置。默认情况下，本节使用 [安全设置](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>

#### 消息

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

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

### 自动化选项卡

#### 自动化设置

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

| 设置 | 说明 |
| - | - |
| **发送自动化** | 到达端口的文件是否会自动作为 RosettaNet 消息发送。 |
| **重试间隔** | 发送失败后重试前等待的分钟数。当服务器未响应发送尝试，或以否定响应表示未收到文件时，会触发重试。 |
| **最大次数** | 端口处理输入文件的最大次数。成功与否取决于服务器成功确认以及（同步请求时）对回执的验证。如果设置为 0，端口会无限期重试该文件。 |
| **重新发送间隔** | 重新发送未确认消息前等待的分钟数。当服务器收到文件但未在预期时间内提供异步确认时，会触发重新发送。 |
| **最大次数（异步）** | 请求异步确认时端口处理输入文件的最大次数。成功与否取决于服务器成功确认后在**重新发送间隔**内返回异步回执。如果未返回成功的服务器确认，则改用**最大次数**。如果设置为 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 通知** 设置。

## 建立连接

配置新的 RosettaNet 端口时，交易伙伴必须提供部分所需的连接详细信息。这些详细信息至少应包括：

* 业务标识符
* 伙伴 URL
* 伙伴证书

### 业务标识符

在 RosettaNet 交易中，交易伙伴由其业务标识符标识。发送传出请求时，业务标识符用于请求标头中以指示接收方。

若要建立 RosettaNet 自测，标识符应设置为与[个人设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/profiles.md)页面上的**业务标识符**相同的值。

> [!NOTE]
>
> 此值区分大小写。

### 伙伴 URL

伙伴 URL 是交易伙伴接收 RosettaNet 传输的端点。传出的 RosettaNet 消息会发送到此目标端点，该端点对每个交易伙伴必须唯一。你可以使用 Web 浏览器测试伙伴 URL，以检查网络或连接问题。

若要建立 RosettaNet 自测，目标 URL 应与个人设置页面上的**接收 URL** 相同或几乎相同。你可以将个人设置页面中的域名替换为环回地址 localhost，以使 RosettaNet 交易保留在本地网络中。本地自测 URL 示例为 `http://localhost:8001/pub/Receive.rsb`。

如果未将域名替换为 localhost，RosettaNet 消息会路由到本地网络之外。你可以利用此方式检查网络配置设置，并确保消息可以通过任何防火墙到达 知行之桥。

### 伙伴证书

每个 RosettaNet 端口都必须为目标交易伙伴配置证书。交易伙伴会提供与其交换 RosettaNet 消息时进行加密和验证所需的证书。知行之桥 接受 X.509 公钥证书（扩展名为 .cer、.der 或 .pem 的文件）。

通常，交易伙伴会提供一个证书，应将其配置在**加密证书**字段中。

如果交易伙伴提供多个证书，应说明每个证书的用途。如果伙伴提供完整证书链（例如从商业证书颁发机构获取），则只需要配置叶证书（链中的最后一个证书）。

## 发送和接收文件

配置 RosettaNet 个人设置和特定伙伴的 RosettaNet 端口后，即可安全地发送和接收文件。

### 发送文件

在 RosettaNet 端口中，**交易**选项卡显示要发送给目标交易伙伴的文件。如果在[自动化](#自动化选项卡)选项卡上启用了**发送自动化**，到达端口**交易**选项卡的文件会自动打包并发送。展开与已传输文件关联的行即可访问所有传输的日志文件。

在**交易**选项卡上，选择**更多 > 创建测试文件**以生成一组简单的测试文件并发送给交易伙伴。

### 重新发送和重试

当预期交易伙伴返回异步确认，但未能在**重新发送间隔**时长内（默认为 60 分钟）返回时，会触发 RosettaNet 重新发送。随后应用程序会尝试重新发送传输。应用程序会继续重新发送消息，直到收到确认为止或\*\*最大次数（异步）\*\*用尽。

当交易伙伴的 HTTP 响应表明服务器未收到传输时，会触发重试。这可能表示网络或连接问题，通常是暂时性的。应用程序每隔**重试间隔**分钟重试传输，直到传输被接收或**最大次数**用尽。

### 接收文件

在 RosettaNet 端口中，**交易**选项卡显示应用程序已接收并路由到该端口的文件（基于传入 RosettaNet 消息中存在的 RosettaNet 标识符）。展开每个文件行可显示该传输的可用日志列表。

这些文件可在端口的**交易**选项卡上查看。如果端口连接到工作流中的其他端口，文件会自动从 RosettaNet 端口的**交易**选项卡移动到工作流中下一个端口的**交易**选项卡。

RosettaNet 协议不允许主动从交易伙伴拉取文件：RosettaNet 端口只能被动等待交易伙伴发送文件。

## 配置 PIP

Partner Interface Processes (PIP) 是 RosettaNet 用于传输各种业务流程信息的逻辑 XML 文档。下面列出了常见 PIP：

| PIP | 说明 |
| - | - |
| 3A1 | 请求报价 |
| 3A2 | 请求价格和可用性 |
| 3A3 | 请求购物车传输 |
| 3A4 | 请求采购订单 |
| 3A5 | 查询订单状态 |
| 3A6 | 分发订单状态 |
| 3A7 | 通知采购订单更新 |
| 3A8 | 请求采购订单变更 |
| 3A9 | 请求取消采购订单 |
| 3A10 | 通知报价确认 |
| 3A13 | 通知采购订单信息 |
| 3A14 | 分发计划订单 |
| 3B1 | 分发运输预测 |
| 3B2 | 通知提前发货 |
| 3B3 | 分发发货状态 |
| 3B4 | 查询发货状态 |
| 3B5 | 请求发货变更 |
| 3B6 | 通知已投标发货 |
| 3B11 | 通知发货订单 |
| 3B12 | 请求发货订单 |
| 3B13 | 通知发货订单确认 |
| 3B14 | 请求取消发货订单 |
| 3B18 | 通知发货单据 |
| 3C1 | 退货 |
| 3C2 | 请求融资批准 |
| 3C3 | 通知发票 |
| 3C4 | 通知发票拒绝 |
| 3C5 | 通知账单 |
| 3C6 | 通知汇款通知 |
| 3C7 | 通知自开票发票 |

## 宏

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

知行之桥 支持这些宏，它们都使用以下语法：`%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.