Oracle Data Integrator でPaylocity のデータをETL する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Oracle Data Integrator（ODI）はOracle エコシステムのハイパフォーマンスなデータ統合プラットフォームです。CData JDBC Driver for Paylocity を使えば、OCI をはじめとするETL ツールからPaylocity データにJDBC 経由で簡単に読み取りと書き込みを実現できます。リアルタイムPaylocity データをデータウェアハウス、BI・帳票ツール、CRM、基幹システムなどに統合すれば、データ活用もぐっと楽に。

CData のコネクタを使えば、Paylocity API にリアルタイムで直接接続して、ODI 上で通常のデータベースと同じようにPaylocity データを操作できます。Paylocity エンティティのデータモデルを構築、マッピングを作成し、データの読み込み方法を選択するだけの簡単なステップでPaylocity データのETL が実現できます。

ドライバーのインストール

ドライバーをインストールするには、インストールフォルダにあるドライバーのJAR ファイルと.lic ファイルをODI の適切なディレクトリにコピーします。

• UNIX/Linux（Agent なし）：~/.odi/oracledi/userlib
• UNIX/Linux（Agent）：$ODI_HOME/odi/agent/lib
• Windows（Agent なし）：%APPDATA%\Roaming\odi\oracledi\userlib
• Windows（Agent）：%APPDATA%\Roaming\odi\agent\lib

ODI を再起動してインストールを完了します。

モデルのリバースエンジニアリング

ODI の機能を使ってモデルをリバースエンジニアリングすることで、ドライバー側で取得したPaylocity データのリレーショナルビューに関するメタデータが取得できます。リバースエンジニアリング後、リアルタイムPaylocity データにクエリを実行してPaylocity テーブルのマッピングを作成できます。

1. ODI でリポジトリに接続し、「New」->「Model and Topology Objects」をクリックします。
2. 表示されるダイアログの「Model」画面で、以下の情報を入力します。
   • Name：Paylocity と入力します。
   • Technology：Technology:Generic SQL（ODI がVersion 12.2+ の場合はMicrosoft SQL Server）を選択します。
   • Logical Schema：Paylocity と入力します。
   • Context：Global を選択します。
3. 表示されるダイアログの「Data Server」画面で、以下の情報を入力します。
   • Name：Paylocity と入力します。
   • Driver List：Oracle JDBC Driver を選択します。
   • Driver：cdata.jdbc.paylocity.PaylocityDriver と入力します。
   • URL：接続文字列を含むJDBC URL を入力します。

     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;
4. Physical Schema 画面で、以下の情報を入力します。
   • Name：ドロップダウンメニューから選択します。
   • Database (Catalog)：CData と入力します。
   • Owner (Schema)：Paylocity にSchema を選択した場合は、選択したSchema を入力し、それ以外の場合はPaylocity と入力します。
   • Database (Work Catalog)：CData と入力します。
   • Owner (Work Schema)：Paylocity にSchema を選択した場合は、選択したSchema を入力し、それ以外の場合はPaylocity と入力します。
5. 開いたモデルで「Reverse Engineer」をクリックしてPaylocity テーブルのメタデータを取得します。

Paylocity データの編集と保存

リバースエンジニアリング後、ODI でPaylocity データを操作できるようになります。 Paylocity データを編集し保存するには、Designer ナビゲーターでモデルアコーディオンを展開し、テーブルを右クリックして「Data」をクリックします。「Refresh」をクリックしてデータの変更を取得します。変更が完了したら「Save Changes」をクリックします。

ETL プロジェクトの作成

次の手順に従って、Paylocity からETL を作成します。Employee エンティティをODI Getting Started VM に含まれているサンプルデータウェアハウスにロードします。

1. SQL Developer を開き、Oracle データベースに接続します。Connections ぺインでデータベースのノードを右クリックし、「New SQL Worksheet」をクリックします。

   もしくは、SQLPlus を使用することもできます。コマンドプロンプトから、以下のように入力します。

   sqlplus / as sysdba
2. 以下のクエリを入力し、ODI_DEMO スキーマにあるサンプルデータウェアハウスに新しいターゲットテーブルを作成します。以下のクエリは、Paylocity のEmployee テーブルに一致するいくつかのカラムを定義します。 CREATE TABLE ODI_DEMO.TRG_EMPLOYEE (LASTNAME NUMBER(20,0),FirstName VARCHAR2(255));
3. ODI でDesigner ナビゲーターのModels アコーディオンを展開し、ODI_DEMO フォルダの「Sales Administration」ノードをダブルクリックします。Model Editor でモデルが開きます。
4. 「Reverse Engineer」をクリックします。TRG_EMPLOYEE テーブルがモデルに追加されます。
5. プロジェクトの「Mappings」ノードを右クリックし、「New Mapping」をクリックします。マッピングの名前を入力し、「Create Empty Dataset」オプションを無効にします。Mapping Editor が表示されます。
6. TRG_EMPLOYEE テーブルをSales Administration モデルからマッピングにドラッグします。
7. Employee テーブルをPaylocity モデルからマッピングにドラッグします。
8. ソースコネクタポイントをクリックしてターゲットコネクタポイントにドラッグします。Attribute Matching ダイアログが表示されます。ここでは、デフォルトオプションを使用します。その場合、目的の動作はターゲットカラムのプロパティに表示されます。
9. Mapping Editor のPhysical タブを開き、TARGET_GROUP の「EMPLOYEE_AP」をクリックします。
10. EMPLOYEE_AP プロパティで、Loading Knowledge Module タブの「LKM SQL to SQL (Built-In)」を選択します。

これで、マッピングを実行してPaylocity データをOracle にロードできます。