Version 26.2.9636

• 核心功能
• 总览
  • 操作
• 端口配置
  • 设置页面
    • 配置
    • 高级设置
  • REST 详情页面
    • 查询参数
    • 认证
    • 标头
    • 正文
    • 选项
  • 高级页面
    • 认证
    • 高级设置
    • 代理配置
    • 日志
    • 特殊设置
  • 自动化页面
    • 自动化设置
    • 性能
  • 通知选项卡
  • SLA 选项卡
  • 事务页面
• 建立连接
  • 创建连接
  • 认证方式
• 测试请求配置
• 静态请求
• 动态请求
  • 原始输入数据
  • 动态表单数据
    • 使用 XML Map 构建动态模板
    • 动态标头
• 使用 ArcScript 编辑器构建请求 URL 和标头
  • 消息标头
  • 保管库
  • 格式化器
• 响应事件
  • 示例
• 宏
  • 示例

REST 端口支持创建动态的 REST 请求来调用 RESTful API Web 服务。

核心功能

• 完整的 RESTful API 客户端，支持所有 HTTP 方法（GET、POST、PUT、PATCH 和 DELETE）
• 具备 Swagger 导入功能，可实现 API 自动配置和请求生成
• 高级认证支持，包括 OAuth 2.0、Bearer Token、AWS Signature、API Key 以及基础/摘要认证（Basic/Digest auth）
• 动态请求构建，支持在 URL、标头和表单数据中使用 ArcScript
• 灵活的正文类型，包括原始数据（raw）、表单数据（form-data）、URL 编码（URL-encoded）及文件上传

总览

REST 端口通过暴露一个简单的接口为 REST 请求创建头部、授权、正文和 HTTP 方法。请求的正文部分可以在端口配置中静态设置，也可以基于端口处理的文件动态生成。

操作

此端口可以执行三种端口操作类型中的任何一种：

• 触发 按计划执行一个 request ，并且可能会生成要沿着工作流发送的文件。 此操作充当工作流的起点。
• 转换 接受来自工作流的消息作为 request 并生成输出。 此操作充当工作流的中间部分。
• 终结 接受来自工作流的消息作为 request 并充当工作流的终点。

端口配置

设置页面

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

配置

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

高级设置

• 本地文件名格式 用于为端口输出的消息分配文件名的方案。 可以在文件名中动态使用宏来包含标识符和时间戳等信息。 有关详细信息，请参阅宏。

REST 详情页面

与端口请求详情相关的设置。

• REST 详情 选择端口应执行的操作。（有关三个选项的详细信息，请参阅操作。）
• 从 Swagger 导入 点击 图标，可直接从 Swagger URL 导入 API 详情。
• 测试 测试当前配置，无需创建发送到流程下游的消息或事务。点击 测试 将打开一个包含附加选项卡的窗口（更多信息请参阅测试请求配置）。
• 请求 URL REST 请求的 HTTP 方法和目标 HTTP URL。可用的方法选项包括：GET、POST、PUT、PATCH 和 DELETE。
• 在 URL 中允许 ArcScript 勾选此项以允许在发出查询之前执行 URL 中的 ArcScript 表达式。选中后，将显示 按钮，可使用 ArcScript 构建动态请求 URL。详情请参阅使用 ArcScript 编辑器构建请求 URL 和标头。
• 正文类型 REST 请求提供的正文内容类型。当 HTTP 方法为 GET 时不可见。有关每个选项的说明，请参阅正文。
• 内容类型 用于原始数据传输的内容类型。仅当 正文类型 设置为 raw 时可见。

查询参数

使用此选项卡向请求 URL 添加查询参数。以名称-值对的形式提供参数，可附加可选描述。点击 保存 以使用参数更新 URL。

上图包含两组查询参数。保存端口后，api.example.com 请求 URL 将变为：https://api.example.com/orders?status=pending&limit=50

点击右侧的省略号可设置另外两个选项：批量编辑视图 和 隐藏描述列。

认证

使用此选项卡配置 API 请求的认证凭据。

