Use CData Connect AI to Access UKG Pro HCM Data in Microsoft Power Pivot

This article will explain how to use CData Connect AI to present UKG Pro HCM data as OData services and then consume the data in Microsoft Excel's Power Pivot business intelligence tool. Follow the steps below to retrieve UKG Pro HCM data in Power Pivot.

Connect to UKG Pro HCM from Power Pivot

To work with UKG Pro HCM data from Power Pivot, we need to connect to UKG Pro HCM from Connect AI, provide user access to the connection, and create a Workspace for the UKG Pro HCM data.

Connect to UKG Pro HCM from Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "UKG Pro HCM" from the Add Connection panel

3. Enter the necessary authentication properties to connect to UKG Pro HCM.

   Start by setting the Profile connection property to the location of the UKGProHCM Profile on disk (e.g. C:\profiles\UKGProHCM.apip). Next, set the ProfileSettings connection property to the connection string for UKGProHCM (see below).

   UKGProHCM API Profile Settings

   UKG Pro HCM uses Basic authentication combined with a customer API key to authorize access to the API. To connect, you will need your UKG Pro HCM credentials and a customer API key issued by UKG.

   Set the following connection properties to authenticate:

   • AuthScheme: Set this to Basic.
   • User: Set this to your UKG Pro HCM username.
   • Password: Set this to your UKG Pro HCM password.
   • ProfileSettings: Set this to a semicolon-separated list containing:
     • Host: Your UKG Pro HCM tenant hostname (e.g., yourcompany.ultipro.com).
     • CustomerAPIKey: Your UKG customer API key. This is passed as the US-CUSTOMER-API-KEY request header on each API call.

   To obtain your customer API key, contact your UKG Pro HCM administrator or refer to the UKG Developer Portal at https://developer.ukg.com.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add UKG Pro HCM Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure UKG Pro HCM Endpoints for Power Pivot

After connecting to UKG Pro HCM, create a workspace for your desired table(s).

1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
2. Click Add to add new assets to the Workspace.
3. Select the UKG Pro HCM connection (e.g. API1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to UKG Pro HCM data from Power Pivot.

Import UKG Pro HCM Tables in Power Pivot

Follow the steps below to import tables that can be refreshed on demand:

1. In Excel, click Data -> Get Data -> From Other Sources -> From OData Feed
2. Fill out the OData feed URL (e.g. https://cloud.cdata.com/api/odata/{workspace_name})
3. On the next screen, select Basic and configure the username and password. Password will be your PAT.

4. Select the tables that you would like to import into Excel

5. After selecting your table(s) and clicking Load, you should see the data appear in an Excel spreadsheet

6. Now, click the Power Pivot tab on the ribbon, and then select Add to Data Model. This can now work with your UKG Pro HCM data in Power Pivot.

   

Free Trial & More Information

If you are interested in connecting to your UKG Pro HCM data (or data from any of our other supported data sources) from Power Pivot, sign up for a free trial of CData Connect AI today! For more information on Connect AI and to see what other data sources we support, refer to our CData Connect AI page.