Apache Spark でPaylocity データをSQL で操作する方法

こんにちは！リードエンジニアの杉本です。

Apache Spark は大規模データ処理のための高速エンジンです。CData JDBC Driver for Paylocity と組み合わせると、Spark はリアルタイムでPaylocity データに連携して処理ができます。本記事では、Spark シェルに接続してPaylocity をクエリする方法について解説します。

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

CData JDBC Driver for Paylocity をインストール

まずは、本記事右側のサイドバーからPaylocity JDBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

Spark Shell を起動してPaylocity データに接続

1. ターミナルを開き、Spark shell でCData JDBC Driver for Paylocity JAR file をjars パラメータに設定します: $ spark-shell --jars /CData/CData JDBC Driver for Paylocity/lib/cdata.jdbc.paylocity.jar
2. Shell でJDBC URL を使ってPaylocity に接続し、SQL Context load() function でテーブルを読み込みます。

   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

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

   scala> val paylocity_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;").option("dbtable","Employee").option("driver","cdata.jdbc.paylocity.PaylocityDriver").load()
3. 接続が完了し、データがロードされたら、テーブルスキーマが表示されます。

4. Paylocity をテンポラリーテーブルとして登録します:

   scala> paylocity_df.registerTable("employee")

5. データに対して、次のようなカスタムSQL クエリを実行します。

   scala> paylocity_df.sqlContext.sql("SELECT FirstName, LastName FROM Employee WHERE EmployeeId = 1234").collect.foreach(println)

   コンソールで、次のようなPaylocity データを取得できました！これでPaylocity との連携は完了です。

CData JDBC Driver for Paylocity をApache Spark で使って、Paylocity に対して、複雑かつハイパフォーマンスなクエリを実行できます。30日の無償評価版 をダウンロードしてぜひお試しください。