Replicate UKG Pro WFM Data from PowerShell

The CData ODBC Driver for UKG Pro WFM enables out-of-the-box integration with Microsoft's built-in support for ODBC. The ODBC driver instantly integrates connectivity to the real UKG Pro WFM data with PowerShell.

You can use the .NET Framework Provider for ODBC built into PowerShell to quickly automate integration tasks like replicating UKG Pro WFM data to other databases. This article shows how to replicate UKG Pro WFM data to SQL Server in 5 lines of code.

You can also write PowerShell code to download UKG Pro WFM data. See the examples below.

Create an ODBC Data Source for 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.

Connect to UKG Pro WFM

The code below shows how to use the DSN to initialize the connection to UKG Pro WFM data in PowerShell:

$conn = New-Object System.Data.Odbc.OdbcConnection
$conn.ConnectionString = "DSN=CData API Source x64"

Back Up UKG Pro WFM Data to SQL Server

After you enable caching, you can use the code below to replicate data to SQL Server.

Set the following connection properties to configure the caching database:

• CacheProvider: The name of the ADO.NET provider. This can be found in the Machine.config for your version of .NET. For example, to configure SQL Server, enter System.Data.SqlClient.

• CacheConnection: The connection string of properties required to connect to the database. Below is an example for SQL Server:

  Server=localhost;Database=RSB;User Id=sqltest;Password=sqltest;

The SQL query in the example can be used to refresh the entire cached table, including its schema. Any already existing cache is deleted.

$conn.Open()
# Create and execute the SQL Query
$SQL = "CACHE DROP EXISTING SELECT * FROM " + $Employees
$cmd = New-Object System.Data.Odbc.OdbcCommand($sql,$conn)
$count = $cmd.ExecuteNonQuery()
$conn.Close()

The driver gives you complete control over the caching functionality. See the help documentation for more caching commands and usage examples. See the help documentation for steps to replicate to other databases.

Other Operations

To retrieve UKG Pro WFM data in PowerShell, call the Fill method of the OdbcDataAdapter method. To execute data manipulation commands, initialize the OdbcCommand object and then call ExecuteNonQuery. Below are some more examples commands to UKG Pro WFM through the .NET Framework Provider for ODBC:

Retrieve UKG Pro WFM Data

$sql="SELECT PersonNumber, UserName from Employees"
 
$da= New-Object System.Data.Odbc.OdbcDataAdapter($sql, $conn)
$dt= New-Object System.Data.DataTable
$da.Fill($dt) 
 
$dt.Rows | foreach {
  $dt.Columns | foreach ($col in dt{
    Write-Host $1[$_]
  }
}