Visualize UKG Pro HCM Data in Sisense

Sisense lets you join, analyze, and picture data to make more intelligent business decisions and craft effective strategies. The CData API Driver for JDBC makes it easy to integrate with UKG Pro HCM data in Sisense. This article shows how to create an ElastiCube that connects to UKG Pro HCM data and use the ElastiCube to visualize UKG Pro HCM data in Sisense.

Configure the Connection to UKG Pro HCM

Before creating the ElastiCube, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData API Driver for JDBC 20XX\lib) or copy the jar file (cdata.jdbc.api.API.jar) to a new folder in the Sisense JDBC driver directory (typically C:\ProgramData\Sisense\DataConnectors\jdbcdrivers).

1. In the Data page of the Sisense application, create a new ElastiCube (or open an existing one).
2. In the Model Editor, click "+ Data" to open the Add Data dialog box.
3. Click Generic JDBC to open the JDBC settings.
4. Set the connection string property to the JDBC URL for UKG Pro HCM, adding required properties.

   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.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the UKG Pro HCM JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   
   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   

   When you configure the JDBC URL, 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.

   A typical example follows:

   
   jdbc:api:Profile=C:\profiles\UKGProHCM.apip;AuthScheme=Basic;User=your_username;Password=your_password;ProfileSettings='Host=yourcompany.ultipro.com;CustomerAPIKey=your_customer_api_key';
   

5. Set the JDBC JARs folder property to the location of the CData JDBC Driver JAR file (see above).
6. Set the driver's class name to the class name for the JDBC Driver: cdata.jdbc.api.APIDriver
7. Leave the username and password properties blank.
8. Click Next.

Add UKG Pro HCM Data to an ElastiCube

Once you are connected to UKG Pro HCM, you can add views to your ElastiCubes.

1. From the Tables list, select the tables and/or views you wish to work with.
2. (Optional) Click "+" to customize the data you want to import with SQL.
3. Click Done.
4. Click Build to build the ElastiCube for analytics.

Visualize UKG Pro HCM Data

With UKG Pro HCM tables added to your ElastiCube, you can perform analytics on your UKG Pro HCM data.

1. Navigate to the Analytics page of the Sisense application
2. Select a Dashboard (or create a new one)
3. Select your Data Source and click Create
4. Click "+ Select Data" and choose fields to add to your visualization.

With the CData API Driver for JDBC, you can access UKG Pro HCM data right in Sisense for powerful visualization and analytics. Download a free, 30-day trial and start working with UKG Pro HCM data in Sisense today!