Appsmith で Paylocity 連携アプリケーションを作成

Cameron Leblanc
Technology Evangelist

Appsmith でCData Connect AI を介して Paylocity のデータに接続し、Paylocity のデータにリアルタイムでアクセスできるカスタムビジネスアプリケーションを作成。

Appsmith は、チームがビジネスオペレーションを改善するためのUI を素早く簡単に構築できる、オープンソースの内部ツールビルダーです。CData Connect AI と組み合わせることで、ビジネスアプリケーションから Paylocity のデータに即座にアクセスできるようになります。この記事では、Connect AI を使用して Paylocity に接続し、Appsmith で Paylocity のデータから基本的なアプリケーションを作成するプロセスを説明します。

CData Connect AI は、Paylocity への純粋なSQL Server のクラウドtoクラウドインターフェースを提供し、Appsmith 内からライブ Paylocity のデータを直接使用してビジネスアプリケーションを作成できます。ネイティブデータベースへのデータレプリケーションは必要ありません。アプリケーションを構築する際、Appsmith はデータを収集するためのSQL クエリを生成します。CData Connect AI は、最適化されたデータ処理機能により、フィルタやJOIN を含むすべてのサポートされるSQL オペレーションを Paylocity に直接送信します。これにより、サーバーサイドの処理を活用して、リクエストされた Paylocity のデータを迅速に取得できます。

Appsmith 用に Paylocity への接続を構成

Appsmith から Paylocity への接続は、CData Connect AI を介して行います。Appsmith から Paylocity のデータを操作するには、まず Paylocity 接続を作成して構成します。

Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします

Add Connection パネルから「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 を設定することを意味します。
Save & Test をクリックします
Add Paylocity Connection ページのPermissions タブに移動し、User-based permissions を更新します。

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

REST API、OData API、またはVirtual SQL Server を介してConnect AI に接続する場合、パーソナルアクセストークン（PAT）を使用してConnect AI への接続を認証します。アクセスの粒度を維持するために、サービスごとに個別のPAT を作成することをお勧めします。

Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
設定ページで、Access Tokens セクションに移動し、 Create PAT をクリックします。
PAT に名前を付けて、Create をクリックします。
パーソナルアクセストークンは作成時にのみ表示されるため、必ずコピーして安全な場所に保存してください。

接続が構成され、PAT が生成されたので、Appsmith から Paylocity のデータに接続する準備が整いました。

ライブ Paylocity のデータからAppsmith アプリケーションを作成

Appsmith からCData Connect AI Virtual SQL Server への接続を確立するには、以下の手順に従います。

Appsmith で Paylocity に接続

Appsmith インスタンスにログインし、新しいアプリケーションを作成します。
新しいアプリケーションで、Data ページを開き、Bring your data を選択します。
このページで、Microsoft SQL Server を検索し、データソースとして選択します。
新しいデータソースの名前を入力し、以下の接続設定を入力します。
- Host address: tds.cdata.com
- Port: 14333
- Database name: 接続するCData Connect AI データソースの接続名を入力します（例：Paylocity1）。
- Username: CData Connect AI のユーザー名を入力します。これはCData Connect AI インターフェースの右上に表示されます。例：test@cdata.com。
- Password: 先ほど生成したPAT を入力します。
Test configuration をクリックして接続が成功したことを確認し、Save をクリックしてデータソースを保存します。

新しいクエリを作成

データソースへの接続を構成したら、SQL クエリを追加してデータソースから実際にデータを取得します。

新しいデータソースの画面で、New Query をクリックします。
クエリエディタが開き、データを選択するSQL クエリを入力できます。SQL クエリの指定については、CData Connect AI のExplorer を使用して、SQL クエリと取得するデータをプレビューできます。
SQL クエリを作成したら、Appsmith のクエリエディタに戻り、SQL クエリを入力してRun をクリックします。
クエリが正常に実行されたら、あとは取得したデータを表示するためのページをセットアップするだけです。