• 凭据 是否从先前配置的连接中提供认证凭据、创建新连接，还是不使用认证发送请求。
  使用连接：选择此项，然后从下拉列表中选择 连接。注意：点击 连接 旁边的加号可创建新连接。
  无凭据：选择此项以不使用认证发送请求。当使用公共 API 或通过查询参数或标头处理认证时，请使用此选项。
• TLS 服务器证书 用于验证 TLS 服务器身份的公钥证书。可以上传证书，将此字段留空以允许底层 OS/JVM 执行证书验证，或将其设置为 Any Certificate 以信任目标服务器的身份。请谨慎使用 Any Certificate：该证书用于验证是否正在连接到目标服务器。

标头

此选项卡支持添加要包含在传出 REST 请求中的 HTTP 标头列表。标头以名称-值对的形式指定。有关更多信息，请参阅静态请求和动态请求。点击右侧的省略号可访问另外三个选项：批量编辑视图、在标头中允许 ArcScript 和 显示自动生成的标头。有关使用 ArcScript 编辑器的详情，请参阅使用 ArcScript 编辑器构建请求 URL 和标头。

正文

如果 正文类型 设置为 form-data 或 x-www-urlencoded，请使用 正文 选项卡提供一组构成请求正文的名称-值对（字段）。以下列表更详细地介绍了每个选项。

• 无（none）：REST 请求未提供任何正文。
• 表单数据（form-data）：正文作为一组名称-值对（字段）提供。使用 名称 旁边的下拉列表选择字段类型。
  • 静态（Static）：提供 名称 和 值。
  • XML：在 UI 中提供 名称。值 是从端口处理的输入文件中动态读取的。有关详细信息，请参阅动态表单数据。
  • 文件（File）：每个端口可以将一个正文字段设置为 File。这会导致输入文件在请求正文中发送。由于端口使用输入文件本身作为表单数据，值 字段呈灰色显示。
  • 消息头（Header）：使用 值 字段指定从输入消息中的哪个消息头读取正文。
  • ArcScript：提供的 值 以 ArcScript 形式渲染，结果值用于请求正文中。
• x-www-urlencoded：正文的配置方式与 form-data 相同；但是，名称-值对被编码为 URL 查询字符串，而不是多部分表单数据。
• 原始数据（raw）：正文设置为端口处理的输入文件的内容。使用下拉列表选择正文的 内容类型，或在 标头 部分中将其指定为自定义标头。

点击右侧的省略号可访问另外两个设置：批量编辑视图 和 显示内容类型列。显示内容类型列可为 form-data 和 x-www-form-urlencoded 正文类型的每个字段单独指定内容类型。

选项

与请求相关的其他设置。

• 为错误响应创建输出消息 默认情况下，当发送的响应带有非成功状态代码时，端口不会向流程输出消息。启用此设置以使端口针对这些错误响应向流程输出消息。可以使用 HTTP-Status-Code 消息头在流程中过滤消息。
• 压缩 HTTP 请求 启用此项以在发送 PUT 或 POST 请求之前将其正文压缩为 gzip 格式。Content-Encoding 标头也会添加到传出请求中。
• GET 请求正文 允许 GET 请求使用输入消息数据作为请求正文。
• HTTP 版本 连接 REST 服务时使用 HTTP 1.0、1.1 还是 2.0。

高级页面

认证

与客户端认证相关的设置。

• 私钥证书 TLS 客户端认证期间提供的私钥证书。
• 证书密码 访问 TLS 客户端证书所需的密码。

高级设置

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

