Mendix のローコード開発プラットフォームで Paylocity のデータを使ったアプリを構築

Dibyendu Datta
Lead Technology Evangelist

CData JDBC Driver for Paylocity を使って Paylocity のデータと Mendix を連携し、アプリを構築。

Siemens 社が開発した Mendix は、Web およびモバイルアプリケーションを迅速に開発、テスト、デプロイするためのローコードプラットフォームです。デジタルトランスフォーメーションの推進とビジネスのアジリティ向上を実現します。CData JDBC Driver for Paylocity と組み合わせることで、Mendix Studio Pro を使って Paylocity のデータを活用したさまざまなアプリケーションを作成できます。

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

この記事では、Mendix が提供する JDBC インターフェースと CData JDBC Driver for Paylocity を組み合わせて、Paylocity のデータを活用したアプリケーションを Mendix で簡単に作成する方法を紹介します。

Mendix 環境の準備

このセクションでは、先ほど紹介した Mendix Studio Pro を使用して、Paylocity のデータを使ったアプリを開発する方法を説明します。事前に Mendix Studio Pro をインストールしておいてください。

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

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

C:\Program Files\CData\CData JDBC Driver for Paylocity 20xx\lib\cdata.jdbc.paylocity.jar

アプリケーションの作成

それでは、アプリの作成を始めましょう。まず、Database Connector が利用可能なアプリを作成します。

Mendix Studio Pro を起動し、「Create New App」をクリックします。
「Blank Web App」オプションを選択します。
「Use this starting point」をクリックして続行します。
任意の名前でアプリを作成します。また、後で参照するために「Disk location」の情報をメモしておきましょう。
これで新しいアプリが作成されました。

アプリケーションに Database Connector を追加

次に、作成したアプリに Database Connector モジュールを追加します。

右上の Marketplace ボタンをクリックします。
Marketplace の検索セクションで Database Connector を検索し、選択します。
Download をクリックして、最新の Database Connector をダウンロードします。
Import Module ウィンドウで、Action として Add as a new module を選択します。
アプリ画面に Database Connector が表示されれば、次のステップに進む準備が整いました。

Mendix Studio Pro への JDBC ドライバーの追加

この Database Connector で CData JDBC ドライバーを使用するには、JDBC ドライバーの JAR ファイルをプロジェクトに追加する必要があります。

先ほどメモした Mendix プロジェクトフォルダ内に「userlib」というフォルダがあります。そのフォルダに「cdata.jdbc.paylocity.jar」と「cdata.jdbc.paylocity.lic」の2つのファイルを配置します。
これで、Database Connector で CData JDBC ドライバーを使用できるようになりました。

データモデルの作成

それでは、アプリを作成していきましょう。まず、Database Connector からデータを読み込み、一覧画面に表示するためのデータモデルを定義します。データを読み込む前に、データモデルを作成しておきます。

MyFirstModule の「Domain model」に Entity を追加します。
Entity 名とフィールド定義を入力します。
DBeaver などのツールを使用して、CData JDBC ドライバー経由でテーブル定義情報を確認すると、データの設定を簡単に行えます。
Entity を定義します。

JDBC URL 用の定数を作成

次に、Database Connector で使用する JDBC URL の定数を作成します。

MyFirstModule に「Constant」を追加します。
Add Constant ウィンドウで定数に名前を付けます。
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 ドライバーに組み込まれている接続文字列デザイナーが便利です。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。
```
java -jar cdata.jdbc.paylocity.jar
```
接続プロパティに値を入力し、接続文字列をクリップボードにコピーします。

一般的な JDBC URL は以下のとおりです。
```
jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;
```
前のステップでコピーした接続文字列を Default value セクションに入力し、OK をクリックします。

Paylocity のデータを取得するマイクロフローの作成

作成した Entity に基づいて、Database Connector からデータを取得するマイクロフローを作成しましょう。

MyFirstModule から「Add microflow」をクリックします。
任意の名前でマイクロフローを作成します。
まず、先ほど定義した Entity 用のオブジェクトを作成します。マイクロフローに「Create Object」アクションを追加します。
Create Object ウィンドウで、Entity の「Select」ボタンをクリックします。
先ほど定義した Entity を選択します。
任意の Object name を入力し、OK をクリックします。
次に、Database Connector からデータを取得するために、マイクロフローに Execute Query アクションを追加します。
Execute Query ウィンドウで各入力項目を定義します。
「jdbc url」には、先ほど定義した定数を指定します。
SQL には、Paylocity からデータを取得するクエリを記述します。
今回は Username と Password は不要なので、「empty」に設定し、前のフローで作成したオブジェクトを Result object として割り当てます。List Name セクションには任意の名前を指定します。
最後に、マイクロフローの出力を定義します。
End Event をダブルクリックして開き、Type ドロップダウンから「List」を選択し、先ほど定義した Entity とリンクします。次に、Execute Query の出力結果を Return value として設定します。
これで、Paylocity からデータを取得するマイクロフローが完成しました。

一覧画面の作成とマイクロフローへのリンク

最後に、マイクロフローから取得した結果を表示する画面を作成しましょう。

Toolbox メニュー内の「Home_web」をダブルクリックして開きます。
Data containers セクションから Data grid テンプレートをドラッグ＆ドロップして一覧画面に配置します。
Data grid を配置したら、ダブルクリックして Edit Data Grid 設定画面を表示します。
Data source タブに移動し、データソースタイプを Microflow とリンクします。
先ほど作成したマイクロフローを選択します。
OK をクリックします。
OK をクリックすると、カラムの自動検出を促すメッセージが表示されます。「Yes」をクリックして続行します。
次に、各 Data grid 用のコントローラーを生成するかどうかを確認するメッセージが表示されます。今回は各ロジックを設定しないので、「No」をクリックします。
以下のようなシンプルな Data grid 画面が作成されます。

動作確認

それでは、正しく動作するか確認しましょう。

「Publish」ボタンをクリックして、作成したアプリを準備します。完了したら、「View App」をクリックしてアプリを開きます。
以下のような Paylocity のデータの一覧が表示されれば成功です！Paylocity の API を意識することなく、ローコードで Paylocity と連携したアプリを作成できました。