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

# File 端口

> File 端口可将文件从外部目录拉入工作流，并将工作流中的文件推送到外部目录。

File 端口能够：

* 将文件从外部目录拉入到 知行之桥 工作流中。
* 将文件从 知行之桥 工作流导出到外部目录中。

## 核心功能

* 集成本地和网络文件系统，支持 UNC 路径
* 为受保护的网络位置提供可配置的身份验证（仅限 .NET 版本）
* 支持 Glob 模式匹配的高级过滤功能及递归目录查找
* 支持带暂存和重命名操作的临时文件处理，确保传输的可靠性
* 提供可选的缓存功能，确保仅下载新增或更新的文件

## 概览

每个 File 端口都需要配置磁盘路径，该路径决定了它将从哪个文件夹读取文件或向哪个文件夹写入文件。可以是本地磁盘路径，也可以是网络上其它文件位置的 UNC 路径。

当 File 端口从配置的路径接收到文件时，它会将接收到的文件传递给 知行之桥 工作流中的下一个端口，不会修改文件。这样，File 端口可用于轮询外部文件夹，以将文件拉入工作流。

当 知行之桥 工作流中的文件被 File 端口处理时，该文件将被写入到配置路径下的文件夹中。通过这种方式，File 端口可用于将已处理的文件放在应用程序外部的位置。

File 端口可以配置用户名／密码凭据，以提供对外部文件路径的访问，否则应用程序将无法访问这些路径。这允许 知行之桥 从受保护的文件夹位置提取文件，而不需要授予整个应用程序对受保护位置的访问权限。

