How to integrate Metabase with UKG Pro HCM Data

Metabase is an open source data visualization tool that allows users to create interactive dashboards. When paired with CData Connect AI, users can easily create visualizations and dashboards linked to live UKG Pro HCM data. This article describes how to connect to UKG Pro HCM and build a simple visualization using UKG Pro HCM data.

CData Connect provides a pure cloud-to-cloud interface for UKG Pro HCM, allowing you to easily integrate with live UKG Pro HCM data in Metabase — without replicating the data. Connect looks exactly like a SQL Server database to Metabase and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc) directly to UKG Pro HCM, leveraging server-side processing to quickly return UKG Pro HCM data.

Configure UKG Pro HCM Connectivity for Metabase

Connectivity to UKG Pro HCM from Metabase is made possible through CData Connect AI. To work with UKG Pro HCM data from Metabase, we start by creating and configuring a UKG Pro HCM connection.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "UKG Pro HCM" from the Add Connection panel

3. Enter the necessary authentication properties to connect to UKG Pro HCM.

   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.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add UKG Pro HCM Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to UKG Pro HCM data from Metabase.

Connect to CData Connect AI from Metabase

After creating the connection in Connect AI, navigate to your Metabase instance. Use the SQL Server interface to connect to Connect AI.

1. Navigate to the administration screen (Settings -> Admin) and click "Add Database" from the "Databases" tab
2. Configure the connection to Connect AI and click "Save"
   • Database type: Select "SQL Server"
   • Name: Name the connection (e.g. "UKG Pro HCM (Connect AI)")
   • Host: tds.cdata.com
   • Port: 14333
   • Database name: The name of the connection you just created (e.g. API1)
   • Username: A Connect AI username (e.g. [email protected])
   • Password: The PAT previously created
   • Click to Use a secure connection (SSL)
   

Execute UKG Pro HCM Data with Metabase

Once you configure the connection to Connect AI, you can query UKG Pro HCM and build visualizations.

1. Use the "Write SQL" tool to retrieve the UKG Pro HCM data
2. Write a SQL query based on the UKG Pro HCM connection in CData Connect AI, e.g.
   
   

   SELECT UserId, UserName FROM UserDetails WHERE UserStatus = 'A'

   
3. Navigate to the "Visualization" screen, choose a visualization, and configure the visualization

More Information & Free Trial

At this point, you have built a simple visualization from UKG Pro HCM data in Metabase. You can continue to work with live UKG Pro HCM data in Metabase just like you would any SQL Server database. For more information on creating a live connection to UKG Pro HCM (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live UKG Pro HCM data in Metabase today.