Connect to UKG Pro WFM Data from PowerBuilder via ADO.NET

This article demonstrates using the CData API Driver for ADO.NET in PowerBuilder, showcasing the ease of use and compatibility of these standards-based controls across various platforms and development technologies that support Microsoft .NET, including Appeon PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData API Driver for ADO.NET to retrieve data.

1. In a new WPF Window Application solution, add all the Visual Controls needed for the connection properties. Below is a typical connection string:

   Profile=C:\profiles\UKGProWFM.apip;AuthScheme=OAuthPassword;ProfileSettings='Host=yourcompany.mykronos.com;User=your_username;Password=your_password;';OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;

   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.

2. Add the DataGrid control from the .NET controls.
3. Configure the columns of the DataGrid control. Below are several columns from the Account table:

   
   
   <DataGrid AutoGenerateColumns="False" Margin="13,249,12,14" Name="datagrid1" TabIndex="70" ItemsSource="{Binding}">
   <DataGrid.Columns>
       <DataGridTextColumn x:Name="idColumn" Binding="{Binding Path=Id}" Header="Id" Width="SizeToHeader" />
       <DataGridTextColumn x:Name="nameColumn" Binding="{Binding Path=PersonNumber}" Header="PersonNumber" Width="SizeToHeader" />
   		...
   	</DataGrid.Columns>
   </DataGrid>
   

4. Add a reference to the CData API Driver for ADO.NET assembly.

Connect the DataGrid

Once the visual elements have been configured, you can use standard ADO.NET objects like Connection, Command, and DataAdapter to populate a DataTable with the results of an SQL query:

System.Data.CData.API.APIConnection conn 
conn = create System.Data.CData.API.APIConnection(connectionString)

System.Data.CData.API.APICommand comm 
comm = create System.Data.CData.API.APICommand(command, conn)

System.Data.DataTable table
table = create System.Data.DataTable

System.Data.CData.API.APIDataAdapter dataAdapter
dataAdapter = create System.Data.CData.API.APIDataAdapter(comm)
dataAdapter.Fill(table)	
datagrid1.ItemsSource=table.DefaultView

The code above can be used to bind data from the specified query to the DataGrid.