Access Live UKG Pro HCM Data in Excel for the Web (Excel 365/Online) through Connect Spreadsheets

Cameron Leblanc
Cameron Leblanc
Senior Technology Evangelist
Connect to UKG Pro HCM data from Excel 365 Online (Excel for the web) with Connect Spreadsheets.

Looking for Connect AI instructions?

Your Connect AI account includes Connect Spreadsheets, so you can use the instructions below. You can expect minor differences when referencing the Connect Spreadsheet platform, but the principles still apply!


Microsoft Excel for the web represents a cloud-native iteration of Microsoft Excel. When combined with Connect Spreadsheets by CData, you gain immediate access to UKG Pro HCM data directly within Excel, facilitating data analysis, collaboration, calculations, and more. This article shows how to connect to UKG Pro HCM in Connect Spreadsheets and access live UKG Pro HCM data in Excel spreadsheets online.

Connect Spreadsheets is the easiest way to get all your live data into Microsoft Excel and Google Sheets - no more downloading, wrangling, and uploading files again. Just connect to your data, select the dataset you'd like to see, and import it into your spreadsheet.

This setup requires a Connect Spreadsheets instance and the Connect Spreadsheets Add-In for Excel. To get started, sign up a free trial of Connect Spreadsheets and install the free Connect Spreadsheets Excel Add-In.


Configure UKG Pro HCM Connectivity for Excel

Connectivity to UKG Pro HCM from Excel is made possible through Connect Spreadsheets . To work with UKG Pro HCM data from Excel, we start by creating and configuring a UKG Pro HCM connection.

  1. Log into Connect Spreadsheets, click Sources and click Add Connection Adding a Connection
  2. Select "UKG Pro HCM" from the Add Connection panel Selecting a data source
  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.

    Configuring a connection (Salesforce is shown)
  4. Click Create & Test

With the connection configured, you are ready to connect to UKG Pro HCM data from Excel for the web.

Access Live UKG Pro HCM Data in Excel for the web

The steps below outline connecting to Connect Spreadsheets from Excel to access live UKG Pro HCM data.

  1. Log into Excel, create a new sheet (or open an existing one).
  2. Click Insert and click Office Add-ins. (If you have already installed the Add-In, jump to step 4.)
  3. Search for Connect Spreadsheets and click "Get it now" to install the Add-in. Install the Add-In
  4. Back in Excel, open the Data ribbon select and click the CData Connect Spreadsheets "Get Data" button. Open Add in panel
  5. In the Add-In panel, click "Log in" to sign into and authenticate with your Connect Spreadsheets account Authorizing the Add-In
  6. In the Connect Spreadsheets panel in Excel, click Import Connect Spreadsheets  panel in Excel
  7. Choose a Connection (e.g. API1), Table (e.g. UserDetails), and Columns to import Connect Spreadsheets  panel in Excel
  8. Optionally add Filters, Sorting, and a Limit Choosing a Connection, Table, and Columns
  9. Click Execute to import the data Executing the Query

Live Access to UKG Pro HCM Data from Spreadsheets

New, you have a direct, cloud-to-cloud connection to live UKG Pro HCM data from your Excel workbook. You can add more data to your workbook for calculations, aggregations, collaboration, and more.

Imported data (Salesforce is shown)

Try Connect Spreadsheets and get real-time data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your spreadsheet apps.

Ready to get started?

Learn more about Connect Spreadsheets or sign up for free trial access:

Free Trial