MicroStrategy でCData JDBC Driver を使ってPaylocity に接続

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

MicroStrategy は、データ主導のイノベーションを可能にする、モビリティプラットフォームです。MicroStrategy をCData JDBC Driver for Paylocity とペアリングすると、MicroStrategy からリアルタイムPaylocity へのデータベースのようなアクセスが得られ、レポート機能と分析機能が拡張されます。この記事では、MicroStrategy Developer でPaylocity のデータベースインスタンスを作成し、Paylocity のWarehouse Catalog を作成します。

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

MicroStrategy Developer のPaylocity に接続

CData JDBC Driver for Paylocity に基づくデータベースインスタンスを追加することにより、MicroStrategy Developer のPaylocity に接続できます。^* 開始する前に、MicroStrategy Developer のインスタンスが接続されているMicroStrategy Intelligence Server をホストとするマシンにJDBC Driver for Paylocity をインストールする必要があります。

1. MicroStrategy Developer を開き、［Project Source］を選択します。
2. ［Administration］->［Configuration Managers］->［Database Instances］と進み、右クリックして新しいインスタンスを追加します。
3. インスタンスに名前を付け、データベース接続タイプとしてGeneric DBMS を選択し、新しいデータベース接続を作成します。
4. データベース接続ウィザードで接続に名前を付け、新しいデータベースログイン名を作成してPaylocity のユーザーとパスワードを設定します。
5. 接続ウィザードの［Advanced］タブで、追加の接続文字列パラメータを以下のように設定します。
   • JDBC キーワードを接続文字列に追加します。
   • MSTR_JDBC_JAR_FOLDER をJDBC ドライバーのJAR ファイルを含むディレクトリのパスに設定します。(C:\Program Files\CData JDBC Driver for Paylocity\lib\ on Windows.)
   • DRIVER をドライバークラスであるcdata.jdbc.paylocity.PaylocityDriver に設定します。
   • URL をPaylocity ドライバーの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 URL を構成する際に、Max Rows プロパティを定めることも可能です。これによって戻される行数を制限するため、可視化・レポートのデザイン設計時のパフォーマンスを向上させるのに役立ちます。

   以下は、一般的な追加の接続文字列プロパティです。

   JDBC;MSTR_JDBC_JAR_FOLDER=PATH\TO\JAR\;DRIVER=cdata.jdbc.paylocity.PaylocityDriver;URL={jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;};
6. ODBC データソースが選択されていないことを確認し、(これによりMicroStrategy がトリガーされ、追加の接続文字列パラメータを使用してデータベースインスタンスが構築されます)［OK］をクリックします。
7. ［OK］をクリックし、データベースインスタンスウィザードを閉じます。
8. ［Project Source］でプロジェクトを右クリックし、［Project configuration］を開きます。
9. ［Database Instances］に移動し、新しく作成したデータベースインスタンスを選択して［OK］をクリックします。
10. MicroStrategy Developerを閉じ、接続されたMicroStrategy Intelligence Server を再起動してデータベースインスタンスの作成を完了します。

データベースインスタンスを構成すると、Warehouse Catalog およびData Import からPaylocity に接続できるようになります。

Warehouse Catalog からPaylocity データに接続する

JDBC Driver for Paylocity に基づいてデータベースインスタンスを作成すると、Warehouse Catalog のデータに接続できます。

1. プロジェクトを選択し、［Schema］->［Warehouse Catalog］をクリックします。
2. ［Read Settings for the Catalog］で［Settings］をクリックし、スキーマを取得するためのクエリを設定します。
   • テーブルのリストを取得するには、以下のクエリを使用します。 SELECT * FROM SYS_TABLES
   • 選択したテーブルの例のリストを取得するには、以下のクエリを使用します。 SELECT DISTINCT CatalogName NAME_SPACE, TableName TAB_NAME, ColumnName COL_NAME, DataTypeName DATA_TYPE, Length DATA_LEN, NumericPrecision DATA_PREC, NumericScale DATA_SCALE FROM SYS_TABLECOLUMNS WHERE TableName IN (#TABLE_LIST#) ORDER BY 1,2,3
3. プロジェクトで使用するテーブルを選択します。

MicroStrategy のCData JDBC Driver for Paylocity を使用すると、Paylocity で安定したビジュアライズとレポートを簡単に作成できます。詳細については、MictroStrategy でのPaylocity への接続やMicroStrategy Desktop でのPaylocity への接続 に関するほかの記事をお読みください。

NoteJDBC Driver を使用して接続するには、3層から4層のアーキテクチャが必要です。