DataGrip で Paylocity のデータ をクエリ

DataGrip は、SQL 開発者がデータベースへのクエリ、作成、管理を行えるデータベース IDE です。CData JDBC Driver for Paylocity と組み合わせることで、DataGrip からリアルタイムPaylocity のデータを操作できます。この記事では、DataGrip で Paylocity のデータ への接続を確立し、テーブルエディタを使用して Paylocity のデータ を読み込む方法を説明します。

Paylocity 用の新しいドライバー定義を作成

以下のステップでは、DataGrip で Paylocity 用の新しいデータソースを作成する方法を説明します。

1. DataGrip で、File -> New -> Project をクリックしてプロジェクト名を入力します。
2. Database Explorer で、プラスアイコン（）をクリックして Driver を選択します。
3. Driver タブで以下を設定します。
   • Name をわかりやすい名前に設定します（例："CData Paylocity Driver"）。
   • Driver Files を適切な JAR ファイルに設定します。ファイルを追加するには、プラス（）をクリックし、「Add Files」を選択して、ドライバーのインストールディレクトリ内の「lib」フォルダに移動し、JAR ファイル（例：cdata.jdbc.paylocity.jar）を選択します。
   • Class を cdata.jdbc.paylocity.Paylocity.jar に設定します。
   また、詳細タブでは、ドライバーのプロパティや、VM Options、VM environment、VM home path、DBMS などの設定を変更できます。
   • ほとんどの場合、Expert options で DBMS type を「Unknown」に変更して、ネイティブの SQL Server クエリ（Transact-SQL）を回避してください。これを行わないと、無効な関数エラーが発生する可能性があります。
4. 「Apply」をクリックし、「OK」をクリックして接続を保存します。

Paylocity への接続を設定

1. 接続を保存したら、プラス（）をクリックし、「Data Source」→「CData Paylocity Driver」を選択して、新しい Paylocity データソースを作成します。
2. 新しいウィンドウで、JDBC URL を使用して Paylocity への接続を設定します。

   組み込みの接続文字列デザイナー

   JDBC URL の構築には、Paylocity JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。

         java -jar cdata.jdbc.paylocity.jar
       

   接続プロパティを入力し、接続文字列をクリップボードにコピーします。

   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 を設定することを意味します。

3. URL を接続文字列に設定します。例：

   jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;

4. 「Apply」と「OK」をクリックして接続文字列を保存します。

これで、Data Explorer にデータソースが表示されます。

Paylocity に対して SQL クエリを実行

JDBC Driver を介してアクセス可能な Paylocity のエンティティ（テーブルとして利用可能）を参照するには、データソースを展開します。

クエリを実行するには、任意のテーブルを右クリックして「New」→「Query Console」を選択します。

Console で、実行したい SQL クエリを記述します。例：

SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'

CData JDBC Driver for Paylocity の30日間の無料トライアルをダウンロードして、DataGrip でリアルタイムPaylocity のデータを操作してみてください。ご不明な点があれば、サポートチームにお問い合わせください。