How to Visualize UKG Pro HCM Data in Python with pandas via CData Connect AI

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Connect AI Python SDK, the pandas and Matplotlib modules, you can build UKG Pro HCM-connected Python applications and scripts for visualizing UKG Pro HCM data. This article shows how to connect to Connect AI and use the pandas and Matplotlib built-in functions to query UKG Pro HCM data and visualize the results.

The Connect AI Python SDK (cdata-connect-ai) is a DB-API 2.0 (PEP 249) compliant client, so pandas can read query results directly from the SDK connection object. There is no driver to install per source and no SQLAlchemy engine to configure: connect with a Personal Access Token and pass the connection straight to pandas.read_sql.

Connect to UKG Pro HCM in Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

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 and update the user-based permissions.

Generate a Personal Access Token (PAT)

The Python SDK authenticates to Connect AI with your account email and a Personal Access Token (PAT). It is best practice to create a separate PAT for each application to maintain granularity of access.

1. Click 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 PAT is only visible at creation, so copy it and store it securely.

Install Required Modules

Install the SDK (with the pandas extra) and Matplotlib using the pip utility:

pip install "cdata-connect-ai[full]"
pip install matplotlib

Visualize UKG Pro HCM Data in Python

Import the modules, then connect to Connect AI with your account email and PAT. Identifiers are three-part: <Connection>.<Schema>.<Table>, where the connection name defaults to the source name (for example, API1).

import pandas
import matplotlib.pyplot as plt
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

Query UKG Pro HCM with pandas

Use the read_sql function from pandas to execute a SQL statement and store the result set in a DataFrame. Pass the SDK connection directly, no engine required.

df = pandas.read_sql(
    "SELECT UserId, UserName "
    "FROM [API1].[API].[UserDetails] "
    "WHERE UserStatus = 'A'",
    conn,
)

Note: pandas may print a UserWarning stating that it only officially supports SQLAlchemy connectables. This is expected when passing a DB-API connection directly—the query runs correctly and the warning is safe to ignore.

Visualize UKG Pro HCM Data

With the query results stored in a DataFrame, use the plot function to build a chart. The show method displays the chart in a new window.

df.plot(kind="bar", x="UserId", y="UserName")
plt.show()

conn.close()

More Information and Free Trial

Now you can read live UKG Pro HCM data into pandas through the CData Connect AI Python SDK. For more information on connecting to UKG Pro HCM (and hundreds of other data sources), visit the Connect AI page. Sign up for a free trial and start working with live UKG Pro HCM data in Python.

Full Source Code

import pandas
import matplotlib.pyplot as plt
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

df = pandas.read_sql(
    "SELECT UserId, UserName "
    "FROM [API1].[API].[UserDetails] "
    "WHERE UserStatus = 'A'",
    conn,
)

df.plot(kind="bar", x="UserId", y="UserName")
plt.show()

conn.close()