How to Query UKG Pro HCM Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for UKG Pro HCM to query UKG Pro HCM data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live UKG Pro HCM data in MySQL Workbench.

Connect to UKG Pro HCM Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to UKG Pro HCM data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query UKG Pro HCM from MySQL Workbench

The steps below outline connecting to the virtual UKG Pro HCM database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live UKG Pro HCM data.

Connect to UKG Pro HCM through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for UKG Pro HCM).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query UKG Pro HCM Data

1. Open the connection you just created (CData SQL Gateway for UKG Pro HCM).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve UKG Pro HCM data, like SELECT * FROM `CData API Sys`.UserDetails;

With access to live UKG Pro HCM data from MySQL Workbench, you can easily work with UKG Pro HCM, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.