微应用

配置集成

现在您已经添加了 HTTP 集成,请配置您的集成。此端点数据以及服务操作配置构成了创建可操作的微应用的基础。

添加数据端点

配置数据端点以将相关数据读入缓存。我们想要向用户显示(或想要使用触发事件或操作)的任何数据都必须被缓存。

要添加数据终端节点,请执行以下步骤:

  1. 选择 “ 数据加载”。

    添加新终端节点

  2. 数据端点配置下,输入 端点名称
  3. (可选)如有必要,添加 模板变量 。此字段提供在 HTTP 请求定义中使用的动态值。模板变量使您能够覆盖或更改以下任一项中原始端点定义的所有参数:

    • 操作前或操作后更新
    • 动作调用
    • 增量同步

    例如,您可能希望在增量同步期间使用模板变量的动态值。

    模板变量

    1. 选择 添加变量
    2. 输入新变量的名称。
    3. 选择数 据类型。选定的数据类型决定了源的选项。

      1. DATETIME 数据类型下,对于 静态值,输入一个
      2. DATETIME 数据类型下, 对于相对日期,选择一个时间段。
    4. 如有必要,选择 配置 菜单,然后输入 日期时间格式类型 详细信息。
    5. 选择保存

    您创建的新变量现在可以在 HTTP 请求中使用。当您在 mustache 标签之间输入变量但该变量不存在时,弹出窗口允许您通过选择 创建变量来添加此变量

    注意:

    模板变量值按照标准 HTTP 编码规则进行百分比编码。 如果您不希望这种情况发生,或者知道这些值已经进行了百分比编码,则必须使用三重藏匿胡子标签而不是普通的双胡子来防止双重编码。例如,将 更改为 }。

    配置模板变量后,必须定义请求方法、分页类型,然后测试 完全同步和增量同步** 部分的服务,如下所述。

  4. 配置 请求方法 和 URL。

  5. (可选)选择 + 添加参数,然后根据需要配置 QUERYHEADER 或请求正文参数。

    注意:

    您选择的 数据类型 决定了属性的格式。格式决定了微应用中的字段。使用胡子标签来引用参数名称。例如,。

  6. 选择 分页类型。您必须选择的分页类型取决于目标应用程序集成的 API 标准。请参阅目标应用程序集成的 API 文档,了解应用程序集成使用的分页方法。

    我们的 HTTP 集成允许您从以下标准分页方法中进行选择。PageOffsetCursor 方法包含一个字段 页面大小值 ,用于定义每页要提取的记录数。

    • -未定义分页。
    • 页面 -设置每页退货的限制。

      示例:https://example.com?limit=100&page=3

    • 偏移 -提供两个参数,偏移和限制。Offset 定义要跳过的记录数,限制每页显示的记录数。

      示例:https://example.com?limit=100&offset=300

    • 链接 -定义分页方法以定义正文中的下一页链接。

      示例:

       {
       “data” […]
       “next”: https://example.com?lpage=3
       }
      
    • 标题链接 -类似于链接分页,但是根据 URL 页面标题定义分页。

      示例:

       Link: <https://api.github.com/search/code?q=addClass+user%3Amozilla&page=15>; rel="next",
       <https://api.github.com/search/code?q=addClass+user%3Amozilla&page=34>; rel="last"
      
    • Cursor -Cursor 分页使用特定记录的唯一标识符,该标识符用作指向要查询的下一条记录的指针,以返回结果页。

      示例:https://example.com?paginationToken=BFLMPSVZ

    • OData -选择您的 OData 版本以按照 OData 标准执行分页。

      设置端点分页类型

  7. 选择 使用参数测试 以检查终端节点是否正确配置。选择 要测试的页数 ,然后选择 使用参数测试。选择 “ 完成 ” 关闭刀片式服务器。
  8. (可选)如有必要,请切换 分页边界 以定义返回记录的条件。这仅适用于 页面偏移 分页类型,并且取决于目标 SoR 要求。
  9. 将要加载的最大页数 设置为变量(默认为 10000,最大为 1000000)。必要时,使用此变量限制从 SoR 返回的记录数量。可以为每个终端节点单独配置要加载的最大页数
  10. 选择 使用参数测试 以检查终端节点是否正确配置。

    如果测试成功,请继续下一步。如果收到错误消息,请根据收到的错误消息进行故障排除。

脚本转换

有关配置脚本转换的详细信息,请参阅 脚本转换

获取数据结构

