How to Visualize UKG Pro WFM Data in Python with pandas

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData API Driver for Python, the pandas & Matplotlib modules, and the SQLAlchemy toolkit, you can build UKG Pro WFM-connected Python applications and scripts for visualizing UKG Pro WFM data. This article shows how to use the pandas, SQLAlchemy, and Matplotlib built-in functions to connect to UKG Pro WFM data, execute queries, and visualize the results.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live UKG Pro WFM data in Python. When you issue complex SQL queries from UKG Pro WFM, the driver pushes supported SQL operations, like filters and aggregations, directly to UKG Pro WFM and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to UKG Pro WFM Data

Connecting to UKG Pro WFM data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

Start by setting the Profile connection property to the location of the UKGProWFM Profile on disk (e.g. C:\profiles\UKGProWFM.apip). Next, set the ProfileSettings connection property to the connection string for UKGProWFM (see below).

UKGProWFM API Profile Settings

UKG Pro Workforce Management uses OAuth 2.0 with the Resource Owner Password Credentials grant (grant_type=password) to authorize access to the API. Unlike most OAuth-based profiles, this does not use a browser redirect/authorization-code step: the driver exchanges your UKG Pro WFM username, password, client ID, and client secret directly for an access token.

Set the following connection properties to authenticate:

• AuthScheme: Set this to OAuthPassword.
• Host: Set this to the hostname of your UKG Pro Workforce Management datacenter/tenant (for example, yourcompany.mykronos.com). Do not include the protocol (https://) or a trailing slash.
• OAuthClientId: Set this to the client ID issued for your UKG Pro Workforce Management OAuth application.
• OAuthClientSecret: Set this to the client secret issued for your UKG Pro Workforce Management OAuth application.
• User: Set this to your UKG Pro Workforce Management username.
• Password: Set this to your UKG Pro Workforce Management password.

Access tokens are obtained from https://{Host}/api/authentication/access_token. Refresh tokens issued by UKG Pro Workforce Management expire after 7 days; if a refresh attempt fails because the refresh token itself has expired, the driver must re-authenticate with your User/Password credentials to obtain a new access token.

Follow the procedure below to install the required modules and start accessing UKG Pro WFM through Python objects.

Install Required Modules

Use the pip utility to install the pandas & Matplotlib modules and the SQLAlchemy toolkit:

pip install pandas
pip install matplotlib
pip install sqlalchemy

Be sure to import the module with the following:

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engine

Visualize UKG Pro WFM Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with UKG Pro WFM data.

engine = create_engine("api:///?Profile=C:\profiles\UKGProWFM.apip&AuthScheme=OAuthPassword&ProfileSettings='Host=yourcompany.mykronos.com&User=your_username&Password=your_password&'&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret")

Execute SQL to UKG Pro WFM

Use the read_sql function from pandas to execute any SQL statement and store the resultset in a DataFrame.

df = pandas.read_sql("SELECT PersonNumber, UserName FROM Employees WHERE PersonId = '12345'", engine)

Visualize UKG Pro WFM Data

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

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

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to UKG Pro WFM data. Reach out to our Support Team if you have any questions.

Full Source Code

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engin

engine = create_engine("api:///?Profile=C:\profiles\UKGProWFM.apip&AuthScheme=OAuthPassword&ProfileSettings='Host=yourcompany.mykronos.com&User=your_username&Password=your_password&'&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret")
df = pandas.read_sql("SELECT PersonNumber, UserName FROM Employees WHERE PersonId = '12345'", engine)

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