连接器任务

连接器任务可让您使用 Integration Connectors 中提供的开箱即用连接器快速安全地连接到集成中的 Google Cloud 服务和其他业务应用。

如需查看 Application Integration 的所有受支持的连接器列表，请参阅连接器参考文档。

须知事项

添加连接器任务

如需向集成添加连接器任务，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往 Application Integration 页面。

    转到 Application Integration

  2. 在导航菜单中，点击集成。

    系统会显示集成页面，其中列出了 Google Cloud 项目中的所有可用集成。

  3. 选择现有集成，或点击创建集成以创建新的集成。

    如需创建新的集成，请执行以下操作：

    1. 在创建集成窗格中输入名称和说明。
    2. 选择集成的区域。
    3. 为集成选择服务账号。您可以随时在集成工具栏的 集成摘要窗格中更改或更新集成的服务账号详细信息。
    4. 点击创建。新创建的集成会在集成编辑器中打开。

  4. 在集成编辑器导航栏中，点击任务以查看可用任务和连接器的列表。

    5. 此图片展示了连接器任务

  5. 如果您想配置新连接，请点击连接器元素，并将其放置到集成编辑器中。然后，点击配置连接器以配置连接。

    此图片展示了连接器任务列表 此图片展示了连接器任务列表

  6. 如果您已有现有连接，请点击连接器标签页，查看最近创建的连接。您还可以通过在搜索字段中输入名称来搜索连接器、连接或任务。

    此图片展示了用于搜索连接器任务的搜索功能

  7. 点击配置的连接器元素，并将其放置到集成编辑器中。如需了解如何配置连接器任务，请参阅配置连接器任务。

配置连接器任务

如需配置连接器任务，请执行以下操作：

  1. 点击设计器上的连接器任务元素，以查看连接器任务配置窗格。

    （可选）点击 以重命名任务。

  2. 点击配置连接器。
  3. 您可以选择相应区域中的现有连接，也可以创建新连接。如需配置现有连接，请在连接器任务编辑器页面中完成以下步骤。

    下图展示了连接器任务编辑器页面的示例布局。 此图片展示了配置连接器任务对话框 此图片展示了配置连接器任务对话框

    1. 在选择连接部分中，选择连接所在的区域。
    2. 从所选区域的可用连接列表中选择一个现有连接。
    3. 点击下一步。
    4. 从类型列表中，选择实体或操作。
      • 如果您选择实体，则设置实体/操作部分会显示连接的受支持实体列表。选择一个实体，然后选择要对该实体执行的操作。
      • 如果您选择操作，则设置实体/操作列中会显示连接支持的操作列表。为连接选择操作。
        • 支持的实体和操作取决于连接器类型。如需查看 Application Integration 的所有受支持的连接器列表，请参阅连接器参考文档。如需查看某个连接器支持的操作和实体，请参阅具体的连接器文档。

        如果连接器支持自定义 SQL 查询，您可以从动作列表中选择执行自定义查询选项。如需了解如何为连接器添加自定义 SQL 查询，请参阅动作：执行自定义 SQL 查询。

    5. 点击完成以完成连接配置并关闭窗格。

配置任务输入和输出变量

连接器任务配置窗格会显示根据配置连接器任务对话框中选择的“实体和操作”或“操作”自动生成的任务输入和任务输出变量。这些变量可配置，并且可作为当前任务的输入、后续任务的输出或当前集成中的条件进行访问。

如需配置任务输入或任务输出变量，请点击相应变量以打开配置变量窗格并执行以下步骤：

  1. 在默认值字段中输入变量值。
  2. （可选）选择用作集成的输入或用作集成的输出。
  3. 点击保存。

如需详细了解连接器任务的输入和输出参数，请参阅实体操作。

配置身份验证替换

如需在运行时动态启用连接以接受不同的后端身份验证，请确保在 Integration Connectors 中，您已为连接选择启用身份验证替换选项。

如需配置身份验证替换，请执行以下操作：

  1. 点击设计器上的连接器任务元素，以查看连接器任务配置窗格。
  2. 展开任务输入部分。最终用户凭证字段设置为 dynamicAuthConfig 变量。

    最终用户凭据 最终用户凭据

    之后，执行以下操作：

    1. 点击 dynamicAuthConfig 变量。系统随即会显示修改变量窗格。

      如需替换身份验证，您必须在测试集成时提供身份验证值。

      修改动态 euc 变量 修改动态 euc 变量

      为此，请按以下步骤操作：

      1. 在变量类型列表中，选择集成输入。
      2. 在 JSON 架构选项中，您可以验证为连接配置的身份验证类型。在测试集成时，使用此架构可替换身份验证值。

        测试身份验证替换的集成 测试身份验证替换的集成

    或者，您也可以在连接器任务配置窗格的任务输入部分中选中使用 HTTPS 标头进行身份验证配置复选框，以通过 HTTP 标头传递身份验证信息。

    动态身份验证标头应采用以下 JSON 格式：

    {"task1":{"oauth2_auth_code_flow.access_token": "token_value"},"task2":{"oauth2_auth_code_flow.userename": "username_value"}}

    在此格式中，taskN 对应于 integrationVersion 中的任务 ID。

    通过将身份验证作为 HTTP 标头传递来测试集成 通过将身份验证作为 HTTP 标头传递来测试集成

