Skip to main content

OrgChart Help Guide

UKG Configuration

Audience:

Audience: Administrators

Overview

UKG is a comprehensive Human Capital Management solution for the modern workforce. OrgChart can connect directly to UKG. The following article provides step-by-step instructions for configuring a UKG Connector

Configure a UKG Connector

  1. Sign in to your UKG account.

  2. Click on the 5_2_2_UKGPRO_API_Gear.png icon located at the top of the left side panel.

    Note

    Note: If the left side panel is not displayed, click on the 5_2_2_UKGPRO_API_Menu.png icon in the top-left corner.

  3. Click on Security, and then click on Service Account Administration option. The following page is displayed:

    5_2_2_UKGPRO_API_Configapi.png

  4. Copy the Customer API Key (under the Service Account Administration heading), and then Paste it in a separate document.

  5. Click on + add (in the top right) to add a Service Account. The following page is displayed:

    UKG_Add_Service_Account.png

  6. Enter a Username (i.e. OCN_API) for the web service user.

  7. Enter a valid Email address (typically that of the UKG Administrator creating this Service Account).

    Note

    Note: The Generate New Password checkbox is automatically checked when adding a new Service Account. After entering the remaining required information and selecting Save, a New Password window displays with the randomly generated password.

  8. Scroll to the bottom of the list, and then check the View checkbox to set the API permissions for the following Web Services:

    • Personnel Integration

    • Employee Person Details

    • Employee Compensation Details

    • Company Configuration Integration (Required to pull Org Details)

    UKG_Pro_Permissions_531_P15.png

  9. Click on the Save icon (in the top right) to preserve the Service Account settings. The automatically generated New Password appears.

  10. Copy the password, and Paste it in a separate document. This password is required for completing the UKG Connector Setup.

    Caution

    Caution: The New Password only appears once. If this password is lost, you will need to generate a new one.

  11. Click on the Web Services tab (in the left side panel).

  12. Copy the first section of the endpoint URL (outlined in red below) listed on the Web Services page, and then paste it in a separate document.

    UKG_WebServices_Endpoint.png

  13. Follow the steps outlined in the UKG Pro (API) Connector Setup article to finalize your integration.