Use the CData ODBC Driver for UKG Pro HCM in MicroStrategy Desktop

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When paired with the CData ODBC Driver for UKG Pro HCM, you gain database-like access to live UKG Pro HCM data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through adding UKG Pro HCM as a data source in MicroStrategy Desktop and creating a simple visualization of UKG Pro HCM data.

The CData ODBC Driver offers unmatched performance for interacting with live UKG Pro HCM data in MicroStrategy due to optimized data processing built into the driver. When you issue complex SQL queries from MicroStrategy to UKG Pro HCM, the driver pushes supported SQL operations, like filters and aggregations, directly to UKG Pro HCM and utilizes the embedded SQL Engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can visualize and analyze UKG Pro HCM data using native MicroStrategy data types.

Connect to UKG Pro HCM as an ODBC Data Source

Information for connecting to UKG Pro HCM follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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.

Windows

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.

Linux

If you are installing the CData ODBC Driver for UKG Pro HCM in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData API Sys]
Driver = CData ODBC Driver for UKG Pro HCM
Description = My Description
Profile = C:\profiles\UKGProHCM.apip
AuthScheme = Basic
User = your_username
Password = your_password
ProfileSettings = 'Host = yourcompany.ultipro.com
CustomerAPIKey = your_customer_api_key'

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Connect to and Visualize UKG Pro HCM Data using MicroStrategy Desktop

In addition to connecting UKG Pro HCM in MicroStrategy enterprise products, you can connect to UKG Pro HCM in MicroStrategy Desktop. Follow the steps below to add UKG Pro HCM data as a dataset and create visualizations and reports of UKG Pro HCM data.

1. Open MicroStrategy Desktop and create a new dossier.
2. In the datasets panel, click New Data, select Databases, and select Type a Query as the Import Option.
3. Add a new data source and choose DSN data sources.
4. Choose the DSN you previously configured (likely CData API Sys) and select Generic DBMS in the Version menu.
5. Set the User and Password properties for the DSN (or use placeholder values) and name the data source.

6. Select the new database instance to view the tables. You may need to manually click the search icon in the Available Tables section to see the tables.
7. Create a SQL query for the UKG Pro HCM data (see below) and click Execute SQL to test the query.

   
   SELECT * FROM UserDetails
   

   NOTE: Since we create a live connection, we can execute a SELECT * query and utilize the filtering and aggregation features native to the MicroStrategy products.
8. Click Finish and choose to connect live.
9. Choose a visualization, choose fields to display (data types are discovered automatically through dynamic metadata discovery) and apply any filters to create a new visualization of UKG Pro HCM data. Where possible, the complex queries generated by the filters and aggregations will be pushed down to UKG Pro HCM, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed client-side by the CData SQL Engine embedded in the driver.
10. Once you are finished configuring the dossier, click File -> Save.

Using the CData ODBC Driver for UKG Pro HCM in MicroStrategy Desktop, you can easily create robust visualizations and reports on UKG Pro HCM data. Read our other articles on connecting to UKG Pro HCM in MicroStrategy and connecting to UKG Pro HCM in MicroStrategy Web for more examples.