Lookup 端口 [废弃]

Version 23.4.8843


Lookup 端口 [废弃]


Lookup 端口支持从数据源获取值并将其插入到现有文件中。

概览

Lookup 端口使用工作流中另一个端口的连接配置连接到数据源。当端口处理输入文件时,端口通过配置的连接发出自定义查询,并将结果存储在处理的文件中。这些响应值可以作为头部的值,也可以作为已配置的 XPath 中的 XML 元素插入到输入文件中。

Lookup 端口在从数据源重复查找值时利用缓存来提高性能。

端口配置

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

设置

端口配置

与端口核心配置相关的设置。

  • 数据源 将用于建立到数据源的连接的端口。Lookup 端口将使用此端口的配置来确定要连接的数据源、如何连接以及连接期间要使用的凭据。

查询设置

与查询语句以及如何解释响应有关的设置。

  • 端口 Id 端口的静态、唯一标识符。
  • 端口类型 显示端口类型及其用途的描述。
  • 端口描述 一个可选字段,用于提供端口及其在流中的角色的自由格式描述。
  • 目标类型 是将查询响应作为头部值插入到已处理的文件中,还是在指定的 XPath 处插入 XML 元素。
  • 目标 如果“目标类型”设置为 XPath,则此值为 XPath,查找响应值将在该 XPath 处插入到输入 XML 文档中。如果“目标类型”设置为“标题”,则此值为头部的名称,其值将设置为响应值。
  • 查询 针对数据源执行的查询。该查询应获取要插入到输入文件中的值。可以使用以下语法在此查询中引用输入文件中的值: ${XPATH:/path/to/element} 或 ${HEADER:HeaderName}
  • 使用第一条记录 当查询返回多个结果时,Lookup 端口可以抛出错误或使用第一个结果。启用此字段可以使用第一个结果,而不是抛出错误。

缓存

与端口维护的缓存有关的设置。

  • 缓存 端口是否应开启缓存以减少对数据源执行的查询数量。
  • 缓存阈值 针对数据源刷新缓存之前,缓存将使用的持续时间。此字段的时间单位由缓存容限单位控制。
  • 缓存阈值单位 缓存阈值的时间单位。
  • 重置缓存 通过查询数据源自动刷新缓存。

自动化配置

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

  • 发送 到达端口的消息是否会被自动处理。

性能

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

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

通知

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

端口邮件设置

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

服务等级协议 (SLA) 配置

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

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

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

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

高级设置

其它设置

不包括在之前类别中的设置。

  • 本地文件名格式 用于为端口输出的消息分配文件名的方案。 可以在文件名中动态使用宏来包含标识符和时间戳等信息。 有关详细信息,请参阅
  • 日志子文件夹方案 指端口根据选定的时间间隔对日志文件夹中的文件进行分组。 例如,Weekly 选项表示端口每周创建一个新子文件夹并将该周的所有日志存储在该文件夹中。 空白设置告诉端口将所有日志直接保存在 Logs 文件夹中。 对于处理大量事务的端口,使用子文件夹有助于保持日志井井有条并提高性能。
  • 日志消息 已处理文件的日志条目是否包含文件本身的副本。
  • 保存至 Sent 文件夹 端口处理的文件是否应复制到端口的已发送文件夹。

特殊设置

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

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

示例

用例

假设需要将特定客户的发票输入 QuickBooks。QuickBooks 要求包含一个内部 CustomerID 字段才能插入发票,但是只有 Customer 是已知的。Lookup 端口可用于在 QuickBooks 中查询特定客户的 CustomerID,并将其插入发票数据中。然后可以将带有 CustomerID 的发票发到 QuickBooks 端口进行插入操作。

输入文件

QuickBooks 端口接收格式化为 XML 的发票数据。在这种情况下,由 Lookup 端口处理的发票文件已经转换为 XML。此 XML 的结构应扁平化,以便插入 QuickBooks 的每个值都是单个插入单元的子元素,如下所示:

<Items>
  <Invoices>
    <InvoiceNumber>123</InvoiceNumber>
    <Date>01012019</Date>
    <Amount>921.22</Amount>
    <Customer>Marshall Rosenberg</Customer>
  </Invoices>
</Items>

配置

QuickBooks 端口必须是已经正确的连接到 QuickBooks,并且该端口应设置为 Lookup 端口的数据源。

由于输入文件是 XML,且目标响应数据应插入此 XML 中,因此目标类型应设置为 “XPath”。

目标字段应设置为 XPath,在其中将在 QuickBooks 插入中适当包含查找值(CustomerID)。对于此示例,假设应将 Customer 元素中的当前客户名称替换为 CustomerID。在这种情况下,目标应设置为:/Items/Invoices/Customer

查询应该设置为返回给定客户名的 CustomerID,例如: SELECT CustomerID FROM Customers WHERE CustomerName = ${XPATH:/Items/Invoices/Customer}

结果

通过上述配置,Lookup 端口将处理示例输入文件,并在 QuickBooks 中查询 “Marshall Rosenberg” 的 CustomerID。此查询返回的 ID 将替换 XML 的 Customer 元素中的 “Marshall Rosenberg”,然后将生成的 XML 推送到 QuickBooks 端口的 Receive 文件夹中。

缓存

默认情况下,当重复查询同一数据源时,Lookup 端口将维护本地缓存以提高性能。此缓存的行为(包括是否启用缓存,针对数据源同步缓存之前的持续时间等)由“设置”选项卡的缓存的字段控制。

启用缓存后,将针对本地缓存而不是外部数据源进行查询。异常情况是端口使用本地缓存不支持的语法处理复杂的查询时。在这种情况下,查询将始终传递到远程数据源。在这些情况下,建议完全禁用缓存以避免端口出现警告(即使启用了缓存,端口仍将成功处理查询)。

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

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%