• 分块编码 发送请求时是否使用 HTTP 分块传输编码。允许应用程序按顺序发送消息的各个块（chunk），以避免连接过载。
• 分块大小 启用 分块编码 时每个分块的大小（字节）。
• 跟随授权标头 启用后，当重定向到不同的协议或主机名时，保留授权标头。
• 输出行为 默认情况下，端口输出一条包含 Response 数据的消息。其他选项允许输出 Input Message 以便进一步处理，或者完全不输出消息。有关更多信息，请参阅响应事件。
• 超时时间（秒） 在引发超时错误之前等待来自 REST 服务器响应的持续时间（秒）。
• 响应标头 设置后，端口会将指定的标头从 REST 消息作为元数据添加到下载的消息中。可以指定多个标头，以逗号分隔。
• 保留 Cookie 若要在输出消息中保留 Cookie，请提供以逗号分隔的待持久化 Cookie 名称列表。使用 * 可保留所有 Cookie。注意：仅保留键值对（name-value pairs），不执行属性检查。用户需自行负责确保 Cookie 不会泄露到非预期的目的地。
• TLS 启用协议 建立出站连接时支持的 TLS/SSL 协议列表。最佳实践是仅使用 TLS 协议。SSL v2 和 SSL v3 被认为存在安全隐患，仅在合作伙伴不支持更高版本时才应使用。请注意，TLS v1.3 尚未被普遍采用，如果目标服务器不支持该协议，连接可能会被拒绝。
• 延迟处理 放置在输入文件夹中的文件的处理延迟的时间量（以秒为单位）。 这是一个遗留设置。 最佳实践是使用 File 端口 来管理本地文件系统，而不是此设置。

代理配置

端口使用代理时的配置。

• 使用“系统设置” 表示端口切换使用在知行之桥的“系统设置”选项卡下配置的代理设置。
• 代理类型 要使用的代理类型。 选择无则不使用代理。 否则，选择Tunnel、SOCKS4、SOCKS5 或 HTTP。
• 代理主机 代理服务器。 格式取决于所选的代理类型。
• 代理端口 连接到代理时使用的端口。
• 代理用户 连接到代理时使用的用户名。
• 代理密码 关联用户名的密码。
• 认证方式 连接到代理时使用的协议。 选项包括Basic、Digest、Proprietary 和 NTLM。

日志

• 日志级别 端口生成的日志的详细程度。请求支持时，请将其设置为 Debug。
• 日志子文件夹方案：指示端口根据所选的时间间隔对日志（Logs）文件夹中的文件进行分组。每周（Weekly）选项（默认设置）指示端口每周创建一个新子文件夹，并将该周的所有日志存储在其中。如果此设置留空，则端口将所有日志直接保存在日志文件夹中。对于处理大量事务的端口，使用子文件夹有助于保持日志井然有序并提高性能。
• 日志消息 勾选此项，使处理文件的日志条目包含文件本身的副本。如果禁用此项，可能无法从 交易选项卡 下载文件副本。

特殊设置

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

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

自动化页面

自动化设置

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

• 发送 切换后，端口将在文件准备好时自动发送文件。
• 重试间隔 端口在重试失败发送之前等待的间隔。
• 重试最大尝试次数 端口尝试发送消息的次数。将此值设置为 1 指示端口仅进行初始发送尝试而不重试。 端口在每次尝试之间等待 重试间隔 指定的时间。
• 接收 一个开关，指示端口按照配置的间隔自动发出 REST 请求。
• 间隔 端口发出配置的 REST 请求的间隔。下一个字段取决于此处的选择：
  每小时：小时后分钟数 下拉菜单允许您指定处理接收文件的小时后分钟数。
  每日：出现一个 时间 字段，用于指定处理接收文件的时间（UTC 时间）。
  每周：出现两个字段。天 允许您选择处理接收文件的星期几，时间 允许您指定处理接收文件的时间（UTC 时间）。
  每月：出现两个字段。日期 允许您选择每月的哪一天进行处理，时间 允许您指定处理接收文件的时间（UTC 时间）。
  分钟：分钟 字段用于指定处理间隔的分钟数。
  高级：五位 Cron 表达式 字段允许您指定精确的处理间隔。在端口中突出显示该字段以获取有关这些表达式的更多信息。
• 整点后的分钟数 每小时计划的分钟偏移量。仅在 接收 设置为”每小时”时适用。例如，如果此值设置为 5，则自动化服务会在 1:05、2:05、3:05 等时间发送请求。

性能

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

• 最大工作线程数 此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 高级设置 页面的 性能设置 部分的默认设置。
• 最大文件数 分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 高级设置 页面的 性能设置 部分的默认设置。

通知选项卡

与配置通知相关的设置。

