SAP Gateway

借助 SAP Gateway 连接器，您可以对 SAP Gateway 数据库执行插入、删除、更新和读取操作。

支持的版本

该连接器使用 SAP Gateway API 来启用对使用网关的 SAP 服务的双向访问。支持以下 SAP 版本：

  • S/4 HANA 云
  • S/4 HANA
  • SAP ERP
  • 支持 SAP Gateway API 的任何其他 SAP 版本

准备工作

在使用 SAP Gateway 连接器之前，请先完成以下任务：

  • 在您的 Google Cloud 项目中：
    • 将 IAM 角色 roles/connectors.admin 授予该用户 配置连接器。
    • 将以下 IAM 角色授予您要用其来使用连接器的服务账号：
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服务账号是一种特殊类型的 Google 账号，用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号，则必须创建一个服务账号。如需了解详情，请参阅创建服务账号。

    • 启用以下服务：
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如需了解如何启用服务，请参阅启用服务。

    如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。

配置连接器

配置连接器时，您需要创建与数据源（即后端系统）的连接。一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下步骤：

  1. 在 Cloud 控制台 中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。

    转到“连接”页面

  2. 点击 + 新建以打开创建连接页面。
  3. 在位置部分中，选择连接的位置。
    1. 区域：从下拉列表中选择一个位置。

      如需查看所有受支持区域的列表，请参阅位置。

    2. 点击下一步。
  4. 在 Connection Details 部分中，完成以下操作：
    1. 连接器：从可用连接器下拉列表中选择 SAP Gateway。
    2. 连接器版本：从可用版本的下拉列表中选择连接器版本。
    3. 在 Connection Name 字段中，输入连接实例的名称。

      连接名称必须满足以下条件：

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 63 个字符。
    4. （可选）输入连接实例的说明。
    5. 服务账号：选择具有所需角色的服务账号。
    6. 如需将连接用于事件订阅，请选择启用事件订阅。正在选择 时，系统会显示以下选项：
      • Enable event subscription with entity and actions（启用包含实体和操作的事件订阅）：选择此选项可以 将连接用于事件订阅和连接器操作（实体和操作）。
      • 仅启用事件订阅：选择此选项可使用连接 仅适用于事件订阅。如果您选择此选项，请点击下一步，然后 配置事件订阅。
    7. 命名空间：指定要从中检索数据的服务命名空间。如果网址中未指定服务，则必须提供此值。
    8. 服务：指定要从中检索数据的服务。如果网址中未指定服务，则必须提供此值。
    9. CustomUrlParams:：指定 HTTP 请求中包含的自定义查询字符串参数。这些参数必须采用以下格式编码为查询字符串：field1=value1&field2=value2。查询字符串中的值必须经过网址编码。
    10. 数据格式：检索数据所使用的数据格式。请选择 XML 或 JSON。
    11. 使用显示名称：用于确定是否使用 SAP 标签的布尔值。
    12. （可选）配置连接节点设置：

      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

      节点是处理事务的连接单元（或副本）。 连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。 如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。

    13. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
    14. 点击下一步。
  5. 在目标位置部分，设置 SAP Gateway 环境的网址或 OData 服务的完整网址。示例格式：${ENVIRONMENT_URL}/sap/opu/odata/${NAMESPACE}/${SERVICE}/，示例网址为 https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/。使用 CustomUrlParams 属性添加任何其他属性。
    1. 目的地类型：选择目的地类型。
      • 从列表中选择主机地址，以指定目的地的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接，请从列表中选择端点连接，然后从端点连接列表中选择所需的端点连接。

      如果要与后端系统建立公共连接以提高安全性，您可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。

      要输入其他目标，请点击 + 添加目标。

    2. 点击下一步。
  6. 在 Authentication（身份验证）部分中，输入身份验证详细信息。
    1. 选择身份验证类型，然后输入相关详情。

      SAP Gateway 连接支持以下身份验证类型：

      • 用户名和密码
      • 匿名

      2. 如需了解如何配置这些身份验证类型，请参阅配置身份验证。

    2. 点击下一步。
  7. 查看：查看您的连接和身份验证详细信息。
  8. 点击创建。

配置身份验证

根据您要使用的身份验证输入详细信息。

  • 用户名和密码
    • 用户名：连接器的用户名
    • 密码：包含与连接器关联的密码的 Secret Manager Secret。
  • 匿名

    如果您要使用匿名登录，请选择不可用。

    • API 密钥：当前经过身份验证的用户的 API 密钥。

配置事件订阅

如果您启用了事件订阅，请在 Event Subscription Details 部分中输入以下值：

  1. 为事件监听器选择以下任意一种身份验证类型。
  2. 输入事件类型字段名称。此字段标识事件类型 与传入事件请求相关联。 
    {
"event_type": "user.created",
...
// other request fields
...
}
  3. 选择启用专用连接以在后端应用之间实现安全连接 以及你的人脉关系如果您选择此选项，则必须执行额外的配置步骤 。如需了解详情，请参阅适用于事件订阅的专用连接。
  4. 输入死信配置。如果您配置了死信，则连接会写入 将未处理的事件发送到指定的 Pub/Sub 主题。输入以下详细信息：
    1. 死信项目 ID ：您在其中配置了死信 Pub/Sub 主题的 Google Cloud 项目的 ID。
    2. 死信主题 ：您要在其中写入未处理事件详细信息的 Pub/Sub 主题。
