UKG

借助 UKG 连接器,您可以对 UKG 数据执行各种操作。

准备工作

在使用 UKG 连接器之前,请先完成以下任务:

  • 在您的 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. 连接详情部分中,完成以下操作:
    1. Connector(连接器):从可用连接器下拉列表中选择 UKG
    2. 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
    3. 连接名称字段中,输入连接实例的名称。

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

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

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

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

    9. (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
    10. 点击下一步
  5. 目标部分中,输入要连接到的远程主机(后端系统)的详细信息。
    1. 目标类型:选择目标类型
      • 从列表中选择主机地址,以指定目的地的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接,请从列表中选择端点连接,然后从端点连接列表中选择所需的端点连接。

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

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

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

      UKG 连接支持以下身份验证类型:

      • 基本身份验证
      • OAUTH 2.0 - 授权代码
      • 如需了解如何配置这些身份验证类型,请参阅配置身份验证

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

配置身份验证

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

  • 基本身份验证
    • 用户名:用于对连接器进行身份验证的用户名。
    • 密码:包含与连接器关联的密码的 Secret Manager Secret。
  • OAUTH 2.0 - 授权代码
    • 客户端 ID:请求访问令牌时所用的客户端 ID。
    • 范围:所需范围的逗号分隔列表。
    • 客户端密钥:包含您创建的关联应用的客户端密钥的 Secret Manager 密文。
    • Enable PKCE:如果您要启用代码交换证明密钥 (PKCE),请选择此选项。
    • 授权网址:应用的授权网址。您将被重定向到此页面以登录您的应用。
    • 访问令牌网址:用于交换访问令牌的网址。请提供包含架构的完整网址。

连接配置示例

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

OAUTH 2.0 - 授权代码连接类型

字段名称 详细信息
位置 us-central1
连接器 UKG
连接器版本 1
连接名称 gcp-ukg-oauth-conn
启用 Cloud Logging
日志级别 错误
服务账号 SERVICEACCOUNT_NAME@developer.gserviceaccount.com
Open API 规范模块 计时功能
详细程度级别 5
节点数下限 2
节点数上限 50
目标类型 主机地址
主机地址 https://google-connect-dev.cfn.mykronos.com
客户端 ID ZG******-****-****-****-*********uDN
客户端密钥 Secret
密钥版本 1
授权网址 https://google-connect-dev.cfn.mykronos.com/oauth2/authorize
访问令牌网址 https://google-connect-dev.cfn.mykronos.com/api/authentication/access_token

系统限制

UKG 连接器每秒可以处理 30 个事务, 每节点, 并throttles任何事务 。 默认情况下,集成连接器会为连接分配 2 个节点(以提高可用性)。

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

操作

借助此连接器,您可以对 UKG 数据执行各种操作。

本部分列出了 UKG 连接器支持的操作。如需了解如何配置操作,请参阅操作示例

RetrieveAllEmployeeGroupsOrByName 操作

按名称检索所有员工群组。

RetrieveAllEmployeeGroupsOrByName 操作的输入参数

参数名称 数据类型 必填 说明
all_details 布尔值 True 一个布尔值,指示响应是否为轻量响应,即仅包含 ID 和名称字段的响应。
name 字符串 True 员工群组的名称。

例如,关于如何配置 RetrieveAllEmployeeGroupsOrByName 操作, 请参阅示例

创建 PayCode 操作

创建支付代码。

Create PayCode 操作的输入参数

参数名称 数据类型 必填 说明
type 字符串 True 付款代码的类型。
name 字符串 True 支付代码的名称。
单位 字符串 True 付款代码的单位。
codeNumber 整数 True 分配给付款代码的代码编号。

例如,关于如何配置 CreatePayCode 操作, 请参阅示例

DeletePayCodebyId 操作

根据 ID 删除付款代码。

DeletePayCodebyId 操作的输入参数

参数名称 数据类型 必填 说明
id 整数 True 付款码的 ID。

如需了解如何配置 DeletePayCodebyId 操作,请参阅示例

“按 ID 更新工作规则”操作

使用 ID 更新工作规则。

“按 ID 更新工作规则”操作的输入参数

参数名称 数据类型 必填 说明
workRuleId 整数 True 工作规则的 ID
workRuleVersion json True 与工作规则关联的工作规则版本。
name 字符串 True 工作规则的名称。
version 整数 True 工作规则的版本。

如需了解如何配置 Update Work Rule by ID 操作,请参阅示例

操作示例

示例 - RetrieveAllEmployeeGroupsOrByName

以下示例将检索员工群组。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 RetrieveAllEmployeeGroupsOrByName 操作,然后点击完成
  3. 数据映射部分 Open Data Mapping Editor,然后在 Input 字段:
     {
      "Query parameters": {
        "all_details": true
      }
    } 
    

    If the action is successful, the RetrieveAllEmployeeGroupsOrByName task's connectorOutputPayload response parameter will have a value similar to the following:

     
      [{
        "ResponseBody": "[{\"name\":\"$U-South Region\",\"id\":1401,\"orgMapGroupRef\":{\"id\":2452,\"qualifier\":\"$U-South Region\"},\"version\":0,\"updateDtm\":\"2020-03-04T16:06:46\",\"persistentId\":\"$U-South#Region\"},{\"name\":\"$U-Canada Region\",\"id\":1451,\"orgMapGroupRef\":{\"id\":2453,\"qualifier\":\"$U-Canada Region\"},\"version\":0,\"updateDtm\":\"2020-03-04T16:07:21\",\"persistentId\":\"}]
      

示例 - 创建 PayCode

此示例会创建付款代码。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 Create PayCode 操作,然后点击完成
  3. 数据映射部分 Open Data Mapping Editor,然后在 Input 字段:
      {
        "RequestBody": {
          "type": "Regular",
          "unit": "HOUR",
          "visibleToTimecardSchedule": true,
          "name": "2nd Meal Premium qaazxse",
          "shortName": "2MP",
          "combined": false,
          "money": false,
          "totals": true,
          "excusedAbsence": false,
          "wageMultiplier": 1.0,
          "wageAddition": 0.0,
          "addToTimecardTotal": true,
          "visibleToUser": true,
          "visibleToReports": true,
          "checkAvailability": 0.0,
          "codeNumber": 7663.0,
          "cascadingDuration": false,
          "processDurationAsSeparateShift": false,
          "editCountsTowardsOvertimeLimits": false,
          "editCountsTowardsConsecutiveDayOT": false,
          "repeating": false,
          "payrollOnly": false,
          "timekeepingOnly": false,
          "netDown": false
        },
        "Headers": {
          "Content-Type": "application/json"
        }
      }
      
      
      
  4. 如果操作成功,CreatePayCode 任务的 connectorOutputPayload 响应参数的值将类似于以下内容:

     
      [{
        "type": "Regular",
        "unit": "HOUR",
        "visibleToTimecardSchedule": true,
        "id": 5904.0,
        "name": "2nd Meal Premium qaazxse",
        "shortName": "2MP",
        "combined": false,
        "money": false,
        "totals": true,
        "excusedAbsence": false,
        "wageMultiplier": 1.0,
        "wageAddition": 0.0,
        "addToTimecardTotal": true,
        "visibleToUser": true,
        "visibleToReports": true,
        "checkAvailability": 0.0,
        "codeNumber": 7663.0,
        "cascadingDuration": false,
        "processDurationAsSeparateShift": false,
        "editCountsTowardsOvertimeLimits": false,
        "editCountsTowardsConsecutiveDayOT": false,
        "repeating": false,
        "payrollOnly": false,
        "timekeepingOnly": false,
        "netDown": false
      }]

示例 - DeletePayCodebyId

以下示例会根据 ID 删除付款代码。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 DeletePayCodebyId 操作,然后点击完成
  3. 数据映射部分中,Open Data Mapping Editor,然后在 Input 字段中输入类似于以下内容的值:
      {
      "Path parameters": {
        "id": 6002.0
      }
    } 
  4. 如果操作成功,DeletePayCodebyId 任务的 connectorOutputPayload 响应参数的值将类似于以下内容:

     
     [{
      "ResponseBody": "",
      "StatusCode": 200.0
    }] 

示例 - 按 ID 更新工作规则

此示例将更新工作规则。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 Update Work Rule by ID 操作,然后点击完成
  3. 数据映射部分中,Open Data Mapping Editor,然后在 Input 字段中输入类似于以下内容的值:
     {
      "Path parameters": {
        "id": 3701.0
      },
      "Headers": {
        "Content-Type": "application/json"
      },
      "RequestBody": {
        "version": 1.0,
        "workRuleId": 3701.0,
        "name": "$AU Call Back Sasori",
        "workRuleVersion": [{
          "effectiveWorkRuleId": 3801.0,
          "effectiveDateTime": "1853-01-01T00:00:00",
          "updateThisVersion": true,
          "expirationDateTime": "4000-01-01T00:00:00",
          "general": {
            "breaks": [],
            "coreHours": [],
            "includeMinimumWagesAdjustment": false,
            "deductions": [{
              "id": 651.0,
              "qualifier": "$AU Oncall Allowance",
              "name": "$AU Oncall Allowance"
            }]
          },
          "workRulePayCodeDistribution": {
            "payCodeDistributionName": "$AU Oncall",
            "deviations": [],
            "overtimes": [],
            "zones": [],
            "majorities": []
          },
          "workRuleAutoBreakPlacement": {
            "minimumTimeBetweenStartOfShiftAndFirstBreak": "0:0",
            "minimumTimeBetweenEndOfBreakAndShiftEnd": "0:0",
            "minimumTimeBetweenBreaks": "0:0",
            "shiftLengthsToExclude": [],
            "newShiftLengths": []
          },
          "version": 1.0
        }],
        "ivrAlias": "1234567890"
      }
    }
  4. 如果操作成功,Update Work Rule by ID 任务的 connectorOutputPayload 响应参数的值将类似于以下内容:

     
     [{
      "workRuleId": 3701.0,
      "name": "$AU Call Back Sasori",
      "ivrAlias": "1234567890",
      "workRuleVersion": [{
        "effectiveWorkRuleId": 3801.0,
        "effectiveDateTime": "1753-01-01T00:00:00",
        "updateThisVersion": false,
        "expirationDateTime": "3000-01-01T00:00:00",
        "general": {
          "breaks": [],
          "coreHours": [],
          "includeMinimumWagesAdjustment": false,
          "deductions": [{
            "id": 651.0,
            "qualifier": "$AU Oncall Allowance",
            "name": "$AU Oncall Allowance"
          }]
        },
        "workRulePayCodeDistribution": {
          "payCodeDistributionName": "$AU Oncall",
          "deviations": [],
          "overtimes": [],
          "zones": [],
          "majorities": []
        },
        "workRuleAutoBreakPlacement": {
          "minimumTimeBetweenStartOfShiftAndFirstBreak": "0:0",
          "minimumTimeBetweenEndOfBreakAndShiftEnd": "0:0",
          "minimumTimeBetweenBreaks": "0:0",
          "shiftLengthsToExclude": [],
          "newShiftLengths": []
        },
        "version": 3.0
      }],
      "version": 3.0
    }]

示例 - 按 ID 删除固定规则

此示例会删除一条特定的固定规则。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 Delete Fixed Rule by ID 操作,然后点击完成
  3. 数据映射部分 Open Data Mapping Editor,然后在 Input 字段:
     {
      "Path parameters": {
        "id": 1152.0
      }
    } 
  4. 如果操作成功,Delete Fixed Rule by ID 任务的 connectorOutputPayload 响应参数的值将类似于以下内容:

     
     [{
      "ResponseBody": "",
      "StatusCode": 204.0
    }] 

示例 - 检索累计增长值代码

以下示例检索的是连续代码。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 Retrieve Accrual Codes 操作,然后点击完成
  3. 数据映射部分 Open Data Mapping Editor,然后在 Input 字段:
     {
      "Query parameters": {
        "id": 1303.0
      }
    } 
  4. 如果操作成功,Retrieve Accrual Codes 任务的 connectorOutputPayload 响应参数的值将类似于以下内容:

     
     [{
      "ResponseBody": "[{\"id\":1303,\"typeId\":2,\"hoursPerDayInSeconds\":28800,\"name\":\"$LC Dia Familia\",\"shortName\":\"$LC Dia Familia\",\"typeName\":\"Day\",\"allowEdit\":true}]",
      "StatusCode": 200.0
    }]

示例 - 创建营业时间

此示例会创建营业时间。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 Create Hours of Operation 操作,然后点击完成
  3. 数据映射部分中,Open Data Mapping Editor,然后在 Input 字段中输入类似于以下内容的值:
     {
      "Headers": {
        "Content-Type": "application/json"
      },
      "RequestBody": {
        "name": "$E-HoO Store 501 dummy3",
        "active": true,
        "effectiveVersions": [{
          "effectiveSpan": {
            "startDate": "1900-01-01",
            "endDate": "3000-01-01"
          },
          "unrestrictedEdit": true,
          "items": [{
            "openTime": "09:00:00",
            "closeTime": "21:00:00",
            "closed": false,
            "holiday": false,
            "weekDay": {
              "id": -1.0,
              "qualifier": "EVERY_DAY"
            }
          }, {
            "openTime": "10:00:00",
            "closeTime": "17:00:00",
            "closed": false,
            "holiday": false,
            "weekDay": {
              "id": 1.0,
              "qualifier": "SUNDAY"
            }
          }, {
            "openTime": "10:00:00",
            "closeTime": "18:00:00",
            "closed": false,
            "holiday": false,
            "weekDay": {
              "id": 7.0,
              "qualifier": "SATURDAY"
            }
          }]
        }]
      }
    }
  4. 如果操作成功, Create Hours of Operation 任务的 connectorOutputPayload 响应 参数的值类似于以下内容:

     
    [{
      "id": 851.0,
      "name": "$E-HoO Store 501 dummy3",
      "active": true,
      "version": 1.0,
      "effectiveVersions": [{
        "effectiveSpan": {
          "startDate": "1900-01-01",
          "endDate": "3000-01-01"
        },
        "unrestrictedEdit": true,
        "items": [{
          "id": 1051.0,
          "openTime": "09:00:00",
          "closeTime": "21:00:00",
          "closed": false,
          "holiday": false,
          "weekDay": {
            "id": -1.0,
            "qualifier": "EVERY_DAY"
          }
        }, {
          "id": 1052.0,
          "openTime": "10:00:00",
          "closeTime": "17:00:00",
          "closed": false,
          "holiday": false,
          "weekDay": {
            "id": 1.0,
            "qualifier": "SUNDAY"
          }
        }, {
          "id": 1053.0,
          "openTime": "10:00:00",
          "closeTime": "18:00:00",
          "closed": false,
          "holiday": false,
          "weekDay": {
            "id": 7.0,
            "qualifier": "SATURDAY"
          }
        }]
      }]
    }]

示例 - 按 ID 更新工时卡设置

此示例更新了特定时间卡片设置。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 Update Timecard Setting by ID 操作,然后点击完成
  3. 数据映射部分中,Open Data Mapping Editor,然后在 Input 字段中输入类似于以下内容的值:
     {
      "Path parameters": {
        "id": 3872335.0
      },
      "RequestBody": {
        "id": 3872335.0,
        "name": "Hourly Timecard -Employee Sharp",
        "label": "Hourly Timecard - Employee View",
        "description": "Hourly Timecard - Employee View",
        "timecardType": {
          "id": "HourlyEmployee",
          "name": "Hourly Employee"
        },
        "canEditFutureTimecard": false,
        "numberOfFutureDays": 0.0,
        "includeOvertimes": true,
        "fourPunchRow": false,
        "columnsOrder": [{
          "id": "Date",
          "name": "Date"
        }, {
          "id": "Schedule",
          "name": "Schedule"
        }, {
          "id": "Absence",
          "name": "Absence"
        }, {
          "id": "In",
          "name": "In"
        }, {
          "id": "Transfer",
          "name": "Transfer"
        }, {
          "id": "Out",
          "name": "Out"
        }, {
          "id": "PayCode",
          "name": "Pay Code"
        }, {
          "id": "Amount",
          "name": "Amount"
        }, {
          "id": "Shift",
          "name": "Shift"
        }, {
          "id": "Daily",
          "name": "Daily"
        }, {
          "id": "Period",
          "name": "Period"
        }],
        "includeActivityEvent": false,
        "includeActivityAllocation": false,
        "includeActivityTotalActual": false,
        "includeActivityTotalAllocated": false,
        "includeActivityTotalVariance": false,
        "hidePaidCorrection": false}
  4. 如果操作成功,Update Timecard Setting by ID 任务的 connectorOutputPayload 响应参数的值将类似于以下内容:

     
      [{
      "id": 3872335.0,
      "name": "Hourly Timecard -Employee Sharp",
      "label": "Hourly Timecard - Employee View",
      "description": "Hourly Timecard - Employee View",
      "timecardType": {
        "id": "HourlyEmployee",
        "name": "Hourly Employee"
      },
      "canEditFutureTimecard": false,
      "numberOfFutureDays": 0.0,
      "includeOvertimes": true,
      "fourPunchRow": false,
      "columnsOrder": [{
        "id": "Date",
        "name": "Date"
      }, {
        "id": "Schedule",
        "name": "Schedule"
      }, {
        "id": "Absence",
        "name": "Absence"
      }, {
        "id": "In",
        "name": "In"
      }, {
        "id": "Transfer",
        "name": "Transfer"
      }, {
        "id": "Out",
        "name": "Out"
      }, {
        "id": "PayCode",
        "name": "Pay Code"
      }, {
        "id": "Amount",
        "name": "Amount"
      }, {
        "id": "Shift",
        "name": "Shift"
      }, {
        "id": "Daily",
        "name": "Daily"
      }, {
        "id": "Period",
        "name": "Period"
      }],
      "includeActivityEvent": false,
      "includeActivityAllocation": false,
      "includeActivityTotalActual": false,
      "includeActivityTotalAllocated": false,
      "includeActivityTotalVariance": false,
      "hidePaidCorrection": false,
      "paidCorrectionFilterEnabled": true}] 

示例 - 检索人物信息个人资料

此示例会检索人物信息个人资料。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 Retrieve People Information Profiles 操作,然后点击完成
  3. 数据映射部分 Open Data Mapping Editor,然后在 Input 字段:
      {
      "Headers": {
        "Content-Type": "application/json"
      },
      "RequestBody": {
        "where": {
          "ids": [-1.0, 651.0]
        }
      }
    }
  4. 如果操作成功, Retrieve People Information Profiles 任务的 connectorOutputPayload 响应 参数的值类似于以下内容:

     
       [{
      "ResponseBody": "[{\"id\":-1,\"description\":\"Default People Information Profile with Default People Information Settings\",\"name\":\"Default People Information Profile\",\"peopleInfoSetting\":{\"id\":-1,\"description\":\"Default People Information Profile with All Hyperfind Query\",\"hfquery\":{\"id\":1,\"hfName\":\"&Person.All_Home\",\"name\":\"All Home\"},\"name\":\"Default People Information Profile\"}},{\"id\":651,\"description\":\"All Home Employees\",\"name\":\"$R-All Home\",\"peopleInfoSetting\":{\"id\":649,\"description\":\"All Home Employees\",\"hfquery\":{\"id\":1,\"hfName\":\"&Person.All_Home\",\"name\":\"All Home\"},\"name\":\"$R-All Home\"}}]",
      "StatusCode": 200.0
    }]

示例 - 检索所有雇佣条款

此示例会检索所有雇佣条款。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 Retrieve All Employment Terms 操作,然后点击完成
  3. 数据映射部分中,Open Data Mapping Editor,然后在 Input 字段中输入类似于以下内容的值:
       {
      "Query parameters": {
        "id": 2202.0
      }
    } 
  4. 如果操作成功,Retrieve All Employment Terms 任务的 connectorOutputPayload 响应参数的值将类似于以下内容:

     
      [{
      "ResponseBody": "[{\"allowsInheritance\":false,\"isActive\":true,\"name\":\"$AU-Casual\",\"id\":2202,\"processType\":\"ENFORCE_END_DATE\",\"versions\":{\"employmentTermVersion\":[{\"id\":702,\"accrualProfile\":{\"id\":1402,\"qualifier\":\"$AU-Casual\",\"name\":\"$AU-Casual\"},\"endDate\":\"3000-01-01\",\"holidayProfile\":{\"id\":152,\"qualifier\":\"AU Casual Holiday Profile\",\"name\":\"AU Casual Holiday Profile\"},\"startDate\":\"1900-01-01\",\"minimumWage\":{}}]},\"persistentId\":\"$AU-Casual\"}]",
      "StatusCode": 200.0
    }]

示例 - 创建证明配置文件

此示例会创建认证配置文件。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 Create Attestation Profiles 操作,然后点击完成
  3. 数据映射部分中,Open Data Mapping Editor,然后在 Input 字段中输入类似于以下内容的值:
     {
      "Headers": {
        "Content-Type": "application/json"
      },
      "RequestBody": {
        "versionCount": 0.0,
        "name": "Empty Profile 3",
        "deleted": false,
        "attestationAssignments": []
      }
    }
  4. 如果操作成功, Create Attestation Profiles 任务的 connectorOutputPayload 响应 参数的值类似于以下内容:

     
    [{
      "id": 434.0,
      "versionCount": 0.0,
      "name": "Empty Profile 3",
      "deleted": false
    }]

示例 - 按 ID 检索离开个人资料

以下示例会根据 ID 检索休假个人资料。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 Retrieve Leave Profile by Id 操作,然后点击完成
  3. 数据映射部分 Open Data Mapping Editor,然后在 Input 字段:
     {
      "Path parameters": {
        "id": 3.0
      }
    } 
  4. 如果操作成功, Retrieve Leave Profile by Id 任务的 connectorOutputPayload 响应 参数的值类似于以下内容:

     
     [{
      "id": 3.0,
      "isActive": true,
      "leaveProfileCategory": [{
        "id": 1.0,
        "qualifier": "Military",
        "leaveProfileCategoryConfigurableData": [{
          "configurableData": {
            "id": 1.0,
            "qualifier": "Active Duty Period"
          }
        }],
        "leaveProfileCategoryRule": [],
        "leaveProfileCategoryType": [{
          "leaveType": [{
            "id": 21.0,
            "qualifier": "Military Duty Leave Tracking"
          }]
        }, {
          "leaveType": [{
            "id": 53.0,
            "qualifier": "Personal Leave"
          }]
        }, {
          "leaveType": [{
            "id": 59.0,
            "qualifier": "Vacation Leave"
          }]
        }]
      }, {
        "id": 2.0,
        "qualifier": "Self",
        "leaveProfileCategoryConfigurableData": [{
          "configurableData": {
            "id": 2.0,
            "qualifier": "Amount Paid"
          }
        }, {
          "configurableData": {
            "id": 4.0,
            "qualifier": "Disability Case Number"
          }
    }]

示例 - 检索可用规则

以下示例将检索可用规则。

  1. Configure connector task 对话框中,点击 actions
  2. 选择 Retrieve Available Rules 操作,然后点击完成
  3. 数据映射部分 Open Data Mapping Editor,然后在 Input 字段:
     {
      "Query parameters": {
        "leave_case_id": 189.0
      }
    } 
  4. 如果操作成功, Retrieve Available Rules 任务的 connectorOutputPayload 响应 参数的值类似于以下内容:

     
     [{
      "leaveCase": {
        "id": 189.0,
        "qualifier": "Physical Therapy",
        "name": "Physical Therapy"
      },
      "availableLeaveRules": [{
        "id": 20.0,
        "availableLeaveTypes": [{
          "id": 1.0,
          "paid": false,
          "enabled": true,
          "payCode": {
            "id": 107.0,
            "qualifier": "LV-ADAA Leave",
            "name": "LV-ADAA Leave"
          },
          "accrualCode": {
            "id": 2.0,
            "qualifier": "LV-ADA Leave",
            "name": "LV-ADA Leave"
          },
          "qualifier": "ADA Leave",
          "name": "ADA Leave"
        }, {
          "id": 11.0,
          "paid": false,
          "enabled": true,
          "presentedInLeaveRule": true,
          "payCode": {
            "id": 134.0,
            "qualifier": "LV-FMLA Injury Illness",
            "name": "LV-FMLA Injury Illness"
          },
          "accrualCode": {
            "id": 12.0,
            "qualifier": "LV-FMLA",
            "name": "LV-FMLA"
          },
          "qualifier": "FMLA Illness Injury",
          "name": "FMLA Illness Injury"
        }, {
          "id": 31.0,
          "paid": false,
          "enabled": true,
          "presentedInLeaveRule": true,
          "payCode": {
            "id": 165.0,
            "qualifier": "LV-Non FMLA Tracking",
            "name": "LV-Non FMLA Tracking"
          },
          "accrualCode": {
            "id": 24.0,
            "qualifier": "LV-Tracking",
            "name": "LV-Tracking"
          },
          "qualifier": "Non-FMLA Illness Injury",
          "name": "Non-FMLA Illness Injury"
        }
    }]

使用 Terraform 创建连接

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

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

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

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

参数名称 数据类型 必需 说明
proxy_enabled BOOLEAN 错误 选中此复选框可为连接配置代理服务器。
proxy_auth_scheme ENUM 错误 用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括:BASIC、DIGEST、NONE
proxy_user STRING 错误 用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password SECRET 错误 用于向 ProxyServer 代理进行身份验证的密码。

在集成中使用 UKG 连接

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

  • 如需了解如何在 Apigee Integration 中创建和使用连接器任务,请参阅连接器任务
  • 如需了解如何在应用集成中创建和使用连接器任务,请参阅连接器任务

向 Google Cloud 社区寻求帮助

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

后续步骤