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

Dibyendu Datta
Lead Technology Evangelist

CData ODBC ドライバーを使って、ColdFusion でPaylocity のデータをインポート・活用。

Adobe ColdFusion は、Web およびモバイルアプリケーションの開発プラットフォームです。独自のスクリプト言語である ColdFusion Markup Language（CFML）を使用して、データ駆動型の Web サイトを作成したり、REST などのリモートサービスを生成したりできます。ColdFusion を CData ODBC Driver for Paylocity と組み合わせることで、ColdFusion の Web およびモバイルアプリケーションとPaylocity のライブデータを連携できます。これにより、アプリケーションをより堅牢で完全なものにすることができます。この記事では、ODBC ドライバーを使って、ColdFusion マークアップファイル内でPaylocity のデータを取得してテーブルを作成する方法を説明します。

このチュートリアルを進めるには、CData ODBC Driver for Paylocity と Adobe ColdFusion をインストールする必要があります。

接続の設定

まだ設定していない場合は、ODBC DSN（データソース名）で接続プロパティを指定します。これはドライバーインストールの最終ステップです。Microsoft ODBC データソースアドミニストレーターを使って ODBC DSN を作成・設定できます。

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

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

DSN を作成したら、以下の手順に従って、新しいデータソースを追加し、接続をテストし、ColdFusion マークアップファイルを作成し、最後にPaylocity のデータをインポートして ColdFusion でテーブルに表示します。

ColdFusion 管理インターフェースから、Data & Services を選択します。
ここで「Add New Data Source」をクリックします。データソース名は、ColdFusion の変数命名規則に準拠していれば任意の名前で構いません。ODBC ドライバーの場合は「ODBC Socket」を選択し、「Add」ボタンをクリックします。
ODBC DSN ドロップダウンメニューから CData Paylocity Sys を選択します。Advanced Settings セクションでは、Connection String は空白のままにしておきます。なお、この入力フィールドで指定されたプロパティは、DSN 設定で指定されたものを上書きします。
次に、先ほど作成した CDataPaylocityODBC データソースの左側にあるチェックマークを押して、接続をテストします。データソースが「OK」ステータスを報告したら、使用する準備ができています。

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

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

          
      <cfquery name="PaylocityQuery" dataSource="CDataPaylocityODBC">
        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="CDataPaylocityODBC">

        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>