JBoss のコネクションプールから Paylocity のデータ に接続

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
Paylocity のデータ を Java サーブレットに統合:JBoss の管理コンソールを使用して Paylocity JDBC Driver をインストール。

CData JDBC Driver は、コネクションプーリングの標準手順に従ってJBoss で設定できます。本記事では、JBoss アプリケーションのコネクションプールから Paylocity のデータ にアクセスする方法を解説します。JBoss 管理インターフェースを使用して CData JDBC Driver for Paylocity を設定し、コネクションプールから Paylocity のデータ にアクセスします。

管理コンソールから Paylocity 用のJDBC データソースを作成

以下の手順に従って、ドライバーJAR を追加し、必要な接続プロパティを定義します。

  1. Runtime メニューで、管理ドメインにデプロイするかスタンドアロンサーバーにデプロイするかに応じて、Domain またはServer メニューを選択し、「Manage deployments」をクリックしてDeployments ページを開きます。
  2. Add をクリックします。表示されるウィザードで、インストールディレクトリのlib サブフォルダにあるドライバーのJAR ファイルとライセンスを追加します。デフォルト設定でウィザードを完了し、ドライバーを選択してEnable をクリックします。
  3. Configuration メニューで、Subsystems -> Connector -> Datasources をクリックします。JDBC Datasources ページが開きます。
  4. Add をクリックし、表示されるウィザードでドライバーの名前とJNDI 名を入力します。例:
    java:jboss/root/jdbc/Paylocity
  5. 上記で追加したドライバーを選択します。
  6. 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:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;
    
  7. 接続をテストしてウィザードを完了します。Paylocity データソースを選択し、Enable をクリックします。

JBoss のその他の統合

上記の手順は、シンプルなコネクションプーリングシナリオでドライバーを設定する方法を示しています。詳細については、JBoss EAP ドキュメントのData Source Management の章を参照してください。

はじめる準備はできましたか?

Paylocity Driver の無料トライアルをダウンロードしてお試しください:

 ダウンロード

詳細:

Paylocity Icon Paylocity JDBC Driver お問い合わせ

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