Version 26.1.9526

• 核心功能
• 概述
• 端口设置
  • 设置选项卡
    • 端口设置
    • 其他设置
  • 自动化页面
    • 自动化设置
  • 高级页面
    • 消息
    • 日志
    • 其他设置
    • 特殊设置
    • 性能
  • 通知选项卡
  • SLA 选项卡
• 宏
  • 示例
• 示例
  • XML to JSON
  • JSON to XML
• JSON 类型转换

JSON 端口支持将 XML 数据转换为 JSON，将 JSON 数据转换为 XML。

核心功能

• JSON 与 XML 之间的双向转换，支持自动格式检测
• 仅需极简配置（端口通常可以使用默认配置正常工作）
• 可配置属性前缀及文本属性处理，确保翻译准确
• 自定义格式选项，包括压缩（Minification）及根元素命名
• 类型转换支持，具备 JSON 类型注释功能以实现精确的数据处理

概述

JSON 端口以最少的配置在 JSON 和 XML 之间进行转换。端口会自动检测输入文件是 JSON 还是 XML，然后端口将文件转换为其他格式。端口支持可配置的语法来区分属性并确保输出是有效的 XML/JSON。

端口设置

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

设置选项卡

端口设置

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

• 端口 Id 端口的静态、唯一标识符。
• 端口类型 显示端口类型及其用途的描述。
• 端口描述 一个可选字段，用于提供端口及其在流中的角色的自由格式描述。
• 根元素名称 从 JSON 转换为 XML 时，此值用作生成的 XML 文档中根元素的名称。这确保输出 XML 具有单个根元素，而不管输入 JSON 的结构如何。
• Attribute Prefix 用于标识 JSON 中的属性的前缀。从 JSON 转换为 XML 时，端口会将带有此前缀的值解释为结果 XML 中的属性。从 XML 转换为 JSON 时，端口会将此前缀添加到生成的 JSON 中的属性值。请参阅 示例 部分了解更多信息。
• 文本属性名称 当 JSON 对象具有属性值和非属性值时，此名称标识非属性值。从 JSON 转换为 XML 时，与此名称关联的值将在生成的 XML 元素的文本中设置。从 XML 转换为 JSON 时，元素中的文本将设置为此名称的值。请参阅 示例 部分了解更多信息。
• 最小化输出 启用后，此选项会指示端口减少生成的 XML 或 JSON 文档中的空格。此选项可节省空间，但可能会使人类更难以阅读输出。

其他设置

• 无效的 XML 名称前缀 当 JSON 元素的名称不是有效的 XML 时，端口会将此前缀添加到 XML 元素名称的开头。
  例如，如果你有一个名为“10price”的 JSON 元素，则必须修改该元素名称以将其转换为 XML。这是因为 JSON 元素名称可以以数字开头，但 XML 元素名称不能。如果将此字段设置为“num”，则 XML 输出中的“10price” JSON 元素将变为“num10price”。
• 本地文件名格式 用于为端口输出的消息分配文件名的方案。 可以在文件名中动态使用宏来包含标识符和时间戳等信息。 有关详细信息，请参阅宏。

自动化页面

自动化设置

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

• 发送 一个开关，指示端口在文件准备就绪时自动发送。

高级页面

消息

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

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

日志

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

其他设置

• 延迟处理 放置在输入文件夹中的文件的处理延迟的时间量（以秒为单位）。 这是一个遗留设置。 最佳实践是使用 File 端口 来管理本地文件系统，而不是此设置。

特殊设置

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

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

性能

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

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

通知选项卡

与配置通知相关的设置。

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

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

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

SLA 选项卡

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

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

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

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

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

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

宏

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

知行之桥 支持这些宏，它们都使用以下语法：%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%

示例

下面是使用 JSON 端口在 XML 和 JSON 之间转换的示例。

XML to JSON

XML 输入:

<Fable>
  <Author alive="false">Aesop</Author>
  <Title>Tortoise and the Hare</Title>
  <Characters>
    <Character id="1" slow="true">Tortoise</Character>
    <Character id="2" slow="hardly">Hare</Character>
  </Characters>
  <Moral>Persistence over speed</Moral>
</Fable>

JSON 输出:

{
  "Fable": {
    "Author": {
      "@alive":"false",
      "#text":"Aesop"
    },
    "Title":"Tortoise and the Hare",
    "Characters": {
      "Character": [
        {
          "@id":"1",
          "@slow":"true",
          "#text":"Tortoise"
        },
        {
          "@id":"2",
          "@slow":"hardly",
          "#text":"Hare"
        }
      ]
    },
    "Moral":"Persistence over speed"
    }
}

JSON to XML

JSON 输入:

{ 
  "Catch": [
    {
      "type": "salmon",
      "quantity": "2",
      "weight": "20.2 lbs"
    },
    {
      "type": "pike",
      "quantity": "21",
      "weight": "521 lbs"
    }
  ],
  "Lake": "Boulder",
  "Weather": "Clear",
  "808s": "Loud" 
}

XML 输出:

<Items>
  <Catch>
    <type>salmon</type>
    <quantity>2</quantity>
    <weight>20.2 lbs</weight>
  </Catch>
  <Catch>
    <type>pike</type>
    <quantity>21</quantity>
    <weight>521 lbs</weight>
  </Catch>
  <Lake>Boulder</Lake>
  <Weather>Clear</Weather>
  <_808s>Loud</_808s>
</Items>

JSON 类型转换

从 XML 转换为 JSON 时，端口将所有 XML 元素视为“字符串”，但两种情况除外：

• 如果端口在 XML 输入的同一 XML 结构中检测到多个元素或值，它会将它们视为一个“数组”。
• 如果你应用 XML 属性来指定 JSON 输出格式，则此属性会覆盖默认的 string 行为。 这些属性在下表中列出。

• json:array=”true” 如果你有一个单元素array，你可以应用这个属性来确保端口把它当作一个array而不是string。
• json:type=”number” 指示端口将 XML 元素视为“数字”。
• json:type=”boolean” 指示端口将 XML 元素视为 boolean。
• json:type=”object” 指示端口将 XML 元素视为“对象”。
• json:type=”null” 端口将空的 XML 元素视为长度为零的“字符串”。 此命令强制输出为 null 而不是空的 string。
• xsi:nil=”true” 与 json:type=”null” 功能相同。