NetBeans で Paylocity のデータ に接続
CData JDBC Driver for Paylocity は、JDBC をサポートする IDE にリアルタイム Paylocity のデータ 接続を統合します。JDBC 標準により、ビルトインのデータアクセスウィザードや迅速な開発をサポートするその他のツールを使用できます。この記事では、NetBeans で Paylocity のデータ に接続する方法を説明します。接続を作成し、テーブルエディターで 編集・保存およびを行います。
NetBeans で Paylocity 用の JDBC データソースを作成
JDBC データソースを作成するには、サービスウィンドウで Database ノードを展開し、Drivers ノードを右クリックして New Driver を選択します。表示される New Driver ウィザードで、以下の情報を入力します:
- Driver File(s):Add をクリックし、表示されるファイルエクスプローラーダイアログで cdata.jdbc.paylocity.jar ファイルを選択します。ドライバー JAR はインストールディレクトリの lib サブフォルダにあります。
- Driver Class:Find をクリックして JAR 内のドライバークラスを検索します。次に、メニューから cdata.jdbc.paylocity.PaylocityDriver を選択します。
- Name:ドライバーの名前を入力します。
接続パラメータの定義
以下の手順で、必要な接続プロパティを定義します:
サービスウィンドウで Database ノードを右クリックし、New Connection をクリックします。
New Connection Wizard で、以下の接続プロパティを入力します:
- Driver Name:メニューから CData JDBC Driver for Paylocity を選択します。
- User Name:ユーザー名を入力します。これは JDBC URL でも定義できます。
- Password:パスワードを入力します。これは JDBC URL でも定義できます。
JDBC URL:JDBC URL を指定します。
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;
- RSAPublicKey:Paylocity アカウントでRSA 暗号化が有効になっている場合は、Paylocity に関連付けられたRSA キーを設定。
Paylocity のデータ のクエリ
Paylocity のデータ に接続するには、Database ノードで接続を右クリックし、Connect をクリックします。接続が確立されたら、展開してスキーマ情報を確認できます。
Data Views ウィンドウにテーブルをロードするには、テーブルを右クリックして View Data をクリックします。Data Views ウィンドウでレコードの挿入、更新、削除も行えます。