UI/UX 特化ローコード開発ツール NEXACRO BEYOND を使ってPaylocity と連携したアプリを開発する方法

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

NEXACRO BEYOND は UI/UX に特化したローコード開発ツールおよびその実行基盤です。この記事では、CData Connect Cloud を経由して NEXACRO BEYOND からPaylocity に連携し、アプリを開発する方法を紹介します。

CData Connect Cloud は、Paylocity のデータのクラウド to クラウドの仮想OData インターフェースを提供し、NEXACRO BEYOND からリアルタイムにPaylocity データへ連携することができます。

CData Connect Cloud とは？

CData Connect Cloud は、以下のような特徴を持ったクラウド型のリアルタイムデータ連携製品です。

• SaaS やクラウドデータベースを中心とする150種類以上のデータソース
• BI、アナリティクス、ETL、ローコードツールなど30種類以上のツールやアプリケーションから利用可能
• リアルタイムのデータ接続に対応。データの複製を作る必要はありません
• ノーコードでシンプルな設定

詳しくは、こちらの製品資料をご確認ください。

Connect Cloud を構成する

NEXACRO BEYOND でPaylocity のデータをリアルタイムで操作するには、Connect Cloud からPaylocity に接続し、コネクションにユーザーアクセスを提供してPaylocity のデータのOData エンドポイントを作成する必要があります。

（オプション）新しいConnect Cloud ユーザーの追加

必要であれば、Connect Cloud 経由でPaylocity に接続するユーザーを作成します。

1. ユーザーページに移動し、 Invite Users をクリックします。
2. 新しいユーザーのE メールアドレスを入力して、 Send to invite the user をクリックします。
3. ユーザーページからユーザーを確認および編集できます。

パーソナルアクセストークンの追加

MotionBoard への接続には、パスワードの代わりとしてパーソナルアクセストークンを利用します。セキュアなアクセス管理を実現するには、サービスごとに個別のPAT を作成するのがベストプラクティスです。

1. Connect Cloud アプリの右上にある歯車アイコンをクリックします。
2. Settings ページで「Access Tokens」タブに移動し、 Create PAT をクリックします。
3. PAT の名前を入力して Create をクリックします。
4. パーソナルアクセストークンは作成時にしか表示されないため、コピーして安全に保存してください。

Connect Cloud からPaylocity に接続

CData Connect Cloud では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。

1. Connect Cloud にログインし、 Add Connection をクリックします。
2. Add Connection パネルから「Paylocity」を選択します。
3. 必要な認証プロパティを入力し、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 を設定することを意味します。

4. Create & Test をクリックします。
5. Edit Paylocity Connection ページのPermissions タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect Cloud にPaylocity OData エンドポイントを追加する

Paylocity に接続したら、目的のテーブルのOData エンドポイントを作成します。

1. OData ページに移動し、 Add to create new OData endpoints をクリックします。
2. Paylocity コネクション（例：Paylocity1）を選択し、Next をクリックします。
3. 使用するテーブルを選択し、Confirm をクリックします。

コネクションとOData エンドポイントが構成されたら、NEXACRO BEYOND からPaylocity に接続できるようになります。

プロジェクトの作成

Web API の準備が整ったのでNEXACRO BEYOND によるアプリケーション開発を進めていきます。NEXACRO BEYOND のアプリケーションは NEXACRO Studio というツールを用いて開発します。

1. まず、NEXACRO Studio を立ち上げて新しいプロジェクトを作成しましょう。
2. 任意の名称でProject を作成します。
3. 作成するアプリケーションの種類は今回はDesktop としました。
4. Template から「Full」を選択して、「Finish」をクリックします。

Form の作成

プロジェクトを作成したら、一覧画面を表示するためのForm を作成しておきます。

1. 「File」→「New」→「Form(.xfdl)」を選択し
2. 任意の名称でEmpty Form を作成します。
3. 以下のようにフォームが表示できればOKです。

DataObject の作成

続いてWeb API との通信の部分を作り込んでいきます。NEXACRO BEYOND ではDataObject という機能を用いて、JSON フォーマットのWeb API との通信やデータ制御を行うようになっています。

1. まず「DataObject」を画面に配置します。
2. DataObject を配置すると、Invisible Object の一覧に配置したDataObject が表示されるので右クリックから「Edit」を選択します。
3. このJson Content Editor でJSON のオブジェクト構造を確認します。ここで先ほどCData Connect Cloud で定義したリソースのエンドポイントを指定します。その際にクエリパラメータでの認証も入力しておきましょう。
4. 併せて、今回はアプリケーションを実行したときに通信が行われるように「preload」を「true」に指定しておきました。

Dataset を構成する

今回は最終的に一覧画面を作るわけですが、一覧画面のコンポーネントはJSON のように不定形なオブジェクトだとバインディングすることができません。

そこで、一度DataObject を「Dataset」という画面上で利用できるオブジェクトにマッピングしてあげた上で、UI 上で表示できるようにします。

1. 「Dataset」を先ほどと同じように画面に配置します。
2. 作成したDataset の「binddataobject」で先ほど作成したDataObject を選択し、次に「dataobjectpath」を編集します。
3. 以下のようなData Path Editor という画面で、JSON のオブジェクト構造をどのようにマッピングするかを構成できます。
4. CData Connect Cloud で作成されたWeb API「$.value」というJSON Path でレコードに分解できます。そのため DataObject Path に「$.value [*]」と入力して、リロードし、各カラムをマッピングさせます。

Grid の作成

最後に一覧表示用のGrid を配置して、取得したデータを表示してみましょう。

1. Grid をキャンパス上に配置します。
2. Grid を配置後、先ほど定義したDataset をGrid 上にドラッグ・アンド・ドロップで持っていくと、以下のよう一覧画面が表示されます。

このように、CData Connect Cloud を経由することで、API 側の複雑な仕様を意識せずにAPI 連携アプリをNEXACRO BEYOND で開発できます。他にも多くのデータソースに対応するCData Connect Cloud の詳細をこちらからご覧ください。