UKG PRO is a comprehensive HRMS that allows the organizations to efficiently manage the personnel data, handle robust payroll tasks, boost scheduling efficiency, and attract, nurture, and grow talent.
Supervisor configuration parameters
To configure the connector, following parameters are required.
-
Connector name
-
Login Username
-
Login Password
-
User API Key for web services
-
Customer API Key for web services
-
Target URL (https://{service_name}.ultipro.com)
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details)
NOTE:
Retrieving credentials to generate token:
- Login to Pro portal
- Access Web Services under System Configuration > Security
- Note the “User API Key”, “Customer API Key” and base URL of the web services listed
Supported objects and operations
Employees
Operation |
VERB |
---|---|
Get Employee by Id |
GET |
List Employees |
GET |
EmpJobs
Operation |
VERB |
---|---|
Get EmpJob by Id |
GET |
List EmpJobs |
GET |
EmpEmployments
Operation |
VERB |
---|---|
Get EmpEmployment by Id |
GET |
List Employments |
GET |
Attributes Mappings
Different mappings associated with this connector are listed in the tables below.
SCIM Properties | SCIM UKG Pro Employee Properties |
---|---|
id | Person/EmployeeIdentifier/EmployeeNumber/text(), Person/EmployeeIdentifier/CompanyCode/text() |
userName | Person/EmployeeIdentifier/EmployeeNumber/text() |
name.familyName | Person/LastName/Text() |
name.givenName | Person/FirstName/Text() |
name.middleName | Person/MiddleName/Text() |
name.honorificPrefix | Person/Prefix/Text() |
name.honorificSuffix | Person/Suffix/Text() |
name.preferredFirstName | Person/PreferredFirstName/Text() |
name.formerLastName | Person/FormerLastName/Text() |
emails.email | Person/EmailAddress/Text() |
emails.alternateEmail | Person/AlternateEmailAddress/Text() |
companyCode | Person/EmployeeIdentifier/CompanyCode/text() |
ssn | Person/SSN/Text() |
supressSsn | Person/SuppressSSN/Text() |
SCIM Properties | SCIM UKG Pro EmpJob Properties |
---|---|
id | Job/EmployeeIdentifier/EmployeeNumber/text(),Job/EmployeeIdentifier/CompanyCode/text() |
agricultural | Job/Agricultural/text() |
alternateTitle | Job/AlternateTitle/text() |
dateInJob | Job/DateInJob/text() |
directLabor | Job/DirectLabor/text() |
effectiveDate | Job/EffectiveDate/text() |
companyCode | Job/EmployeeIdentifier/CompanyCode/text() |
employeeNumber | Job/EmployeeIdentifier/EmployeeNumber/text() |
employeeType | Job/EmployeeType/text() |
fullOrPartTime | Job/FullOrPartTime/text() |
hourlyOrSalaried | Job/HourlyOrSalaried/text() |
jobCode | Job/JobCode/text() |
jobGroup | Job/JobGroup/text() |
localUnion | Job/LocalUnion/text() |
nationalUnion | Job/NationalUnion/text() |
orgLevel1 | Job/OrgLevel1/text() |
orgLevel2 | Job/OrgLevel2/text() |
orgLevel3 | Job/OrgLevel3/text() |
orgLevel4 | Job/OrgLevel4/text() |
payFrequency | Job/PayFrequency/text() |
payGroup | Job/PayGroup/text() |
payScaleCode | Job/PayScaleCode/text() |
project | Job/Project/text() |
promotion | Job/Promotion/text() |
reasonCode | Job/ReasonCode/text() |
scheduledHours | Job/ScheduledHours/text() |
seasonal | Job/Seasonal/text() |
shiftCode | Job/ShiftCode/text() |
shiftGroup | Job/ShiftGroup/text() |
stepNo | Job/StepNo/text() |
supervisorCompanyCode | Job/Supervisor/CompanyCode/text() |
supervisorEmployeeNumber | Job/Supervisor/EmployeeNumber/text() |
timeClock | Job/TimeClock/text() |
transfer | Job/Transfer/text() |
youthTraining | Job/YouthTraining/text() |
SCIM Properties | SCIM UKG Pro EmpEmployment Properties |
---|---|
id | EmploymentInformation/EmployeeIdentifier/EmployeeNumber/text(),EmploymentInformation/EmployeeIdentifier/CompanyCode/text() |
arrearsSuspendedFrom | EmploymentInformation/ArrearsSuspendedFrom/text() |
arrearsSuspendedTo | EmploymentInformation/ArrearsSuspendedTo/text() |
beneSeniority | EmploymentInformation/BeneSeniority/text() |
deceased | EmploymentInformation/Deceased/text() |
deceasedDate | EmploymentInformation/DeceasedDate/text() |
earlyRetirement | EmploymentInformation/EarlyRetirement/text() |
companyCode | EmploymentInformation/EmployeeIdentifier/CompanyCode/text() |
employeeNumber | EmploymentInformation/EmployeeIdentifier/EmployeeNumber/text() |
employmentStatus | EmploymentInformation/EmploymentStatus/text() |
fmlaCode | EmploymentInformation/FMLA_Code/text() |
hcsoEndDate | EmploymentInformation/HCSOEndDate/text() |
hcsoNotCovered | EmploymentInformation/HCSONotCovered/text() |
hcsoStartDate | EmploymentInformation/HCSOStartDate/text() |
job | EmploymentInformation/Job/text() |
jobStart | EmploymentInformation/JobStart/text() |
lastHire | EmploymentInformation/LastHire/text() |
lastPerfReview | EmploymentInformation/LastPerfReview/text() |
lastSalaryReview | EmploymentInformation/LastSalaryReview/text() |
leaveReason | EmploymentInformation/LeaveReason/text() |
nextPerfReview | EmploymentInformation/NextPerfReview/text() |
nextSalaryReview | EmploymentInformation/NextSalaryReview/text() |
originalHire | EmploymentInformation/OriginalHire/text() |
ptoSuspendedFrom | EmploymentInformation/PTOSuspendedFrom/text() |
ptoSuspendedTo | EmploymentInformation/PTOSuspendedTo/text() |
payAutomatically | EmploymentInformation/PayAutomatically/text() |
paySuspendedFrom | EmploymentInformation/PaySuspendedFrom/text() |
paySuspendedTo | EmploymentInformation/PaySuspendedTo/text() |
roeIssueReason | EmploymentInformation/ROEIssueReason/text() |
regularRetirement | EmploymentInformation/RegularRetirement/text() |
seniority | EmploymentInformation/Seniority/text() |
statusAnticipatedEnd | EmploymentInformation/StatusAnticipatedEnd/text() |
statusStartDate | EmploymentInformation/StatusStartDate/text() |
weeks | EmploymentInformation/Weeks/text() |
Connector SCIM configurations
While UKG Pro system does not support disabling attributes feature, the Starling Connector for UKG Pro does supports disabling attributes by removing the SCIM mapping in the object GET response.
Connector limitations
-
Target APIs do not support created date and last modified date for employees.
-
The target API does not exactly validate the Id, the results are returned even when some additional characters are added to the end of a valid resource Id.