Connect to UKG Pro WFM Data in DBArtisan
The CData ODBC Driver for UKG Pro WFM seamlessly integrates UKG Pro WFM data into database management tools like DBArtisan by enabling you to access UKG Pro WFM data as a database. This article shows how to create an data source for UKG Pro WFM in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.
Integrate UKG Pro WFM Data into DBArtisan Projects
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.
You can then follow the steps below to register UKG Pro WFM data as a database instance in your project:
- In DBArtisan, click Data Source -> Register Datasource.
- Select Generic ODBC.
- Enter a name for the data source and select the DSN.
- Finish the wizard to connect to UKG Pro WFM data. UKG Pro WFM entities are displayed in the Datasource Explorer.
You can now work with UKG Pro WFM data as you work with any other database. See the driver help documentation for more information on the queries supported by the UKG Pro WFM API.
