Excel Spreadsheet Automation on UKG Pro HCM Data with the QUERY Formula

The CData Excel Add-In for UKG Pro HCM provides formulas that can query UKG Pro HCM data. The following three steps show how you can automate the following task: Search UKG Pro HCM data for a user-specified value and then organize the results into an Excel spreadsheet.

The syntax of the CDATAQUERY formula is the following:

=CDATAQUERY(Query, [Connection], [Parameters], [ResultLocation]);

This formula requires three inputs:

• Query: The declaration of the UKG Pro HCM data records you want to retrieve, written in standard SQL.

• Connection: Either the connection name, such as APIConnection1, or a connection string. The connection string consists of the required properties for connecting to UKG Pro HCM data, separated by semicolons.

  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.

• ResultLocation: The cell that the output of results should start from.

Pass Spreadsheet Cells as Inputs to the Query

The procedure below results in a spreadsheet that organizes all the formula inputs in the first column.

1. Define cells for the formula inputs. In addition to the connection inputs, add another input to define a criterion for a filter to be used to search UKG Pro HCM data, such as UserStatus.
2. In another cell, write the formula, referencing the cell values from the user input cells defined above. Single quotes are used to enclose values such as addresses that may contain spaces.

=CDATAQUERY("SELECT * FROM UserDetails WHERE UserStatus = '"&B8&"'","Profile="&B1&";AuthScheme="&B2&";User="&B3&";Password="&B4&";ProfileSettings="&B5&";CustomerAPIKey="&B6&";Provider=API",B9)


3. Change the filter to change the data.