ColdFusion にリアルタイムPaylocity データをインポートしてアプリケーションを構築

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

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

ColdFusion とCData JDBC Driver for Paylocity を組み合わせると、ColdFusion のWeb アプリケーションやモバイルアプリケーションを、運用中のPaylocity データにリンクできます。 これにより、アプリケーションの堅牢性と完成度を高めることができます。この記事では、JDBC ドライバーを使ってColdFusion マークアップファイルからPaylocity のデータを入力したテーブルを作成する方法について詳しく説明します。

最適化されたデータ処理が組み込まれたCData JDBC ドライバは、リアルタイムPaylocity データを扱う上で高いパフォーマンスを提供します。 Paylocity にSQL クエリを発行すると、CData ドライバーはフィルタや集計などの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 ファイルを実行します。

データソースを追加してテーブルを作成する

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

1. JDBC Driver for Paylocity およびlic ファイルを"C:\Program Files\CData\CData JDBC Driver for Paylocity\lib" から"C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib"にコピーします。 cdata.jdbc.paylocity.jar cdata.jdbc.paylocity.lic

   Note：.lic ファイルをjar ファイルとともにコピーしないと、有効なライセンスがインストールされていないことを示すライセンスエラーが表示されます。 これは評価版、製品版ともに同様です。

2. ColdFusion Administrator インターフェースで「データとサービス」を選択します。
3. 「新規のデータソースの追加」を行います。データソース名は、ColdFusion の変数命名規則に従っていればどのような名前でもかまいません。 JDBC ドライバーの場合は、「その他」を選択して「追加」ボタンをクリックします。
4. 次に、ドライバーのプロパティを入力します。
   • 「JDBC URL」は、次のような形式である必要があります： jdbc:paylocity:|connectionString|
   • 典型的な接続文字列は次のようになります：
     jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH
   • 「ドライバクラス」は次のようになります：cdata.jdbc.paylocity.PaylocityDriver
   • 「ドライバ名」の入力は任意で、これは単にColdFusion Administrator コンソールでデータソースを認識するために使われます。
5. ここで、作成したCDataPaylocityJDBC データソースの左側にあるチェックマークをクリックして、接続をテストしてください。 データソースのステータスが「OK」になると、使用可能な状態です。
6. 次に、ColdFusion Markup ファイル（.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>  
       

7. 最後に、デフォルトのポート8500のブラウザでコードをローカルに実行します。これでPaylocity のデータが入力されたテーブルが作成されました！

なお、CData JDBC ドライバはcfqueryparam 要素を使用したパラメータ化クエリもサポートしています。 次に例を示します。 SELECT * FROM Account WHERE name =

今日からはじめましょう

CData JDBC Driver for Paylocity の 30日間無償トライアル をダウンロードして、Adobe ColdFusion でPaylocity と連携したアプリケーションの作成をはじめましょう！ご不明な点があれば、サポートチームにお問い合わせください。