File 端口

Version 24.3.9111

File 端口

File 端口能够：

概览

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

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

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

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

端口配置

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

设置

端口设置

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

端口 Id 端口的静态、唯一标识符。
端口类型 显示端口类型及其用途的描述。
端口描述 一个可选字段，用于提供端口及其在流中的角色的自由格式描述。
路径外部文件路径，端口将从该路径中获取文件或将文件推送到该路径。

接收

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

文件掩码 一种全局模式，用于过滤应该从已配置的路径中提取的文件。只有与文件掩码匹配的文件才会被提取。此设置可与“高级”选项卡中的接收过滤规则结合使用，以指定多个过滤器。
删除文件（接收后） 当文件被获取到工作流后，是否从外部路径中删除文件。

认证

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

缓存

与缓存和比较多次下载之间的文件相关的设置。

文件大小比较 选中此选项可记录下载的文件名和大小。除非文件大小与上次下载的不同，否则将跳过以前下载的文件。
时间戳比较 选中此选项可保留下载文件名和上次修改时间戳的记录。除非时间戳与上次下载的时间戳不同，否则将跳过以前下载的文件。

注意：启用缓存后，文件名不区分大小写。例如，端口无法区分 TEST.TXT和test.txt。

自动化

自动化设置

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

发送切换后，端口将在文件准备好时自动发送文件。
重试间隔 端口在重试失败发送之前等待的间隔。
重试最大尝试次数 端口尝试发送消息的次数。将此值设置为 1 指示端口仅进行初始发送尝试而不重试。端口在每次尝试之间等待 重试间隔 指定的时间。
接收切换后，端口可在文件准备好时自动处理文件并将它们获取到“输出”选项卡。
接收间隔 端口处理所有待处理文件并将它们获取到输出选项卡的间隔。下一个字段取决于此处的选择： Hourly - 一个小时后 下拉菜单允许你指定一小时后的分钟数来处理接收文件。 Daily — 出现一个时字段，用于指定处理接收文件的时间（以 UTC 为单位）。 Weekly — 出现两个字段。天允许你选择一周中的哪一天进行处理，时允许你指定处理接收文件的时间（UTC）。 Monthly — 出现两个字段。天允许你选择一个月中的哪一天进行处理，时允许你指定处理接收文件的时间（以 UTC 为单位）。 Minute — 出现一个分字段，用于指定处理间隔之间的分钟数。 Advanced — 五位 Cron 表达式 字段允许你指定精确的处理间隔。突出显示端口中的字段以获取有关这些表达式的更多信息。

性能

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

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

通知

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

端口邮件设置

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

服务等级协议 (SLA) 配置

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

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

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

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

高级设置

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

复写选项 当端口尝试将文件写入外部路径并且该文件已经存在时，指定端口如何处理。端口可以将当前文件重命名为唯一的文件名，覆盖现有文件，将当前文件附加到现有文件，跳过操作且不报错，或者停止操作并抛出错误。
延迟处理 端口等待处理输入文件夹中文件的时间（以秒为单位）。
延迟处理 放置在输入文件夹中的文件的处理延迟的时间量（以秒为单位）。这是一个遗留设置。最佳实践是使用 File 端口来管理本地文件系统，而不是此设置。
递归远程子目录 切换下载目标远程路径子文件夹中的文件。
最大下载文件数 在单个接收间隔内将提取的最大文件数。如果该值不是正整数，将不会应用任何限制。
临时发送路径 在将文件移动到配置的目标路径之前，用作暂存文件夹的目录。
临时发送前缀 如果指定，端口将上传带有临时前缀的文件，然后在操作完成后将文件重命名为其原始文件名。
临时发送扩展名 如果指定，端口将上传带有临时扩展名的文件，然后在操作完成后将文件重命名为其原始文件名和扩展名
本地文件名格式 用于为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏来包含标识符和时间戳等信息。有关详细信息，请参阅宏。
接收过滤规则 一个全局模式过滤器，用于确定应该从远程存储下载哪些文件(例如 *.txt)。负模式可用于指示不应下载的文件(例如 -*.tmp)。当需要多个 文件屏蔽 模式时，应使用此设置。多个模式可以用逗号分隔，除非找到完全匹配，否则后面的过滤器优先。

消息

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

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

日志

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

特殊设置

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

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

建立连接

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

如果运行知行之桥的用户尚未拥有访问路径、用户名、密码、和域字段的权限，则可以将这些字段设置为具有适当权限的特定用户。

发送／接收文件

发送文件

File 端口将文件从 Send 文件夹发送到路径中指定的外部文件夹。如果在“高级”选项卡中指定了发送过滤规则，则只会发送与过滤规则匹配的文件。如果端口中启用了自动发送功能，文件将自动发送。

接收文件

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

如果在“自动化”选项卡中启用了自动接收，端口将自动轮询要接收的文件的外部文件夹。

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

子目录消息头

如果 递归远程子目录 被选择，File 端口从路径接收文件：

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

当发送文件时，子目录消息头会在发送文件到路径时保留：

文件将会被放在此子目录中，其相对于配置的路径。
如果文件不存在并且有权限的话，子目录会被自动创建。

宏

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

知行之桥支持这些宏，它们都使用以下语法：%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%：其中 vaultitem 是 vault 中项目的名称。例如，%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%

示例

某些文件需要根据文件中包含的数据放置在不同的文件夹中，例如在知行之桥消息中的消息头部值。如果文件有一个名为“Customer”的头部，其中包含应放置文件的文件夹，则File 端口的路径属性可以设置为以下内容：

/some/path/%Header:Customer%