Analyze UKG Pro HCM Data in Cognos Analytics
Cognos Analytics, powered by IBM Watson®, empowers users to cleanse and establish connections with their data while creating visualizations. When integrated with CData Connect AI, users gain immediate, real-time connectivity between cloud-based data sources and Cognos Analytics, facilitating data management, visualization, analytics, and more. This article provides step-by-step guidance on connecting to UKG Pro HCM via CData Connect AI and subsequently analyzing UKG Pro HCM data within Cognos Analytics.
NOTE: These instructions require Cognos Analytics 11.2.4 or higher
CData Connect AI offers a dedicated cloud-to-cloud interface for UKG Pro HCM, enabling users to perform real-time analysis on UKG Pro HCM data within Cognos without the need to replicate data to a natively supported database. Equipped with built-in optimized data processing capabilities, CData Connect AI efficiently directs all supported SQL operations, including filters and JOINs, directly to UKG Pro HCM. This harnesses server-side processing to promptly provide the requested UKG Pro HCM data.
Configure UKG Pro HCM Connectivity for Cognos Analytics
Connectivity to UKG Pro HCM from Cognos Analytics is made possible through CData Connect AI. To work with UKG Pro HCM data from Cognos Analytics, we start by creating and configuring a UKG Pro HCM connection.
- Log into Connect AI, click Sources, and then click Add Connection
- Select "UKG Pro HCM" from the Add Connection panel
-
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.
- Click Save & Test
-
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.
- Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
- On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
- 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 Cognos Analytics.
Connect to UKG Pro HCM from Cognos Analytics
The steps below outline connecting to CData Connect AI from Cognos Analytics to analyze live UKG Pro HCM data.
Download and install the CData Connect AI JDBC driver
- Open the Integrations page of CData Connect AI.
- Search for and select JDBC.
- Download and run the setup file.
- When the installation is complete, copy the JAR file (cdata.jdbc.connect.jar) from the installation directory (e.g., C:\Program Files\CData\JDBC Driver for CData Connect\lib) to the "drivers" folder in your Cognos Analytics installation directory.
Configure the Connection to CData Connect AI
- Open IBM Cognos and navigate to Manage > Data server connections.
- Click the icon to add a data server.
- Select CData Connect AI.
- Set JDBC URL to the appropriate connection string. For example:
jdbc:connect:AuthScheme=Basic;user=username;password=PAT; - Set Driver class name to "cdata.jdbc.connect.ConnectDriver"
- Create and store authenticate credentials by selecting an authentication method
- Set Username to your CData Connect AI username (e.g., [email protected])
- Set Password to the PAT you previously generated.
- Click Test connection to confirm that the connection succeeds.
At this point, you are ready to analyze and visualize UKG Pro HCM data in Cognos Analytics. For more information about using Cognos Analytics, please refer to the Cognos Analytics documentation.
Live Access to UKG Pro HCM Data for Analytics
Now you have a direct, cloud-to-cloud connection to live UKG Pro HCM data from Cognos Analytics. You can create new visualizations, build reports, and more — without replicating UKG Pro HCM data.
Try CData Connect AI and get real-time data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications.