Note: This is a premium feature or service. This article only applies to your community if your Firstup contract includes this premium functionality. Please contact your Customer Success Manager with any questions about feature availability for your community.

This article provides steps to enable UKG Dimensions Integration with your Firstup community. Refer to UKG Productivity Integration for an in-depth look at the UKG integration functionality included.

Enable UKG Integration

Prerequisites

To complete these instructions, you must have access to UKG (administrator level), an active community with Firstup, and a contract with Firstup for this premium feature. 

To establish the connection between Firstup and your UKG instance:

1. Log in to the member experience.
2. Log in to your UKG Experience.
3. You also need your UKG Client ID and Client Secret. Contact UKG support if you do not have this.

Create App Key in UKG Experience

Set up your App Key with your Client ID and Client Secret in UKG Experience:

1. Go to Administration > Application Setup.
2. Then select Common Setup > My Apps.
3. On the My Apps page:
   
   
   1. Select + App.
      
      
   2. Enter a unique app name e.g. Firstup Integration. 
   3. Select one or more products.
   4. Select Save.
      
      
      
      
4. Select the created app from the app list. 
5. Select Details.
6. Copy the App Key from the Appkey Details panel:
   
   

Allow Firstup URLs in UKG Experience

1. Go to Administration > Application Setup.
2. Select System Configuration > System Settings.
3. Select the Global Values tab.
   
   
   
   
4. In the Global Values tab, locate global.oAuth.authCode.redirection.uris and append the Firstup callback URLs separated by a comma. The callback URLs are:
   • US customers: https://eva.socialchorus.com/api/v/integrations/ukg_dimensions/callback
   • EU customers: https://eva.onfirstup.eu/api/v1/integrations/ukg_dimensions/callback
5. Select Save.

Enable endpoint accessibility in UKG Experience

The integration utilizes the following endpoint to retrieve authenticated user information. This endpoint may be disabled by default:

• /api/v1/commons/persons/current_user_info

Function Access Profiles control the API access, and need to be set to allowed:

1. Go to Administration > Application Setup.
2. Select Access Profiles > Function Access Profiles.
3. Select a specific profile. 
   
   
   
   
4. Expand APIs > REST API and locate Current User Information API.
5. Select Allowed from the drop-down and select Save & Return.
6. Repeat steps 3 to 5 for all of the other Function Access Profiles that use the UKG integration.
7. Once you have completed these steps, supply Firstup with the following:
   • Base URL
   • App Key
   • Client ID
   • Client Secret
8. Support will finalize the integration setup on the Firstup side.