UKG

UKG コネクタを使用すると、UKG データに対してさまざまなアクションを実行できます。

始める前に

UKG コネクタを使用する前に、次の作業を行います。

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）
  サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

コネクタを構成する

コネクタを構成するには、データソース（バックエンドシステム）への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
2. [NEXT] をクリックします。
[接続の詳細] セクションで、次の操作を行います。
1. コネクタ: 使用可能なコネクタのプルダウンリストから [UKG] を選択します。
2. コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 49 文字以内で指定してください。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
6. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
7. サービス / モジュール: UKG モジュールを選択します。
8. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
9. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
10. [NEXT] をクリックします。
[宛先] セクションに、接続するリモートホスト（バックエンドシステム）の詳細を入力します。
1. 宛先の種類: 宛先の種類を選択します。
  - リストから [ホストアドレス] を選択し、宛先のホスト名または IP アドレスを指定します。
  - バックエンドシステムへのプライベート接続を確立する場合は、リストからエンドポイントアタッチメントを選択し、次にエンドポイントアタッチメントリストから必要なエンドポイントアタッチメントを選択します。
    注: エンドポイントアタッチメントの作成方法については、PSC サービスアタッチメントとエンドポイントアタッチメントをご覧ください。エンドポイントアタッチメントを作成すると、[エンドポイントアタッチメント] リストに表示されます。
  セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的アウトバウンド IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォールルールを構成します。
  
  他の宛先を入力するには、[+ 宛先を追加] をクリックします。
2. [NEXT] をクリックします。
[認証] セクションで、認証の詳細を入力します。
1. [認証タイプ] を選択し、関連する詳細を入力します。
  UKG 接続でサポートされる認証タイプは次のとおりです。
  - 基本認証
  - OAuth 2.0 - 認証コード
  - [NEXT] をクリックします。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

基本認証
- ユーザー名: コネクタの認証に使用されるユーザー名。
- パスワード: コネクタに関連付けられたパスワードを含む Secret Manager の Secret。

OAUTH 2.0 - 認証コード

クライアント ID: アクセストークンのリクエストに使用されるクライアント ID。
スコープ: 必要なスコープのカンマ区切りのリスト。
クライアントシークレット: 作成した接続されているアプリのクライアントシークレットを含む Secret Manager のシークレットです。
PKCE を有効にする: Proof Key of Code Exchange（PKCE）を有効にする場合は、このオプションを選択します。
認証 URL: アプリの認証 URL。アプリにログインするためにこのページにリダイレクトされます。
アクセストークン URL: アクセストークンの交換に使用する URL。スキームを含む完全な URL を指定してください。

接続構成のサンプル

このセクションでは、接続の作成時に構成するさまざまなフィールドのサンプル値を示します。

OAUTH 2.0 - 認証コードの接続タイプ

フィールド名	詳細
ロケーション	us-central1
コネクタ	UKG
コネクタのバージョン	1
接続名	gcp-ukg-oauth-conn
Cloud Logging を有効にする	○
ログレベル	エラー
サービスアカウント	SERVICEACCOUNT_NAME@developer.gserviceaccount.com
Open API 仕様モジュール	Timekeeping
詳細レベル	5
ノードの最小数	2
ノードの最大数	50
宛先の種類	ホストアドレス
ホストアドレス	https://google-connect-dev.cfn.mykronos.com
クライアント ID	ZG****----*******uDN
クライアントシークレット	シークレット
シークレットバージョン	1
認証 URL	https://google-connect-dev.cfn.mykronos.com/oauth2/authorize
アクセストークンの URL	https://google-connect-dev.cfn.mykronos.com/api/authentication/access_token

注: ホスト名として、デフォルトのホストアドレスである URL https://login.UKG.com を渡すことができます。組織でカスタムログインエンドポイントを使用している場合は、別のホストアドレスを使用する必要があります。

システムの上限

UKG コネクタは、ノードごとに 1 秒あたり 30 件のトランザクションを処理することができ、この上限を超えるトランザクションはすべてスロットルされます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

