RapidMiner からPaylocity データに連携

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

この記事では、CData JDBC Driver for Paylocity をRapidMiner のプロセスと簡単に統合する方法を示します。この記事では、CData JDBC Driver for Paylocity を使用してPaylocity をRapidMiner のプロセスに転送します。

RapidMiner のPaylocity にJDBC Data Source として接続する

以下のステップに従ってPaylocity へのJDBC 接続を確認できます。

1. Paylocity 用の新しいデータベースドライバーを追加します。［Connections］->［Manage Database Drivers］とクリックします。
2. 表示されるウィザードで［Add］ボタンをクリックし、接続に名前を入力します。
3. JDBC URL のプレフィックスを入力します。 jdbc:paylocity:
4. インストールディレクトリのlib サブフォルダにあるcdata.jdbc.paylocity.jar ファイルにパスを入力して下さい。
5. ドライバークラスを入力します。 cdata.jdbc.paylocity.PaylocityDriver
6. 新しいPaylocity 接続を作成します。［Connections］->［Manage Database Connections］とクリックします。
7. 接続の名前を入力します。
8. データベースシステムの場合は、以前構成したPaylocity ドライバーを選択します。
9. Host ボックスで接続文字列を入力します。

   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

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

   以下は一般的な接続文字列です。

   OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH
10. 必要であればユーザー名とパスワードを入力します。

プロセス内の様々なRapidMiner オペレーターとのPaylocity 接続を使用できます。Paylocity を取得するには、［Operators］ビューから［Retrieve］をドラッグします。 ［Retrieve］オペレータを選択した状態で、［repository entry］の横にあるフォルダアイコンをクリックして［Parameters］ビューで取得するテーブルを定義できます。表示されるRepository ブラウザで接続ノードを展開し、目的のサンプルセットを選択できます。

最後に、［Retrieve］プロセスから結果に出力をワイヤリングし、プロセスを実行してPaylocity を確認します。