Rapidly Develop UKG Pro HCM-Driven Apps with Active Query Builder

Write standard .NET to expose UKG Pro HCM data through an SQL interface: Active Query Builder helps developers write SQL interfaces; the CData ODBC Driver for UKG Pro HCM enables standards-based access to UKG Pro HCM. This integration uses the Microsoft ADO.NET Provider for ODBC as a bridge between the ODBC Driver and the Active Query Builder objects to build a visual SQL composer.

Connect to UKG Pro HCM as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Use SQL to Interact with UKG Pro HCM

Follow the steps below to create a WinForms visual query builder.

1. Open Active Query Builder for .NET WinForms.
2. In the new Windows Forms project go to the "File" menu and click "Connect..."
3. Under Database Connections, click "Add..."
4. Set your desired Connection Name (e.g. CData UKG Pro HCM), set Connection Type to "ODBC" and locate your previously configured DSN in the "User/System" DSN dropdown.
5. Click "OK" to save the new connection.
6. Back in the Database Connection wizard, select the newly created connection and click "OK."
7. Click "File" > "New Query" to create a QueryBuilder

You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.