RazorSQL で Paylocity のデータに接続

Jerod Johnson
Senior Technology Evangelist

RazorSQL データベース管理ツールのウィザードを使用して Paylocity に接続し、GUI で Paylocity のデータをクエリします。

CData JDBC Driver for Paylocity は、IDE のウィザードからデータ管理・分析ツールまで、サードパーティツールからの標準ベースのアクセスを可能にします。この記事では、RazorSQL のウィザードを使用して Paylocity に接続する方法を説明します。

Paylocity のデータ用の JDBC データソースを作成

RazorSQL アプリケーションを開き、「Connections」メニューから「Add Connection Profile」->「Other」->「JDBC」を選択します。
表示される「Connection Wizard」で、以下のプロパティを設定します。
- Driver Location：インストールディレクトリ内の lib サブフォルダへのパスを設定します。
- Driver Class：ドライバークラスを cdata.jdbc.paylocity.PaylocityDriver に設定します。
- Username：ユーザー名を入力します（このプロパティは JDBC URL 内でも設定できます）。
- Password：パスワードを入力します（このプロパティは JDBC URL 内でも設定できます）。
- JDBC URL：接続パラメータを入力します。JDBC URL は jdbc:paylocity: で始まり、その後にセミコロンで区切られた接続プロパティが続きます。
  
  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 を設定することを意味します。
  ビルトイン接続文字列デザイナー
  
  JDBC URL の構築には、Paylocity JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインから jar ファイルを実行します。
```
java -jar cdata.jdbc.paylocity.jar
```
  接続プロパティを入力し、接続文字列をクリップボードにコピーします。
  
  一般的な JDBC URL は以下のとおりです。
```
jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;
```