Connect to UKG Pro HCM Data in DBArtisan
The CData ODBC Driver for UKG Pro HCM seamlessly integrates UKG Pro HCM data into database management tools like DBArtisan by enabling you to access UKG Pro HCM data as a database. This article shows how to create an data source for UKG Pro HCM in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.
Integrate UKG Pro HCM Data into DBArtisan Projects
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.
You can then follow the steps below to register UKG Pro HCM data as a database instance in your project:
- In DBArtisan, click Data Source -> Register Datasource.
- Select Generic ODBC.
- Enter a name for the data source and select the DSN.
- Finish the wizard to connect to UKG Pro HCM data. UKG Pro HCM entities are displayed in the Datasource Explorer.
You can now work with UKG Pro HCM data as you work with any other database. See the driver help documentation for more information on the queries supported by the UKG Pro HCM API.
