How to Query UKG Pro WFM Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for UKG Pro WFM to query UKG Pro WFM data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live UKG Pro WFM data in MySQL Workbench.

Connect to UKG Pro WFM Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to UKG Pro WFM data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query UKG Pro WFM from MySQL Workbench

The steps below outline connecting to the virtual UKG Pro WFM database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live UKG Pro WFM data.

Connect to UKG Pro WFM through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for UKG Pro WFM).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query UKG Pro WFM Data

1. Open the connection you just created (CData SQL Gateway for UKG Pro WFM).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve UKG Pro WFM data, like SELECT * FROM `CData API Sys`.Employees;

With access to live UKG Pro WFM data from MySQL Workbench, you can easily work with UKG Pro WFM, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.