Viewing UKG Pro WFM Data in RAD Studio Data Explorer

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for UKG Pro WFM, you gain access to live UKG Pro WFM data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to both retrieve UKG Pro WFM data. This article will walk through connecting to UKG Pro WFM using the Data Explorer.

Configure a Connection to UKG Pro WFM

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.

Connecting to UKG Pro WFM Data Using Data Explorer

You can create a simple application for displaying UKG Pro WFM data by utilizing the CData FireDAC Components for UKG Pro WFM and a new VCL Forms Application:

1. Open the Data Explorer in RAD Studio and expand FireDAC.
2. Right-click the ODBC Data Source node in the Data Explorer.
3. Click Add New Connection.
4. Enter a name for the connection.
5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for UKG Pro WFM.
6. Back in the Data Explorer, expand the views for the connection.

7. Create a new VCL Forms application and drag a view (for example: Employees) onto the form.

   
8. Select the EmployeesView object on the form and set the Active property to true.

9. Right-click on the object, bind visually, and link everything (*) to a new control (TStringGrid).

   

10. Arrange the TStringGrid on the form and run the application to see the Employees data.

    

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

• DataBind Controls to UKG Pro WFM Data in C++Builder
• DataBind Controls to UKG Pro WFM Data in Delphi
• Build a Simple VCL Application for UKG Pro WFM Data