This guide provides step-by-step instructions for integrating UKG Reporting Services with WorkEasy. The integration enables you to:
-
Import New Employees: Seamlessly bring new hires from UKG into WorkEasy.
-
Sync Existing Employee Data: Keep employee information up to date across both platforms.
How the Integration Works
The integration relies on a report generated by UKG and accessed through an API call. WorkEasy reads the report and maps the data to:
-
Link existing employees
-
Sync new employees not yet present in WorkEasy
Credentials Required for UKG Integration
To establish the connection, obtain the following credentials from your UKG Pro account manager:
-
Username
-
Password
-
Customer API Key
-
User API Key
-
Report ID
Tip: Contact your UKG Pro account manager for assistance in creating an employee demographics report for UKG Reporting Services.
Integration Setup Steps
- Navigate to Global Settings > Integrations > UKG Reporting Services > Start.
- Enter the login credentials provided by your UKG Pro account manager.
-
Choose one of the following options:
-
All Employees: Sync all employees, inactive and terminated.
-
Only Active: Sync only active employees.
-
- Toggle Show only required fields if you only need essential data fields.
- Map the data fields. Review the UKG Fields column; these fields are preselected based on the integration report.
-
For each field, select the corresponding Default value from the integration report. For example:
For Pay Schedule, choose the default value that matches the integration report.
For Pay Rate, toggle Sync Pay Rate if you want to synchronize pay rates. - Click Save.
- If a mandatory field is missing, the system will prevent you from proceeding. Double-check the mapping and complete any missing fields.
-
Once all required fields are mapped, click Synchronize.
Troubleshooting Failed Synchronization
- If the synchronization is successful, you will see the following confirmation: "Synchronization process in progress. You will be notified when it has been completed."
- If the synchronization is unsuccessful, the following message appears:
If this happens, you need to do some troubleshooting.
- Click Edit to review the Default value column.
- Verify each item against the integration form. A common issue to check is mismatched pay schedules (pay periods). Ensure the Default value matches the report.
- After correcting the discrepancies, click Save > Synchronize again.
- A notification will appear at the top of your screen. Click Details. to monitor the process.
FAQs
Q: What is the purpose of the UKG-WorkEasy integration?
A: The integration allows you to automatically import new employees and sync existing ones between UKG and WorkEasy, ensuring accurate and up-to-date employee records.
Q: What credentials are needed to set up the integration?
A: You’ll need the following:
-
Username
-
Password
-
Customer API Key
-
User API Key
-
Report ID
These can be obtained from your UKG Pro account when generating the employee demographics report.
Q: How do I generate the integration report in UKG?
A: The integration requires an employee demographics report from UKG Reporting Services. Contact your UKG Pro account manager for assistance with creating this report.
Q: Can I choose which employees to sync?
A: Yes. During setup, you can select:
-
All Employees – Sync all employees from UKG.
-
Only Active Employees – Sync only employees with active status.
-
- Click Edit to review the Default value column.