SAP Gateway

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

支持的版本

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

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

准备工作

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

  • 在您的 Google Cloud 项目中：
    • 确保已设置网络连接。如需了解网络模式，请参阅网络连接。
    • 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
    • 将以下 IAM 角色授予您要用其来使用连接器的服务账号：
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

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

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

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

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

在 S/4HANA 本地版上配置 SAP OData 服务

如需在 S/4HANA 本地版上配置 SAP OData 服务，请执行以下任务：

  • 启用 ICM 服务
  • 激活 SAP Gateway
  • 激活 OData 服务
  • 在 SAP 服务器上测试已激活的 OData 服务

启用 ICM 服务

SAP OData 服务通过 HTTP 或 HTTPS 协议运行。因此，请确保在 Internet Communication Manager (ICM) 中启用相关服务。使用 HTTPS 来保护传输中的数据。

  1. 前往事务 SMICM。
  2. 前往“服务”。
  3. 依次点击服务 > 创建。
  4. 定义新服务。

    5. 定义服务端口时，系统会根据 SAP 系统预先填充一些参数。

  5. 为 HTTP 和 HTTPS 协议设置其余参数。

激活 SAP Gateway

如需激活 SAP 网关，请执行以下步骤：

  1. 前往事务 SPRO，然后选择 SAP 参考 IMG。
  2. 依次展开节点 SAP NetWeaver > SAP Gateway > OData Channel > Configuration > User Settings > Connection Settings > Activate or Deactivate SAP Gateway，然后右键点击并选择 Edit Activity。
  3. 点击 Activate（激活）。如果对话框中显示“SAP Gateway 目前处于活跃状态”消息，请点击取消。

激活 OData 服务

如需激活 OData 服务，请执行以下步骤。

  1. 前往交易 SICF。
  2. 点击执行（或按 F8）。
  3. 在选择界面中跳过过滤。
  4. 前往树节点 default_host > sap > opu > OData，以激活所有 OData (V2) 服务。
  5. 前往树中更深层的相应节点，以激活单个服务。
  6. 右键点击 OData 服务节点，然后选择激活。

在 SAP 服务器上测试已激活的 OData 服务

使用 SAP Gateway Client 工具执行 OData 请求。

调用以下事务以启动该工具：/n/IWFND/GW_CLIENT

  1. 指定 OData 请求 URI。
  2. 选择 HTTP 方法、协议（HTTP 或 HTTPS）、请求标头和请求正文。
  3. 输入所有必要的请求数据后，点击执行以发送请求。

    4. 执行后，系统会显示响应标头和响应数据。

在 S/4HANA Cloud 上配置 SAP OData 服务

如需在 S/4HANA Cloud 上配置 SAP OData 服务，请执行以下任务：

  • 创建通信用户
  • 创建通信系统
  • 创建通信配置

创建通信用户

通信用户是一种特殊类型的技术用户，用于外部 OData 服务调用。它仅用于 SAP 与外部系统的通信，无法使用通信用户通过 SAP GUI 登录。借助“维护通信用户”应用，您可以在云端定义这些设置。

  1. 前往维护通信用户应用。
  2. 点击新建以创建新用户。
  3. 输入用户的用户名和说明。
  4. 输入密码。使用 propose password 生成密码。
  5. 点击创建。

创建通信系统

通信系统是一种系统规范，用于表示通信伙伴以及通信所需的所有必要技术信息，例如主机名/IP 地址、身份、用户信息和证书。在 S/4HANA Cloud 系统中，这些实体是外部通信所必需的。借助“Communication Systems”应用，您可以在云端定义这些设置。

  1. 前往通信系统应用。
  2. 点击新建以创建新的通信系统。
  3. 输入系统 ID 和系统名称。
  4. 点击 + 以添加为入站通信创建的通信用户。输入通信用户的详细信息。

    5. 入站通信是指通信伙伴使用已定义的系统从外部调用 SAP S/4HANA 系统。

  5. 点击保存。

创建通信配置

如需了解通信安排，请参阅 通信安排。

  1. 前往通信配置应用。
  2. 点击新建以创建新的通信安排。
  3. 选择您的通信场景，输入编排名称，然后点击创建。
  4. 添加您的通信系统，然后选择要在此通信安排中使用的通信用户。
  5. 调用 OData 服务的网址可在通信安排中找到，格式如下：https://-api.s4hana.ondemand.com/sap/opu/odata/sap/
  6. 点击保存

