Setup Steps
DLH.io Setup Guide for UKG Pro HCM
Connector Pre-Requisites
Connecting to UKG Pro HCM, you need to make sure that you have the following:
- A web service account, created by a system administrator under System Configuration > Security > Service Account Administration, with the View role on: Employee Person Details, Personnel Integration, Employee Compensation Details, Payroll Integration, Company Configuration Integration and Employee Pay Statements.
- Your Customer API Key and web service host, both shown under System Configuration > Security > Web Services.
Instructions (Basic Connection Setup)
DLH.io connects to UKG Pro HCM over secure channels using your web service account. This connection is read only.
Using the form please complete the following basic steps:
- Enter a Name or Alias for this connection, in the 'Name/Alias' field, that is unique from other connectors.
- Enter in the 'Target Schema Prefix' field, a name that will be unique in your target destination where you wish to land the data.
- Enter the Web Service Host, for example
service5.ultipro.com. - Enter the Service Account User and Password.
- Enter the Customer API Key.
- Optionally enter the Primary Company Code, found under System Configuration > Company Setup. Pay statements and pay detail reports are only synchronized when it is set.
- Optionally set a Historical Start Date. Without one, the first synchronization reads the last three years of payroll history.
- Click Save & Test. The 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.
If the connection stops working after a password change, edit this source, update the password and click Save & Test. If any issues persist please contact our support team via the DLH.io Support Portal.