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

# FTP 端口

> FTP 端口的配置和使用指南，用于在远程 FTP 服务器之间传输文件。

FTP 端口可与远程 FTP 服务器传输文件。

## 核心功能

* 支持 FTPS (FTP over TLS/SSL) 和传统 FTP 文件传输协议
* 支持主动和被动模式，具备完善的防火墙兼容性
* 支持断点续传功能，适用于中断的上传和下载任务
* 提供高级身份验证，包括基于证书的客户端身份验证
* 支持连接池和临时文件处理，确保传输的可靠性
* 提供可选的缓存功能，确保仅下载新增或更新的文件

## 概述

每个 FTP 端口连接上传文件到指定的文件夹，并从远程 FTP 服务器上的一组文件夹下载。

在 知行之桥 工作流中到达 FTP 端口的文件被上传到上传目标文件夹，在下载目标文件夹中找到的文件被下载并输入到 知行之桥 工作流中。端口支持上传和下载过滤规则，仅发送和接收指定的文件名和／或文件扩展名。

## 端口配置

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

### 设置

#### 主机配置

*与建立到远程 FTP 主机的连接相关的设置。*

| 设置 | 描述 |
| - | - |
| **端口 ID** | 端口的静态唯一标识符。 |
| **端口类型** | 显示端口名称及其功能描述。 |
| **端口描述** | 一个可选字段，用于对端口及其在工作流中的角色进行自由说明。 |
| **远程主机** | FTP 服务器的主机名或 IP 地址。 |
| **TLS 类型** | 连接到服务器时如何协商 TLS/SSL。当设置为 "Explicit" 时，将建立明文连接，然后用显式命令启动 TLS/SSL。当设置为 "Implicit" 时，将立即协商 TLS/SSL，而无需先建立明文连接。 |
| **远程主机端口** | 连接到 FTP 服务器的端口。 |

#### 客户端验证

*与向 FTP 服务器进行身份验证相关的设置。*

| 设置 | 描述 |
| - | - |
| **用户名** | 登录 FTP 服务器的用户名。 |
| **密码** | 登录 FTP 服务器的密码。 |

#### 服务器验证

*与验证 FTP 服务器身份相关的设置。*

| 设置 | 描述 |
| - | - |
| **服务器公钥证书** | 用于验证 TLS/SSL 服务器身份的公钥证书。如果目标服务器使用 TLS/SSL，请将此字段设置为标识服务器的证书。如果服务器证书不可用，可以将此设置留空以允许底层 OS/JVM 执行证书验证，或将其设置为 `Any Certificate` 以隐式信任服务器身份。 |

#### 上传

*与文件上传到 FTP 服务器相关的设置。*

