> ## 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.
# AS3 端口
> 知行之桥AS3 端口的配置和使用指南，支持通过 FTP 使用具备 AS2 风格安全性的 AS3 协议发送和接收文件。
export const CommonServerCommands = ({extraCommands}) => <>
这些选项允许您在端口执行期间的不同时间在目标服务器上执行自定义命令。
虽然下面描述的命令是普遍接受的，但在尝试使用命令之前，请务必与目标服务器管理员核实，以确保服务器可以接受该命令。
| 设置 | 描述 |
|---|
| After Connect | 连接后直接执行此命令。 |
| After Get | 下载每个文件后执行此命令。 |
| After Put | 上传每个文件后执行此命令。 |
| Before Get | 在下载每个文件之前执行此命令。 |
| Before Put | 在上传每个文件之前执行此命令。 |
以下是当将以下命令包含在上述字段中时可以提交给目标服务器的命令：
• onerror：传递 fail 参数以指示端口将来自自定义脚本的错误视为整个事务的错误。如果没有 fail，端口会记录任何异常并继续处理。
• cd：改变目录。
• mkdir：创建目录。
• rn 或 move：重命名或移动文件。
• del 或 rm：删除文件。
• rmdir：删除目录。
{extraCommands}
知行之桥通过这些命令支持以下宏。它们都使用以下语法：%Macro%。某些宏，例如 %Date% 和 %SourceFilename%，不需要参数，但其他宏则需要。带参数的宏使用以下语法：%Macro:argument%。
| 宏 | 描述 |
|---|
| MsgHeader:headername | 计算消息的消息头值（例如：%MsgHeader:headername%）。 |
| SourceFilename | 计算当前正在处理的文件的文件名（包括扩展名）。 |
| SourceFilenameNoExt | 计算当前正在处理的文件的文件名（不带扩展名）。 |
| Date | 以 yyyy-MM-dd 格式计算文件的上次修改日期（例如 2024-02-13）。 |
| DateTime | 以 yyyy-MM-dd'T'HH:mm:ss 格式计算文件上次修改的日期时间（例如 2024-02-13T08:14:22）。 |
| Time | 以 HH:mm:ss 格式计算文件的上次修改时间（例如 08:14:22）。 |
| DateTime.tz | 以 yyyy-MM-dd'T'HH:mm:ss zzz 格式计算文件上次修改的日期时间（例如 2024-02-13T08:14:22 PST）。 |
| Time.tz | 以 HH:mm:ss zzz 格式计算文件的上次修改时间（例如 08:14:22 PST）。 |
| DateFormat:format | 以指定格式（format）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 示例日期格式。 |
示例：下载后，您希望将每个文件从下载文件夹移动到 History 子文件夹。使用 After Get 字段为 move 命令提供 %SourceFilename% 宏。
;
export const CommonProxySettings = () => <>
这是一组用于识别连接所经代理并对其进行身份验证的设置。默认情况下，本节使用 安全设置 页面的 代理设置 部分中的全局设置。清除此复选框可为您的端口提供特定的设置。
| 设置 | 描述 |
|---|
| 代理类型 |
基于代理的防火墙使用的协议。 |
| 代理主机 |
基于代理的防火墙的名称或 IP 地址。 |
| 代理端口 |
基于代理的防火墙的 TCP 端口。 |
| 代理用户 |
用于通过基于代理的防火墙进行身份验证的用户名。 |
| 代理密码 |
用于对基于代理的防火墙进行身份验证的密码。 |
| 身份验证方案 |
保留默认值 None 或选择以下身份验证方案之一：Basic、Digest、Proprietary 或 NTLM。 |
;
export const CommonCacheCleanup = () => <>
知行之桥会自动清理资源缓存。此过程在每次接收周期的后台运行，删除远程服务器上已不存在的文件对应的过期缓存条目。这使得缓存大小始终保持在可管理范围内，无需任何手动操作。
默认情况下，文件保留 30 天，但您可以在高级选项卡的其他设置字段中使用 ResourceCacheRetentionDays 设置来调整保留时间以适应您的环境。例如，ResourceCacheRetentionDays=15 表示文件保留 15 天后将被删除。
;
export const SlasTab = ({siteName = "知行之桥"}) => <>
与配置服务级别协议 (SLA) 相关的设置。
SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，{siteName} 会发送电子邮件警告用户，并将 SLA 标记为 存在风险，这意味着如果 SLA 未能尽快达到，则会被标记为 已违反。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为已违反，并再次通知用户。
要定义 SLA，请启用 预期数据量，然后点击 设置 选项卡。
- 如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。
- 在窗口的 预计至少 部分中：
- 设置预计处理的最小事务数量（交易量）
- 使用 每个 字段指定时间范围
- 指示 SLA 生效的时间。如果选择 开始于，请填写日期和时间字段。
- 勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择 每天。
- 在窗口的 将状态设置为“有风险” 部分中，指定应将 SLA 标记为有风险的时间。
- 默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选 发送“有风险”通知。
以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。
如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的 设置，然后跳转到 通知 > 通用通知。点击平板和铅笔图标进行编辑，并取消勾选 SLA 通知 设置。
;
export const AlertsTab = ({siteNameShort = "知行之桥"}) => <>
与配置通知相关的设置。
在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，{siteNameShort} 使用 通知 选项卡上的全局设置。要为此端口使用其他设置，请启用 覆盖全局设置。
默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中 启用 复选框。
输入 主题（必填），然后（可选）输入以逗号分隔的 收件人 电子邮件列表。
;
export const Message = () => <>
消息设置确定端口如何搜索消息并在处理后管理它们。
| 设置 | 描述 |
|---|
| 保存到已发送文件夹 |
选中此项可将端口处理的文件复制到该端口的“已发送”文件夹中。 |
| 已发送文件夹方案 |
端口根据选定的时间间隔对 已发送 文件夹中的文件进行分组。例如，Weekly 选项指示端口每周创建一个新的子文件夹，并将本周发送的所有文件存储在该文件夹中。空白设置告诉端口将所有文件直接保存在 已发送 文件夹中。对于处理许多事务的端口，使用子文件夹可以帮助保持文件有序并提高性能。 |
;
export const MiscConnector = () => <>
特殊设置适用于特定用例。
| 设置 |
描述 |
| 其他设置 |
允许在以分号分隔的列表中配置隐藏的端口设置，例如 setting1=value1;setting2=value2。正常的端口用例和功能不需要使用这些设置。 |
;
export const Logging = () => <>
用于管理日志创建和存储的设置。
| 设置 |
描述 |
| 日志级别 |
指定要记录在端口日志目录中的信息类型：
- None - 不创建任何日志。
- Error - 仅当端口遇到错误时才创建日志。
- Warning - 仅当端口发出警告时才创建日志。
- Info - 记录工作流的一般信息，包括任何错误和警告（如果适用）。
- Debug - 记录成功和失败工作流的详细调试信息。
- Trace - 记录成功和失败工作流的详细跟踪信息。
请注意：Debug 和 Trace 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。 |
| 日志文件夹结构 |
指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，Weekly 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。 |
| 保留消息副本 |
指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。 |
;
export const MacrosExamples = ({extraMacros = []}) => <>
某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。所有带有参数的宏都使用以下语法：%Macro:argument%
以下是带有参数的宏的一些示例：
- %Header:headername%：其中
headername 是消息上消息头的名称。
- %Header:mycustomheader% 解析为输入消息上设置的
mycustomheader 消息头的值。
- %Header:ponum% 解析为输入消息上设置的
ponum 消息头的值。
- %RegexFilename:pattern%：其中
pattern 是正则表达式模式。例如，%RegexFilename:^([\w][A-Za-z]+)% 匹配并解析为文件名中的第一个单词，并且不区分大小写（test_file.xml 解析为 test）。
- %Vault:vaultitem%：其中
vaultitem 是 vault 中项目的名称。例如，%Vault:companyname% 解析为存储在保管库中的 companyname 项的值。
- %DateFormat:format%：其中
format 是可接受的日期格式（有关详细信息，请参阅 示例日期格式）。例如，%DateFormat:yyyy-MM-dd-HH-mm-ss-fff% 解析为文件上的日期和时间戳。
{extraMacros.filter(item => item.example).map(item => - {item.example}
)}
还可以创建更复杂的宏，如以下示例所示：
- 将多个宏组合在一个文件名中：
%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%
- 包括宏之外的文本：
MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%
- 在宏中包含文本：
%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%
;
export const MacrosTable = ({siteName = "知行之桥", extraMacros = []}) => <>
在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。
{siteName} 支持这些宏，它们都使用以下语法：%Macro%。
| 宏 | 描述 |
|---|
| ConnectorID | 替换为端口的 ConnectorID。 |
| Ext | 替换为端口当前正在处理的文件的文件扩展名。 |
| Filename | 替换为端口当前正在处理的文件的文件名（包括扩展名）。 |
| FilenameNoExt | 替换为端口当前正在处理的文件的文件名（不带扩展名）。 |
| MessageId | 计算端口输出的消息的 MessageId。 |
| RegexFilename:pattern | 将正则表达式模式应用于端口当前正在处理的文件的文件名。 |
| Header:headername | 替换为端口正在处理的当前消息的目标消息头（headername）的值。 |
| LongDate | 以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。 |
| ShortDate | 以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。 |
| DateFormat:format | 以指定格式（format）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 示例日期格式。 |
| Vault:vaultitem | 计算指定保管库项目的值。 |
{extraMacros.map(item =>
| {item.name} |
{item.description} |
)}
;
export const Performance = () => <>
与端口资源分配相关的设置。
| 设置 |
描述 |
| 最大工作线程数 |
此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 高级设置 页面的 性能设置 部分的默认设置。 |
| 最大文件数 |
分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 高级设置 页面的 性能设置 部分的默认设置。 |
;
export const siteNameShort = "知行之桥";
export const siteName = "知行之桥";
AS3 端口支持使用 Applicability Statement 3 (AS3) 协议发送和接收文件。
## 核心功能
* 结合 FTP 协议与 [AS2](./as2) 风格安全性的安全文件传输
* 支持数字加密和签名以增强安全性
* 生成并处理 MDN 回执，用于可靠的交付确认
* 支持带过滤功能的上传和下载操作
* 支持 TLS/SSL，并具备客户端认证能力
## 概述
每个 AS3 端口都配置为与单个 AS3 交易伙伴交换文件。AS3 端口使用 FTP 协议传输文件，并通过数字加密和签名增加安全性和验证。配置 AS3 交易关系需要交换 AS3 专用的配置文件详情，例如 AS3 ID 和数字证书，以及目标 FTP 服务器的连接详情。
## 端口配置
本节包含所有可配置的端口属性。
### 设置 Tab
#### 交易伙伴信息
*用于识别并连接到特定 AS3 交易伙伴的设置。*
| 设置 | 说明 |
| ---------- | ------------------------ |
| **端口 ID** | 端口的静态唯一标识符。 |
| **端口类型** | 显示端口名称及其功能说明。 |
| **端口描述** | 可选字段，用于自由描述端口及其在工作流中的作用。 |
| **AS3 ID** | 目标交易伙伴专用的 AS3 标识符。 |
#### 本地配置文件
*用于标识本地 AS3 配置文件的设置。*
| 设置 | 说明 |
| ------------- | ------------------- |
| **本地 AS3 ID** | 你的 AS3 标识符。 |
| **私钥证书** | 用于解密传入消息并签名传出消息的证书。 |
| **证书密码** | 访问本地私钥证书所需的密码。 |
#### 连接信息
*与目标 FTP 服务器连接参数相关的设置。*
| 设置 | 说明 |
| ----------- | ------------------------------------------------------------------------------------------------------------ |
| **主机** | FTP 服务器的主机名或 IP 地址。 |
| **端口** | 连接 FTP 服务器所用的端口。 |
| **用户** | 登录 FTP 服务器的用户名凭据。 |
| **密码** | 登录 FTP 服务器的密码凭据。 |
| **TLS 类型** | 连接服务器时如何协商 TLS/SSL。选择 **Explicit** 时，将先建立纯文本连接，然后通过显式命令启动 TLS/SSL。选择 **Implicit** 时，不建立纯文本连接，而是立即协商 TLS/SSL。 |
| **消息发送安全性** | 是否签名和/或加密传出的 AS3 消息。强烈建议使用签名和加密。 |
| **消息接收安全性** | 是否要求传入的 AS3 消息包含签名和加密。如果收到的消息缺少必需的安全参数，将引发错误。 |
| **压缩** | 是否压缩传出消息的负载。 |
| **连接超时时间** | 端口在抛出超时错误之前等待连接响应的时长（秒）。 |
#### MDN 回执
*与发送 AS3 消息时请求 MDN 相关的设置。*
| 设置 | 说明 |
| ------------- | ---------------------------------------- |
| **请求 MDN 回执** | 是否应返回 MDN 回执以响应传出的 AS3 消息。强烈建议请求 MDN 回执。 |
| **MDN 路径** | 伙伴上传 MDN 回执的服务器文件夹路径。 |
| **安全性** | MDN 回执是否应包含签名块，以验证消息完整性和接收者身份。强烈建议使用此选项。 |
#### 上传
*与如何上传传出的 AS3 消息相关的设置。*
| 设置 | 说明 |
| -------- | ------------------------- |
| **远程路径** | 传出消息应上传到的远程 FTP 服务器文件夹路径。 |
#### 下载
*与如何下载传入的 AS3 消息相关的设置。*
| 设置 | 说明 |
| -------- | ----------------------------------------- |
| **远程路径** | 下载传入消息的远程 FTP 服务器文件夹路径。 |
| **文件掩码** | 用于确定应下载**远程路径**中哪些文件的 glob 模式（例如 \*.txt）。 |
| **删除文件** | 成功下载文件后，是否应从 FTP 服务器删除这些文件。 |
#### 交易伙伴证书
*与交易伙伴提供的公钥证书相关的设置。*
| 设置 | 说明 |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **加密证书** | 发送消息时用于 AS3 加密的公钥证书。该证书必须与交易伙伴的私钥证书配对，交易伙伴在共享 AS3 配置详情时应提供此公钥证书。 |
| **验证证书** | 接收消息时用于验证 AS3 签名的公钥证书。此字段通常不是必需的；大多数 AS3 参与方使用同一个私钥证书进行签名和解密。如果未指定此字段，应用程序将使用**加密证书**验证签名。 |
| **TLS 服务器证书** | 用于验证 SSL/TLS 服务器身份的公钥证书。仅当 FTP 服务器要求 FTPS（基于 TLS/SSL 的 FTP）时才需要。如果交易伙伴未提供 TLS 服务器证书，可以将此设置留空，以允许底层 OS/JVM 执行证书验证；也可以将其设置为 `Any Certificate`，以无条件信任目标服务器的身份。 |
### 高级 Tab
#### 本地配置文件
*需要双向 SSL 认证时，与客户端认证相关的设置。*
| 设置 | 说明 |
| ---------- | -------------------------------------------- |
| **使用配置文件** | 是否使用“配置文件”页面上配置的**私钥证书**作为客户端认证的 TLS 证书。 |
| **私钥证书** | TLS 客户端认证期间提供的私钥证书。仅当不使用“配置文件”页面中的同一私钥证书时适用。 |
| **证书密码** | 访问 TLS 客户端证书所需的密码。 |
#### 服务器命令
#### 高级设置
*先前类别中未包含的设置。*
| 设置 | 说明 |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| **主动模式** | 在远程 FTP 服务器上启用主动模式还是被动模式。被动模式较少受到防火墙对连接的干扰。 |
| **明文命令通道** | 选中此项可使用明文通道而不是加密通道发送 FTP 命令。 |
| **明文数据通道** | 选中此项可让应用程序在与 FTP 服务器通信时使用明文数据通道。 |
| **加密算法** | 加密传出 AS3 消息时使用的算法。 |
| **EPSV** | 选中此项可使用扩展被动模式。如果需要使用 IPv4 以外的协议，这可能是必要的。 |
| **排除扩展名** | 端口不应处理的文件扩展名列表，用逗号分隔。 |
| **FSwitch** | 与 **Simple Dir List** 结合使用。选中此项可将目录列表限制为仅包含文件。 |
| **本地文件命名方案** | 为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏，以包含标识符、时间戳等信息。更多信息，请参阅[宏](#宏)。 |
| **隐式 TLS 的 PROT 命令** | 告诉服务器数据通道受隐式 TLS 连接保护。在**设置** Tab 上选择 TLS 类型。 |
| **被动模式远程主机地址** | 仅在未设置**主动模式**时适用。留空时，应用程序将从先前服务器响应中解析远程主机以发送回复。选中此项后，应用程序将改用 RemoteHost 设置的值。 |
| **签名算法** | 签名传出消息时使用的算法。相应的 MDN 回执也会请求使用同一算法。 |
| **Simple Dir List** | 当服务器返回无法解析的长响应，因而需要简单目录列表命令时，选中此项。设置后，如果端口仍无法解析目录列表，请添加 **FSwitch** 设置，将目录列表限制为仅包含文件。 |
| **启用的 TLS 协议** | 建立传出连接时支持的 TLS/SSL 协议列表。最佳实践是仅使用 TLS 协议。SSL v2 和 SSL v3 被认为存在漏洞，只有在伙伴不支持更高版本时才应使用。请注意，TLS v1.3 尚未被普遍采用，如果目标服务器不支持，可能会被拒绝。 |
| **处理延迟** | 放入**交易** Tab 的文件延迟处理的时间（秒）。这是一个旧设置。最佳实践是[使用文件端口](../flows/designing-a-flow#interacting-with-the-local-file-system)来管理本地文件系统，而不是使用此设置。 |
#### 代理设置
#### 消息
#### 日志
#### 其他
### 自动化 Tab
#### 自动化设置
*与端口自动处理文件相关的设置。*
| 设置 | 说明 |
| -------------- | --------------------------------------------------------------------------------------------------------- |
| **上传** | 到达端口的文件是否应自动上传。 |
| **重试间隔** | 重试失败上传前等待的分钟数。 |
| **最大尝试次数** | 端口处理输入文件的最大次数。是否成功取决于服务器成功确认以及回执验证（同步请求回执时）。如果设置为 0，端口将无限期重试该文件。 |
| **重发间隔** | 重新发送未确认消息前等待的分钟数。当服务器收到文件，但未在预期时间范围内提供异步 MDN 回执时，将触发重发。 |
| **最大尝试次数（异步）** | 请求异步回执时，端口处理输入文件的最大次数。是否成功取决于服务器成功确认后，异步回执是否在**重发间隔**内返回。如果未返回成功的服务器确认，则改用**最大尝试次数**。如果设置为 0，端口将无限期重发该文件。 |
| **接收** | 端口是否应自动轮询远程下载路径以查找要下载的文件。 |
| **间隔** | 自动下载尝试之间的间隔。 |
| **整点后分钟数** | 小时计划的分钟偏移量。仅当上述间隔设置为\_每小时\_时适用。例如，如果此值设置为 5，自动化服务将在 1:05、2:05、3:05 等时间下载。 |
| **时间** | 尝试发生的具体时间。仅当上述间隔设置为\_每天\_、\_每周\_或\_每月\_时适用。 |
| **日期** | 尝试发生的日期。仅当上述间隔设置为\_每周\_或\_每月\_时适用。 |
| **分钟数** | 尝试下载前等待的分钟数。仅当上述间隔设置为\_分钟\_时适用。 |
| **Cron 表达式** | 表示 cron 表达式的五段字符串，用于确定尝试发生的时间。仅当上述间隔设置为\_高级\_时适用。 |
#### 性能
### 警报 Tab
### SLA Tab
## 建立连接
要连接到远程 FTP 服务器，请指定服务器所需的**主机**、**端口**、**用户**、**密码**和 **TLS 类型**。使用**测试连接**按钮验证连接参数是否正确。
连接后，请设置上传和下载的**远程路径**，以便从适当位置放置和读取文件，从而与交易伙伴通信。
## 自动缓存清理
同样的缓存清理过程也适用于 [MDN 回执](#mdn-回执)。
## 宏
### 示例