ColdFusion で JDBC 経由でリアルタイム Paylocity のデータをインポートしてアプリケーションを構築

Dibyendu Datta
Lead Technology Evangelist

CData JDBC Driver を使用して、ColdFusion で Paylocity のデータをインポートして活用する方法を説明します。

Adobe ColdFusion は、Web およびモバイルアプリケーションの開発プラットフォームです。独自のスクリプト言語である ColdFusion Markup Language（CFML）を使用して、データ駆動型のWeb サイトを構築したり、REST などのリモートサービスを生成したりできます。

ColdFusion と CData JDBC Driver for Paylocityを組み合わせると、ColdFusion の Web およびモバイルアプリケーションを Paylocity の運用データに接続できます。これにより、アプリケーションをより堅牢で完成度の高いものにできます。この記事では、 JDBC Driver を使用して、ColdFusion マークアップファイル内で Paylocity データを含むテーブルを作成する方法を説明します。

CData JDBC Driver は、最適化されたデータ処理機能を組み込んでおり、Paylocity のデータとのリアルタイム連携において圧倒的なパフォーマンスを提供します。複雑な SQL クエリを Paylocity に発行すると、ドライバーはフィルタや集計などのサポートされている SQL 操作を Paylocity に直接プッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンがクライアント側で処理します。組み込みの動的メタデータクエリ機能により、ネイティブのデータ型を使用して Paylocity のデータを操作・分析できます。

Paylocity への接続を設定

ColdFusion と Paylocity 間の接続を確立するには、JDBC 接続文字列が必要です。

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 を生成（paylocity の例）

データソースの追加とテーブルの作成

接続を設定したら、次の手順に従って CData JDBC Driver を ColdFusion の lib ディレクトリに追加し、新しいデータソースを追加し、接続をテストし、 ColdFusion マークアップファイルを作成して、最終的に Paylocity のデータとリアルタイムに接続し、ColdFusion Markup Language（CFML）で記述されたテーブルに表示します。

Paylocity 用の JDBC Driver と lic ファイルを「C:\Program Files\CData[product_name]\lib」から「C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib」にコピーします。
```
            cdata.jdbc.paylocity.jar
            cdata.jdbc.paylocity.lic
        
```
注意：.lic ファイルを jar と一緒にコピーしないと、有効なライセンスがインストールされていないことを示すライセンスエラーが表示されます。これはトライアル版と製品版の両方に当てはまります。
ColdFusion 管理画面から、Data & Services を選択します。
ここで「Add New Data Source」をクリックします。データソース名は、ColdFusion の変数命名規則に従っていれば任意の名前を指定できます。 JDBC Driver の場合は「other」を選択し、「Add」ボタンをクリックします。
次に、ドライバーのプロパティを入力します。
- JDBC URL は次の形式で指定します： jdbc:paylocity:|connectionString|
- 一般的な接続文字列は次のようになります：
  
  jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;
- Driver Class：cdata.jdbc.paylocity.PaylocityDriver
- Driver Name は任意で、ColdFusion 管理コンソールでデータソースを識別するためだけに使用されます。
作成した CDataPaylocityJDBC データソースの左側にあるチェックマークをクリックして、接続をテストします。データソースが「OK」ステータスを報告すれば、使用可能な状態です。

次に、新しい ColdFusion マークアップファイル（.cfm）を作成し、ColdFusion の wwwroot ディレクトリ（「C:\ColdFusion2021\cfusion\wwwroot」）に配置します。

以下のコードでデータソースにクエリを実行します：

            
        <cfquery name="PaylocityQuery" dataSource="CDataPaylocityJDBC">
          SELECT * FROM Employee
        </cfquery>

CFTable を使用すると、HTML でテーブルを素早く出力できます：

            
          <cftable
          query = "PaylocityQuery"
          border = "1"
          colHeaders
          colSpacing = "2"
          headerLines = "2"
          HTMLTable
          maxRows = "500"
          startRow = "1">

          <cfcol header="<b>FirstName</b>" align="Left" width=2 text="FirstName"/>

          <cfcol header="<b>LastName</b>" align="Left" width=15 text="LastName"/>

          ...

        </cftable>

HTML 部分を含む完全なコードは以下のとおりです：

            
        <html>
        <head><title>CData Software | Paylocity Employee Table Demo </title></head>
        <body>
        <cfoutput>#ucase("Paylocity Employee Table Demo")#</cfoutput>
        <cfquery name="PaylocityQuery" dataSource="CDataPaylocityJDBC">

          SELECT * FROM Employee

        </cfquery>
        <cftable
          query = "PaylocityQuery"
          border = "1"
          colHeaders
          colSpacing = "2"
          headerLines = "2"
          HTMLTable
          maxRows = "500"
          startRow = "1">
          <cfcol header="<b>FirstName</b>" align="Left" width=2 text="FirstName"/>

          <cfcol header="<b>LastName</b>" align="Left" width=15 text="LastName"/>

          ...

        </cftable>
        </body>

        </html>