配置连接

一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下操作：

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

    转到“连接”页面

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

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

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

      连接名称必须符合以下条件：

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

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

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

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

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

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

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

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

      • 用户名和密码
      • 匿名
      • SAP BTP（OAuth 2.0 - 客户端凭据）

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

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

配置身份验证

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

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

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

    • API 密钥：当前经过身份验证的用户的 API 密钥。
  • SAP BTP（OAuth 2.0 - 客户端凭据）
    • 客户端 ID：输入从 API 客户端页面获取的客户端 ID。
    • 客户端密钥：输入从 API 客户端页面获得的客户端密钥。
    • 密文版本：输入上面所选密文的密文版本。
    • OAuthAccessTokenURL：输入 OAuth 访问令牌的网址。
    • 目标名称：输入 SAP BTP 目标的名称。
    • 目标网址：输入 SAP BTP 的目标网址。
    • 启用身份验证替换：选择此选项可启用连接，以便在运行时动态接受其他身份验证。

配置事件订阅

如果您已启用事件订阅，请在事件订阅详细信息部分中输入以下值：

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

连接配置示例

本部分提供了在创建 SAP Gateway 连接器时配置的各个字段的示例值。

基本身份验证 - 连接类型

字段名称 详细信息
区域 us-central1
连接器 SAP Gateway 连接器
连接器版本 1
连接器名称 sapgateway-basicauth-conn
服务账号 SERVICE_ACCOUNT-compute@developer.gserviceaccount.com
数据格式 JSON
详细程度 5
主机地址 http://192.0.2.0/sap/opu/odata/sap/HOST_ADDRESS
Authentication: 用户密码
用户名 用户名
密码 密码
版本 1

API 令牌 - 连接类型

字段名称 详细信息
区域 us-central1
连接器 SAP Gateway 连接器
连接器版本 1
连接器名称 sapgateway-api-token-conn
服务账号 SERVICE_ACCOUNT-compute@developer.gserviceaccount.com
数据格式 JSON
详细程度 5
主机地址 http://192.0.2.0/sap/opu/odata/sap/HOST_ADDRESS
API 密钥 API_KEY-example-pet-store.com
版本 1

代理 - 连接类型

字段名称 详细信息
区域 us-central1
连接器 SAP Gateway 连接器
连接器版本 1
连接器名称 sapgateway-basicauth-conn
服务账号 SERVICE_ACCOUNT-compute@developer.gserviceaccount.com
数据格式 JSON
详细程度 5
主机地址 http://192.0.2.0/sap/opu/odata/sap/HOST_ADDRESS
数据格式： JSON
详细程度： 5
代理 正确
代理 SSL 类型 自动
代理服务器 34.148.1.XX:XXXX
主机地址： http://192.0.2.0/sap/opu/odata/sap/HOST_ADDRESS
Authentication: 用户密码
用户名 用户名
密码： 密码
版本 1

SAP BTP (OAuth 2.0 - 客户端凭据) - 连接类型

字段名称 详细信息
区域 us-central1
连接器 SAP Gateway 连接器
连接器版本 1
连接器名称 sap-gateway-oauth-client-connection
服务账号 SERVICE_ACCOUNT-compute@developer.gserviceaccount.com
数据格式 JSON
主机地址： https://my-api.s4hana.cloud.sap/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV
Authentication: SAP BTP
客户端 ID CLIENT_ID
客户端密钥 CLIENT_SECRET
OAuthAccessTokenURL https://atrial.authentication.us10.hana.ondemand.com/oauth/token
目的地名称 DESTINATION_NAME
目标网址 https://destination-configuration.cfapps.us10.hana.ondemand.com/destination-configuration/v1/destinations/Google
版本 1

实体、操作和动作

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

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

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

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

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

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

系统限制

  • SAP 网关连接器每节点每秒最多可处理 9 个事务。

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

  • 不支持以下功能：
    • 基于 OAuth 2.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. 在连接器任务的任务输入部分，点击 EntityId，然后在默认值字段中输入 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，然后在默认值字段中输入 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 论坛中发布您的问题以及讨论此连接器。

后续步骤