注: Integration Connectors ノードの数は、使用状況に応じて動的に自動スケーリングされます。ただし、自動スケーリングを待たずに大量の容量を確保する場合は、接続の最小ノード値を調整できます。1 つの接続により多くのトランザクションを処理するには、より多くのノードが必要です。逆に、接続が処理するトランザクションが少ない場合は、必要なノードの数が少なくなります。ノードの値を構成するには、次の手順を行います。

従量課金制をご利用のお客様は、接続の編集ページでノードの最小値と最大値を構成します。
サブスクリプションベースで利用されているお客様は、サポートにお問い合わせください。

ノードが処理できる最大トランザクションは、さまざまな要因によって異なります。そのため、スループットを高めるために最小ノードを調整する前に、バックエンドシステムが必要なトラフィックを処理するために最適に設定されているかどうかを確認することをおすすめします。

アクション

このコネクタを使用すると、UKG データに対してさまざまなアクションを実行できます。

このセクションには、UKG コネクタでサポートされているアクションが一覧表示されます。アクションの構成方法については、アクションの例をご覧ください。

RetrieveAllEmployeeGroupsOrByName アクション

すべての従業員グループを名前で取得します。

RetrieveAllEmployeeGroupsOrByName アクションの入力パラメータ

パラメータ名	データ型	必須	説明
all_details	ブール値	True	レスポンスが軽量かどうかを示すブール値。軽量なレスポンスとは、ID フィールドと名前フィールドのみを含むレスポンスです。
name	文字列	True	社員グループの名前。

RetrieveAllEmployeeGroupsOrByName アクションの構成例については、例をご覧ください。

Create PayCode アクション

支払いコードを作成します。

Create PayCode アクションの入力パラメータ

パラメータ名	データ型	必須	説明
type	文字列	True	支払いコードのタイプ。
name	文字列	True	支払いコードの名前。
単位	文字列	True	支払いコードの単位。
codeNumber	integer	True	支払いコードに割り当てられたコード番号。

CreatePayCode アクションの構成例については、例をご覧ください。

DeletePayCodebyId アクション

ID に基づいて支払いコードを削除します。

DeletePayCodebyId アクションの入力パラメータ

パラメータ名	データ型	必須	説明
id	integer	True	支払いコードの ID。

DeletePayCodebyId アクションの構成例については、例をご覧ください。

Update Work Rule by ID アクション

ID を使用してワークルールを更新します。

Update Work Rule by ID アクションの入力パラメータ

パラメータ名	データ型	必須	説明
workRuleId	integer	True	勤務ルールの ID
workRuleVersion	json	True	ワークルールに関連付けられているワークルールのバージョン。
name	文字列	True	ワークルールの名前。
version	integer	True	ワークルールのバージョン。

Update Work Rule by ID アクションの構成例については、例をご覧ください。

アクションの例

例 - RetrieveAllEmployeeGroupsOrByName

この例では、従業員グループを取得します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[RetrieveAllEmployeeGroupsOrByName ] アクションを選択してから、[完了] をクリックします。

[データマッピング] セクションで 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 を作成する

この例では、支払いコードを作成します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[Create PayCode] アクションを選択してから、[完了] をクリックします。

[データマッピング] セクションで、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 に基づいて支払いコードを削除します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[DeletePayCodebyId ] アクションを選択してから、[完了] をクリックします。
[データマッピング] セクションで Open Data Mapping Editor をクリックし、Input フィールドに次のような値を入力します。
```
  {
  "Path parameters": {
    "id": 6002.0
  }
} 
```

アクションが成功すると、DeletePayCodebyId タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

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

例 - ID でワークルールを更新する

この例では、ワークルールを更新します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[Update Work Rule by ID ] アクションを選択してから、[完了] をクリックします。

[データマッピング] セクションで 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 で固定ルールを削除する

