Create SSAS Tabular Models from UKG Pro HCM Data

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
How to build a SQL Server Analysis Service Tabular Model from UKG Pro HCM data using CData drivers.

SQL Server Analysis Services (SSAS) is an analytical data engine used in decision support and business analytics. It provides enterprise-grade semantic data models for business reports and client applications, such as Power BI, Excel, Reporting Services reports, and other data visualization tools. When paired with the CData API Driver for ODBC, you can create a tabular model from UKG Pro HCM data for deeper and faster data analysis.

Create a Connection to UKG Pro HCM Data

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.

Creating a Data Source for UKG Pro HCM

Start by creating a new Analysis Services Tabular Project in Visual Studio. Ensure that you select a Compatibility Level of 1400 or higher in the Tabular model designer dialog. Next create a Data Source for UKG Pro HCM in the project.

  1. In the Tabular Model Explorer, right-click Data Sources and select "New Data Source"
  2. Select "ODBC" from the Other tab and click "Connect" Selecting ODBC as the connector
  3. Select the DSN you previously configured Selecting the DSN (Salesforce is shown)
  4. Choose "Default or Custom" as the authentication option and click "Connect" Connecting to the DSN (Salesforce is shown)

Add Tables & Relationships

After creating the data source you are ready to import tables and define the relationships between the tables.

  1. Right-click the new data source, click "Import New Tables" and select the tables to import Importing the tables (Salesforce is shown)
  2. After importing the tables, right-click "Relationships" and click "Create Relationships"
  3. Select table(s), and choose the foreign keys, cardinality, and filter direction Configuring relationships between tables (Salesforce is shown)

Create Measures

After importing the tables and defining the relationships, you are ready to create measures.

  1. Select the column in the table for which you wish to create a measure
  2. In the Extensions menu -> click "Columns" -> "AutoSum" and select your aggregation method Creating measures (Salesforce is shown)

Deploy the Model

Once you create measures, you are ready to deploy the model. Configure the target server and database by right-clicking the project found in the Solution Explorer and selecting "Properties." Configure the "Deployment Server" properties and click "OK."

Configuring the deployment database

After configuring the deployment server, open the "Build" menu and click "Deploy Solution." You now have a tabular model for UKG Pro HCM data in your SSAS instance, ready to be analyzed, reported, and viewed. Get started with a free, 30-day trial of the CData API Driver for ODBC.

Ready to get started?

Connect to live data from UKG Pro HCM with the API Driver

Connect to UKG Pro HCM