Organizations can utilize the Betterworks UKG Pro integration to sync user data changes from UKG to Betterworks on a regular basis. This automates the process of:
- Creating new users
- Updating user information (i.e. change in manager, department, etc.)
- Deactivating users who are no longer with your organization
Note: Do not complete step 4 until a member of the Support Team has asked you to do so. Completing this step early will result in integration errors.
1. Contact the Betterworks Support Team (email@example.com) who will work with you to:
- Ensure that all user data in Betterworks is up-to-date
- Collect additional configuration details that will need to be applied on the backend
2. Create a Service Account in UKG Pro by:
- Going to System Configuration → Security → Service Account Administration
- Granting permissions in the following 3 categories
- Company Configuration Integration
- Employee Export
- Personal Integration
3. Retrieve the Customer API Key and base API URL (aka the API Host URL) by:
- Going to System Configuration → Web Services
4. Enter and save your UKG Pro instance details in Betterworks by:
- Going to Admin → Platform Configuration → Integrations → Third-party Integrations → UKG → Setup
Note: When you enter the API Host URL, add an 's' so that the URL begins with 'https' (instead of 'http'). The 's' triggers a secure connection.
The fields below are mapped automatically.
Note: UKG Pro allows organizations to customize label names. As such, the label names shown above may not be an exact match to your configuration. However, API names are static.
Once the connection is created the sync will initiate between UKG Pro and Betterworks. Following the first sync, a new sync will occur every 24 hours.
- Sync Failure: If the data sync between UKG Pro and Betterworks fails, verify that the credentials provided for UKG Pro and ensure that the UKG Pro API is accessible and not experiencing any downtime or connectivity issues.
- Missing Data: Ensure that user accounts or data meet the criteria for syncing, including being active and not excluded based on filters. Check field mapping in the integration settings.
- Incorrect Credentials Error: Check for typos in the username, password, API URL, and API Key.
How often does the data sync occur between UKG Pro and Betterworks?
The data sync between UKG Pro and Betterworks occurs every 24 hours from the time of the last sync. This ensures that updates to user information, new users, and user deactivations are reflected in Betterworks regularly.
What happens if there is a failure in the data sync process?
In case of a failure in the data sync process, it is essential to troubleshoot the issue by verifying the credentials, connectivity, and configuration settings. Once the issue is resolved, the sync will resume automatically based on the defined schedule.
How can I track the status and progress of the data sync between UKG Pro and Betterworks?
Betterworks sends an automated email notification to the Technical Contact if there is an error. The notification contains a report that lists the errors and links to this article for potential solutions.