Use the CData ODBC Driver for UKG Pro WFM in Microsoft Power Query

The CData ODBC Driver for UKG Pro WFM enables you to link to UKG Pro WFM data in Microsoft Power Query, ensuring that you see any updates. This article details how to use the ODBC driver to import UKG Pro WFM data into Microsoft Power Query.

Connect to UKG Pro WFM 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.

Import UKG Pro WFM Data

Follow the steps below to import UKG Pro WFM data using standard SQL:

1. From the ribbon in Excel, click Power Query -> From Other Data Sources -> From ODBC.

2. Enter the ODBC connection string. Below is a connection string using the default DSN created when you install the driver:

   Provider=MSDASQL.1;Persist Security Info=False;DSN=CData API Source

3. Enter the SELECT statement to import data with. For example:

   
       SELECT PersonNumber, UserName FROM Employees WHERE PersonId = '12345'
       

   

4. Enter credentials, if required, and click Connect. The results of the query are displayed in the Query Editor Preview. You can combine queries from other data sources or refine the data with Power Query formulas. To load the query to the worksheet, click the Close and Load button.