Workday

借助 Workday 连接器，您可以连接到 Workday 实例，并作为传统数据库访问 Workday 数据。

准备工作

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

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

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

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

工作日配置

设置 Workday 账号

登录 Workday 登录页面，创建 Workday 账号。如需了解 Workday 社区，请参阅 Workday 社区。如需了解 REST API，请参阅 REST API。

为 Oauth 2.0 身份验证设置客户端 ID 和客户端密钥

如需在 Workday 中创建和注册 API 客户端，请执行以下操作：

1. 在 Workday 中，点击注册 API 客户端。
2. 输入客户名称。
3. 将客户端授权类型选择为授权代码授权。
4. 选择 Bearer 访问令牌类型，根据需要添加其他范围，然后点击 OK。
5. 输入注册 API 客户端所需的所有详细信息和范围。
6. 如需设置 SOAP 身份验证类型，请添加用户名和密码。

配置连接器

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

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

   转到“连接”页面

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

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

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

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

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

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

   注意：仅当您是随用随付客户时，才能自定义连接节点值。
   8. 租户：账号的租户。例如 abc_cms1。您可以在 Workday 实例配置详情中获取租户的名称。
   9. 服务：要从中检索数据的特定服务。请以英文逗号分隔列表的形式输入。例如 absenceManagement,common,compensation,recruiting,payroll,person
   10. WSDL 版本：要使用的 WSDL 的版本。
   11. 使用代理：选中此复选框可为连接配置代理服务器并配置以下值：
   • 代理身份验证方案：选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型：
     • 基本：基本 HTTP 身份验证。
     • 摘要：摘要 HTTP 身份验证。
   • 代理用户：用于向代理服务器进行身份验证的用户名。
   • 代理密码：用户密码的 Secret Manager 密文。
   • 代理 SSL 类型：连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型：
     • 自动：默认设置。如果网址是 HTTPS 网址，则使用“隧道”选项。如果网址是 HTTP 网址，则使用“永不”选项。
     • 始终：连接始终启用 SSL。
     • 永不：连接未启用 SSL。
     • 隧道：连接通过隧道代理建立。代理服务器会打开与远程主机的连接，并且流量会流经该代理。
   • 在代理服务器部分中，输入代理服务器的详细信息。
     1. 点击+ 添加目标。
     2. 选择目标类型。
        • 主机地址：指定目标的主机名或 IP 地址。

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

          • 创建 PSC 服务连接。
          • 创建端点连接然后在主机地址字段中输入端点连接的详细信息。
   12. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   13. 点击下一步。
5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
   1. 您可以配置以下任意目标类型：
      • 基本网址：点击 + 添加目标，然后输入 Workday 实例的基本网址。例如 https://wd5-impl-service23.workday.com
      • API 网址：点击 + 添加目标位置，然后输入 Workday 实例的 API 网址。例如 https://wd5-impl-service23.workday.com/srx/api/v1/TENANT
      • WSDL 网址：点击 + 添加目标，然后输入 Workday 实例的 WSDL 网址。

      您可以使用 REST 或 SOAP 协议与 Workday 实例进行通信。如需了解如何为每种协议配置连接，请参阅为 REST 或 SOAP 配置连接。

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

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

      • 用户名和密码
      • OAuth 2.0 - 授权代码

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

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

为 REST 或 SOAP 配置连接

REST 的配置

如需让连接使用 REST 协议，您必须使用 OAuth 2.0 - 授权代码身份验证类型，并配置以下字段：

在连接详情部分中：

• 租户
• 服务
• WSDL 版本

在目标部分中：

• 基准网址
• API 网址

在身份验证部分中：

• 客户端 ID
• 客户端密钥

SOAP 配置

如需让连接使用 SOAP 协议，您必须使用用户名和密码身份验证类型，并配置以下字段：

在连接详情部分中：

• 租户
• 服务
• WSDL 版本

在目标部分中：

• 基准网址

在身份验证部分中：

• 用户名
• 密码

配置身份验证

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

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

• OAuth 2.0 - 授权代码
• 客户端 ID：由外部应用提供的客户端 ID。
• 范围 ：权限范围。
• 客户端密钥 ：选择 Secret Manager 密钥。 您应该先创建 Secret Manager 密钥，然后再配置此授权。
• 密钥版本：客户端密钥的 Secret Manager 密钥版本。
• 授权网址：输入您在创建 Workday 实例时生成的授权网址。
• 连接类型：选择连接类型。

对于 OAuth 2.0 - Authorization code 身份验证类型，在创建连接后，您应执行一些额外的步骤来配置身份验证。如需了解详情，请参阅创建连接后的其他步骤。

注意：如果您使用的是 OAuth 2.0 - Authorization code 身份验证类型，并且在 Workday 应用中进行了任何配置更改，则必须重新授权您的 Workday 连接。如需了解如何重新授权，请参阅重新授权授权代码。

创建连接后的其他步骤

如果您选择了 OAuth 2.0 - Authorization code 作为身份验证方式，则必须在创建连接后执行以下额外步骤：

1. 在“连接”页面中，找到新创建的连接。

   请注意，新连接器的状态将为需要授权。

2. 点击需要授权。

   系统随即会显示修改授权窗格。

3. 将重定向 URI 值复制到您的外部应用。
4. 验证授权详细信息。
5. 点击授权。

   如果授权成功，“连接”页面中的连接状态将设为有效。

重新授权授权代码

如果您使用的是 Authorization code 身份验证类型，并且在 Workday 应用中进行了任何配置更改，则必须重新授权您的 Workday 连接。如需重新授权关联，请执行以下步骤：