在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，知行之桥使用 通知 选项卡上的全局设置。要为此端口使用其他设置，请启用覆盖全局设置。

默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中启用复选框。

输入主题（必填），然后（可选）输入以逗号分隔的收件人电子邮件列表。

SLA 选项卡

与配置服务级别协议 (SLA) 相关的设置。

SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，知行之桥会发送电子邮件警告用户，并将 SLA 标记为_存在风险_，这意味着如果 SLA 未能尽快达到，则会被标记为_已违反_。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为_已违反_，并再次通知用户。

要定义 SLA，请启用预期数据量，然后点击设置选项卡。

• 如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。
• 在窗口的预计至少部分中：
  • 设置预计处理的最小事务数量（交易量）
  • 使用每个字段指定时间范围
  • 指示 SLA 生效的时间。如果选择开始于，请填写日期和时间字段。
  • 勾选希望 SLA 生效的星期几对应的复选框。如有必要，请使用下拉菜单选择每天。
• 在窗口的将状态设置为“有风险”部分中，指定应将 SLA 标记为有风险的时间。
  • 默认情况下，只有在违反 SLA 的情况下才会发送通知。要更改此设置，请勾选发送“有风险”通知。

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

注意：如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的设置，然后跳转到通知 > 通用通知。点击平板和铅笔图标进行编辑，并取消勾选 SLA 通知设置。

事务页面

此页面列出了与该端口关联的所有消息。使用搜索栏查找特定消息，或点击漏斗图标应用过滤器。可以按时间、消息方向和/或状态进行过滤。

此页面上的选项因端口的操作类型而异：

• 如果端口是 触发 端口，使用 接收文件 按钮启动流程。
• 如果端口是 转换 或 终结 端口，使用 上传文件 按钮将文件上传到流程。

建立连接

要建立到任何 REST 服务的连接，需要有效的目标 URL。服务 URL 可以支持各种 HTTP 方法，应根据特定的 Web 服务操作或要检索的数据集配置方法。某些服务可能还需要认证或一组自定义标头才能调用该服务。

认证选项卡的 凭据 部分支持指定连接凭据。可从以下选项中选择：

• 使用连接：选择先前配置的知行之桥共享连接，或点击 连接 字段旁边的加号创建连接。
• 无凭据：用于公共 API 或通过查询参数或标头处理认证的情况。如果目标 URL 是 HTTPS URL，请将 TLS 服务器证书 设置为标识服务器的公钥证书。要隐式信任目标端点，请将该字段设置为 Any Certificate。

创建连接

要创建新连接，请选择 使用连接，然后点击 连接 字段旁边的加号。

• 输入唯一的 连接名称。
• 类型 始终设置为 REST。
• 选择 认证方案。详情请参阅认证方式。

认证方式

REST 端口支持多种认证类型，每种类型都有其自己的要求：

• Basic（明文）、Digest（加密）和 NTLM 需要用户名密码认证。这些凭据作为请求中的标头提供给 REST 服务。

• OAuth 认证需要在 REST 服务的 Web 门户或开发控制台中注册应用程序。要包含在应用程序注册中的 回调 URL 显示在知行之桥 UI 中。选择适用于 REST 服务的 授予类型，并从 REST 服务的 Web 门户或开发控制台中显示的详细信息中指定其余设置。然后点击 获取新访问令牌 以获取与服务交互所需的令牌。检索到初始令牌后，应用程序会在令牌即将到期时自动刷新它们。

• Bearer Token 认证需要来自服务的 Web 门户或开发控制台的令牌。

• AWS Signature 认证，用于针对 Amazon 进行身份验证，需要 Amazon 提供的配置凭据：访问密钥（Access Key）、密钥（Secret Key） 等。

• API Key 认证需要一个键值对，然后必须指定该密钥应作为标头还是查询参数添加。

测试请求配置

可以随时测试当前配置，而无需创建发送到流程中的消息或事务。点击 REST 详情 页面上的 测试。下图显示了成功测试触发端口的 响应正文 结果。

• 响应正文：以服务器返回的格式显示 REST 请求的输出。
• 响应标头：显示服务器返回的响应中包含的响应标头。
• 消息标头：显示测试输出中包含的消息标头。
• 日志：显示测试日志。

