CData JDBC Driver を使用して Paylocity を IBM WebSphere に接続

IBM WebSphere は、多くのエンタープライズレベルの Java アプリケーションやサービスを実行する強力なアプリケーションサーバーです。CData JDBC Driver for Paylocity と組み合わせることで、IBM WebSphere アプリケーションは複雑な API を使用せずに、標準 SQL クエリで Paylocity に接続し、データを操作できます。これにより、連携作業の簡素化、開発工数の削減、重要なビジネスデータへの安全なリアルタイムアクセスが可能になります。

前提条件

1. Paylocity アカウントへのアクセス（API 権限付き）
2. IBM WebSphere Application Server（構成済みで実行中）
3. CData JDBC Driver for Paylocity
4. デプロイ用の Java Servlet WAR アプリケーション

Note: この記事では Salesforce をデモ用のデータソースとして使用していますが、同じ手順で CData が提供する 250 種類以上の JDBC Driver に接続できます。

はじめに

ステップ1：CData JDBC Driver for Paylocity のダウンロードとインストール

CData JDBC Driver for Paylocity をダウンロードしてインストールします。インストールすると .jar ファイルが提供されます：cdata.jdbc.paylocity.jar

ステップ2：IBM WebSphere のインストールと構成

1. IBM 公式サイトから IBM WebSphere のアカウントを作成します。
2. IBM WebSphere Application Server のドキュメントを参照して、ローカルシステムに IBM WebSphere Application Server をインストール・構成します。
3. アプリケーションサーバーのインストールが完了したら、ブラウザで管理コンソールを使用して WebSphere Server を起動します：https://your-server:9043/ibm/console

ステップ3：Paylocity 用の JDBC プロバイダーとデータソースの設定

1. Resources に移動し、JDBC セクションを展開して、JDBC providers を選択して新しいプロバイダーを作成します

2. ドロップダウンメニューから適切なスコープを選択します

3. New をクリックして JDBC プロバイダーを追加します
• データベースタイプとして User defined を選択します
• implementation class name として cdata.jdbc.paylocity.PaylocityConnectionPoolDataSource を入力します
• プロバイダーの名前を入力します（例：User defined JDBC Provider）
• classpath フィールドに JDBC ドライバー JAR ファイルのフルパスを入力します
• Next をクリックし、Finish をクリックして、マスター構成に変更を保存します

4. JDBC プロバイダーが作成されたら、JDBC データソースを追加します。
• Data Source Name や JNDI name などの基本情報を入力します
• 先ほど作成した JDBC provider を選択します（例：CData Paylocity Provider）
• Implementation class name を指定します：cdata.jdbc.paylocity.PaylocityConnectionPoolDataSource
• Data Store Helper Class Name を追加します：com.ibm.websphere.rsadapter.GenericDataStoreHelper
• 必要に応じて authentication aliases を設定してセキュリティを構成します
• Summary ページですべての詳細を確認し、Finish をクリックしてデータソースの作成を完了します

5. 一覧から新しく作成したデータソースを選択し、Custom properties を開きます
6. URL プロパティに JDBC 接続文字列を追加し、OK を押します。例：

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

   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
         

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

   

   Note: URL プロパティが利用できない場合は、作成してから JDBC 接続文字列を追加してください。

   Tip: URL プロパティに入力する前に、必ずドライバーで接続文字列をテストしてください。
7. データソースを開き、Test Connection を選択します

ステップ4：Web アプリケーションのビルド

1. お好みの Java フレームワーク（Servlet、JSP、Spring）を使用して Web アプリケーションをビルドします。生成される .war ファイルは通常、次のような構造になります：

		PaylocityServletApp.war
		|--webcontent
		|  |--index.jsp                 -- JSP ページ（エントリーポイント）
		|  |
		|  |--WEB-INF/                  -- ブラウザから直接アクセス不可
		|     |--web.xml                 -- デプロイメント記述子
		|     |
		|     |--classes/                  -- コンパイル済み .class ファイル
		|       |--com/example/Paylocity/
		|          |--PaylocityServlet.class
		|
		|--lib/                      -- 依存 JAR ファイル
		|--cdata.jdbc.paylocity.jar
	

2. JDBC または JPA を使用してデータアクセスロジックを定義し、JNDI 名でデータソースを参照します
3. この記事では、JDBC 接続の設定と Java Servlet アプリケーションのデプロイについて説明します
4. プロジェクトを WAR（Web Application Archive）または EAR（Enterprise Archive）ファイルとしてパッケージ化してデプロイします
• ターミナルで以下のコマンドを使用して Java ファイルをコンパイルします：

  			cd webcontent
  			jar cvf ..\PaylocityServletApp.war *
  		

ステップ5：WebSphere に Paylocity アプリケーションをデプロイ

1. WebSphere 管理コンソールで Applications に移動し、Install New Application を選択します
2. WAR ファイルを参照してアップロードし、インストールウィザードを進めます。

ステップ6：WebSphere から Paylocity のデータ を取得

1. コンテキストルートを使用してアプリケーションにアクセスします：http://hostname:port/context-root/page
Note: ブラウザで開く前に、デプロイしたアプリケーションが起動していることを確認してください。

これでソースから取得したデータを表示できるようになりました。データは IBM WebSphere を通じて直接アクセスできます。このセットアップは、Servlet を WebSphere にデプロイして JDBC ドライバーを使用して Paylocity データを取得する方法を示しており、Paylocity を活用した高度なエンタープライズアプリケーションを構築するための強固な基盤となります。

Paylocity から IBM WebSphere への接続を始めましょう

CData JDBC Connector を使用して、今すぐ Paylocity から IBM WebSphere への接続を始めましょう。30日間の無料トライアルをダウンロードして、アプリケーションへの安全でリアルタイムなデータアクセスがいかに簡単に実現できるかをお試しください。ご不明な点がございましたら、サポートチームがいつでもお手伝いします。