Extracting data from UKG Pro Onboarding

To set up the UKG New Hire integration, you'll need to retrieve some organizational data from UKG and provide it to ClearCompany. Specifically, ClearCompany requires the Tenant ID, API host, and Department Organization Level. Follow the step-by-step guide below to find this information in UKG.

In this article:
Company Code
Tenant ID
API Host
Department Organization Level

Company Code

1. Log in to your UKG Onboarding Instance
2. Navigate to System Administration
3. Navigate to Company Setup
4. You will most likely only have one but if you have multiple we would need that information.

Tenant Id

1. Log in to your UKG Onboarding instance.
2. Navigate to the Onboarding Gateway by clicking on Menu ->My Team.
3. Click on the Onboarding Gateway option.
4. A new window will open, and the highlighted portion of the URL will contain your Tenant ID. For example, the org's Tenant ID might be USG1008IT057S.
   
   
   
   

API Host

1. UKG utilizes several API Host options.
2. To determine the connector your organization is set up on, submit a support request to UKG asking for the Data Center your UKG instance is on.
3. UKG will provide you with the available API Host options based on your instance's setup.
4. Below are the available options as of the creation of this article.

Department Organization Level

Depending on if these fields are required and you are utilizing them, it is not necessary if it's not needed.

1. Log in to UKG Pro Onboarding.
2. Go to Menu -> System Configuration.
3. Navigate to Display.
4. On the next page, you'll find various organization levels.
5. Note the organization level associated with the Department and communicate this information to ClearCompany. Please remember that the Department organization level may differ for each organization and might not always be level 2, as shown in the example above.
   

By following the steps outlined above, you will be able to retrieve the necessary data from UKG for the successful setup of the UKG New Hire integration with ClearCompany. Remember, providing the Tenant ID, API host, and Department Organization Level is crucial to ensure a seamless connection between the two systems. If you encounter any difficulties or have further questions, don't hesitate to reach out to [e-mail].