AS3 端口

Version 23.4.8843


AS3 端口


AS3 端口支持通过 AS3 协议发送和接收文件。

概览

为每个 AS3 交易伙伴单独配置 AS3 端口用以传输文件。AS3 端口使用 FTP 协议传输文件,并通过数字加密和签名来增加安全性和验证。配置 AS3 交易伙伴需要交换 AS3 的配置文件详情,例如 AS3 ID 和数字证书,以及目标 FTP 服务器的连接详情。

端口配置

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

设置

交易伙伴信息

用于识别和连接到特定 AS3 交易伙伴的设置。

  • 端口 Id 端口的静态、唯一标识符。
  • 端口类型 显示端口类型及其用途的描述。
  • 端口描述 一个可选字段,用于提供端口及其在流中的角色的自由格式描述。
  • AS3 ID 交易伙伴专用的 AS3 标识符。

个人设置

标识本地 AS3 配置文件的设置。

  • 本地 AS3 ID 此端口的 AS3 ID。
  • 私钥证书 该证书将用于解密接收消息和签名发送消息。
  • 证书密码 本地私钥证书密码。

连接信息

设置与目标 FTP 服务器相关的连接参数。

  • 远程主机 FTP 服务器的主机名或 IP 地址。
  • 端口 连接到 FTP 服务器的端口。
  • 用户 登录 FTP 服务器的用户名凭证。
  • 密码 登录到 FTP 服务器的密码。
  • TLS 类型 连接到服务器如何协商 TLS/SSL。当设置为 ‘Explicit’ 时,将建立纯文本连接,然后使用显示命令启动 TLS/SSL。设置为 ‘Implicit’ 时,无需先建立纯文本连接即可立即协商 TLS/SSL。
  • 消息发送安全性 是否签名和加密发送的 AS3 消息。强烈建议签名和加密。
  • 消息接收安全性 是否要求接收的 AS3 消息存在签名和加密。如果收到额消息没有必需的安全性参数,将抛出错误。
  • 压缩 是否压缩要发送的消息。
  • 连接超时时间 端口在抛出超时错误之前,等待连接响应的时长。

MDN 回执

与发送 AS3 消息时请求 MDN 相关的设置。

  • 请求 MDN 回执 对于已发送的 AS3 消息是否要求回复 MDN 回执。强烈建议请求 MDN 回执。
  • MDN 路径 合作伙伴上传 MDN 收据的服务器上的文件夹路径。
  • 安全性 MDN 回执是否应该被签名,以验证消息的接受者的身份。强烈建议使用 MDN 安全性设置。

上传

与如何上传发送的 AS3 消息相关的设置。

  • 远程目录 应该将发送的文件上传到的远程 FTP 服务器文件夹路径。

下载

与如何下载接收的 AS2 消息相关的设置。

  • 远程目录 下载文件的远程 FTP 服务器上的文件夹。
  • 文件掩码远程文件夹下载的文件需满足的全局表达式 (如 *.txt)。如果需要多个过滤条件,请使用高级设置界面的下载过滤
  • 删除文件(下载后) 成功下载文件后是否从 FTP 服务器删除原文件。

交易伙伴证书

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

  • 加密证书 发送消息时用于 AS3 加密的公钥证书。该证书必须与交易伙伴的专用解密证书匹配,并且交易伙伴在共享 AS3 配置信息时应提供此公钥证书。
  • 验证证书 接收消息时用于验证 AS3 签名的公钥证书。该字段通常不是必需的。大多数 AS3 交易方将使用想用的证书进行签名和解密,如果未指定该证书,则应用程序将使用加密证书来验证签名。
  • TLS 服务器证书 用于验证 TLS/SSL 服务器身份的公钥证书。仅当 FTP 服务器需要 FTPS (基于 TLS/SSL 的 FTP)时才需要。如果交易伙伴不提供 TLS 服务器证书,此设置可以留空,以允许底层 OS/JVM 执行证书验证,或者将其设置为 “Any Certificate”,以无条件信任目标服务器的身份。

自动化

自动化设置

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

  • 上传 是否将到达端口的文件自动上传到远程 FTP 服务器。
  • 重试间隔 重试发送失败文件之前的时间。当发送尝试未得到服务器的回复,或者回复一个否定的响应表示未收到文件时,将触发重试。
  • 最大重试次数 端口处理输入文件的最大次数。是否成功基于服务器相应和回执的验证(如需要回执)。如果设置为 0,那么端口将无限次尝试处理失败文件。
  • 重发间隔 重新发送未确认的消息之前的时间。服务器收到文件后未在预期的时间范围内提供 MDN 回执,将会触发重新发送。
  • 最大重发尝试次数(异步) 如果需要异步回执时,端口处理输入文件的最大次数。是否成功基于服务器在正确相应后异步回执是否在重发间隔内返回(如果服务器没有正确响应,那么最大重试次数会被使用)。如果设置为 0,那么端口将无限次尝试处理失败文件。
  • 下载 端口是否应自动轮询远程下载路径以查找要下载的文件。
  • 下载间隔 自动下载尝试之间的间隔。
  • 每次执行等待的分钟数。仅当执行间隔被设置为 Minute 时适用。
  • 第几分钟/小时 每小时计划的分钟偏移量。仅当执行间隔被设置为 Hourly 时适用。例如,如果将此值设置为 5,将在 1:05、2:05、3:05 自动执行脚本。
  • 在指定的某一天内进行消息处理的时间。仅当执行间隔被设置为 DailyWeeklyMonthly 时适用。
  • 进行消息处理的某一天。仅当执行间隔被设置为 WeeklyMonthly 时适用。
  • Cron 表达式 表示 cron 表达式的任意字符串,用于确定何时执行。仅当执行间隔被设置为 Advanced 时适用。

