IBM SPSS Modeler にPaylocity のデータをシームレスに読み込む方法

IBM SPSS Modeler とCData ODBC ドライバを使ってPaylocity のデータを取り込む方法をご紹介します。

杉本和也
リードエンジニア
最終更新日：2023-10-01

この記事で実現できるPaylocity 連携のシナリオ

CData

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

本記事では、データサイエンティスト向けのツールとして有名なIBM SPSS Modeler でCData Driver を利用し、各種クラウドサービスのデータを取り込み、予測モデル作成につなげる方法を紹介したいと思います。

IBM SPSS Modeler とは？

IBMが提供するビジュアル・データサイエンスと機械学習（ML）のソリューションです。

https://www.ibm.com/jp-ja/products/spss-modeler SPSS公式ウェブサイト

SPSS Modeler はローコードで予測モデルの作成およびモデルの作成に必要なデータ加工などのプレパレーションを実施できます。今回の記事では、このSPSS Modeler にPaylocity のデータを取り込んでみたいと思います。データの取得ができれば、予測モデルの作成などに自在に活用できます。

連携シナリオ

さて、今回の記事ではSPSS からPaylocity に接続していきますが、このときに必要となるのがCData ODBC ドライバです。

SPSS にはODBC を経由して他サービスに接続する機能が標準提供されています。この機能とCData が提供しているODBC Drivers ラインナップを組み合わせることで、各種クラウドサービスのAPI やデータベースにシームレスにアクセスすることができるようになります。

とは言っても、説明だけではイメージできない部分もあると思うので、実際に連携を試してみましょう。

CData Paylocity ODBC Driver のインストール

最初にCData Paylocity ODBC Driver を対象のマシンにインストールします。

以下のページから30日間のトライアルがダウンロードできます。

Paylocity ドライバーページ

インストーラーを入手後、対象のマシンでセットアップを進めていきます。

セットアップが完了すると接続設定画面が表示されるので、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 を設定することを意味します。

あとは「接続のテスト」ボタンをクリックし、接続が成功したら、「接続ウィザード」の「OK」ボタンをクリックして保存します。

接続完了後、メタデータタブから利用できるテーブル・ビューの情報を確認できます。

ここで予めPaylocity のどのオブジェクト、項目を利用するか確認しておくと良いでしょう。