现在,您可以在 获取数据结构 部分中创建表。

  1. 选择 “ 生成表”。
  2. 选择 “ 来自 API ” 或 “ 来自 JSON”:
    • 从 API -从定义的终端节点自动获取数据。
    • 来自 JSON -如有必要,使用来自示例 JSON 粘贴 API,例如,您有响应但现在无法调用 API。 (可选)如果需要来自定义的端点的备用根目录,请定义根 路径 。根路径必须使用 JSON 指针表示法定义。
  3. 选择 “ 生成表”。
  4. 要设置 主键,请选择 编辑属性 铅笔图标,然后切换要用作 主键 的属性的主键(例如, id)。重要的是,主键列不能包含空值。请勿将数据类型更改为 TIMESTAMP。

    注意:

    创建自定义集成和微应用时,必须始终分配主键以启用正确的增量加载,而不是在同步数据时进行完全覆盖。

  5. (可选)选择 添加表 并根据所需的目标应用程序的要求配置额外的表属性,然后单击 保存。然后,您可以从 API 终端节点重新加载表结构。

  6. 增量同步

    在启用 增量同步 的情况下,您可以设置同步。也就是说,以更频繁的时间间隔仅下载自上次数据同步以来更新的记录。为此,请配置您希望 API 调用运行的频率。至少输入一个服务器时间参数。在不设置同步计划的情况下离开会将同步设置为手动。

    只有在目标应用程序需要自定义参数时才需要这些参数必要时请参阅目标应用程序集成文档。如果要创建用于同步的自定义字符串,则必须在方括号中输入。例如, [更新了 >=] ‘YYY-MM-DD hhmm’。

    有关同步的详细信息,请参阅下面的 设置数据同步

  7. 获取数据结构 部分中输入已创建表的基本名称,然后选择:
    • 从 API -从定义的终端节点自动获取数据。
    • 来自示例 JSON -如有必要,何时使用来自示例 JSON 粘贴 API,例如,您有响应但现在无法调用 API。

    设置同步

  8. 选择添加

您的数据端点已映射,您现在可以设置服务操作。

注意:

设置并添加终端节点后,表结构将被锁定。如果需要重构,则必须创建并配置新的数据加载端点。

添加其他 API 调用

为应用程序集成配置数据终端节点时,可以向原始父终端节点添加额外的子端点以启用呼叫链接。设置好数据终端节点后,您可以添加更多关联的终端节点。

请按照以下步骤进行操作:

  1. 在要向其中添加孩子呼叫的集成菜单上选择 编辑

    集成编辑菜单

    集成页面随即打开。

  2. 要添加的数据端点菜单中选择添加子 API 调用

    添加子 API 调用菜单

  3. 选择父表并定义终端节点,如上面 “数据加载” 部分中的步骤所做的那样。

定义请求方法时,可以将路径设置为静态值或列值。 现在,您的 API 调用链已与父 API 调用关联。现在,您定义的父/子端点将显示在 “数据端点” 页面中。

注意:

创建集成时,建议仅从一个终端节点加载数据,而不是从多个终端节点加载数据。尽可能支持批处理调用而不是单个端点调用。

合并表

配置子 API 调用时,您可以选择通过选择以下选项之一来选择将子表与父表合并:

如果 不想合并 父表和子表,请选择不合并。

选择 “ 合并为详细信息 ” 可从记录系统中获取所有任务和请求以及请求中的每个请求详细信息,然后合并它们,例如,如果父表和子表是:

/request-list
{
“id”: 123,
“Title”: “Car”,
“Role”: “Order”,
“Category”: “Sales”
}

还有:

/request-detail/123
{
“id”: 123,
“Title”: “Car”,
“Desc”: “Cabriolet”,
“Date”: “2020-01-01”
}

选择 详细信息后,将 返回下表:

ID 标题 角色 类别 说明 日期
123 汽车 命令 销售 敞篷车 2020-01-01

选择 “ 合并为子列 表”,将每个子表分别附加到父表中。使用上面的示例,合并为子列表会产生以下结果:

ID 标题 角色 类别 id 标题 DESC 日期
123 汽车 命令 销售 123 汽车 敞篷车 2020-01-01

配置表

您可以在不设置新配置的情况下重新配置表主键。为此,请删除表屏幕中的各个表条目,重新同步表,然后选择新的主键。

支持的时间格式

