UKG Pro HCM
DLH.io documentation for UKG Pro HCM
UKG Pro HCM (formerly UltiPro) is a human capital management platform covering core HR, payroll, benefits and talent data. Replicating it into your data cloud lets analytics teams combine workforce, compensation, pay statement and organization data for headcount, labor cost and payroll reporting.
Setup Instructions
Follow the setup steps guide for configuring your UKG Pro HCM connection to enable data to flow into your destination via DLH.
Supported Features
Here are key features supported for this connector.
| Sync Feature | Supported | Details |
|---|---|---|
| Custom Data and Development | ✓ | Ability to enhance connector upon request |
| Historical Re-Load/Load | ✓ | |
| Incremental/Delta Load | ✓ | Changed people records are read since the last sync; recent payroll is re-read |
| Column Selection | ✓ | |
| Column Hashing | ✓ | |
| Re-Sync Table/Entity | ✓ | Select at the table level to reload data history (on next Sync Bridge run) |
| Custom Queries | Utilizing SQL Data Query Connector | |
| Custom Data | ||
| Captures Deleted Rows | Not captured automatically (use a historical re-sync) | |
| API Sync Bridge Initiation | ✓ | |
| Priority Scheduling | ✓ | |
| Private VPC/Link | ☂ | |
| DLH Data Model Available | - |
If you have any questions about these supported features please reach out to our Customer Support team.
Details on Sync Processing
This connection is read only and never writes data back to UKG Pro HCM. Be sure to also check the change log and notes page from time to time for any changes.
- The first synchronization reads every table.
- After that, people, employment, contracts, direct deposits and banking records are read when they changed since the last synchronization.
- Payroll history, pay statements and pay detail reports are read again for the last 31 days to pick up corrections and voids. To change the 31 day window, contact DLH.io support.
- Company setup, benefits and custom fields are read in full on every run.
- Without a Historical Start Date, the first synchronization reads the last three years of payroll history.
- Pay statements and pay detail reports are only synchronized when the Primary Company Code is set.
- The connection test lists any permission the service account is missing. Tables that need a missing permission are skipped until it is granted. After granting a permission or adding the Primary Company Code later, run a historical re-sync so those tables load their history.
Issue Handling
If any issues occur with the connection simply return to the sources page in DLH.io, edit the source details and click the Save & Test button to confirm connectivity. If any issues persist please contact our support team via the DLH.io Support Portal.
Replicated Entities
The following 60 entities are replicated by default to your Target Connection. These are the table names you will see in your Target Connection. If you believe any entities/tables are missing please open a ticket with Customer Support:
COMPANIESEMPLOYMENT_DETAILSPERSON_DETAILSEMPLOYEE_CONTRACTSEMPLOYEE_GLOBAL_LOCALIZATION_ELEMENTSEMPLOYEE_EXTENDED_ELEMENTSCOMPENSATION_DETAILSJOB_HISTORYSUPERVISORSCONTACTSPHONE_NUMBERSEDUCATIONDEMOGRAPHICSMULTIPLE_JOBSMULTIPLE_POSITIONSUSERSUSER_PROFILESPTO_PLANSEMPLOYEE_STATUSPOSITION_REPORTUSER_DEFINED_FIELDSCOBRAINTERNATIONAL_EMPLOYEESNATIONAL_DOCUMENTSSECURITY_USERSDIRECT_DEPOSITSEMPLOYEE_GLOBAL_BANKSEMPLOYEE_PAY_DEDUCTION_ELEMENTSEARNINGS_HISTORYPAY_REGISTERPAYROLL_DEDUCTIONS_HISTORYPAY_STATEMENTSPAY_STATEMENT_EARNINGSPAY_STATEMENT_DEDUCTIONSPAY_STATEMENT_TAXESPAY_STATEMENT_ACCRUALSPAY_STATEMENT_NET_PAYPAY_DETAIL_REPORTSPAY_DETAIL_REPORT_EARNINGSPAY_DETAIL_REPORT_DEDUCTIONSPAY_DETAIL_REPORT_TAXESPAY_DETAIL_REPORT_ACCRUALSPAY_DETAIL_REPORT_NET_PAYDEPENDENT_DEDUCTIONSBENEFIT_OPTION_CHANGE_DATESLOCATIONSJOBSJOB_GROUPSORG_LEVELSORG_REPORTING_CATEGORIESPOSITIONSTAX_GROUPSROLESEARNINGSOPTION_RATESINSURANCE_RATESCODE_TABLESSHIFT_CODESPAY_GROUP_PAY_PERIODSPLATFORM_CONFIG_FIELDS
Schema Details (ER Diagram)
This entity relationship diagram (ERD) provides you with information about what entities/tables DLH provides for you out-of-the-box and how they are related to one another.