转换和终结端口有一个 输入 面板，其中包含 XML、标头 和 日志 选项卡。

• XML 选项卡仅在请求正文中定义了 XML 字段时才会填充，如下图所示。
• 如果勾选了 在 URL 中允许 ArcScript 或 在标头中允许 ArcScript，请使用 标头 选项卡提供可能在脚本上下文中使用的消息标头（有关这些选项的详情，请参阅使用 ArcScript 编辑器构建请求 URL 和标头）。如果请求的 form-data 或 x-www-form-urlencoded 正文中配置了消息头（Header）元素，则标头名称会显示在此处，您可以为测试提供值。
• 日志 选项卡包含上次测试的结果。

静态请求

具有完全静态内容的 REST 请求（例如使用 HTTP GET 方法的请求）不需要输入文件，因为请求内容完全在端口 UI 中配置。只需在 标头 部分添加任何必要的名称-值对作为自定义标头，或在 正文 部分添加表单数据即可。

如果启用了 接收自动化，则可以根据计划自动发送静态请求。对每个请求的响应将存储在输出文件夹中，或转发到工作流中的下一个端口。

如果启用了 发送自动化，到达端口 事务 文件夹的文件也会触发静态请求。输入文件的内容将被忽略，并根据 UI 中的配置发送请求。

动态请求

可以使用到达端口 事务 文件夹中的文件数据动态填充 REST 请求。

原始输入数据

如果请求的 正文类型 设置为 raw，输入文件的内容将作为 REST 请求的正文发送。

使用 内容类型 下拉列表设置数据的具体内容类型。如果所需的内容类型未列出，可以在 标头 部分添加 Content-Type 标头。

动态表单数据

如果请求的 正文类型 设置为 form-data 或 x-www-urlencoded，端口将从输入文件中查找特定值来填充请求。对于每个设置为 XML 的名称-值对，端口会扫描输入文件以查找与字段名同名且遵循以下特定 XML 结构的 XML 元素：

<Items>
  <FormData>
    <FieldName></FieldName>
  </FormData>
</Items>

为了适应这种结构，我们强烈建议在工作流中的 REST 端口之前使用 XML Map 端口，如下文所述。

当端口找到与字段名和所需 XML 结构匹配的元素时，此元素中的值将用作名称-值对中的值。例如，如果正文具有名为 CustomerID 的动态字段，并且输入文件具有以下 XML，则 REST 端口会将 CustomerID 字段的值设置为 12354。

<Items>
  <FormData>
    <CustomerID>12354</CustomerID>
  </FormData>
</Items>

使用 XML Map 构建动态模板

使用 XML Map 端口与 REST 端口配合，可轻松根据其他 XML 数据结构构建动态请求。XML Map 端口将自定义 XML 结构转换为 REST 端口期望的 XML 结构。

首先，使用请求中应存在的动态（和静态）正文 字段集配置 REST 端口。接下来，在知行之桥工作流中将 XML Map 端口连接到 REST 端口并保存流程更改。这允许 XML Map 端口检测 REST 端口在传入输入文件中期望的字段。

然后，在 XML Map 端口内部，目标文件 下拉列表包含 REST 请求模式。选择此作为目标，并将 源文件 设置为自定义 XML 结构。这将填充 XML Map 映射编辑器，您可以将需要包含在 REST 请求中的数据从源结构拖放到目标结构中。映射完成后，XML Map 端口会自动将匹配源文件的文件转换为有效的 REST 请求结构。

有关使用 XML Map 端口的更多信息，请参阅 XML Map 端口文档。

动态标头

ArcScript 中的表达式也可以用于生成动态字符串作为标头值。详情请参阅标头。

使用 ArcScript 编辑器构建请求 URL 和标头

您可以使用下图所示的 ArcScript 编辑器来构建请求 URL 和标头。以下图片显示的是请求 URL 编辑器，但标头值编辑器的工作方式相同。

