Query UKG Pro HCM Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData API Driver for JDBC, DataGrip can work with live UKG Pro HCM data. This article shows how to establish a connection to UKG Pro HCM data in DataGrip.

Create a New Driver Definition for UKG Pro HCM

The steps below describe how to create a new Data Source in DataGrip for UKG Pro HCM.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData UKG Pro HCM Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.api.jar).
   • Set Class to cdata.jdbc.api.API.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to UKG Pro HCM

1. Once the connection is saved, click the plus (), then "Data Source" then "CData UKG Pro HCM Driver" to create a new UKG Pro HCM Data Source.
2. In the new window, configure the connection to UKG Pro HCM with a JDBC URL.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the UKG Pro HCM JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   
         java -jar cdata.jdbc.api.jar
       

   Fill in the connection properties and copy the connection string to the clipboard.

   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.

   
3. Set URL to the connection string, e.g.,

   jdbc:api:Profile=C:\profiles\UKGProHCM.apip;AuthScheme=Basic;User=your_username;Password=your_password;ProfileSettings='Host=yourcompany.ultipro.com;CustomerAPIKey=your_customer_api_key';

4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against UKG Pro HCM

To browse through the UKG Pro HCM entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example:

SELECT UserId, UserName FROM UserDetails WHERE UserStatus = 'A'

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live UKG Pro HCM data in DataGrip. Reach out to our Support Team if you have any questions.