UKG Pro Integration

Setting Up and Administering an Integration with UKG Pro

Last Updated: March 21, 2025

In this article:

• Requirements
• Establish an Integration with UKG
• Manage Integration Mapping

Overview

Integrating UKG with Quantum Workplace keeps employee information current across your organization. This integration streamlines user management and enhances the functionality of Quantum Workplace features, such as Goals, Surveys, and Recognition.

Requirements

• Available to full admin users

Establish an Integration with UKG

Access Integrations

To access the Integrations page and request the HRIS integration:

1. Click and expand Administration in the left-hand navigation menu 
2. Click Integrations from the expanded menu
3. Click the HRIS/HRMS card
4. Click the UKG card to configure the integration

Integration Setup

To set up the UKG integration:

1. Enter the host information in the Host Name field
2. Enter the API key in the US Customer API Key field
   • The unique API Key is assigned to your organization's UKG Pro web service account
   • Click here to learn how to find your US Customer API Key field
3. Enter the username and password in the respective fields
   • This is the login credentials used for the UKG Pro web service account
4. Click Save to continue

Verify Connection

To verify the API connection:

1. Click Verify Connection 
2. If successful, click Approve to continue
   • If unsuccessful, click Back and confirm the information in the previous step// is correct

Configure Demographic Mapping

1. Click and expand Edit Mappings
   • Click Standard Mappings to configure standard properties
   • Click Demographic Mappings to configure custom demographics
   • Click SMS Mappings to configure SMS properties
2. Once configured, click Activate Integration in the top-right 
   • Once active, integration details can be viewed and modified, learn more//

Standard Mappings

To map standard properties:

1. Confirm the User Property value's corresponding UKG Pro Field value is correct
   • Click the UKG Pro Field value to expand a drop-down menu with additional options
2. Click Save

Demographic Mappings

To map custom demographics:

1. Click Add Mapping to configure new custom demographics
2. Use the drop-down fields to map demographics in UKG to those in Quantum Workplace
3. Click Add/Save to add the new custom demographic
4. Repeat steps 1-3 as necessary

SMS Mappings

To map SMS properties:

1. Click and expand the UKG Pro field corresponding to Mobile Phone Number, and select the appropriate demographic
2. Click and expand the UKG Pro field corresponding to SMS Messaging Consent, and select the appropriate demographic
3. Click Save

Manage an Active Integration

To navigate and manage an active UKG integration:

1. Click and expand Administration in the left-hand navigation menu; click Integrations
2. Click HRIS/HRMS to access the integration
3. To navigate the HRIS integration:

• • A. Integration Settings: View the integration status and schedule
    • Use the Send Welcome Email... toggle to automatically send welcome emails to new users according to the latest integration
    • Use the Run Now button to trigger an immediate integration run
  • B. Data File: Indicates when the data file was last updated
    • Click Refresh Now to manually refresh the data file
    • Click Download to download the current data file
  • C. Mapped Data: Use the Edit Mappings drop-down to view and manage demographic mappings
    • Click Preview Mapped User Data to view the first 100 rows of the mapped user data
  • D. Pause & Remove Integration: 
    
    • Click Pause/Activate Integration to pause the integration feed until further action
    • Click Remove Integration to uninstall the integration and delete any user data files