性能

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

  • 最大线程数 从线程池中消耗用于处理此端口上的文件的最大工作线程数。 如果设置,这将覆盖 设置 > 自动化 页面上的默认设置。
  • 最大文件数 分配给端口的每个线程发送的最大文件数。 如果设置,这将覆盖 设置 > 自动化 页面上的默认设置。

通知

与配置警报和服务等级协议 (SLA) 相关的设置。

端口邮件设置

在执行 SLA 之前,需要设置电子邮件警报以获取通知。 单击 配置通知 将打开一个新的浏览器窗口,转到 系统设置,可以在其中设置系统范围的警报。 有关详细信息,请参阅通知

服务等级协议 (SLA) 配置

SLA 能够配置期望工作流中的端口发送或接收的数量,并设置期望满足该数量的时间范围。 知行之桥在不满足 SLA 时发送电子邮件警告用户,并将 SLA 标记为 有风险,这意味着如果很快不满足 SLA,则会将其标记为 已违反。 这使用户有机会介入并确定未满足 SLA 的原因,并采取适当的措施。 如果在风险时间段结束时仍未满足 SLA,则将 SLA 标记为违反,并再次通知用户。

要定义 SLA,请单击 添加预期数量条件

  • 如果端口具有单独的发送和接收操作,请使用单选按钮指定 SLA 所属的方向。
  • 期待至少 设置为期望处理的最小交易数量(交易量),然后使用 字段指定时间范围。
  • 默认情况下,SLA 每天都有效。 要更改此设置,请取消选中每日,然后选中想要的一周中的几天的框。
  • 使用 将状态设置为“有风险” 来指示何时应将 SLA 标记为存在风险。
  • 默认情况下,在违反 SLA 之前不会发送通知。 要更改此设置,请选中 发送“有风险”通知

以下示例显示为预计周一至周五每天接收 1000 个文件的端口配置的 SLA。 如果尚未收到 1000 个文件,则会在该时间段结束前 1 小时发送风险通知。

高级设置

TLS 客户端认证

需要双向 TLS 认证时,与客户端认证有关的设置。

  • 使用配置文件 是否使用配置文件页面上配置的私有证书作为客户端身份验证的 TLS 证书。
  • 私有证书 TLS 客户端身份验证期间提供的私有证书。 仅当未使用“个人设置”页面中的相同私有证书时才适用。
  • 证书密码 TLS 客户端身份认证证书的密码。

服务器命令

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

  • After Connect 连接后直接执行此命令。
  • After Get 下载每个文件后执行此命令。
  • After Put 上传每个文件后执行此命令。
  • Before Get 在下载每个文件之前执行此命令。
  • Before Put 在上传每个文件之前执行此命令。

注意:在处理过程中,宏 %SourceFilename% 和 %SourceFilenameNoExt% 解析为当前文件的名称和不带扩展名的当前文件的名称。

示例:下载后,你需要将每个文件从下载文件夹移动到历史子文件夹。 使用 After Get 字段提供 move 命令。

可用命令如下所述:

  • onerror:传递 fail 参数以指示端口将来自自定义脚本的错误视为整个事务的错误。 如果没有 fail,端口会记录任何异常并继续处理。
  • cd: 改变目录。
  • mkdir: 创建目录。
  • rnmove:重命名或移动文件。
  • delrm:删除或删除文件。
  • rmdir: 删除目录。

代理设置

这些是一组设置的集合,用于识别和验证代理(AS3 连接应通过该代理进行路由)。 默认情况下,此部分使用设置页面上的全局设置。 清除该复选框可提供特定于的 AS3 端口的设置。

  • 代理类型 基于代理的防火墙使用的协议。
  • 代理主机 基于代理的防火墙的名称或 IP 地址。
  • 代理端口 基于代理的防火墙的 TCP 端口。
  • 代理用户 用于通过基于代理的防火墙进行身份验证的用户名。
  • 代理密码 用于对基于代理的防火墙进行身份验证的密码。
  • 身份验证方案 保留默认值 None 或选择以下身份验证方案之一:BasicDigestProprietaryNTLM

