Connect to AD uses the UKG Ready Saved Reports API to read employee records and determine what data will be transferred to Active Directory.
For a successful setup, you will need to create a UKG Ready Service Account and then create a Saved Report specifically designed for Connect to AD, as well as some additional information.
In this five parts guide we will cover:
- How to create a UKG Ready Service Account
- How to gather the additional information we need for the Connect to AD connection
- How to create the Saved Report
- How to configure the Saved Report (as required by Connect to AD)
- How to setup 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 a Security Profile which can read all necessary employee data and update email addresses, then 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
- 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.
Step 3 - Create a Saved Report for Connect to AD
We will now move on to creating a Saved Report, which will act as the data source for Connect to AD.
To do so, navigate to My Info > My Reports > Reports Hub > Overview > Build Report
Follow the instructions to create an Employee Information report and save it.
Please note: The name of the report is not too important, but we suggest using something immediately recognizable such as Connect to AD Source Report or similar.
We also suggest adding a quick description along the lines of “This report is designed specifically for Connect to AD - Please do not modify this report or your UKG to Active Directory sync might stop working”
Navigate to My Saved Reports and click Edit on your newly created report.
When we edit the Saved Report, we need to make sure that the report is shared or Connect to AD will not be able to access the report. We do this by enabling the Share checkbox and then selecting the Share with All Employees or Share with All options. This is fundamental for Connect to AD to work.
Save your report and make a note of the System ID before moving on to the next section.
Step 4 - Configure the Saved Report
Navigate to My Info > My Reports > Reports Hub > My Saved Reports and select the Connect to AD report.
We now need to include all the UKG Ready columns that we need to sync over to Active Directory as well as some required fields we will explore later.
Each report column holds the UKG Ready field for Connect to AD to read.
To add or remove columns click on the ellipsis (three-dots) button in the upper right corner of the report and select Add/Remove Columns
Connect to AD does require that you do include the Employee Id and Account Id columns, so be sure to include those, then select all the columns you need to have in the report and Apply to save the changes.
Please note: Column names should never be changed from the standard UKG Ready naming convention, as Connect to AD relies on column having specific names to work. There are some exceptions, specific to the Cost Centre columns, which will be explored later.
Cost Centre Columns
The final step before moving from UKG Ready to Connect to AD is to rename the Cost Centre columns in the report using the following naming convention:
- CostCentre1Level1 > CostCentre1Level2 > CostCentre1Level3
- CostCentre2Level1 > CostCentre2Level2 > CostCentre2Level3
- CostCentre3Level1 > CostCentre3Level2 > CostCentre3Level3
By using this name convention, Connect to AD will be able to correctly read the Cost Centre hierarchy and precisely replicate it in Active Directory.
To do that, select the column to be renamed, click on the Down Arrow shaped icon and select Column Settings at the bottom of the menu. Rename the column using the “Custom label for” field and click on Apply to save your changes.
We are now ready to configure Connect to AD UKG Ready connection.
Step 5 - 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 firstname.lastname@example.org.