UKG Pro HCM Reporting and Star Schemas in OBIEE

The CData ODBC Driver for UKG Pro HCM is a standard database driver that can integrate real-time access to UKG Pro HCM data into your data warehouse or directly into your reporting tool. This article shows how to bypass the data warehouse and import operational UKG Pro HCM data into Oracle Business Intelligence Enterprise Edition (OBIEE).

See the knowledge base for ODBC integrations with ETL tools like Informatica PowerCenter. For an ETL solution into Oracle Warehouse Builder, use the driver with the Oracle ODBC Gateway to Access UKG Pro HCM Data as a Remote Oracle Database.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Import UKG Pro HCM Metadata

Follow the steps below to use the OBIEE Client Tools to import UKG Pro HCM metadata into an OBIEE repository. You can then integrate UKG Pro HCM data into your business models.

1. Open the Administration Tool and click File -> New Repository.

2. In the Connection Type menu, select ODBC 3.5 and select the CData DSN.
3. Select the metadata types you want to import under the Relational Sources option and then select UKG Pro HCM tables.