HTTP 集成支持记录数据系统的以下时间格式:

  • ISO 日期格式
  • OData 格式
  • "yyyy-M-dd HH:mm:ss.SSS",
  • "M/d/yy h:mm a",
  • "M/d/yyyy h:mm:ss a",
  • "dd/MM/yy HH:mm",
  • "MMM d, yyyy h:mm:ss a",
  • "dd-MMM-yyyy HH:mm:ss",
  • "MMMM d, yyyy h:mm:ss a",
  • "dd MMMM yyyy HH:mm:ss",
  • "EEEE, MMMM d, yyyy h:mm:ss a",
  • "EEEE, d MMMM yyyy HH:mm:ss 'o''clock'",
  • "h:mm a",
  • "HH:mm",
  • "h:mm:ss a",
  • "HH:mm:ss"

添加服务操作

配置 HTTP 集成后,您可以配置服务操作。使用服务操作,您可以在应用程序集成的记录系统上配置回写操作。您可以按照与数据终端节点类似的方式配置服务操作。由于您的应用程序集成可以是任意数量的定制组合,因此我们将采用通用方法来解释服务操作的工作原理。您还可以选择通过设置操作执行前和执行后数据更新来配置服务操作以检查目标记录系统 (SoR)。

配置维修操作参数和模板变量时,不支持以下字符:

  • Whitespace ! " # % & ' ( ) * + , . / ; < = > @ [ \ ] ^ { | } ~ truefalseelsenullundefinedthis

要添加维修操作,请执行以下步骤:

  1. 应用程序名称下选择您创建的集成。
  2. 选择 维修操作添加新的维修操作。
  3. 给它一个 操作名称 (例如获取 JIRA 票证信息)。
  4. (可选)在 参数部分中选择添加参数,然后定义所需的参数名称数据类型

在 “ 操作序列” 部分中定义您的操作执行

  1. 输入 端点 URI 路径:(/rest/api/2/issue/)。
  2. 根据应用程序集成的 API 要 求配置请求方 法。

    注意:

    使用胡子标签来引用参数名称。例如,。

  3. 选择 添加 以保存此维修操作。现在,您可以根据需要添加额外的维修操作。

动作序列

您可以将服务操作序列配置为通过操作执行以及操作前后数据更新返回数据。操作前和操作后的数据更新是可选的,旨在对微应用正在访问的数据进行可靠的检查,并确保在配置可操作的微应用时数据始终准确。 (可选)在执行操作之前配置数据更新,以确保微应用最终用户在执行操作时完全同步数据。例如,您要确保可操作的微应用上显示的金额是要批准的正确金额,并且在创建和批准之间的时间内未更新。

重要提示:

此操作执行前数据更新功能仅适用于 Text 组件。这意味着执行操作之前的其他数据更改不会显示给最终用户。同样,如果为 “ 文本 ” 组件的 “页面逻辑” 输入了值,则不会运行检查。如果 Workspace 用户进行并发修改,则不会出现警告。

执行操作之前的数据更新

要在执行之前设置数据更新,请执行以下步骤:

  1. 选择要从中获取更新记录的现有 数据端点
  2. (可选)仅当需要 子数据端点 来获取更新记录的完整详细信息时,才启用包括子端点。
  3. (可选)如果允许更新获取单条记录,则扩展原始 Endpoint URI 。例如,如果数据端点 URI 更新 https://domain/api/itemshttps://domain/api/items/itemId。新端点 URI 必须返回与原始端点 URI 相同的数据结构,否则数据解析将失败。

注意:

如果在此初始设置后端点配置发生了更改,则更改不会在此处自动传播。

  1. (可选)如果允许筛选单条记录,则使用 添加附加参数 扩展原始请求参数。
  1. 选择 使用参数测试 以检查终端节点是否正确配置。选择 要测试的页数 ,然后选择 使用参数测试。选择 “ 完成 ” 关闭刀片式服务器。

    如果测试成功,请继续下一步。如果收到错误消息,请根据收到的错误消息进行故障排除。

完成配置后,选择 保存

执行操作后的数据更新

(可选)为确保执行操作后数据完全同步,您可以配置数据更新以从目标应用程序记录系统中提取新数据。

要在执行后设置数据更新,请按照下列步骤操作:

  1. 选择要从中获取更新记录的现有 数据端点
  2. (可选)仅当需要 子数据端点 来获取更新记录的完整详细信息时,才启用包括子端点。
  3. (可选)如果允许更新获取单条记录,则扩展原始 Endpoint URI 。例如,如果数据端点 URI 更新 https://domain/api/itemshttps://domain/api/items/itemId。新端点 URI 必须返回与原始端点 URI 相同的数据结构,否则数据解析将失败。
  4. (可选)如果允许筛选单条记录,则使用 添加附加参数 扩展原始请求参数。

  5. 选择 使用参数测试 以检查终端节点是否正确配置。选择 要测试的页数 ,然后选择 使用参数测试。选择 “ 完成 ” 关闭刀片式服务器。

    如果测试成功,请继续下一步。如果收到错误消息,请根据收到的错误消息进行故障排除。

