SAP SuccessFactors

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

准备工作

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

• 在您的 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)

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

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

• 确保您拥有有关计划连接的 SAP HANA 数据库的详细信息。如需了解如何安装 SAP HANA 数据库，请参阅安装 SAP HANA 数据库。

配置连接器

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

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

   转到“连接”页面

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

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

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

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

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
   4. （可选）输入连接实例的说明。
   5. 您可以选择启用 Cloud Logging，然后选择日志级别。默认情况下，日志级别设置为 Error。
   6. 服务账号：选择具有所需角色的服务账号。
   7. （可选）配置连接节点设置：
      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

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

   注意：仅当您是随用随付客户时，才能自定义连接节点值。
   8. 公司 ID：贵公司的唯一标识符。必须填写此字段才能进行身份验证。
   9. 数据格式：检索数据所使用的数据格式。选择 ATOM 或 JSON。
   10. Include Navigation Properties：一个布尔值，表示是否应在列列表中添加导航属性。
   11. Purge Type：PurgeType 是一个可选参数，用于确定是对实体执行增量更新还是完全更新。
   12. 使用客户端分页：适用于 SAP SuccessFactors 的 CData ADO.NET 提供方是否应使用客户端分页。
   13. 使用显示名称：用于确定是否使用 SAP 标签的布尔值。
   14. 使用代理：表示是否使用系统代理设置。此设置的优先级高于其他代理设置，因此您需要将 ProxyAutoDetect 设置为 FALSE，才能使用自定义代理设置。
   15. 代理身份验证方案：用于向 ProxyServer 代理进行身份验证的身份验证类型。
   16. 代理用户：用于向 ProxyServer 代理进行身份验证的用户名。
   17. 代理密码：用于向 ProxyServer 代理进行身份验证的密码。
   18. 代理 SSL 类型：连接到 ProxyServer 代理时使用的 SSL 类型。
   19. 使用代理：选中此复选框可为连接配置代理服务器并配置以下值：
   • 代理身份验证方案：选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型：
     • 基本：基本 HTTP 身份验证。
     • 摘要：摘要 HTTP 身份验证。
   • 代理用户：用于向代理服务器进行身份验证的用户名。
   • 代理密码：用户密码的 Secret Manager 密文。
   • 代理 SSL 类型：连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型：
     • 自动：默认设置。如果网址是 HTTPS 网址，则使用“隧道”选项。如果网址是 HTTP 网址，则使用“永不”选项。
     • 始终：连接始终启用 SSL。
     • 永不：连接未启用 SSL。
     • 隧道：连接通过隧道代理建立。代理服务器会打开与远程主机的连接，并且流量会流经该代理。
   • 在代理服务器部分中，输入代理服务器的详细信息。
     1. 点击+ 添加目标。
     2. 选择目标类型。
        • 主机地址：指定目标的主机名或 IP 地址。

          如果要与后端系统建立专用连接，请执行以下操作：

          • 创建 PSC 服务连接。
          • 创建端点连接然后在主机地址字段中输入端点连接的详细信息。
   20. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   21. 点击下一步。
5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
   1. 目标类型：选择目标类型。
      • 从列表中选择主机地址，以指定目标的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接，请从列表中选择端点连接，然后从端点连接列表中选择所需的端点连接。
        注意 ：如需了解如何创建端点连接，请参阅 PSC 服务连接 以及端点连接。在您之后 端点连接已创建完毕，它将显示在端点连接列表中。

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

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

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

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

      • 用户名和密码

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

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

配置身份验证

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

• 用户名和密码
  • 用户名：连接器的用户名
  • 密码：包含与连接器关联的密码的 Secret Manager Secret。
  • 身份验证方案：用于身份验证的方案

基本身份验证连接类型示例

下表列出了基本身份验证连接类型的示例配置值。请参阅 连接创建界面，以了解必填字段和可选字段。

字段名称	示例值
区域	us-central1
连接器	SAP SuccessFactors
连接器版本	1
连接名称	sapsf-basicauth-conn
说明	SuccessFactors 连接
服务账号	[e-mail]
公司 ID	SFPART068178
主机地址	https://HOST_NAME.successfactors.eu/
用户名	sfadmin
密码	PASSWORD
身份验证方案	基本

实体、操作和动作

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

注意：您可以在连接器任务中查看连接器的实体、操作和动作。

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

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

• 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
  • 列表
  • 获取
  • 创建
  • 更新
  • 删除

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

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

注意 ：所有实体和操作都具有与其关联的架构。例如，动作架构将包含参数详细信息，例如：参数名称及其相应的数据类型。实体和操作的架构（元数据）由连接位于 从后端提取代码如果架构有任何更新，此类更新将不会 会自动体现在您的现有连接中；您必须手动刷新架构刷新 连接架构，打开连接的连接详情页面，然后点击 刷新连接架构。

系统限制

SAP SuccessFactors 连接器每秒可以处理 10 个事务， 每节点， 并throttles任何事务 。 默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

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

注意：Integration Connectors 节点的数量会动态地自动扩缩 根据您的使用情况不过，如果您想为大量数据预留容量，而不必等待自动扩缩，则可以调整连接的最小节点值。更多 节点处理更多连接事务。反之，节点数量越少 如果连接处理的事务较少，则必需项。如需配置节点值，请执行以下操作：

• 如果您是随用随付的客户，请配置最小和最大节点值 “修改连接”页面中
• 如果您是订阅型客户，请与支持团队联系。

节点可处理的最大事务数取决于多种因素。因此，在调整最小节点数以提高吞吐量之前，建议您检查后端系统是否已以最佳方式设置，以处理所需的流量。

操作

本部分列出了 SuccessFactors 关联支持的所有操作。

