This article only applies to your community if your Firstup contract includes this functionality. Please contact your Customer Success Manager with any questions about feature availability for your community.

This article provides steps to enable UKG Pro Integration with your Firstup community. This integration streamlines the flow of HR data, enabling personalized communications and an enhanced employee experience. Once enabled, refer to UKG Pro Productivity Integration for an overview of how to use the integration.

Before You Start

To complete these instructions, you must have:

• Administrator-level access to UKG Pro and Brand Super Admin level access to Firstup Creator Studio.
• An active Firstup community.
• A contract with Firstup for this premium feature.

To establish the connection between Firstup and your UKG Pro instance:

1. Log in to Firstup Studio.
2. Log in to  UKG Pro (administrator access required).
3. You will need specific API keys and credentials from UKG Pro during this process (see below).

Notes:

• Firstup utilizes Merge for this integration. This article outlines the steps required to connect your Firstup instance to your UKG Pro instance. For a comprehensive guide on the UKG Pro steps, please refer to Merge's documentation.
• If you need to reset your configuration once completed, or have any issues during the setup, please contact customer support who can investigate and correct your configuration steps. 

Link Your UKG Pro Account to Firstup Creator Studio

This integration utilizes service accounts and API keys to connect Firstup to UKG Pro. You will be guided through a modal to establish this connection. For further assistance with guidance on the UKG Pro side, please follow Merge's self-serve wizard, or their documentation.

To link your accounts, go to Creator Studio. 

1. Go to Configuration > Integration Management. Select UKG Pro.
2. On the UKG Pro setup page, select Link Account.
3. A modal prompts you to confirm your administrator status. Select I am an admin.
4. Select the UKG data you want the Firstup integration to have access to, then Next.
5. A UKG Enter your API key modal appears:
   • In your UKG Pro environment, use the search bar to find Service Account Administration.
   • Locate and copy your Customer API Key (found at the top of this page).
   • Paste this key into the corresponding field in Firstup, then select Next.
6. A UKG Enter Your Service Account Credentials modal appears:
   • In UKG Pro > Service Account Administration, click Add (or select an existing service account to modify).
   • Provide the integration administrator's username and email for this service account in UKG Pro and in the modal.
   • You must select all available permissions for this service account. Select Save.
   • UKG Pro will display a generated password. Copy this password immediately and paste it into the modal in Firstup Studio.
7. A UKG Enter your web services URL modal appears:
   • In your UKG Pro environment, use the search bar to find Web Services.
   • Copy all of the URLs displayed on this page.
   • Paste the URLs into the modal. Select Next.
8. The modal indicates a successful connection. Click Next and then Finish.

Any errors are likely to be due to missing permissions from step 6. 
 

Configure Integration Details in Firstup

After successfully linking the account, you must configure the data integration specifics.

1. On the Firstup UKG Pro configuration page, select Configure.
2. Enter your UKG Pro URL.

Sync User Identifiers

Every user application account has an attribute used as a user identifier. Syncing a user's UKG Pro account identifier and their Firstup account identifier syncs that user account between both applications. 

To sync your users, select a UKG Pro attribute that identifies your users' UKG Pro accounts and a Firstup attribute that identifies their Firstup accounts. For example, their UKG Pro work email and their Firstup primary email.  

The following identifiers can be used to map the two systems:

Notes: 

• For further guidance on using custom attributes as an identifier, refer to Custom Attribute Identifiers.
• The UKG user identifier is required to exist in Firstup Creator Studio and UKG. For example, if Work email is the UKG identifier, that user's email address must also exist as a user attribute in Firstup Creator Studio.

1. From the dropdown, select the attribute used as your UKG Pro identifier.
   
   
    
2. From the dropdown, select the attribute used as your Firstup user identifier. 
   
   
    
3. Select Save. 

The program is now set up to start syncing user accounts. User accounts are synced passively. 

Note: The data sync between Firstup and UKG Pro is every 24 hours. 

Custom Attribute Identifiers

You can select a custom attribute as the Firstup identifier. 

A custom attribute is a user attribute customized to your community, and not a default user attribute. For example, a user's first name, last name, email address, etc. are all default user attributes. A custom attribute may be, for example, UKG_Id, etc. 

When selecting a custom attribute as an identifier, you must enter the custom attribute name as free text.

This free-text box accepts any value, including:

• Spacing
• Upper case
• Lower case
• Mixture of upper and lower case
• Special characters 

The custom attribute provided must match the exact custom attribute field on the user's profile. For example, if you set UKG_id as an attribute_name, but the attribute on the user's profile is called ukg_id (lower case), the mapping fails.