Build UKG Pro HCM-Connected Visualizations in datapine

datapine is a browser-based business intelligence platform. When paired with the CData Connect AI, you get access to your UKG Pro HCM data directly from your datapine visualizations and dashboards. This article describes connecting to UKG Pro HCM in CData Connect AI and building a simple UKG Pro HCM-connected visualization in datapine.

CData Connect AI provides a pure SQL Server interface for UKG Pro HCM, allowing you to query data from UKG Pro HCM without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to UKG Pro HCM, leveraging server-side processing to return the requested UKG Pro HCM data quickly.

Configure UKG Pro HCM Connectivity for datapine

Connectivity to UKG Pro HCM from datapine is made possible through CData Connect AI. To work with UKG Pro HCM data from datapine, 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 datapine.

Connecting to UKG Pro HCM from datapine

Once you configure your connection to UKG Pro HCM in Connect AI, you are ready to connect to UKG Pro HCM from datapine.

1. Log into datapine
2. Click Connect to navigate to the "Connect" page
3. Select MS SQL Server as the data source
4. In the Integration step, fill in the connection properties and click "Save and Proceed"
   • Set the Internal Name
   • Set Database Name to the name of the connection we just configured (e.g. API1)
   • Set Host / IP to "tds.cdata.com"
   • Set Username to your Connect AI username (e.g. [email protected])
   • Set Password to the corresponding PAT
   • Set Database Port to "14333"
   
5. In the Data Schema step, select the tables and fields to visualize and click "Save and Proceed"
6. In the References step, define any relationships between your selected tables and click "Save and Proceed"
7. In the Data Transfer step, click "Go to Analyzer"

Visualize UKG Pro HCM Data in datapine

After connecting to CData Connect AI, you are ready to visualize your UKG Pro HCM data in datapine. Simply select the dimensions and measures you wish to visualize!

Having connect to UKG Pro HCM from datapine, you are now able to visualize and analyze real-time UKG Pro HCM data no matter where you are. To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from datapine, try CData Connect AI today!