UpsertEntity 操作

您可以通过此操作更新/插入实体的记录。

UpsertEntity 操作的输入参数

参数名称	数据类型	必填	说明
entityType	字符串	True	要更新/插入的实体类型。
payload	对象	True	以 JSON 格式更新/插入载荷。

UpsertEntity 操作的输出参数

此操作会返回状态 200 (OK)，并在响应正文中指明所有更新/插入结果。

如需了解如何配置 UpsertEntity 操作，请参阅示例。

操作示例

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

示例 - 更新 PerPersonal 实体中的记录

以下示例更新了 PerPersonal 实体中的记录。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 UpsertEntity 操作，然后点击完成。
3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段：

   {
   "entityType": "PerPersonal",
   "payload": {
     "personIdExternal": "109031",
     "startDate": "1800-01-01 00:00:00.0",
     "firstName": "John",
     "lastName": "Job",
     "nationality": "IND"
     }
   }

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

[{
  "personIdExternal": "109031",
  "startDate": "1989-12-31 23:00:00.0"
}]

示例 - 更新 PaymentInformationDetailV3 实体中的记录

以下示例将更新 PaymentInformationDetailV3 实体中的记录。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 UpsertEntity 操作，然后点击完成。
3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段：

   {
     "entityType": "PaymentInformationDetailV3",
     "payload": {
       "PaymentInformationV3_effectiveStartDate": "2015-01-21 00:00:00.0",
       "PaymentInformationV3_worker": "82096",
       "externalCode": 563.0,
       "currency": "EUR"
     }
   }

如果该操作成功 连接器任务的 connectorOutputPayload 字段中会显示一个 值类似于以下内容：

[{
  "externalCode": 563.0,
  "PaymentInformationV3_effectiveStartDate": "2015-01-20 23:00:00.0",
  "PaymentInformationV3_worker": "82096"
}]

示例 - 在实体中创建记录

以下示例会在 TodoEntryV2 实体中创建一条记录。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 UpsertEntity 操作，然后点击完成。
3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段：

   {
     "entityType": "TodoEntryV2",
     "payload": {
       "todoEntryName": "Finish Your Tasks",
       "status": 1.0,
       "categoryId": "41",
       "LinkeduserNav": {
         "__metadata": {
           "uri": "https://apisalesdemo2.successfactors.eu/odata/v2/User('613577712')",
           "type": "SFOData.User"
         }
       }
     }
   }

如果操作执行成功，则连接器任务的 connectorOutputPayload 字段 将具有类似于以下内容的值：

[{
  "todoEntryId": 221443.0
}] 

实体示例

示例 - 列出实体的记录

以下示例列出了 FOCompany 实体的记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 FOCompany。
3. 选择 LIST 操作，然后点击完成。
4. 在连接器任务的任务输入部分，您可以设置 filterClause。

   例如，将过滤条件子句设置为 externalCode='5100' and startDate='1900-01-01 00:00:00'，仅列出这些记录 其 externalCode 为 5100，startDate 为 1900-01-01 00:00:00。

示例 - 从实体获取记录

此示例会从 User 实体中提取记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 User。
3. 选择 GET 操作，然后点击完成。
4. 在连接器任务的任务输入部分，点击 EntityId，然后在默认值字段中输入 103032。

   其中，103032 是 Users 实体的主键。

示例 - 从实体中删除记录

此示例会从 FOCompany 实体中删除一条记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 FOCompany。
3. 选择 DELETE 操作，然后点击 完成。
4. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 113132。

   或者，如果实体具有复合主键，则无需指定 entityId，可以执行以下操作： 设置 filterClause。例如 externalCode='5100' and startDate='1900-01-01 00:00:00'。

示例 - 在实体中创建记录

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 FOCompany。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "externalCode": "1000",
   "startDate": "1900-01-01 00:00:00.0",
   "standardHours": 40.0,
   "status": "I",
   "currency": "EUR",
   "country": "DEU"
   }

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

   {
   "externalCode": "1000",
   "startDate": "1900-01-01 00:00:00.0"
   }

示例 - 在 TimeZone 实体中创建记录

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 TimeZone。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "effectiveStartDate": "2023-08-16 00:00:00.0",
   "externalCode": "10013",
   "effectiveStatus": "A",
   "utcDstOffset": "UTC+01:00",
   "utcOffset": "+0100"
   }

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

   {
   "effectiveStartDate": "2023-08-16 00:00:00.0",
   "externalCode": "10013"
   }

示例 - 更新实体中的记录

此示例会更新 FOCompany 实体中的记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 FOCompany。
3. 选择 Update 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "description": "BestRun India"
   }

5. 在连接器任务的任务输入部分，点击 entityId 并 然后在 Default Value 字段中输入 103032。

   或者，如果实体具有复合主键，则无需指定 entityId，可以执行以下操作： 设置 filterClause。例如 externalCode='5100' and startDate='1900-01-01 00:00:00'。

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

{
"externalCode": "5100",
"startDate": "1900-01-01 00:00:00.0"
}

使用 Terraform 创建连接

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

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

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

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

参数名称	数据类型	必需	说明
company_id	STRING	True	贵公司的唯一标识符。您必须提供用户名才能验证身份。
purge_type	STRING	错误	PurgeType 是一个可选参数，用于确定将对实体执行增量更新还是完全更新。
use_client_side_paging	BOOLEAN	错误	SAP SuccessFactors 的 CData ADO.NET 提供程序是否应使用客户端分页。
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 SuccessFactors 连接

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

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

向 Google Cloud 社区寻求帮助

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

后续步骤

• 了解如何暂停和恢复连接。
• 了解如何监控连接器使用情况。
• 了解如何查看连接器日志。