UKG Ready Integration

Create or use an API key to authenticate the integration and allow Exclaimer to connect to UKG Ready during the connection process. 

To create an API key:

1. Within UKG Ready, from the menu sidebar, select the Settings tab, select Global Setup, then select Company Setup.
   
   _{Select the Settings tab, select Global Setup, then select Company Setup.}
    

   The Company Setup screen is displayed. 
    

2. Select the Login Config tab.
   
   
   _{Select the Login Config tab.}
    
3. Scroll down to the API Keys section.

4. If there is no key, select GENERATE to create one. Select Yes to generate a new API key. Paste the value as the UKG Ready API key.

   IMPORTANT! If there are existing integrations using this key, do not select GENERATE. Copy the existing API key and paste the value as the UKG Ready API key. 

   
   
   _{Example image of the API section.}

Create a security profile with the correct permissions to allow Exclaimer to access the required employee data via the UKG Ready API.

To configure security permissions:

1. Within UKG Ready, from the menu sidebar, select the Settings tab, select Profiles/Policies, then select Security.
   
   The Company Security Profiles screen is displayed.
   
   
   _{Example image showing the Company Security Profiles.} 
    
2. Select New Security Profile.
   
   
   _{Select NEW SECURITY PROFILE.} 
    
3. In the Security Profile section, enter a name for the new security profile.
    
4. Within the Security Items section, select the HR tab. 
    
5. Scroll down to the Employee Management section, and select the following permissions required for Exclaimer: 

6. Leave all other Employee Management fields blank.
    

7. Select the Modules tab.
   
   
   _{Select the Modules tab.}

    

8. Scroll down to the REST API RESOURCES section, and select the following permissions required for Exclaimer:

   Resources	Permissions
   Employee Demographics	View
   Employee HR Custom Field	View
   Employee Profiles	View
   Employees	View

Create a service account to authenticate and complete the integration with UKG Ready using its credentials during the connection process.

To create a service account:

1. Within UKG Ready, from the menu sidebar, select the Settings tab, select Global Setup, then select Company Setup.
    
2. Select Edit Tabs.
   
   
   _{Select Edit Tabs.}
    
3. From the Available Windows, drag Service Accounts to the Top section.
   
   
   _{Example image showing Service Accounts in the Top section.}
    
4. Select SAVE.
5. Select the arrow next to Tabs Configuration, then select the Login Config tab.
   
   
   _{Select the left arrow.}  
       
6. Select ADD SERVICE ACCOUNT.
   
   
   _{Select ADD SERVICE ACCOUNT.}
    
7. Follow the on-screen instructions and enter the appropriate credentials.
   
   
   _{Enter the appropriate details.}
    

8. In Security Profile, select the security profile you created earlier.
   
   
   _{In the Security profile, select the security profile you created earlier.}

    

9. In ACCOUNT ACCESS, select the magnifying glass icon to search for the account groups. Select the group name, All Company Employees. 
   
   
   _{Select the group name, All Company Employees.} 
    
10. Select Save.  
     

To connect to your HRIS to allow Exclaimer to synchronize user contact details:

1. From the drop-down list, select UKG Ready.
   
   
   _{From the drop-down list, select UKG Ready.}
    

2. Select Connect.
   The UKG Ready window is displayed. Grant read-only access and choose which data models are shared.

   WARNING! If the UKG Ready Permissions window is not displayed, allowlist cdn.bindbee.dev (and preferably .bindbee.dev) to ensure the Bindbee SDK loads correctly in the browser.
   NOTE: If you require additional custom fields, our team can configure them manually. This option is not currently available as a self-service feature. Get in touch with our Support team for help in setting up any required custom fields.

   
   

   _{The UKG Ready Permissions window.} 
    

3. Select Allow and Continue.
    

4. Enter your UKG Ready Domain name.
   
   
   _{Enter the UKG Ready Domain name.}

   To retrieve your Domain name:

   1. Within UKG Ready, check the URL in your browser. Copy the value between http:// and /ta/.
      
      
      _{Example image showing where to find the Domain name.}
      
      This is the UKG Ready Domain name.
       
   2. Paste this value as the UKG Ready Domain name.
      
       
5. Select Next. 
    

6. Enter your UKG Ready Company Short Name.
   
   
   _{Follow the on-screen instructions and enter the UKG Ready Company Short Name.}
    

   To retrieve the UKG Ready Company Short Name:

   1. Within UKG Ready, from the menu sidebar, select the Settings tab, select Global Setup, then select Company Setup.
      
      _{Select Global Setup, then select Company Setup.}
      
      The Company Setup screen is displayed. 
       
   2. Select the Company Info tab.
      
      
      _{Select the Company Info tab.} 
       
   3. Scroll down to the Company Address section.
       
   4. Copy the details within the Company Short Name.
      
      
      _{Example image showing where to find the Company Short Name.}
       
   5. Paste this value as the UKG Ready Company Short Name.
       
7. Select Next.
    
8. Enter your UKG Ready API key.
   
   
   _{Follow the on-screen instructions and enter the UKG Ready API key.}
     

9. Select Connect. 

   
   _{Example screen showing that the connection has been established.}

   WARNING! Keep the window open until the connection is complete. If you close it too soon, the connection may not finish setting up, and it may not appear as connected in Exclaimer.
   
   If you try to connect to UKG Ready, you may see a message saying that the connector already exists. If this happens, raise a support ticket so the team can assist you. 

   Once a connection is established with the UKG Ready system, the Connected text is displayed within Exclaimer. 
   
   
   _{Once a connection is established with the UKG Ready system, the Connected text is displayed within Exclaimer.} 

To re-connect to the UKG Ready system:

1. Select Re-connect.
   
   A message is displayed that reconnecting will entirely remove your connection to UKG Ready, and any data will no longer be available, and a new connection flow will start automatically.
   
   
   _{Select OK to reconnect to the UKG Ready system.}  
    
2. Select OK to continue.

To disconnect from the UKG Ready system:

1. Select Disconnect.
   
   A message is displayed that disconnecting will entirely remove your connection to UKG Ready, and any data from the system will no longer be available.
   
   
   _{Select OK to disconnect from the UKG Ready system.}  
     
2. Select OK to continue.