完成配置后,选择 保存

验证所需的实体

使用 来验证存储在缓存中的表的当前列表以及应用于这些表的筛选器。

现在,除非需要创建自定义关系,否则可以设置和运行第一个数据同步。有关详细信息,请参阅 设置数据同步

API 请求方法

现在,您可以使用以下组件根据应用程序集成 API 要求配置请求方法:

  • GET -无需修改即可从应用程序集成 SOR 中检索资源。
  • POST -在应用程序集成 SOR 中创建新资源。
  • PUT -更新应用程序集成中的现有资源。
  • PATCH -对资源进行部分更新。
  • 删除 -删除资源。

使用以下可配置的 API 参数:

  • Header -定义请求标头中包含的与授权相关的参数。
  • Path -在端点的路径内,在查询字符串之前定义参数。
  • 查询 -在端点的查询字符串中定义参数。
  • Body -定义请求正文中包含的参数。

脚本转换

有关配置脚本转换的详细信息,请参阅 脚本转换

创建自定义关系

使用 “关 ” 页面可以在集成中的表之间创建自定义连接。如果您有多个基本 URL 并且需要多个集成,或者如果要在同一集成中创建自定义关系,则可以使用此选项。这是一个高级用例,我们建议您先熟悉在单个集成上创建微应用程序的过程,然后再开始映射多个集成。

  1. 在 “管理微应用” 页面中,选择要为其验证实体的集成旁边的菜单。
  2. 选择 编辑 ,然后选择 关系
  3. 选择 添加新关系

    添加关系页面随即打开。

  4. 您可以将主表映射到外表。
  5. 输入你想要的别名。

现在,您可以根据在每个集成上设置的主键来映射和添加额外的参考列。

重要:

如果删除表,所有关系也会被删除。

设置数据同步

将数据从集成应用程序提取到微应用平台,以便与缓存进行比较。作为最佳做法,完全同步每 24 小时执行一次,并且可以将增量同步配置为每五分钟提取一次。

有关同步规则、不符合其计划的同步和否决规则的完整信息,请参阅同步数据

  1. 在 “管理微应用” 页面中,选择要为其设置同步的集成旁边的菜单。
  2. 选择 “ 同步”。

    如何设置数据同步

  3. 设置 完整增量 数据同步值。

    • 完全 删除本地缓存并从源系统中提取所有数据。

      重要:

      运行完全同步可能需要很长时间。我们建议在夜间运行完全同步,或者通常在非工作时间运行您可以通过选择 X 图标随时取消正在进行的数据同步。

    • 增量 拉取仅更改(新的和更新的)记录。不加载已删除的数据。

      重要:

      并非所有 API 都支持增量同步。

      定义每 日或每 同步时,同步会在您选择的时隙内随机进行。例如,选择 00-04 每日完全同步将在该时段内随机选择的时间运行完全同步。

  4. 选择保存

注意:

如有必要,您还可以选择箭头图标以按需运行集成。

显示集成日志

使用 集成日志 查看按严重性分类的更改历史记录。使用它来解决集成中的问题。例如,如果您发现同步失败,请查看集成日志以了解原因。或者,如果未显示预期的卡片,请检查集成日志以查看是否发生了同步。

如何查找集成日志

  1. 在 “管理微应用” 页面中,选择要查看其集成日志的集成旁边的菜单。
  2. 选择 集成日志
  3. 查看条目,然后根据需要选择菜单以按错误进行筛选。

导出集成配置

您可以导出集成配置。所有凭证都将被丢弃。这包括密码和客户端详细信息。仅导出存储在微应用服务器中的配置。例如,导出保留你的用户名而不是你的密码,而且导出会保留你的 OAuth 配置,但不保留客户端机密。

  1. 在 “管理微应用” 页面中,选择要导出的集成旁边的菜单。
  2. 选择 导出配置

    service .mapp 文件将下载。

下一步的去向

现在,您已经创建并配置了自定义集成,请构建自己的微应用,以提供最佳的最终用户体验,满足您的需求并简化日常工作流程。有关更多信息,请参阅 创建微应用

配置集成