Jetty コネクションプールからPaylocity データに連携。

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData JDBC Driver for Paylocity は、Java Web アプリケーションに簡単に統合して利用することができます。本記事では、Jetty でドライバーをコネクションプールとして設定することで、効率的にPaylocity データをアプリケーションで連携利用する方法を説明します。Jetty でJNDI resource for Paylocity を設定します。

DBC Driver for Paylocity を JNDI Data Source として設定

次の手順で、Jetty とPaylocity の接続を確立します。

1. Jetty ベースでJNDI モジュールを有効化します。JNDI を有効化するコマンドラインは以下の通り:

   java -jar ../start.jar --add-to-startd=jndi
2. JDBC Driver の.jar ファイルと.lic ファイル（インストールディレクトリのlib フォルダ下）をcontext path のlib フォルダに配置します。
3. リソースおよびスコープを宣言します。リソース宣言で必要な接続プロパティを入力します。この例では、Paylocity データソースをWeb アプリケーションのWEB-INF\jetty-env.xml レベルにdeclare しています。
   <Configure id='paylocitydemo' class="org.eclipse.jetty.webapp.WebAppContext"> <New id="paylocitydemo" class="org.eclipse.jetty.plus.jndi.Resource"> <Arg><Ref refid="paylocitydemo"/></Arg> <Arg>jdbc/paylocitydb</Arg> <Arg> <New class="cdata.jdbc.paylocity.PaylocityDriver"> <Set name="url">jdbc:paylocity:</Set> <Set name="OAuthClientID">YourClientId</Set> <Set name="OAuthClientSecret">YourClientSecret</Set> <Set name="RSAPublicKey">YourRSAPubKey</Set> <Set name="Key">YourKey</Set> <Set name="IV">YourIV</Set> </New> </Arg> </New> </Configure>

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

4. Web xml でリソースを設定します:

   jdbc/paylocitydb javax.sql.DataSource Container

5. これで、java:comp/env/jdbc/paylocitydb へのルックアップでPaylocity データにアクセスできます: InitialContext ctx = new InitialContext(); DataSource mypaylocity = (DataSource)ctx.lookup("java:comp/env/jdbc/paylocitydb");

Jetty にさらに統合

ここでは、シンプルなコネクションプーリングシナリオでのドライバーの接続について説明しました。追加での連携ケースについては、Jetty ドキュメントのWorking with Jetty JNDI 　参照してください。