实体操作和动作

您可以对连接器的实体执行 CRUD（创建、读取、更新、删除）操作。其中每个实体操作都有一组不同的输入和输出参数。下表列出了各种实体操作的输入和输出参数。

操作名称 输入参数 输出参数
列出
  • listEntitiesPageSize
  • listEntitiesPageToken
  • listEntitiesSortByColumns
  • filterClause
  • connectorOutputPayload
  • listEntitiesNextPageToken
获取 entityId connectorOutputPayload
创建 connectorInputPayload connectorOutputPayload
更新
  • connectorInputPayload
  • entityId
  • filterClause
 connectorOutputPayload
删除
  • entityId
  • filterClause
 不适用

输入参数

下表介绍了各种实体操作的输入参数。

参数名称 数据类型 说明
entityId 字符串

您要访问的行的唯一标识符。

通常，entityId 是表或数据集的主键值。如果您为 entityId 指定了值，并且表或数据集没有主键列，则集成会报告运行时错误，并且连接器任务会失败。

例如，如需从 MySQL 表中获取特定行，entityId 需要是表中的主键值。
connectorInputPayload JSON 要在实体中添加或更新的实际数据。以下示例展示了要添加到表中的行数据的 JSON 代码段：
{
"employee_first_name": "John",
"employee_emailID": "test-05@test.com"
}

在此示例中，employee_first_name 和 employee_emailID 是具有相应值 John 和 test-05@test.com 的列名称。
filterClause 字符串 根据条件限制操作结果。如需详细了解如何添加过滤条件子句，请参阅为操作添加过滤条件。
listEntitiesPageSize 整数

指定页面中应返回的结果数。

页面是结果集中记录的逻辑分组。如果您希望结果集中包含大量记录，则页面的概念非常有用。如果结果集很大，则连接器任务可能会失败，因为连接器任务可以处理的数据大小存在限制。您可以通过将结果集细分为较小的数据块来避免此问题。

例如，如果您希望结果集中有 1000 条记录，则可以将 listEntitiesPageSize 设置为 100。因此，连接器任务首次运行时，会返回前 100 条记录，第二次运行时返回下 100 条记录，依此类推。
listEntitiesPageToken 字符串

用于访问特定页面的页面标识符（令牌）。

您可以从 listEntitiesNextPageToken 输出参数中获取页面令牌的值。由于每个页面都有唯一的令牌，因此您可以灵活地访问结果集中您需要的任何页面。如需了解此参数的用法，另请参阅 listEntitiesNextPageToken 输出参数的说明。
listEntitiesSortByColumns 字符串数组 作为结果集排序依据的列名称。

输出参数

下表介绍了各种实体操作的输出参数。

参数名称 数据类型 说明
connectorOutputPayload JSON 操作的输出（采用 JSON 格式）。
listEntitiesNextPageToken 字符串

系统为页面生成的标识符。您可以将令牌视为可通过其访问结果集特定页面的指针。

如果您已通过设置 listEntitiesPageSize 参数将结果集拆分为多个页面，则您需要一种机制来浏览各个页面。借助 listEntitiesNextPageToken 输出参数，您便可以实现这一目的。连接器任务每次运行时，系统都会为下一页生成令牌，并将 listEntitiesNextPageToken 的值设置为新生成的令牌。之后，您便可以使用该令牌访问结果集中的下一页。若要访问下一页，您必须将 listEntitiesPageToken 输入参数设置为下一页的令牌值。

例如，假设您已将 listEntitiesPageSize 参数设置为 2。连接器任务首次运行时，listEntitiesNextPageToken 便会设置为 ChoKC2VtcGxveWVlX2lkEgkRAAAAAAAA8D8YDw== 令牌值。然后，您可以将 listEntitiesPageToken 输入参数设置为此令牌值，以在后续运行连接器任务时获取下一页。

如果结果集包含大量页面，您可以考虑使用 While 循环任务来获取下一页，并使用数据映射任务在每次运行后自动为 listEntitiesPageToken 输入参数分配页面令牌值。将上一次循环迭代中的 listEntitiesNextPageToken 映射到当前循环迭代的 Connectors 任务的 LIST Operation 中的 listEntitiesPageToken。当 listEntitiesNextPageToken 为 NULL 时，While 循环任务结束，这意味着没有更多网页。

实体操作的过滤条件子句

您可以使用可用作任务输入的过滤条件子句变量来限制连接器任务处理的记录。例如，对于删除操作，您可以添加过滤条件子句以删除具有特定 orderId 的记录。

过滤条件子句只能应用于以下实体操作：

  • 列表
  • 删除
  • 更新

选择上述任何操作时，连接器任务的任务输入部分都会自动显示 Filter clause（过滤条件子句）字段。

添加过滤条件子句

如需添加过滤条件子句，请执行以下步骤：

  1. 点击设计器上的连接器任务元素，以查看连接器任务配置窗格。
  2. 展开任务输入部分，然后点击 filterClause(Connectors) 字符串变量。

    随即会出现配置变量对话框。

  3. 在默认值字段中输入过滤条件子句（在子句语法后面）。
  4. 点击保存。

过滤条件子句语法和示例

过滤条件子句采用以下格式：