Overview

This guide shows how to connect UKG Pro as an HRIS in YeshID, and the specific steps within UKG. Refer to the document for follow-on activities

• Connect & Integrate HRIS Applications

Steps

1. Create a Service Account

1. In UKG, navigate to Security -> Web Services -> Service Account Administration (in search)

2. Create a new Service Account

   1. Grant permission Employee Export: VIEW
      

3. This will generate a password that needs to be stored (this will be added to YeshID later)

2. Create a Report in UKG Pro

1. Sign in to your UKG Pro instance with administrator permissions.

2. Navigate to Business Intelligence -> People Analytics

     

   

3. Click Explore Analytics

4. Click New and Select Report

5. Click Blank Template and Click Ok

6. Click the Pages icon on the toolbar, right-click Report, and then select Open report from clipboard.

   

7. Open the YeshID UKG Pro report spec (attached below), copy the contents into the report window, and then click OK.

   UKG Report Spec.txt

8. Click OK when the report validation completes.

9. Select Save as, click Collapsed items, and select Team content.

10. Click the new folder icon, enter YeshID for the folder name, enter a name for the report in the Save as field, and click Save.

11. Click Home, click Action menu (...) for the report you created in step 10, and select Properties.

12. Expand Advanced and copy the value in the ID field to a text editor. This is your Report ID. ✨

3. Get additional details from UKG

1. Sign in to your UKG Pro instance with administrator permissions.

2. Click MenuSystem Configuration and select Web Services below Security.

3. Copy the values displayed in the User API Key and Customer API Key fields and paste them in a text editor.

1. Copy the base URL displayed next to Business Intelligence web service endpoint and paste it in a text editor. The base URL is the portion of the URL that is common to all of the displayed fields.

Note down:

• BaseURL = Business Intelligence web serve endpoint (before BIDataService)

• User Key = User API Key from Service Account

• Customer Key = Customer API Key

4. Add UKG Pro to YeshID as an Application

1. Go to Applications -> Add Application

   

5. Configure UKG Pro Integration in YeshID

1. Click "Connect"

2. Fill out the following details

   

• Base URL: the base url from step 2d

• Customer Key: the customer api key from step 2c

• Password: Enter the UKG Pro administrator password

• Report ID: the report ID copied from the last step in Creating a report in UKG Pro

• User Key: the user api key from step 4c

• Username: Enter the UKG Pro Service Account user name

6. Test Integration

1. Under Import & Mapping click the “Test” button. This will fetch the report from UKG Pro and display the results. At this point the field mapping from UKG Pro to YeshID can be modified to suit your needs, including adding any custom fields. Once you are happy with the results, click “Save”

Troubleshooting

The integration cannot access or run the report

If YeshID cannot retrieve the UKG Pro report, check access for the integration account configured in YeshID, not just an administrator account.

1. Confirm BI / Reports-as-a-Service access. Ask UKG Support to confirm that the integration account is enabled for BI / Reports-as-a-Service and can execute the report through the BI web service. If access is not enabled, open a support case in the UKG Customer Success Portal to request enablement before retrying.

2. Confirm access to the Administrator Package. The YeshID report is built on UKG's delivered Administrator Package under UltiPro BI for Core HR and Payroll. The integration account needs access to this package as well as to the report.

3. Check report and parent-folder permissions. In Team content > YeshID, locate the report and confirm that the integration account can access and execute it. Check permissions on the report and its parent folders so the account can reach the report.

4. Verify the current Report ID. Open the report's Properties > Advanced > ID. Compare this value with the Report ID configured in YeshID and, if an error includes a Report ID, the value in that error. If they differ, update YeshID to use the ID of the report you intend the integration to run.

Important: A report running successfully under an administrator login does not confirm that the integration account can run it. The integration account has its own permissions.

After completing these checks, return to Import & Mapping in YeshID and click Test. A successful test retrieves the report and displays its results for field mapping.