Connect to UKG Pro WFM Data in DBeaver
NOTE: The Legacy ODBC driver was removed in DBeaver Community Edition 23.1. As an alternative, you can use a CData JDBC Driver (learn how here: How to Connect DBeaver to UKG Pro WFM via JDBC). If you need to use ODBC Drivers, refer to the DBeaver Documentation.
The CData API Driver for ODBC enables access to live data from UKG Pro WFM under the ODBC standard, allowing you work with UKG Pro WFM data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage UKG Pro WFM data with visual tools in DBeaver like the query browser.
The CData ODBC drivers offer unmatched performance for interacting with live UKG Pro WFM data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver to 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 (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can manage and analyze UKG Pro WFM data.
Connect to UKG Pro WFM
If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the Microsoft ODBC Data Source Administrator. 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.
Finally, set the "Map To WVarchar connection property to False in the DSN Configuration window for the driver. This configuration will allow string types to be mapped to SQL_VARCHAR and prevent SQL_WVARCHAR types from being displayed as NULL.
Connecting to the UKG Pro WFM ODBC Data Source in DBeaver
- Open the DBeaver application and in the Database menu, select the New Database Connection option.
- In the 'Connect to a database' window, select ODBC and click Next.
- In the Database/Schema field, enter the DSN name (CData UKG Pro WFM Source by default). It will be automatically added to the JDBC URL as well.
- Click the Test Connection button. You should receive a 'Connected' message after DBeaver has detected the DSN, along with details about the driver if the connection is successful.
Query UKG Pro WFM Data
You can now query information from the tables exposed by the data source connection. You can expand the database structure in order to view all the tables. You can retrieve the table's data by right-clicking on a table name and selecting View data. The data will then be available in the Data tab.
Free Trial & More Information
At this point, you have connected to live UKG Pro WFM data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live UKG Pro WFM data DBeaver today.