Access Live UKG Pro WFM Data in SAS JMP via ODBC
You can use the CData API Driver for ODBC to integrate live data into your statistical analysis with SAS JMP. The driver proxies your queries directly to the UKG Pro WFM API, ensuring that your analysis reflects any changes to the data. The CData ODBC Driver supports the standard SQL used by JMP in the background as you design reports.
This article shows how to access UKG Pro WFM data into a report and create data visualization. It also shows how to use SQL to query UKG Pro WFM data from the JMP Query Builder.
Access UKG Pro WFM Data as an ODBC Data Source
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
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.
When you configure the DSN, 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.
Import UKG Pro WFM Data with the Query Builder
After you have created the UKG Pro WFM DSN, you can use SQL to invoke the capabilities of the UKG Pro WFM API. Follow the steps below to execute some supported queries in the Query Builder:
- In SAS JMP, click File -> Database -> Query Builder. The Select Database Connection dialog is displayed.
- Click New Connection.
- On the Machine Data Source tab, select the ODBC DSN you configured and then click Next.
- The Select Tables for Query dialog is displayed and in the Available Tables section, select a table and click Primary. After choosing the primary table, click Build Query to open the Query Builder.
- As you drag Available Columns to the Included Columns tab, the underlying SQL query is updated and you can view the generated SQL Query in the SQL tab.
- Click Run Query to display the data.
- To refresh the results with the current data, right-click Update from Database and click Run Script.
Visualize UKG Pro WFM Data
After importing, you can use the Graph Builder to create graphs visually. To open the Graph Builder, click the Graph Builder button in the toolbar.
- Drag a dimension column onto the x axis. For example, PersonNumber.
- Drag a measure column onto the y axis. For example, UserName.
- Select a chart type. For example, a bar chart.