UKG Pro HCM v2

Provides integration with UKG Pro HCM, a platform for personnel, payroll, benefits, recruiting, learning and workforce management.

Use the Node to read records, look up identifiers and submit supported business actions, imports and record changes.

Revision History

0.0.1.3 - Initial release.

Connection

Property Type Description
API URL String HTTPS API origin supplied by UKG, without an endpoint path.
Username String UKG web service account username.
Password Masked UKG web service account password.
Customer API Key Masked Tenant Customer API Key.
Client ID String Optional primary company code (US-Client-Id), required for pay-statement retrieval.
Access Token Masked Bearer token for Recruiting, Onboarding or Learning; use a separate connection for each service origin and token scope.
Global Tenant ID String Tenant identifier for the Learning global-tenant-id header.
Test Operation ID String Query template used by Connection Test. Defaults to EmploymentDetails for core HCM.
Test Options JSON String Options JSON for Connection Test, for example the recruiting tenantalias. Do not put credentials here.
Timeout (seconds) Integer Maximum duration of each API request.

Setup Notes

This Node supports Cloud and Local Runtimes.

Use a separate Connection for each service origin and authentication scope. Set API URL to the HTTPS origin without an endpoint path. Core HCM uses Username, Password and Customer API Key. Recruiting and Onboarding use Access Token; Learning may also require Global Tenant ID. Client ID is the primary company code required by applicable payroll APIs. Select Test Operation ID and supply its Test Options JSON when testing services other than core HCM.

Methods

Query

Queries UKG data with automatic paging.

Parameter Type Description
Connection Connection UKG Pro HCM service account.
OperationId String Operation selected by the template.
Options Object Provider query filters. Paging is automatic.
Return Type Description
Response Array Provider-shaped rows without Flowgear mutation metadata. Scalar results use Value.

Lookup

Searches UKG data using provider request bodies.

Parameter Type Description
Connection Connection UKG Pro HCM service account.
OperationId String Operation selected by the template.
Items Array Identifier records or Body requests, as shown by the selected template.
Options Object Provider route and query values.
BatchSize Integer Employee-ID records per batch, 1 to 100. Body templates send one complete request per input.
Return Type Description
Response Array Provider-shaped read results without Flowgear mutation metadata.

Create

Creates UKG records or uploads recruiting documents.

Parameter Type Description
Connection Connection UKG Pro HCM service account.
OperationId String Operation selected by the template.
Items Array PTO records or Body requests, as shown by the selected template.
Options Object Provider route and query values.
BatchSize Integer PTO records per batch, 1 to 100. Body templates send one complete request per input.
Return Type Description
Response Array Provider fields plus Flowgear.IsSuccess, Flowgear.Message and Flowgear.Request. Check success for each result.

Update

Updates existing UKG records.

Parameter Type Description
Connection Connection UKG Pro HCM service account.
OperationId String Operation selected by the template.
Items Array PTO values or Body requests, as shown by the selected template.
Options Object Provider route, query and declared header values.
Return Type Description
Response Array Provider fields plus Flowgear.IsSuccess, Flowgear.Message and Flowgear.Request. Check success for each result.

Delete

Deletes selected UKG resources.

Parameter Type Description
Connection Connection UKG service connection.
OperationId String Operation selected by the template.
Items Array One request per input; Body contains native bulk payloads where supported.
Options Object Provider route, query and declared header values.
Return Type Description
Response Array Provider fields plus Flowgear.IsSuccess, Flowgear.Message and Flowgear.Request. Check success for each result.

Execute

Executes a UKG business action.

Parameter Type Description
Connection Connection UKG service connection.
OperationId String Operation selected by the template.
Items Array One request per input with its provider Body.
Options Object Provider route, query and declared header values.
Return Type Description
Response Array Provider fields plus Flowgear.IsSuccess, Flowgear.Message and Flowgear.Request. Check success for each result.

Import

Submits UKG import transactions.

Parameter Type Description
Connection Connection UKG service connection.
OperationId String Operation selected by the template.
Items Array One request per input with its provider Body.
Options Object Provider route, query and declared header values.
Return Type Description
Response Array Request acceptance and provider sub-results plus Flowgear.IsSuccess, Flowgear.Message and Flowgear.Request. Query status to establish completion.

Usage Notes

  • Select a template to populate the operation GUID, declared Options and request structure. Templates do not imply that your tenant has the required licence or permissions.
  • Query and Lookup preserve provider fields without mutation metadata. Writes include Flowgear.IsSuccess, Flowgear.Message and Flowgear.Request.
  • Most write and POST-read templates take one complete provider request per Items row under Body. Native bulk arrays remain inside Body and are not split by BatchSize.
  • Employee-ID Lookup and PTO Create use batches of 1 to 100 records, defaulting to 100. Their original record contracts differ from Body templates.
  • Supply an explicit empty object input for a bodyless delete. Empty input performs no calls.
  • The first request runs before streaming starts; later pages and input records run on demand. Imports report acceptance; query their status to confirm completion.
  • Acquire and renew bearer tokens through your identity integration. Time and Attendance sessions are established for each invocation. The Node does not automatically retry requests.
  • Use Employee Changes no more frequently than every three hours.

Examples

Map a complete provider body

For a template that exposes Body, place the complete provider payload under that field in each Items row. For example, a code-table create template can accept:

{
  "Body": {
    "code": "EXAMPLE",
    "description": "Example code"
  }
}

Use the fields required by your selected template. For a native bulk operation, keep the complete provider array or envelope inside Body; BatchSize does not divide it into separate requests.