1. 在“连接”页面中，点击所需的连接。

   系统随即会打开连接详情页面。

2. 点击修改以修改关联详情。
3. 在身份验证部分中，验证 OAuth 2.0 - 授权代码详细信息。

   根据需要进行必要的更改。

4. 点击保存。您随即会进入连接详情页面。
5. 点击身份验证部分中的修改授权。系统随即会显示 Authorize（授权）窗格。
6. 点击授权。

   如果授权成功，“连接”页面中的连接状态将设为活跃。

连接配置示例

本部分列出了您在创建 Workday 关联时配置的各种字段的示例值。

用户名密码连接类型

字段名称	详细信息
位置	us-central1
连接器	Workday
连接器版本	1
连接名称	google-cloud-workday-soap-conn
启用 Cloud Logging	否
服务账号	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
租户	TENANT_NAME
服务	SERVICE_NAME
WSDL 版本	v41.0
详细程度	5
节点数下限	2
节点数上限	50
基准网址	BASE_网址
身份验证	USER_PASSWORD
用户名	用户名
密码	密码
密钥版本	1

OAuth 2.0 - 授权代码连接类型

字段名称	详细信息
位置	us-central1
连接器	Workday
连接器版本	1
连接名称	google-cloud-workday-rest-conn
启用 Cloud Logging	否
服务账号	XSERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
租户	TENANT_NAME
详细程度	5
节点数下限	2
节点数上限	50
基准网址	BASE_网址
API网址	API_网址
身份验证	OAuth 2.0 - 身份验证代码
客户端 ID	CLIENT_ID
范围	system
客户端密钥	CLIENT_SECRET
密钥版本	1
授权网址	AUTHORIZATION_网址
连接类型	REST

如需了解如何为 REST API 客户端设置 OAuth 2.0，请参阅 Workday 文档。

集成系统用户连接类型

字段名称	详细信息
位置	europe-west1
连接器	Workday
连接器版本	1
连接名称	CONNECTION_NAME
启用 Cloud Logging	否
服务账号	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
租户	TENANT_NAME
服务	SERVICE_NAME
节点数下限	2
节点数上限	50
基准网址	BASE_网址
身份验证	集成系统用户
客户端 ID	CLIENT_ID
客户端密钥	CLIENT_SECRET
密钥版本	8
刷新令牌	REFRESH_TOKEN
密钥版本	7

实体、操作和动作

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

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

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

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

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

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

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

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

系统限制

Workday 连接器每个节点每秒可处理 3 笔交易，并会对超出此限制的所有交易进行节流。默认情况下，集成连接器会为连接分配 2 个节点（以提高可用性）。

如需了解适用于集成连接器的限制，请参阅限制。

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

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

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

在集成中使用 Workday 连接

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

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

实体操作示例

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

使用 Workday 连接时，实体名称的格式为“SCHEMA_NAME.ENTITY_NAME”。例如，在“Staffing.Workers_training”中，Staffing 是架构名称，Workers_training 是表名称。

视图仅支持列表和获取操作，而表支持所有 CRUD 操作（如 Entity API 中所定义）。

示例 - 列出所有记录

此示例列出了 Scorecards 实体中的所有记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Scorecards。
3. 选择 List 操作，然后点击完成。
4. 您还可以在连接器任务的任务输入部分中，通过指定过滤条件子句来过滤结果集。请务必使用单引号 (') 指定过滤条件子句值。例如，Id='13b1724a91ce448bad2f1986321fc70f'。您还可以使用逻辑运算符指定多个过滤条件。例如 Id='13b1724a91ce448bad2f1986321fc70f' and Inactive=false。

示例 - 获取记录

此示例会从 Scorecards 实体中获取指定 ID 的记录。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Scorecards。
3. 选择 Get 操作，然后点击完成。
4. 在连接器任务的任务输入部分，点击 EntityId，然后在默认值字段中输入 1|CN=admin,CN=Users,DC=test-ldap,DC=com。

   其中，1|CN=admin,CN=Users,DC=test-ldap,DC=com 是 Scorecards 实体中的主键值。

示例 - 创建记录

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

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

   {
   "Worker_Id": "21327",
   "Worker_Descriptor": "Worker 2"
   }

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

   {
   "Id": "c3c68bc9a13f901d43ca8e5ddcaa0000"
   }

示例 - 更新记录

此示例会更新 Scorecards 实体中具有指定 ID 的记录。

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

   {
   "ScorecardDescription": "New updated description",
   "ScorecardName": "Scorecard_1"
   }

5. 点击 entityId，然后在 Default Value 字段中输入 f368471438b14705a1178c6744d75853。

示例 - 删除记录

以下示例会删除 Scorecards 实体中具有指定 ID 的记录。

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

注意： 如果实体具有复合主键，您可以指定过滤条件语句。 例如，Id='e002de05784910123c443f7eb0970722' and Inactive=false。

使用 Terraform 创建连接

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

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

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

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

参数名称	数据类型	必需	说明
租户	STRING	False	账号的租户。
服务	STRING	False	要从中检索数据的特定服务。请以英文逗号分隔列表的形式输入。
wsdlversion	STRING	False	要使用的 WSDL 的版本。
proxy_enabled	BOOLEAN	False	选中此复选框可为连接配置代理服务器。
proxy_auth_scheme	ENUM	False	用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括：BASIC、DIGEST、NONE
proxy_user	STRING	False	用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password	SECRET	False	用于向 ProxyServer 代理进行身份验证的密码。
proxy_ssltype	ENUM	False	连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括：AUTO、ALWAYS、NEVER、TUNNEL

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 社区的 Cloud 论坛中发布您的问题以及讨论此连接器。

后续步骤

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