この例では、特定の固定ルールを削除します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[Delete Fixed Rule by ID ] アクションを選択してから、[完了] をクリックします。
[データマッピング] セクションで Open Data Mapping Editor をクリックし、Input フィールドに次のような値を入力します。
```
 {
  "Path parameters": {
    "id": 1152.0
  }
} 
```

アクションが成功すると、Delete Fixed Rule by ID タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

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

例 - ワークルールコードを取得する

この例では、ワークルールコードを取得します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[Retrieve Accrual Codes ] アクションを選択してから、[完了] をクリックします。
[データマッピング] セクションで 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
}]

例 - オペレーション時間を作成する

この例では、オペレーション時間を作成します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[Create Hours of Operation ] アクションを選択してから、[完了] をクリックします。

[データマッピング] セクションで 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 でタイムカード設定を更新する

この例では、特定のタイムカードの設定を更新します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[Update Timecard Setting by ID ] アクションを選択してから、[完了] をクリックします。

[データマッピング] セクションで 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}]

例 - 個人情報プロファイルを取得する

この例では、個人情報プロファイルを取得します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[Retrieve People Information Profiles ] アクションを選択してから、[完了] をクリックします。

[データマッピング] セクションで 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
}]

例 - すべての雇用条件を取得する

この例では、すべての雇用条件を取得します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[Retrieve All Employment Terms ] アクションを選択してから、[完了] をクリックします。
[データマッピング] セクションで 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
}]

例 - 証明書プロファイルを作成する

この例では、証明書プロファイルを作成します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[Create Attestation Profiles ] アクションを選択してから、[完了] をクリックします。

[データマッピング] セクションで 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 に基づいて休暇プロファイルを取得します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[Retrieve Leave Profile by Id ] アクションを選択してから、[完了] をクリックします。
[データマッピング] セクションで 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"
      }
}]

例 - 使用可能なルールを取得する

この例では、使用可能なルールを取得します。

[Configure connector task] ダイアログで、[actions] をクリックします。
[Retrieve Available Rules ] アクションを選択してから、[完了] をクリックします。
[データマッピング] セクションで 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 構成ファイルで次の変数を設定する必要があります。

パラメータ名	データ型	必須	説明
proxy_enabled	BOOLEAN	False	接続用のプロキシサーバーを構成するには、このチェックボックスをオンにします。
proxy_auth_scheme	ENUM	False	ProxyServer プロキシへの認証に使用する認証タイプです。サポートされている値は、BASIC、DIGEST、NONE です。
proxy_user	STRING	False	ProxyServer プロキシへの認証に使用されるユーザー名です。
proxy_password	SECRET	False	ProxyServer プロキシの認証に使用されるパスワード。

統合で UKG 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。

UKG

始める前に

コネクタを構成する

認証を構成する

接続構成のサンプル

OAUTH 2.0 - 認証コードの接続タイプ

システムの上限

アクション

RetrieveAllEmployeeGroupsOrByName アクション

RetrieveAllEmployeeGroupsOrByName アクションの入力パラメータ

Create PayCode アクション

Create PayCode アクションの入力パラメータ

DeletePayCodebyId アクション

DeletePayCodebyId アクションの入力パラメータ

Update Work Rule by ID アクション

Update Work Rule by ID アクションの入力パラメータ

アクションの例

例 - RetrieveAllEmployeeGroupsOrByName

例 - PayCode を作成する

例 - DeletePayCodebyId

例 - ID でワークルールを更新する

例 - ID で固定ルールを削除する

例 - ワークルール コードを取得する

例 - オペレーション時間を作成する

例 - ID でタイムカード設定を更新する

例 - 個人情報プロファイルを取得する

例 - すべての雇用条件を取得する

例 - 証明書プロファイルを作成する

例 - ID で休暇プロファイルを取得する

例 - 使用可能なルールを取得する

Terraform を使用して接続を作成する

統合で UKG 接続を使用する

Google Cloud コミュニティの助けを借りる

次のステップ

例 - ワークルールコードを取得する