。

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

  • 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

    但是，连接器可能不支持或不支持任何实体，在这种情况下， “Entities”列表将为空。

  • 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：

    从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。但是，如果连接器不支持任何实体操作， 操作未在 Operations 列表中列出。

  • 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作有一些输入参数和一个输出 参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。
。

系统限制

  • SAP Gateway 连接器针对每个节点每秒最多可以处理 9 个事务。

    如需了解适用于 Integration Connectors 的限制，请参阅限制。

  • 不支持以下功能：
    • 基于 OAuth2.0 的身份验证
    • ETag
    • 深插入
    • 基于文件的操作

实体操作示例

本部分介绍如何在此连接器中执行某些实体操作。

示例 - 列出所有记录

以下示例列出了 SalesOrderSet 实体中的所有记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 SalesOrderSet。
  3. 选择 List 操作，然后点击完成。
  4. （可选）在连接器任务的任务输入部分，您可以执行以下操作： 通过指定过滤子句来过滤结果集。 例如 City='Bangalore'。您 也可以使用逻辑运算符指定多个过滤条件。例如 City='Bangalore' and region='asia-south2'。

示例 - 获取记录

此示例从 SalesOrderSet 实体中获取具有指定 ID 的记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 SalesOrderSet。
  3. 选择 Get 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击实体 ID，然后 然后在 Default Value 字段中输入 13。

    其中，13 是 SalesOrderSet 实体中的主键值。

示例 - 创建记录

此示例在 SalesOrderSet 实体中创建了一条记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 SalesOrderSet。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"Vbeln":"999",
"Erdat":"2020-08-25 00:00:00",
"Erzet":"13:12:31",
"Ernam":"Test"
}

    如果集成成功，连接器任务的 connectorOutputPayload 字段将显示 值类似于以下内容：

    {
"Vbeln": "999"
}

示例 - 创建记录

此示例在 SalesPriceSet 实体中创建了一条记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 SalesPriceSet。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"Vbeln": "129",
"Posnr": "000000",
"Knumh": "SUN25MAY",
"Kpein": 1.0
}

    如果集成成功，连接器任务的 connectorOutputPayload 字段将显示 值类似于以下内容：

    {
"Posnr": "000000",
"Vbeln": "129"
}

示例 - 更新记录

此示例将更新 SalesOrderSet 实体中的一条记录。

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 SalesOrderSet。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段： 
    {
"Ernam": "Test123"
}
  5. 点击 entityId，然后在 Default Value 字段中输入 99。

    如果集成成功，连接器任务的 connectorOutputPayload 字段将显示 值类似于以下内容：

    {
"Vbeln": "999"
}

使用 Terraform 创建连接

您可以使用 Terraform 资源以创建新连接。

如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。

如需查看用于创建连接的 Terraform 模板示例，请参阅示例模板。

使用 Terraform 创建此连接时，您必须在 Terraform 配置文件中设置以下变量：

参数名称 数据类型 必需 说明
命名空间 STRING 错误 指定要从中检索数据的服务命名空间。如果网址中未指定服务，则必须提供此值。
服务 STRING 错误 指定要从其中检索数据的服务。如果网址中未指定服务，则必须提供此值。
custom_url_params STRING 错误 CustomUrlParams 可让您指定 HTTP 请求中包含的自定义查询字符串参数。这些参数必须编码为查询字符串，格式为：field1=value1&field2=value2。查询字符串中的值必须经过网址编码。
data_format ENUM 错误 用于检索数据的数据格式。请选择 XML 或 JSON。支持的值包括：XML、JSON
use_display_names BOOLEAN 错误 用于确定是否使用 SAP 标签的布尔值。
详细程度 STRING 错误 连接的详细程度级别从 1 到 5 不等。较高的详尽级别将记录所有通信详情（请求、响应和 SSL 证书）。
proxy_enabled BOOLEAN 错误 选中此复选框可为连接配置代理服务器。
proxy_auth_scheme ENUM 错误 用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括：BASIC、DIGEST、NONE
proxy_user STRING 错误 用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password SECRET 错误 用于向 ProxyServer 代理进行身份验证的密码。
proxy_ssltype ENUM 错误 连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括：AUTO、ALWAYS、NEVER、TUNNEL

在集成中使用 SAP Gateway 连接

创建连接后，它便可同时在 Apigee Integration 和 Application Integration。您可以使用连接 通过连接器任务在集成中进行集成。

  • 如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
  • 如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 中发布问题和讨论此连接器 Cloud 论坛。

后续步骤