高级设置

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

  • 主动模式 在远程 FTP 服务器上启用主动模式还是被动模式。被动模式下的连接较少受防火墙的干扰。
  • 明文命令通道 选中此项可使用明文通道而不是加密通道发送 FTP 命令。
  • 清除数据通道 选中此项可以让应用程序在与 FTP 服务器通信时使用清除数据通道。
  • 加密算法 加密发送的 AS3 消息时使用的算法。
  • EPSV 选中此项以使用扩展被动模式。 如果需要使用 IPv4 以外的协议,这可能是必要的。
  • 排除扩展名 端口将不会处理的文件包含的扩展名列表,需用逗号分隔。
  • 本地文件名格式 用于为端口输出的消息分配文件名的方案。 可以在文件名中动态使用宏来包含标识符和时间戳等信息。 有关详细信息,请参阅
  • 延迟处理 放置在输入文件夹中的文件的处理延迟的时间量(以秒为单位)。 这是一个遗留设置。 最佳实践是使用 File 端口 来管理本地文件系统,而不是此设置。
  • 隐式 TLS 时使用 PROT 命令 告诉服务器数据通道受到隐式 TLS 连接的保护。 在 设置 选项卡上选择 TLS 类型。
  • 被动远程主机地址 仅在未设置 主动模式 时适用。 保留空白以使应用程序解析远程主机以发送来自先前服务器响应的回复。 选中此项后,应用程序将使用 RemoteHost 设置的值。
  • 签名算法 签名发送消息时使用的算法。
  • 启用 TLS 建立传输连接时支持的 TLS/SSL 协议列表。强烈建议仅使用 TLS 协议。某些过时的操作系统不支持 TLS1.2。

消息

消息设置 确定端口如何搜索消息并在处理后管理它们。 可以将邮件保存到你的 已发送 文件夹,或者可以根据 已发送 文件夹方案将它们保存,如下所述。

  • 保存至 Sent 文件夹 切换为端口在已发送文件夹中保留已发送邮件副本。
  • 已发送文件夹方案 端口根据选定的时间间隔对已发送文件夹中的文件进行分组。例如,选项每周(Weekly)指示端口每周创建一个新的子文件夹,并将本周发送的所有文件存储在该文件夹中。空白设置告诉端口将所有文件直接保存在“Sent”文件夹中。对于处理许多事务的端口,使用子文件夹可以帮助保持文件有序并提高性能。

日志

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

  • 日志级别 端口生成的日志的详细程度。 当请求支持时,请将其设置为 Debug
  • 日志子文件夹方案 指端口根据选定的时间间隔对日志文件夹中的文件进行分组。 例如,Weekly 选项表示端口每周创建一个新子文件夹并将该周的所有日志存储在该文件夹中。 空白设置告诉端口将所有日志直接保存在 Logs 文件夹中。 对于处理大量事务的端口,使用子文件夹有助于保持日志井井有条并提高性能。
  • 日志消息 选中此项可使已处理文件的日志条目包含文件本身的副本。 如果禁用此功能,可能无法从 输入输出 选项卡下载文件的副本。

特殊设置

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

  • 其他设置 允许在以分号分隔的列表中配置隐藏的端口设置,例如setting1=value1;setting2=value2。 正常的端口用例和功能不需要使用这些设置。

建立连接

要连接到远程 FTP 服务器,请指定服务器所需的远程主机端口用户名密码TLS 类型测试连接按钮可以验证连接参数是否正确。

连接后,应指定上传和下载的远程目录,以便可以从远程服务器上正确的位置下载文件并将下载后的文件放到正确的位置,保证和交易伙伴的通信。

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

ArcCN 支持这些宏,它们都使用以下语法:%Macro%

描述
ConnectorID 替换为端口的 ConnectorID。
Ext 替换为端口当前正在处理的文件的文件扩展名。
Filename 替换为端口当前正在处理的文件的文件名(包括扩展名)。
FilenameNoExt 替换为端口当前正在处理的文件的文件名(不带扩展名)。
RegexFilename:pattern 将正则表达式模式应用于端口当前正在处理的文件的文件名。
Header:headername 替换为端口正在处理的当前消息的目标标头 (headername) 的值。
LongDate 以常规格式计算系统的当前日期时间(例如,2024 年 1 月 24 日星期三)。
ShortDate 以 yyyy-MM-dd 格式计算系统的当前日期时间(例如 2024-01-24)。
DateFormat:format 以指定格式(format)计算系统的当前日期时间。 有关可用的日期时间格式,请参阅示例日期格式
Vault:vaultitem 计算指定保管库项目的值。

示例

某些宏(例如 %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%:其中 vaultitemvault 中项目的名称。 例如,%Vault:companyname%解析为存储在保管库中的companyname项的值。
  • %DateFormat:format%:其中 format 是可接受的日期格式(有关详细信息,请参阅示例日期格式)。 例如,%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%解析为文件上的日期和时间戳。

还可以创建更复杂的宏,如以下示例所示:

  • 将多个宏组合在一个文件名中:%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%