Connect to UKG Pro HCM Data from HeidiSQL

HeidiSQL is an open-source database administration tool that natively supports MariaDB, MySQL, SQL Server, and PostgreSQL. When paired with CData Connect AI, HediSQL reach extends to include access to live UKG Pro HCM data. This article demonstrates how to connect to UKG Pro HCM using Connect AI and query UKG Pro HCM data in HeidiSQL.

CData Connect AI provides a pure SQL Server interface for UKG Pro HCM, allowing you to query data from UKG Pro HCM without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to UKG Pro HCM, leveraging server-side processing to return the requested UKG Pro HCM data quickly.

Configure UKG Pro HCM Connectivity for HeidiSQL

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

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.

With the connection configured and a PAT generated, you are ready to connect to UKG Pro HCM data from HeidiSQL.

Connect to UKG Pro HCM from HeidiSQL using Connect AI

To establish a connection from HeidiSQL to the CData Connect AI Virtual SQL Server API, follow these steps.

Create a new HeidiSQL Session

1. In the Session Manager, select New in the bottom-left
2. Give the new session a descriptive name, e.g. Connect-Cloud-UKG Pro HCM

Configure a SQL Server Connection to Connect AI

1. In the session settings, set the Network type to Microsoft SQL Server (TCP/IP)
2. The Library DLL should automatically update to MSOLEDBSQL
3. Set the Hostname/IP to tds.cdata.com
4. Set the User to your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected]
5. Set the Password to your PAT created in Connect AI in the previous section.
6. Set the Port to 14333

Query UKG Pro HCM from HeidiSQL

1. In the database listing on the left, find your connection to UKG Pro HCM configured earlier.
2. Expand this connection to view individual tables or data objects present within UKG Pro HCM.
3. Write custom SQL queries targeting these tables, treating the data source like any SQL Server database, or visually explore each tabular data set by selecting the relevant tables

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your SQL Server database, try CData Connect AI today!