Before Importing


Initial API configuration must be completed before importing data. Click here for additional information on configuration.

 

Client HRIS Admins should familiarize themselves with their UKG setup and compile the following:

  • Base Compose field mapping, noting what data exists in UKG environment
  • Code Tables referenced in Base Compose field mapping
  • Platform Configuration Fields (to be imported into Compose)

Compose Import Process

 

Object Mapping order:

Compose Object (Base)

API End Point

Job Code

Jobs

Country

Country (Code Table)

Location

Location (Code Table)

Status Code

Status Code (Code Table)

Employee (Time Series Data)

Employee Job History

Employee (Name, Email, DE&I)

Person

Employee (Hire/Term Dates)

Employment Details

Employee Comp Cycle (Supervisor, Org ID)

Employee Job History

Employee Comp Cycle (Performance Rating)

Compensation Details

(Various; Field Dependent)

Platform Configuration Fields

 

Jobs – Job Code Object

 

Suggested Filter Parameter – isActive = TRUE and countryCode = only the countries they use


** Note: Country code is part of the job code, and there are potentially duplicate job code ‘descriptions’ because of the country code being affixed to the job code.

https://developer.ukg.com/hcm/reference/getjobslist

 

UKG Field Name

Compose Field Name

Job Code

Job Code

Title

Job Title / Position Description

Long Description (Alternate)

Job Title / Position Description

Job Family

Job Family

Job Group Code

Job Level

isActive

(used as Filter Parameter)

Country Code

(used as Filter Parameter)

 

Code Tables

Anticipated Code Tables to use: Status, Country, Location

 


To view and identify relevant Code Tables, Client can navigate in their UKG tenant to: Admin System Configuration > Business Rules (Example Below)

Image Placeholder

 

 

Employee Job History
– Employee Object, ECC Object

Time series Employee object fields, ECC Supervisor and Org ID fields



UKG Field Name

Compose Field Name

AnnualSalary

Annual Salary

CompanyId

 

Currency

Currency Code

EmployeeNumber

Employee ID

EmployeeStatus

Status Code

EmployeeType

Employee Type

FLSACategory

FLSA

FullTimeOrPartTime

Employee Class

HourlyPayRate

Hourly Rate

JobCode

Job Code

JobEffectiveDate

Last Promotion Date

LocationCode

Location

Org Level 1 Code

Org ID (ECC)

Org Level 2 Code

Org ID (ECC)

Org Level 3 Code

Org ID (ECC)

Org Level 4 Code

Org ID (ECC)

SalaryOrHourly (Alternate)

Employee Type

ScheduledFullTimeEquivalency

FTE

ScheduledWorkHours

Working Hours

SupervisorId

Supervisor (ECC)

WeeklyHours

Scheduled Hours

 

Person Details – Employee Object

Non Time Series Name, Email, and DE&I fields

Dev Hub: https://developer.ukg.com/hcm/reference/get_personnel-v1-person-details

 

UKG Field Name

Compose Field Name

DateOfBirth

DOB

EmailAddress

Email

EmployeeNumber

Employee ID

EthnicDescription

Ethnicity

FirstName

First Name

Gender

Gender

IsDisabled

IWD

LastName

Last Name

MilitaryService

Vets

PreferredName (Alternate)

First Name

 


Employment Details – Employee Object

Non Time Series Employee Object fields

Dev Hub: https://developer.ukg.com/hcm/reference/get_personnel-v1-employment-details


 

UKG Field Name

Compose Field Name

DateOfTermination

Termination Date

EmployeeNumber

Employee ID

LanguageCode

Preferred Language

LastHireDate

Rehire Date

OriginalHireDate

Hire Date

TermType

 


Compensation Details – Employee Comp Cycle Object

Non Time Series ECC fields. Primarily used for Performance Rating import.

Note: This end point exposes many fields that are typically Time Series (effective dated) in Compose. Importing these data points via this end point into the Employee Object may result in NULL “From Date” records being inserted rather than updating the most recent record. It is recommended that this end point is used to import data into the Employee Comp Cycle object as instructed by the

Dev Hub: https://developer.ukg.com/hcm/reference/get_personnel-v1-compensation-details

 

 

UKG Field Name

Compose Field Name

PerformanceReviewRating

Performance Rating



Platform Configuration Fields

Exposes UKG platform configuration fields, the equivalent of client-specific “custom fields” in UKG. Mapping for Platform Configuration Fields will depend on the data that is being imported. All Platform Configuration Field data is NOT effective dated and cannot be captured as Time Series on the Employee Object. Fields in this area of UKG need to have Compose equivalent fields created at the time of implementation.

Dev Hub: https://developer.ukg.com/hcm/reference/pcfieldsdatav2_getfieldsdata

 

 

Employee Demographics – DO NOT USE

Retrieves current employee demographics data for all employees All data that can be pulled in from this end point can also be pulled in via the person details end point, which also has additional data points  unavailable here.