Blazor でUKG Pro WFM のデータにリアルタイムで連携するアプリを構築

Blazor は、.NET を使って対話型のクライアント側Web UI を構築するためのフレームワークです。JavaScript の代わりにC# を使って、UI を作れるところが魅力です。また、既存の.NET ライブラリや.NET エコシステムを使うことができる利点があります。

CData ADO.NET Provider for API は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってUKG Pro WFM を操作可能にします。Blazor が.NET Core 対応をしているため、Server Side Blazor からADO.NET Provider を使うことができます。この記事では、Server Side Blazor からUKG Pro WFM に接続して直接SQL クエリを実行する方法を説明します。

CData ADO.NET Provider for API のインストール

CData ADO.NET Provider は、通常であればRDB に接続するフレームワークである ADO.NET DataAdapter やLinqToSQL（もしくはDapper などのORM を挟んでもいいです）であり、UKG Pro WFM のデータへもRDB と同感覚でアクセスが可能になります。

CData のWebsite からProvider をダウンロードして、マシンにインストールします。NuGet からインストールすることも可能です。UKG Pro WFM ADO.NET Data Provider で検索してください。

SELECT UKG Pro WFM のデータ from the Blazor App

1. Open the Index.razor file from the Project page.
2. In a APIConnection object, set the connection string:

   まず、Profile 接続プロパティをディスク上の UKGProWFM プロファイルの場所に設定します（例：C:\profiles\UKGProWFM.apip）。次に、ProfileSettings 接続プロパティを UKGProWFM の接続文字列に設定します（以下を参照）。

   UKGProWFM API プロファイル設定

   UKG Pro Workforce Management では、OAuth 2.0 の Resource Owner Password Credentials グラント（grant_type=password）を使用して API へのアクセスを認可します。一般的な OAuth ベースのプロファイルとは異なり、ブラウザでのリダイレクトや認可コードのステップはありません。ドライバーが UKG Pro WFM のユーザー名、パスワード、クライアント ID、クライアントシークレットを使って、直接アクセストークンを取得します。

   認証するには、以下の接続プロパティを設定します。

   • AuthScheme：OAuthPassword に設定します。
   • Host：UKG Pro Workforce Management のデータセンター/テナントのホスト名に設定します（例：yourcompany.mykronos.com）。プロトコル（https://）や末尾のスラッシュは含めないでください。
   • OAuthClientId：UKG Pro Workforce Management の OAuth アプリケーションに発行されたクライアント ID に設定します。
   • OAuthClientSecret：UKG Pro Workforce Management の OAuth アプリケーションに発行されたクライアントシークレットに設定します。
   • User：UKG Pro Workforce Management のユーザー名に設定します。
   • Password：UKG Pro Workforce Management のパスワードに設定します。

   アクセストークンは https://{Host}/api/authentication/access_token から取得します。UKG Pro Workforce Management が発行するリフレッシュトークンの有効期限は7日間です。リフレッシュトークン自体の期限切れによってトークンの更新に失敗した場合、ドライバーは User/Password の認証情報で再認証し、新しいアクセストークンを取得する必要があります。

   For example: 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;

   Blazor でUKG Pro WFM にデータ連携するアプリを構築

   Blazor にADO.NET Provider for API を接続

   • Visual Studio を立ち上げて、Blazor アプリのプロジェクトを作成します。
   
   • ソリューションエクスプローラーで「依存関係」から右クリックで「プロジェクト参照の追加」をクリック。
   • 参照マネージャーが開くので、「参照」ボタンをクリックして、先ほどインストールしたADO.NET Provider の.dll を選択します。「C:\Program Files\CData\CData ADO.NET Provider for API 2019J\lib etstandard2.0」内のSystem.Data.CData.API.dll」を参照に選びます。
   

   Blazor でUKG Pro WFM のデータをSELECT

   サンプルプロジェクトの「Page」→「Index.razor」を開きます。

   以下のコードを書きます。使っているクエリはおなじみの標準SQL です。UKG Pro WFM 固有のAPI を書かなくてもRDB と同感覚でSQL が書けるところがADO.NET Prover for API の強味です。
   

         @page "/"
         @using System.Data;
         @using System.Data.CData.API;
   
         <h1>Hello, world!</h1>
   
         Welcome to your Data app.
   
         <div class="row">
             <div class="col-12">
   
                 @using (APIConnection connection = new APIConnection(
                   "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;"))
                 {
                     var sql = "SELECT PersonNumber, UserName FROM Employees WHERE PersonId = '12345'";
                     var results = new DataTable();
   
                     APIDataAdapter dataAdapter = new APIDataAdapter(sql, connection);
                     dataAdapter.Fill(results);
   
                     <table class="table table-bordered">
                         <thead class="thead-light">
                             <tr>
                                 @foreach (DataColumn item in results.Rows[0].Table.Columns)
                                 {
                                     <th scope="col">@item.ColumnName</th>
                                 }
                             </tr>
                         </thead>
                         <tbody>
                             @foreach (DataRow row in results.Rows)
                             {
                                 <tr>
                                     @foreach (var column in row.ItemArray)
                                     {
                                         <td>@column.ToString()</td>
                                     }
                                 </tr>
                             }
                         </tbody>
                     </table>
                 }
             </div>
         </div>
       

   まず、Profile 接続プロパティをディスク上の UKGProWFM プロファイルの場所に設定します（例：C:\profiles\UKGProWFM.apip）。次に、ProfileSettings 接続プロパティを UKGProWFM の接続文字列に設定します（以下を参照）。

   UKGProWFM API プロファイル設定

   UKG Pro Workforce Management では、OAuth 2.0 の Resource Owner Password Credentials グラント（grant_type=password）を使用して API へのアクセスを認可します。一般的な OAuth ベースのプロファイルとは異なり、ブラウザでのリダイレクトや認可コードのステップはありません。ドライバーが UKG Pro WFM のユーザー名、パスワード、クライアント ID、クライアントシークレットを使って、直接アクセストークンを取得します。

   認証するには、以下の接続プロパティを設定します。

   • AuthScheme：OAuthPassword に設定します。
   • Host：UKG Pro Workforce Management のデータセンター/テナントのホスト名に設定します（例：yourcompany.mykronos.com）。プロトコル（https://）や末尾のスラッシュは含めないでください。
   • OAuthClientId：UKG Pro Workforce Management の OAuth アプリケーションに発行されたクライアント ID に設定します。
   • OAuthClientSecret：UKG Pro Workforce Management の OAuth アプリケーションに発行されたクライアントシークレットに設定します。
   • User：UKG Pro Workforce Management のユーザー名に設定します。
   • Password：UKG Pro Workforce Management のパスワードに設定します。

   アクセストークンは https://{Host}/api/authentication/access_token から取得します。UKG Pro Workforce Management が発行するリフレッシュトークンの有効期限は7日間です。リフレッシュトークン自体の期限切れによってトークンの更新に失敗した場合、ドライバーは User/Password の認証情報で再認証し、新しいアクセストークンを取得する必要があります。

   プロジェクトをリビルドして実行します。このようにUKG Pro WFM からデータを直接取得し、HTML テーブル形式にレンダリングしています。

   

   もちろんSaaS データソースへの接続の場合には、RDB 向けのドライバーと違い最終的にはHTTP リクエストが行われるので、サーバーサイド Blazor としてサーバーサイドから実行されるのか、クライアントサイド Blazor として、実行中のブラウザからHTTPリクエストが行われるのかの違いはあります。そのあたりはネットワークやプロキシの設定として注意が必要でしょう。設定はコード内の接続プロパティで可能です。

   まとめ

   このようにサーバーサイドBlazor アプリから簡単にADO.NET Provider を使ってUKG Pro WFM にリアルタイムでデータ取得を行うアプリを作ることができました。Blazor が.NET Core、フレームワークのツール群を使えるというメリットを活かすことができます。今回はSELECT * でしたが、フィルタリングやJOIN も可能です。是非、30日の無償評価版でシンプルかつパワフルなADO.NET Provider でのサーバーサイドBlazor 連携をお試しください。