製品をチェック

Paylocity Data Provider の30日間無償トライアルをダウンロード

 30日間の無償トライアルへ

製品の詳細

Paylocity アイコン Paylocity ADO.NET Provider 相談したい

Paylocity データに連携する.NET アプリケーションを素早く、簡単に開発できる便利なドライバー。

Blazor でPaylocity データにリアルタイムで連携するアプリを構築

ASP.NET Core Blazor C# でPaylocity にSQL でクエリ。

杉本和也
リードエンジニア

最終更新日:2021-11-03
paylocity ロゴ

CData

ado ロゴ画像
Blazor ロゴ

こんにちは!リードエンジニアの杉本です。

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

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

Blazor はADO.NET Provider の利用が可能

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

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

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

NuGet でADO.NET Paylocity Provider をインストール

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

Blazor にADO.NET Provider for Paylocity を接続

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

Blazor でPaylocity データをSELECT

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

以下のコードを書きます。使っているクエリはおなじみの標準SQL です。Paylocity 固有のAPI を書かなくてもRDB と同感覚でSQL が書けるところがADO.NET Prover for Paylocity の強味です。
@page "/" @using System.Data; @using System.Data.CData.Paylocity;

Hello, world!

Welcome to your Data app.
@using (PaylocityConnection connection = new PaylocityConnection( "OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;")) { var sql = "SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'"; var results = new DataTable(); PaylocityDataAdapter dataAdapter = new PaylocityDataAdapter(sql, connection); dataAdapter.Fill(results); @foreach (DataColumn item in results.Rows[0].Table.Columns) { } @foreach (DataRow row in results.Rows) { @foreach (var column in row.ItemArray) { } }
@item.ColumnName
@column.ToString()
}

Paylocity への接続を確立するには以下を設定します。

  • RSAPublicKey:Paylocity アカウントでRSA 暗号化が有効になっている場合は、Paylocity に関連付けられたRSA キーを設定。

    このプロパティは、Insert およびUpdate ステートメントを実行するために必須です。この機能が無効になっている場合は必須ではありません。

  • UseSandbox:サンドボックスアカウントを使用する場合はTrue に設定。
  • CustomFieldsCategory:Customfields カテゴリに設定。これは、IncludeCustomFields がtrue に設定されている場合は必須です。デフォルト値はPayrollAndHR です。
  • Key:Paylocity の公開鍵で暗号化されたAES 共通鍵(base 64 エンコード)。これはコンテンツを暗号化するためのキーです。

    Paylocity は、RSA 復号化を使用してAES 鍵を復号化します。
    これはオプションのプロパティで、IV の値が指定されていない場合、ドライバーは内部でキーを生成します。

  • IV:コンテンツを暗号化するときに使用するAES IV(base 64 エンコード)。これはオプションのプロパティで、Key の値が指定されていない場合、ドライバーは内部でIV を生成します。

OAuth

OAuth を使用してPaylocity で認証する必要があります。OAuth では認証するユーザーにブラウザでPaylocity との通信を要求します。詳しくは、ヘルプドキュメントのOAuth セクションを参照してください。

Pay Entry API

Pay Entry API はPaylocity API の他の部分と完全に分離されています。個別のクライアントID とシークレットを使用し、アカウントへのアクセスを許可するにはPaylocity から明示的にリクエストする必要があります。 Pay Entry API を使用すると、個々の従業員の給与情報を自動的に送信できます。 Pay Entry API によって提供されるものの性質が非常に限られているため、CData では個別のスキーマを提供しないことを選択しましたが、UsePayEntryAPI 接続プロパティを介して有効にできます。

UsePayEntryAPI をtrue に設定する場合は、CreatePayEntryImportBatch、MergePayEntryImportBatch、Input_TimeEntry、およびOAuth ストアドプロシージャのみ利用できることに注意してください。 製品のその他の機能を使用しようとするとエラーが発生します。また、OAuthAccessToken を個別に保存する必要があります。これは、この接続プロパティを使用するときに異なるOAuthSettingsLocation を設定することを意味します。

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

Blazor アプリからPaylocity データをクエリ

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

まとめ

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。