在端口配置面板的 REST 详情页面上选择 在 URL 中允许 ArcScript，以允许执行 ArcScript 中的表达式来生成动态 URL 字符串。例如，以下 URL 包含日期和时间：

http://myendpoint.com/api?day=[_ | now('yyyyMMdd HH:mm:ss')]

此 URL 在传入消息中包含一个标头，用于通过发送自动化触发的查询：

http://myendpoint.com/api?customer=[_message.header:customerid]

最后，此 URL 使用从上次查询时间到当前时间戳的动态日期范围，并对第一次查询使用默认时间戳：

http://myendpoint.com/api?DateFrom=[_connector.lastruntimestamp | def('2025-01-01T00:00:00-04:00')]&DateTo=[_connector.currenttimestamp]

您可以直接在 URL 中添加表达式，也可以使用编辑器编写。

选择 在标头中允许 ArcScript 以启用在发出查询之前执行标头中的 ArcScript 表达式。例如，以下标头包含日期和时间：

Timestamp [_ | now('yyyyMMdd')]

此标头包含通过发送自动化触发的查询的客户 ID：

Customer [_message.header:customerid]

消息标头

消息标头帮助知行之桥跟踪数据在工作流中的处理进度。所有跟踪标头都显示在编辑器的 消息标头 选项卡上，您可以在表达式中引用它们。

您还可以通过使用编辑器中的 添加消息标头 字段并提供现有标头的名称，在表达式中包含其他消息标头。这些不必是跟踪标头。

保管库

使用 保管库 选项卡将全局设置保管库中的项目添加到表达式中。如果您有在工作流中不同位置重复使用的值，这会非常有用。您可以在保管库中定义这些值，然后在表达式开头引用它们。请注意，如果您希望映射使用保管库中项目的 值，需要在方括号内引用它；否则编辑器会将项目 名称 解释为字面量。

格式化器

格式化器支持对不同 xpath 返回的值进行操作。格式化器在表达式中以管道字符（|）分隔，并从左到右执行。例如：

[xpath('City') | toupper | substring(0,3)]

在此示例中，在返回 City xpath 的值之前，所有字符串字符都会转换为大写字符，并返回前三个字符的子字符串。例如，如果源文档的值为：

<City>Durham</City>

则结果表达式返回：

DUR

格式化器列在 格式化器 选项卡中。点击列表中的格式化器即可将其添加到表达式中。

响应事件

可以在 REST 端口中使用响应事件与从服务器收到的响应（包括正文、标头、Cookie 等）进行交互，并丰富从端口生成的输出消息。可以在 Response 事件中使用以下特殊项目。

• _cookies
• _message
• _request
• _response

示例

此脚本读取从 REST 调用收到的 JSON 响应，解析 JSON 中包含的访问令牌，并将其作为标头添加到 REST 端口创建的输出消息中：

<arc:set attr="json.text" value="[_response.body]" />
<arc:set attr="json.map:access_token" value="/json/args/token" />
<arc:call op="jsonDOMGet" item="json">
  <arc:set attr="_message.header:access_token" value="[json.access_token | def('Token not found!')]"/>
</arc:call>

以下步骤详细说明了处理过程：

1 通过 _response.body 访问服务器发送回知行之桥中 REST 端口的响应正文，并将其设置为 jsonDOMGet 操作的 text 属性。jsonDOMGet 的其他属性也会被填充，例如 map 属性，其中包含指向响应正文中所需令牌的 jsonpath。

2 调用 jsonDOMGet 操作。如果在响应 JSON 正文中找到令牌，则通过 _message.header:access_token 语法将其作为消息标头添加到 REST 端口的输出消息中。如果未找到令牌，则 access_token 标头的值将设置为静态字符串：Token not found!。

在知行之桥中查看来自 REST 端口的消息的输出消息详情时，结果如下所示：

当需要从服务器返回的原始 JSON 响应正文中解析数据时，这种类型的脚本非常有用。然后可以在工作流中的后续端口中读取和使用该标头。

提示：如果服务器使用 XML 进行响应，则可以使用 xmlDOMget 实现相同的结果。

宏

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

知行之桥 支持这些宏，它们都使用以下语法：%Macro%。

示例

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