SCP 端口

Version 24.3.9118


SCP 端口


SCP 端口通过 Secure Copy Protocol connector (SCP) 在 SSH 服务器之间传输文件。

总览

SCP 端口将文件上传连接到指定的文件夹,并从远程 SSH 服务器上的文件夹中下载文件。

到达知行之桥工作流中 SCP 端口的文件被上传到目标文件夹中,在下载目标文件夹中的文件被下载并进入知行之桥工作流。端口支持上传和下载筛选器,以便仅发送和接收指定的文件名和/或文件扩展名。

端口配置

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

设置

主机配置

与建立与远程 SSH 主机的连接相关的设置。

  • 端口 Id 端口的静态、唯一标识符。
  • 端口类型 显示端口类型及其用途的描述。
  • 端口描述 一个可选字段,用于提供端口及其在流中的角色的自由格式描述。
  • 远程主机 SSH 服务器的主机名或 IP 地址。
  • 远程端口 连接 SSH 服务器的端口。

客户端认证

与 SSH 服务器认证有关的设置。

  • 认证方式 SSH 服务器使用的身份验证类型。
  • 用户名 登录 SSH 服务器的用户名。
  • 密码 登录 SSH 服务器的密码。
  • 客户端证书 公钥认证期间要使用的私钥的证书。
  • 证书密码 访问“客户端证书”所需的密码。

服务器认证

与验证 SSH 服务器身份有关的设置。

  • 服务器指纹 标识 SSH 服务器证书的指纹。这也可以设置为包含服务器公钥的证书文件。测试连接时,端口将提示接受/信任服务器提供的指纹。

上传

与将文件上传到 SSH 服务器相关的设置。

  • 远程目录 端口处理的文件将被上传到指定的远程文件夹。

下载

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

  • 远程目录 从中下载文件的远程文件夹。如果要从多个文件夹下载,请使用逗号分隔指定的文件夹。
  • 文件掩码 全局匹配模式,用于确定应该下载远程目录中的哪些文件(例如,*.txt)。
  • 删除文件(下载后) 之后是否应从 SSH 服务器中删除已成功下载的文件。

自动化

自动化设置

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

  • 上传 是否自动上传文件到该端口。
  • 重试间隔 失败的上传重试之前的时间间隔。
  • 最大重试次数 端口处理输入文件的最大次数。是否成功基于服务器相应和回执的验证(如需要回执)。如果设置为 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 小时发送风险通知。

高级设置

代理设置

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

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

高级设置

其它设置

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

  • 删除命令 下载后删除文件时使用的命令。
  • 延迟处理 放置在输入文件夹中的文件的处理延迟的时间量(以秒为单位)。 这是一个遗留设置。 最佳实践是使用 File 端口 来管理本地文件系统,而不是此设置。
  • 递归子目录 是否下载目标远程目录子文件夹中的文件。
  • SSH 加密算法 包含所有允许的加密算法的逗号分隔列表。默认情况下,所有的加密算法都已启用。支持以下加密算法:

    aes256-ctr, aes256-cbc, aes192-ctr, aes192-cbc, aes128-ctr, aes128-cbc, 3des-ctr, 3des-cbc, cast128-cbc, blowfish-cbc, arcfour, arcfour128, arcfour256, aes128-gcm@openssh.com, aes256-gcm@openssh.com, chacha20-poly1305@openssh.com
  • 本地文件名格式 用于为端口输出的消息分配文件名的方案。 可以在文件名中动态使用宏来包含标识符和时间戳等信息。 有关详细信息,请参阅
  • 超时 端口在引发超时错误之前等待连接响应的持续时间。
  • 文件上传权限 对端口上传文件设置的文件权限。

消息

  • 保存至 Sent 文件夹 选中此选项可将端口处理的文件复制到端口的已发送文件夹中。
  • 已发送文件夹方案 指示端口根据选定的时间间隔对已发送文件夹中的消息进行分组。 例如,Weekly 选项指示端口每周创建一个新的子文件夹,并将该周的所有消息存储在该文件夹中。 空白设置告诉端口将所有消息直接保存在“已发送”文件夹中。 对于处理许多消息的端口,使用子文件夹有助于保持消息的组织性并提高性能。

日志

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

特殊设置

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

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

建立连接

连接到远程 SSH 服务器需要以下设置:

  • 远程主机
  • 远程端口
  • 认证模式
  • 用户名
  • 密码或客户端证书/证书密码
  • 服务器指纹

测试与服务器的连接时,端口将提示接受/信任服务器公钥的指纹。

上传文件

SCP 端口从Send 文件夹上传文件。如果端口启用了自动上传,文件将自动上传到 SSH 服务器。

远程目录应设置为远程 SSH 服务器上传文件的文件夹。登录服务器后,应用程序将目录更改为指定的文件夹。

如果无法上传任何文件,则端口将在重试间隔配置的分钟数后再次尝试发送。此过程将持续进行,直到达到最大重试次数配置的次数,此后端口将抛出错误,并且文件将不再自动发送。

下载文件

下载的文件显示在端口的 “输入文件夹”中,或转发到工作流中的下一个端口。如果在端口中启用了“自动下载”功能,将从 SSH 服务器自动下载文件,并且可以通过单击“输出”选项卡中的接收按钮来手动下载文件。

远程目录设置为远程 SSH 服务器上的文件夹,从中下载文件。应用程序在登录到服务器后将目录更改为指定的文件夹。文件掩码过滤文件,以便仅从服务器下载与全局模式匹配的文件名。

覆盖本地文件决定是否应覆盖 “输入文件夹”中已经存在的文件。成功下载文件后,删除文件(下载后)设置可用于删除远程服务器上的文件。在“输出”选项卡中,单击“接收”以测试这些设置并从服务器检索匹配的文件。

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

知行之桥 支持这些宏,它们都使用以下语法:%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 计算指定保管库项目的值。

示例

某些宏(例如 %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%