Dataiku からリアルタイム Paylocity データを使って AI/ML モデルを構築

Dibyendu Datta
Lead Technology Evangelist

CData JDBC Driver for Paylocity を使って Paylocity データを Dataiku に接続。

Dataiku は、データの準備、分析、可視化、AI/ML モデルのデプロイメントに利用されるデータサイエンスおよび機械学習プラットフォームです。チームでの協業と効率的なデータドリブンな意思決定を可能にします。CData JDBC Driver for Paylocity と組み合わせることで、Dataiku は Paylocity のデータのデータ連携、データ準備、リアルタイム分析、そして信頼性の高いモデルデプロイメントをさらに強化します。

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

この記事では、Dataiku DSS（Data Science Studio）プラットフォームで CData JDBC Driver for Paylocity を使って Paylocity に簡単に連携する方法を紹介します。データの準備やカスタム AI/ML モデルの構築を行いましょう。

Dataiku DSS 環境の準備

このセクションでは、先に紹介した Dataiku を Paylocity のデータ向けにセットアップする方法を説明します。事前に、お使いのオペレーティングシステムに対応した Dataiku DSS（オンプレミス版）をインストールしておいてください。

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

まず、Dataiku と同じマシンに CData JDBC Driver for Paylocity をインストールします。JDBC Driver は以下のパスにインストールされます：

C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.paylocity.jar

Dataiku DSS での JDBC Driver 接続設定

Dataiku で CData JDBC Driver を使用するには、新しい SQL データベース接続を作成し、DSS の接続設定で JDBC Driver の JAR ファイルを追加する必要があります。

Dataiku DSS プラットフォームにログインします。ブラウザでローカルに開きます（例：localhost:11200）。
プラットフォームの右上にある Navigate to other sections of Dataiku メニューをクリックし、Administration を選択します。
Connections タブを選択します。
Connections 画面で New Connections ボタンをクリックします。
スクロールして Other SQL databases を選択します。
Paylocity に接続するための JDBC URL を生成します。jdbc:paylocity: で始まり、その後にセミコロン区切りの接続文字列プロパティを続けます。

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 ファイルをダブルクリックするか、コマンドラインから実行してください。
```
java -jar cdata.jdbc.paylocity.jar
```
接続プロパティを入力し、接続文字列をクリップボードにコピーします。

一般的な JDBC URL は次のようになります：
```
jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;
```
New SQL database (JDBC) connection 画面で、New connection name フィールドに名前を入力し、基本パラメータを指定します：
- JDBC Driver Class：cdata.jdbc.paylocity.PaylocityDriver
- JDBC URL：前のステップで取得した JDBC 接続 URL
- Driver jars directory：システム上で JAR ファイルがインストールされているフォルダパス
次に、SQL dialect を選択します。ここでは「SQL Server」を選択しています。Create をクリックします。接続が成功すると、「Connection OK」というメッセージが表示されます。
Data Catalog ウィンドウが表示されます。Connection to browse、Restrict to catalog、Restrict to schema ドロップダウンから目的の接続、カタログ、スキーマを選択し、List Tables をクリックします。Dataiku プラットフォームに必要なテーブルがすべて一覧表示されます。
一覧からテーブルを選択し、Preview をクリックしてテーブルデータを表示します。Close をクリックしてウィンドウを閉じます。

新しいプロジェクトの作成

Dataiku DSS プラットフォームでデータフローの準備、ダッシュボードの作成、Paylocity のデータの分析、AI/ML モデルの構築を行うには、まず新しいプロジェクトを作成する必要があります。

Navigate to other sections of Dataiku メニューから Projects を選択します。
Projects 画面で New Project をクリックし、+ Blank Project を選択します。
New Project ウィンドウで、Name と Project Key を入力します。Create をクリックすると、新しいプロジェクトのダッシュボードが開きます。
プロジェクト画面上部のメニューから Notebooks を選択します。
+ Create Your First Notebook ドロップダウンメニューをクリックし、Write your own オプションを選択します。
New Notebook ウィンドウで SQL を選択します。
Connection ドロップダウンから必要な接続を選択し、Notebook Name フィールドに名前を入力します。