| 设置 | 描述 |
| - | - |
| **远程目录** | 端口处理的文件将上传到指定的远程文件夹。可以在路径中使用宏动态创建按日期划分的文件夹（例如年份或月份文件夹）。有关更多信息，请参阅[宏](#宏)。 |

#### 下载

*与从 FTP 服务器下载相关的设置。*

| 设置 | 描述 |
| - | - |
| **远程目录** | 从中下载文件的远程文件夹。使用逗号分隔列表指定多个路径。可以在路径中使用宏动态创建按日期划分的文件夹（例如年份或月份文件夹）。有关更多信息，请参阅[宏](#宏)。 |
| **文件掩码** | 确定应下载**远程目录**中哪些文件的模糊匹配模式（例如 \*.txt）。 |
| **删除文件（下载后）** | 勾选这个以从 FTP 服务器删除成功下载的文件。 |

#### 缓存

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

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

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

### 高级设置

#### TLS 客户端认证

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

| 设置 | 描述 |
| - | - |
| **客户端证书** | 在 TLS 客户端身份验证期间提供的私有证书。 |
| **客户端证书密码** | 访问 TLS 客户端证书所需的密码。 |

#### 服务器命令

这些选项允许您在端口执行期间的不同时间在目标服务器上执行自定义命令。

> [!NOTE]
>
> 虽然下面描述的命令是普遍接受的，但在尝试使用命令之前，请务必与目标服务器管理员核实，以确保服务器可以接受该命令。

<table><thead><tr><th>设置</th><th>描述</th></tr></thead>
<tbody><tr><td>**After Connect**</td><td>连接后直接执行此命令。</td></tr>
<tr><td>**After Get**</td><td>下载每个文件后执行此命令。</td></tr>
<tr><td>**After Put**</td><td>上传每个文件后执行此命令。</td></tr>
<tr><td>**Before Get**</td><td>在下载每个文件之前执行此命令。</td></tr>
<tr><td>**Before Put**</td><td>在上传每个文件之前执行此命令。</td></tr></tbody></table>

以下是当将以下命令包含在上述字段中时可以提交给目标服务器的命令：

• `onerror`：传递 `fail` 参数以指示端口将来自自定义脚本的错误视为整个事务的错误。如果没有 `fail`，端口会记录任何异常并继续处理。

• `cd`：改变目录。

• `mkdir`：创建目录。

• `rn` 或 `move`：重命名或移动文件。

• `del` 或 `rm`：删除文件。

• `rmdir`：删除目录。

知行之桥通过这些命令支持以下宏。它们都使用以下语法：`%Macro%`。某些宏，例如 `%Date%` 和 `%SourceFilename%`，不需要参数，但其他宏则需要。带参数的宏使用以下语法：`%Macro:argument%`。

<table><thead><tr><th>宏</th><th>描述</th></tr></thead>
<tbody><tr><td>MsgHeader:*headername*</td><td>计算消息的消息头值（例如：%MsgHeader:headername%）。</td></tr>
<tr><td>SourceFilename</td><td>计算当前正在处理的文件的文件名（包括扩展名）。</td></tr>
<tr><td>SourceFilenameNoExt</td><td>计算当前正在处理的文件的文件名（不带扩展名）。</td></tr>
<tr><td>Date</td><td>以 yyyy-MM-dd 格式计算文件的上次修改日期（例如 2024-02-13）。</td></tr>
<tr><td>DateTime</td><td>以 yyyy-MM-dd'T'HH:mm:ss 格式计算文件上次修改的日期时间（例如 2024-02-13T08:14:22）。</td></tr>
<tr><td>Time</td><td>以 HH:mm:ss 格式计算文件的上次修改时间（例如 08:14:22）。</td></tr>
<tr><td>DateTime.tz</td><td>以 yyyy-MM-dd'T'HH:mm:ss zzz 格式计算文件上次修改的日期时间（例如 2024-02-13T08:14:22 PST）。</td></tr>
<tr><td>Time.tz</td><td>以 HH:mm:ss zzz 格式计算文件的上次修改时间（例如 08:14:22 PST）。</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></tbody></table>

**示例**：下载后，您希望将每个文件从下载文件夹移动到 History 子文件夹。使用 **After Get** 字段为 `move` 命令提供 `%SourceFilename%` 宏。

![Server command example](https://docs.kasoftware.com/26.4/images/server_command_example.png)

#### 高级设置

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

| 设置 | 描述 |
| - | - |
| **账号** | 应该向 FTP 服务器显示 Windows 用户帐户的凭据。 |
| **主动模式** | 选中此项以在远程 FTP 服务器上启用主动模式。请记住，被动模式不太可能导致防火墙干扰连接。 |
| **新命令通道** | 指示应用程序使用新命令通道与 FTP 服务器进行通信。 |
| **新数据通道** | 指示应用程序在与 FTP 服务器通信时使用新的数据通道。 |
| **连接池** | 勾选此项让端口使用一个池来访问和存储连接。这在服务器限制登录尝试频率的情况下很有用。 |
| **下载排除扩展名** | 端口不会下载包含这些扩展名的文件，当指定多个扩展名时，使用逗号分隔。 |
| **下载排除前缀** | 端口不会下载包含这些前缀的文件，当指定多个前缀时，使用逗号分隔。 |
| **EPSV** | 选中此项以使用扩展被动模式。如果你需要使用 IPv4 以外的协议，这可能是必需的。 |
| **FSwitch** | 与**简单目录列表**结合使用。选中此项以将目录列表限制为仅文件。 |
| **最大文件下载数** | 在一个轮询间隔内从 FTP 服务器下载的最大文件数。设置为 **-1** 以允许下载所有文件。 |
| **最小文件大小** | 要处理的最小文件大小（以字节为单位）。如果正在上传的文件小于指定大小，则最终确定为 **Skipped**。对于正在下载的文件，端口会添加一个事务日志条目，指示该文件因其大小而被跳过。 |
| **最大文件大小** | 要处理的最大文件大小（以字节为单位）。如果正在上传的文件大于指定大小，则最终确定为 **Skipped**。对于正在下载的文件，端口会添加一个事务日志条目，指示该文件因其大小而被跳过。 |
| **监控文件增长** | 选中此选项可让应用程序在轮询间隔之间存储远程文件的文件大小，并且仅下载大小不变的文件。这可以防止端口下载仍在服务器上写入过程中的文件。 |
| **被动模式地址** | 仅在未选中**主动模式**时使用。如果未选中**被动模式地址**，应用程序将解析远程主机以发送来自先前服务器响应的回复。如果选中此项，应用程序将使用**远程主机**设置的值。 |
| **隐式 TLS 时使用 PROT 命令** | 告诉服务器数据通道受到隐式 TLS 连接的保护。在**设置**选项卡上选择 TLS 类型。 |
| **递归** | 选中此项以下载目标远程路径的子文件夹中的文件。为接收到的文件保留子目录。 |
| **恢复下载** | 如果启用，当文件下载期间发生错误时，端口会存储已下载的文件部分，并在下次尝试下载时尝试下载文件的其余部分。 |
| **恢复上传** | 如果启用，当文件上传期间发生错误时，端口会记录已传输的字节数，并尝试在下一次上传尝试时上传文件的剩余部分。 |
| **简单目录列表** | 当你需要一个简单的目录列表命令用于发送回无法解析的长响应的服务器时，请选中此选项。设置此项后，如果端口仍然无法解析目录列表，请添加 **FSwitch** 设置以将目录列表限制为仅文件。 |
| **启用 TLS 协议** | 建立传出连接时支持的 TLS/SSL 协议列表。最佳做法是仅使用 TLS 协议。请记住，SSLv2 和 SSLv3 被认为存在漏洞，仅在交易伙伴不支持更高版本时使用。请注意，TLS v1.3 尚未被普遍采用，如果目标服务器不支持，可能会被拒绝。 |
| **临时下载扩展名** | 在传输过程中附加到文件下载的临时文件扩展名。 |
| **临时上传扩展名** | 在传输过程中附加到文件上传的临时文件扩展名。 |
| **临时上传路径** | 上传文件的远程 FTP 服务器上的临时路径。传输完成后，文件将移至永久上传路径。 |
| **临时上传前缀** | 在传输过程中添加到文件上传的临时文件前缀。 |
| **超时时间** | 端口在抛出超时错误之前等待连接响应的持续时间。 |
| **传输模式** | 文件应以 ASCII 还是二进制格式传输。如果设置为**默认**，服务器选择传输模式。 |
| **单事务上传** | 选中此项以在单一事务中上传所有文件。默认情况下（未选中），应用程序在每次上传后从服务器注销。 |
| **本地文件命名规则** | 用于为端口输出消息分配文件名的规则。可以在文件名中使用宏动态包含标识符和时间戳等信息。更多信息，请参见[宏](#宏)。 |
| **接收过滤规则** | 一个 glob 模式过滤器，用于确定应从远程存储（例如，\*.txt）下载哪些文件。可以使用否定模式来指示不应下载的文件（例如，-\*.tmp）。当你需要多个**文件掩码**模式时使用此设置。多个模式可以用逗号分隔，后面的过滤器优先，除非找到完全匹配。 |
| **使用 MLSD 进行目录列表** | 选中此项以使用 MLSD 命令返回详细的目录列表。某些旧版 FTP 服务器可能不支持此功能，并可能返回 *Command not understood* 等错误。在旧版服务器上取消选中此项以解决该错误。 |
| **处理延迟** | **事务**选项卡中文件处理延迟的时间（秒）。这是一个旧版设置。最佳做法是[使用 File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/designing-a-flow.md#与本地文件系统交互)来管理本地文件系统，而不是使用此设置。 |

#### 代理设置

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

### 自动化

#### 自动化设置

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

| 设置 | 描述 |
| - | - |
| **上传** | 到达端口的文件是否会自动上传。 |
| **重试间隔（分）** | 再次发送文件之前等待的时长。 |
| **最大重试次数** | 端口处理输入文件的最大次数。是否成功基于服务器的成功确认。如果设置为 0，那么端口将无限次尝试处理失败文件。 |
| **下载** | 端口是否应该为要下载的文件自动轮询远程下载路径。 |
| **间隔** | 自动下载尝试的间隔时间。 |
| **整点后分钟数** | 每小时计划的分钟偏移量。仅当上面的间隔设置为 *每小时* 时适用。例如，如果此值设置为 5，则自动化服务在 1:05、2:05、3:05 等时间下载。 |
| **时间** | 尝试应发生的时间。仅当上面的间隔设置为 *每天*、*每周* 或 *每月* 时适用。 |
| **日期** | 尝试应发生的日期。仅当上面的间隔设置为 *每周* 或 *每月* 时适用。 |
| **分钟数** | 尝试下载之前等待的分钟数。仅当上面的间隔设置为 *分钟* 时适用。 |
| **Cron 表达式** | 一个五位字符串，表示确定尝试发生时间的 Cron 表达式。仅当上面的间隔设置为 *高级* 时适用。 |
| **开始日期和时间** | 自动化首次运行的日期和时间。之后的每次运行都遵循上方的间隔设置。上次和下次运行时间显示在 [自动化状态](#自动化状态) 部分中。 |

#### 自动化状态

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

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

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

![自动化选项卡上的自动化状态卡片，显示已暂停状态、失败的上次处理结果以及下次运行时间](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 通知** 设置。

## 建立一个连接

连接到远程 FTP 服务器需要以下设置：

* **远程主机**
* **TLS 类型**
* **远程主机端口**
* **用户名**
* **密码**

在**高级**选项卡下，FTP 服务器可能还需要**服务器公钥证书**和 [TLS 客户端认证](#tls-客户端认证)。

## 上传文件

FTP 端口从**事务**选项卡上传文件。如果端口中启用了**上传自动化**功能，文件将自动上传到 FTP 服务器。

**远程目录**应设置为远程 FTP 服务器上应上传文件的文件夹。可以使用[宏](#宏)动态创建按日期划分的文件夹（例如年份或月份文件夹）。登录到服务器后，应用程序会将目录更改到指定的文件夹。可以在**高级**选项卡中设置临时上传扩展名、前缀或路径，以确保文件在**远程目录**文件夹中结束之前已被完全传输。

如果有任何文件无法上传，端口会在**重试间隔**分钟后尝试发送它们。此过程一直持续，直到达到**最大重试次数**设置，之后端口将引发错误，文件将不再自动发送。

## 下载文件

下载的文件显示在端口的**事务**选项卡中，或者传递给工作流中的下一个端口。如果端口中启用了**下载自动化**功能，文件将自动从 FTP 服务器上下载，并且可以通过单击**事务**选项卡中的**接收文件**按钮手动下载。

**远程目录**应设置为远程 FTP 服务器上的文件夹，文件应从该文件夹下载。可以使用[宏](#宏)动态创建按日期划分的文件夹（例如年份或月份文件夹）。登录到服务器后，应用程序将目录更改到指定的文件夹。**文件掩码**属性过滤文件，以便只从服务器下载与全局模式匹配的文件名。可以在**高级**选项卡中设置临时下载扩展名或前缀，以确保文件在**事务**选项卡中结束之前已被完全传输。

\*\*删除文件（下载后）\*\*设置可用于在成功下载文件后删除远程服务器上的文件。

完成配置后，文件将会根据**自动下载**的配置下载，或者在**事务**选项卡上手动点击**接收文件**按钮。

## 子目录消息头

如果**递归**被选择，FTP 端口从**远程目录**接收文件时：

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

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

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

## 宏

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

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