Setup the UKG Ready Connection

Connect to AD uses the UKG Ready Saved Reports API to read employee records and determine what data will be transferred to [target-system] .

For a successful setup, you will need to create a UKG Ready Service Account, a Saved Report, and a Security Profile specifically designed for Connect to AD, as well as some additional information.

In this four-part guide, we will cover:

1. How to create a UKG Ready Service Account
2. How to gather the additional information we need for the Connect to AD connection
3. How to create and configure the Saved Report (as required by Connect to AD)
4. How to set up the connection to UKG Ready in Connect to AD 

Step 1 - Create a Service Account

To create a service account in UKG Ready, navigate to:

• Settings > Global Setup > Company Setup

Then navigate to the Login Config tab and find and select the Service Accounts section.

If the Service Accounts section is not visible, then select Edit Tabs, drag the Service Accounts section onto your preferred position on the screen and then return to Login Config.

Once the Service Account section is available, click on Add Service Account.

We recommend using ConnecttoAD for both your Username and External ID to make them easily recognizable. 

Set your Password, select the custom Security Profile you created for Connect to AD, an Account Group that has access to all the employees we need to sync and save the service account.

Your UKG Ready Service Account is now ready. Please, take note of the Username, Password and External ID before moving on to the next section.

Step 2 - Collecting Additional Information

Before leaving the Login Config tab, let’s grab the REST API Key.  Click on the eye-shaped icon to make it visible or on the GENERATE button to create a new one if the key is not present. Copy and paste it somewhere safe as we will need it later.

From here, navigate to the Company Info tab, then scroll down to the Company Address section and take note of the Company Short Name.

Lastly, we will need to get the Host Domain. To do that, simply copy and paste the base URL your browser shows while you are in UKG Ready.

By this point, we should have gathered the following information:

• User Name
• Password
• External ID
• REST API Key
• Company Short Name
• Host Domain

Please, make sure to have these on hand before moving on to the next section.

If you wish to create a specific Connect to AD Security Profile, please follow the instructions in this article before moving on to the next section

Step 3 - Create and configure a Saved Report for Connect to AD

Next, we’ll create a Saved Report that will serve as the data source for Connect to AD.

To begin, navigate to:
My Info > My Reports > Reports Hub > Overview > Build Report

Scroll down to the search bar and search for the following three mandatory columns:

• Employee Id
  
  
• Account Id
  
  
• Employee Status
  
  

Once selected, click "Show Reports," choose an Employee Information Report, and then click "Continue" to begin the configuration process.

3.1 Configure the saved report Click Edit Report Settings and provide a name and description for your report.

While the report name isn’t critical, we recommend something easy to recognize, such as Connect to AD Source Report. For the description, we recommend putting a note like: “This report is designed specifically for Connect to AD. Please do not modify this report, or your UKG to [target-system] sync may stop working.”

Click "Add/Remove Columns" and include all the UKG Ready columns required for the sync to Active Directory. You’ll also need to include a few additional required fields, which we’ll cover in a later section.

A correctly setup report is key to a successful sync. Before proceeding to the next step, please refer to this article to confirm all of your chosen columns are following the correct naming convention.

Once you’re satisfied with your configuration, click Save.

Lastly, we need to ensure the saved report is shared with the service account we created earlier.

Navigate to:

My Info > My Reports > Reports Hub > My Saved Reports

Find the report and click Edit.

Then do the following:

1. Enable the Share checkbox
   
   
2. Click Share with others > Browse > Service account
   
   
3. Select the Connect to AD service account you created earlier
   
   
4. Click Save

This step is critical — Connect to AD will not work without access to the report.

After saving, make a note of the System ID of the report — we'll need it for the next section.

Step 4 - Setup the UKG Ready Connection in Connect to AD

Open Connect to AD, select the + icon to create a new environment, select UKG Ready from the Source drop down menu and click Next.

Navigate to UKG Ready Connection, enter the data we have collected so far in the requested fields and then click on the Check Connection icon to test the connection between Connect to AD and UKG Ready.

If the connection is successful, you should see something similar to the image below:

If the connection has failed, please confirm that you have entered your UKG Ready values correctly (check for leading and trailing spaces) and try again.

If you are still unable to establish a good connection, please reach out to our support team at [e-mail].

This article is exclusively for UKG Ready. If you use UKG Pro, please refer to this article instead