How to Create Power BI Visual Reports with Real-Time UKG Pro HCM Data

CData Power BI Connectors provide self-service integration with Microsoft Power BI. The CData API Driver for Power BI links your Power BI reports to real-time UKG Pro HCM data. You can monitor UKG Pro HCM data through dashboards and ensure that your analysis reflects UKG Pro HCM data in real time by scheduling refreshes or refreshing on demand. This article details how to use the Power BI Connector to create real-time visualizations of UKG Pro HCM data in Microsoft Power BI Desktop.

If you are interested in publishing reports on UKG Pro HCM data to PowerBI.com, refer to our other Knowledge Base article.

Collaborative Query Processing

The CData Power BI Connectors offer unmatched performance for interacting with live UKG Pro HCM data in Power BI due to optimized data processing built into the connector. When you issue complex SQL queries from Power BI to UKG Pro HCM, the connector pushes supported SQL operations, like filters and aggregations, directly to UKG Pro HCM and utilizes the embedded SQL Engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can visualize and analyze UKG Pro HCM data using native Power BI data types.

Connect to UKG Pro HCM as a Power BI Data Source

Installing the Power BI Connector creates a DSN (data source name) called CData Power BI UKG Pro HCM. This the name of the DSN that Power BI uses to request a connection to the data source. Configure the DSN by filling in the required connection properties.

You can use the Microsoft ODBC Data Source Administrator to create and configure the DSN: From the Start menu, enter "ODBC Data Sources" and select the CData PowerBI REST DSN. Ensure that you run the version of the ODBC Administrator that corresponds to the bitness of your Power BI Desktop installation (32-bit or 64-bit). You can also use run the ConfigureODBC.exe tool located in the installation folder for the connector.

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.

How to Query UKG Pro HCM Tables

Follow the steps below to build a query to pull UKG Pro HCM data into the report:

1. Open Power BI Desktop and click Get Data -> Other -> CData API.
2. Select CData PowerBI UKG Pro HCM in the Data Source Name menu and select a data connectivity mode:
   Select Import if you want to import a copy of the data into your project. You can refresh this data on demand.
   Select DirectQuery if you want to work with the remote data.
3. Select tables in the Navigator dialog.

4. In the Query Editor, you can customize your dataset by filtering, sorting, and summarizing UKG Pro HCM columns. Click Edit to open the query editor. Right-click a row to filter the rows. Right-click a column header to perform actions like the following:

   • Change column data types
   • Remove a column
   • Group by columns

   Power BI detects each column's data type from the UKG Pro HCM metadata retrieved by the connector.

   Power BI records your modifications to the query in the Applied Steps section, adjusting the underlying data retrieval query that is executed to the remote UKG Pro HCM data. When you click Close and Apply, Power BI executes the data retrieval query.

   Otherwise, click Load to pull the data into Power BI.

How to Create Data Visualizations in Power BI

After pulling the data into Power BI, you can create data visualizations in the Report view by dragging fields from the Fields pane onto the canvas. Follow the steps below to create a pie chart:

1. Select the pie chart icon in the Visualizations pane.
2. Select a dimension in the Fields pane: for example, UserId.
3. Select a measure in the Fields pane: for example, UserName.

You can change sort options by clicking the ellipsis (...) button for the chart. Options to select the sort column and change the sort order are displayed.

You can use both highlighting and filtering to focus on data. Filtering removes unfocused data from visualizations; highlighting dims unfocused data. You can highlight fields by clicking them:

You can apply filters at the page level, at the report level, or to a single visualization by dragging fields onto the Filters pane. To filter on the field's value, select one of the values that are displayed in the Filters pane.

Click Refresh to synchronize your report with any changes to the data.

At this point, you will have a Power BI report built on top of live UKG Pro HCM data. Learn more about the CData Power BI Connectors for UKG Pro HCM and download a free trial from the CData API Driver for Power BI page. Let our Support Team know if you have any questions.