UKG

連線設定範例

本節列出建立連線時設定的各個欄位範例值。

OAUTH 2.0 - 授權碼連線類型

作業

這個連接器可讓您對 UKG 資料執行各種動作。

本節列出 UKG 連接器支援的操作。如要瞭解如何設定動作，請參閱「動作範例」。

RetrieveAllEmployeeGroupsOrByName 動作

依名稱擷取所有員工群組。

RetrieveAllEmployeeGroupsOrByName 動作的輸入參數

如要瞭解如何設定 RetrieveAllEmployeeGroupsOrByName 動作，請參閱範例。

建立 PayCode 動作

建立薪資代碼。

「建立 PayCode」動作的輸入參數

如要瞭解如何設定 CreatePayCode 動作，請參閱範例。

DeletePayCodebyId 動作

根據 ID 刪除薪資代碼。

DeletePayCodebyId 動作的輸入參數

如要瞭解如何設定 DeletePayCodebyId 動作，請參閱範例。

透過「依 ID 更新工作規則」動作更新工作規則

使用 ID 更新工作規則。

「依 ID 更新工作規則」動作的輸入參數

如要瞭解如何設定 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"
       }
     }
     
     
     

如果動作成功，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
     }
   } 

如果動作成功，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"
     }
   }

如果動作成功，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
     }
   } 

如果動作成功，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
     }
   } 

如果動作成功，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"
           }
         }]
       }]
     }
   }

如果動作成功，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}

如果動作成功，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]
       }
     }
   }

如果動作成功，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
     }
   } 

如果動作成功，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": []
     }
   }

如果動作成功，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
     }
   } 

如果動作成功，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
     }
   } 

如果動作成功，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 設定檔中設定下列變數：

在整合服務中使用 UKG 連線

建立連線後，Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。

• 如要瞭解如何在 Apigee Integration 中建立及使用「連線器」工作，請參閱「連線器工作」。
• 如要瞭解如何在 Application Integration 中建立及使用「連線器」工作，請參閱「連線器工作」。

向 Google Cloud 社群尋求協助

後續步驟

• 瞭解如何暫停及恢復連線。
• 瞭解如何監控連結器用量。
• 瞭解如何查看連接器記錄。