File 端口中配置的路径可以使用宏动态填充。更多信息，请参见[宏](#宏)部分。

## 端口配置

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

### 设置

#### 端口设置

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

| 设置 | 描述 |
| - | - |
| **端口 ID** | 端口的静态唯一标识符。 |
| **端口类型** | 显示端口名称及其功能描述。 |
| **端口描述** | 一个可选字段，用于对端口及其在工作流中的角色进行自由说明。 |
| **路径** | 端口从中获取文件或将文件推送到的外部文件路径。路径可以包含宏以进行动态求值，详情参见[宏](#宏)。 |

#### 接收

*与从外部文件路径提取文件相关的设置。*

| 设置 | 描述 |
| - | - |
| **文件掩码** | 一种全局模式，用于过滤应该从已配置的**路径**中提取的文件。只有与文件掩码匹配的文件才会被提取。此设置可与**高级**选项卡中的**接收过滤规则**结合使用，以指定多个过滤器。 |
| **删除文件（接收后）** | 当文件被获取到 知行之桥 工作流后，是否从外部路径中删除文件。启用**延迟最终确定接收的文件**时，文件仅在成功最终确定后才会被删除。 |
| **延迟最终确定接收的文件** | 将接收到的文件保持为待处理状态，直到下游的 [Finalize](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/finalize.md) 端口完成对其的处理。待处理的文件不会被再次接收。**自动化**选项卡上的\*\*接收待处理超时（分）\*\*会释放这些文件以供再次接收，但不会删除源文件。此设置默认禁用，且不影响发送文件。有关更多信息，请参阅[延迟最终确定](#延迟最终确定)。 |

#### 认证

| 设置 | 描述 |
| - | - |
| **用户名** | 用于访问文件的 Windows 用户帐户。如果未指定，端口将使用当前用户帐户。 |
| **密码** | 指定用户帐户的密码。 |
| **域** | Windows 用户帐户的域。如果指定的用户是本地用户帐户，则该值可以为空。 |

#### 缓存

*与缓存及多次下载之间文件比对相关的设置。*

| 设置 | 描述 |
| - | - |
| **文件大小比对** | 选中此项可保存已下载文件名和大小的记录。之前已下载的文件将被跳过，除非文件大小与上次下载不同。 |
| **时间戳比对** | 选中此项可保存已下载文件名和最后修改时间戳的记录。之前已下载的文件将被跳过，除非时间戳与上次下载不同。 |

> [!NOTE]
>
> 知行之桥会自动清理资源缓存。此过程在每次接收周期的后台运行，删除远程服务器上已不存在的文件对应的过期缓存条目。这使得缓存大小始终保持在可管理范围内，无需任何手动操作。 默认情况下，文件保留 30 天，但您可以在**高级**选项卡的**其他设置**字段中使用 `ResourceCacheRetentionDays` 设置来调整保留时间以适应您的环境。例如，`ResourceCacheRetentionDays=15` 表示文件保留 15 天后将被删除。 启用缓存后，文件名不区分大小写。例如，端口无法区分 `TEST.TXT` 和 `test.txt`。

### 高级设置

#### 高级设置

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

| 设置 | 描述 |
| - | - |
| **最大下载文件数** | 在单个接收间隔内将提取的最大文件数。如果该值不是正整数，将不会应用任何限制。 |
| **复写选项** | 当端口尝试将文件写入外部路径并且该文件已经存在时，指定端口如何处理。端口可以将当前文件重命名为唯一的文件名，\_覆盖\_现有文件，\_追加\_当前文件到现有文件，\_跳过\_操作且不报错，或者\_停止\_操作并抛出错误。 |
| **延迟接收** | 端口在从远程路径接收文件之前等待的时间（秒）。 |
| **递归子目录** | 设置为 true 以下载目标远程路径子文件夹中的文件。为接收到的文件保留目录结构。 |
| **临时发送路径** | 在将文件移动到配置的目标路径之前，用作暂存文件夹的目录。 |
| **临时发送前缀** | 如果指定，端口将上传带有临时前缀的文件，然后在操作完成后将文件重命名为其原始文件名。 |
| **临时发送扩展名** | 如果指定，端口将上传带有临时扩展名的文件，然后在操作完成后将文件重命名为其原始文件名和扩展名。 |
| **最小文件大小** | 要处理的最小文件大小（以字节为单位）。如果正在上传的文件小于指定大小，则最终确定为 **Skipped**。对于正在下载的文件，端口会添加一个事务日志条目，指示该文件因其大小而被跳过。 |
| **本地文件命名规则** | 用于为端口输出消息分配文件名的规则。可以在文件名中使用宏动态包含标识符和时间戳等信息。更多信息，请参见[宏](#宏)。 |
| **接收过滤规则** | 一个全局模式过滤器，用于确定应该从远程存储下载哪些文件（例如 \*.txt）。负模式可用于指示不应下载的文件（例如 -\*.tmp）。当需要多个**文件掩码**模式时，应使用此设置。多个模式可以用逗号分隔，除非找到完全匹配，否则后面的过滤器优先。 |
| **处理延迟** | **事务**选项卡中文件处理延迟的时间（秒）。这是一个旧版设置。最佳做法是[使用 File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/designing-a-flow.md#与本地文件系统交互)来管理本地文件系统，而不是使用此设置。 |

#### 消息

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

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

### 自动化

#### 自动化设置

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

| 设置 | 描述 |
| - | - |
| **发送** | 切换开关，用于指示端口在文件准备好后自动发送文件。 |
| **重试间隔** | 端口在重试失败发送之前等待的间隔时间。 |
| **最大重试次数** | 端口尝试发送消息的次数。将此值设置为 *1* 表示端口仅进行初始发送尝试而不重试。端口在每次尝试之间等待**重试间隔**指定的时长。 |
| **接收** | 切换开关，用于指示端口在文件准备好后自动处理文件并将其发送到**事务**选项卡。 |
| **间隔** | 端口处理所有待处理文件并将其发送到**事务**选项卡的间隔时间。 |
| **整点后的分钟数** | 每小时计划的分钟偏移量。仅当上述间隔设置为\_每小时\_时适用。例如，如果此值设置为 5，自动化服务会在 1:05、2:05、3:05 等时间处理文件。 |
| **时间** | 尝试发生的具体时间。仅当上述间隔设置为\_每天\_、\_每周\_或\_每月\_时适用。 |
| **天** | 尝试发生的日期。仅当上述间隔设置为\_每周\_或\_每月\_时适用。 |
| **分钟** | 处理文件前等待的分钟数。仅当上述间隔设置为\_分钟\_时适用。 |
| **Cron 表达式** | 表示 Cron 表达式的五段字符串，用于确定尝试发生的时间。仅当上述间隔设置为\_高级\_时适用。 |
| **开始日期和时间** | 自动化首次运行的日期和时间。之后的每次运行都遵循上方的间隔设置。上次和下次运行时间显示在 [自动化状态](#自动化状态) 部分中。 |
| **接收待处理超时（分）** | 接收到的文件在等待下游 [Finalize](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/finalize.md) 端口完成处理时保持待处理状态的分钟数。超时后，该消息会被标记为 Pending Timeout 错误，源文件不会被删除，并且该文件会被释放以便再次接收。默认值为 10 分钟。设置为 0 可使文件无限期保持待处理状态。 |

#### 自动化状态

*只读摘要，显示自动化是否正在运行、上次运行的结果以及下次运行的时间。*

**自动化状态**卡片显示在 **自动化** 选项卡的 **启用** 复选框下方，适用于 **接收**、**下载** 和 **定时发送** 自动化。该卡片回答三个问题：自动化是否已运行、运行是否成功，以及下次运行的时间。

在保存端口之前，当您更改 **启用** 复选框，或者更改 **间隔** 或 **开始日期和时间** 设置时，卡片会随之更新。

![自动化选项卡上的自动化状态卡片，显示已暂停状态、失败的上次处理结果以及下次运行时间](https://docs.kasoftware.com/26.4/images/automation-status-card.png)

状态

端口自动化的当前状态。

<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>端口在多次运行失败后处于[退避](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/connector-backoff.md)状态，自动化服务会跳过该端口。</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>上次运行的结果：
<ul><li>**成功**：运行已完成并处理了数据。</li>
<li>**无数据**：运行已完成，但没有需要处理的内容，例如查询未返回任何行。</li>
<li>**失败**：运行未完成。</li></ul></td></tr>
<tr><td>**上次成功时间**</td>
<td>最近一次成功运行的日期和时间。当上次运行失败或未返回数据时，会显示此字段，以便您了解端口已有多长时间未成功运行。</td></tr></tbody></table>

下次运行时间

**日期** 字段显示自动化下一次计划运行的时间。自动化禁用时，该字段为空。

查看详情

**已暂停** 状态、**失败** 结果和 **无数据** 结果都包含一个 **查看详情** 链接，单击后会打开一个显示完整消息的对话框：

<ul><li>**已暂停**：列出每个处于退避状态的实例、其失败次数以及自动化服务恢复的时间。有关端口如何退出此状态，请参阅[端口退避](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/connector-backoff.md)。</li>
<li>**失败**：显示上次失败运行的错误消息。</li>
<li>**无数据**：显示端口报告的消息，例如 `0 rows returned`。</li></ul>

未运行与无数据

该卡片会区分尚未运行的端口与已运行但未找到任何内容的端口。如果 **上次处理结果** 为空，说明自动化尚未运行，请检查 **下次运行时间** 和计划设置。如果结果为 **无数据**，说明自动化已按计划运行，但数据源未返回任何内容，请检查数据源中是否有新数据。

已禁用的端口

已禁用的端口会保留其上次运行信息，因此您仍可以查看其上次运行的时间及结果。只有 **下次运行时间** 会被清除。

#### 性能

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

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

## 建立连接

File 端口必须具有适当的权限，才能从配置的**路径**读取／写入。当配置的路径是到网络上另一个服务器的 UNC 路径时，权限问题是主要关注的问题，但是当从本地磁盘上受保护的文件夹推送或提取文件时，也可能出现权限问题。

如果运行 知行之桥 的用户没有访问该路径的权限，请在**设置**选项卡的[认证](#认证)部分，将**用户名**、**密码**和**域**字段设置为具有相应权限的特定用户。

## 发送／接收文件

### 发送文件

File 端口将文件从**事务**选项卡发送到**路径**中指定的外部文件夹。如果在[自动化](#自动化设置)选项卡中启用了**发送**功能，文件将自动发送。

### 接收文件

File 端口从**路径**中指定的外部文件夹接收文件，并将它们放置在端口的**事务**选项卡中。如果 File 端口连接到工作流中的另一个端口，则文件不会保留在此文件夹中，而是传递到下一个连接的端口。

如果在[自动化](#自动化设置)选项卡中启用了**接收**功能，端口将自动轮询外部文件夹以接收文件。

端口将只提取与指定**文件掩码**匹配的文件。如果**启用时间戳比对**或**启用文件大小比对**已启用，端口将缓存从远程路径提取的文件名，并且仅接收以前未收到的文件或自上次收到后已修改的文件。

当一次接收操作中有多个符合条件的文件时，端口会按最后修改时间戳升序处理这些文件，因此较早的文件会先进入工作流。时间戳相同的文件会按一致且可预测的顺序处理。

### 延迟最终确定

默认情况下，端口在接收文件后会立即完成该文件，任何已配置的清理操作（例如**删除文件（接收后）**）也会立即执行。如果工作流中的后续步骤失败，源文件已经不存在了。

启用**延迟最终确定接收的文件**后，端口会将每个接收到的文件保持为待处理状态，并等待下游的 [Finalize](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/finalize.md) 端口确认工作流已成功。如果需要在处理完成之前保留源文件，这是使用\*\*删除文件（接收后）\*\*的推荐方式。

要使用延迟最终确定：

1. 在接收文件的 File 端口上启用**延迟最终确定接收的文件**。
2. 在工作流成功路径的末尾添加一个 Finalize 端口。

文件处于待处理状态时：

* 端口不会再次接收该文件。
* 如果文件到达 Finalize 端口，端口会完成该文件并执行已配置的清理操作。
* 如果文件在\*\*接收待处理超时（分）\*\*到期之前未到达 Finalize 端口，该消息会被标记为 Pending Timeout 错误，并且该文件会被释放以便再次接收。源文件不会被删除。端口会记录一条 **Send Failure: Pending Timeout** 错误通知。
* 如果源文件在接收后发生了变化，即使该文件已最终确定，端口也不会删除它。

延迟最终确定仅适用于接收文件，不会改变端口发送文件的方式。

### 子目录消息头

如果**递归子目录**设置为 **True**，File 端口从**路径**接收文件时：

* 收到的文件消息将在其元数据中包含子目录消息头。
* 这个消息头包含子目录，其相对于配置的**路径**。
* 这个子目录消息头可以被其它支持该功能的发送端口所识别和支持。

当发送文件时，如果发送到 File 端口**路径**的消息中存在子目录消息头：

* 文件将被放置在子目录消息头中指定的子目录（相对于 File 端口的路径设置）中。
* 如果有权限，子目录会被自动创建。

## 宏

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

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