SaaS 連携データベース Yoom を使ってPaylocity データを使ったフローボットを作成する

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

Yoom は さまざまなSaaS とノーコードで連携し、業務を自動化するSaaS 連携データベースです。この記事では、CData Connect Cloud を経由して Yoom からPaylocity に接続し、Paylocity データを利用したフローボットを作成する方法を紹介します。

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

CData Connect Cloud の設定

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

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 をクリックします。

パーソナルアクセストークン（PAT）の取得

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン（PAT）を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

1. Connect Cloud アプリの右上にあるユーザー名をクリックし、User Profile をクリックします。
2. User Profile ページで、Personal Access Tokens セクションまでスクロールし、Create PAT をクリックします。
3. PAT に名前を付け、Create をクリックします。
4. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

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

Yoom でフローボットを作成

Web API の準備が整ったので、Yoom にてフローボットの作成を進めていきます。

1. まず、Yoom にログインします。
2. フローボットを新規作成します。

ループ設定

フローボットのトリガー設定後、プロセスを作成します。まずはデータを複数行データベースに追加するため、ループ処理を設定します。ループを件数分実行するための一意のデータをPaylocity から取得します。

1. CData Connect Cloud コネクタを利用して、Paylocity データを取得します。＋ ボタンでプロセスを追加し、オペレーションタイプの選択から「アプリと連携する」を選択します。
2. アプリ一覧から「CData Connect」を選択します。
3. アカウント情報を登録します。アクセストークンに、Connect Cloud のアカウント（メールアドレス）とPAT をコロンで繋ぎ、Base64 エンコードしたものを設定します。
4. アクション選択では、「レコードの一覧を取得」を選択します。アクション設定画面では、Connect Cloud のOData で設定したテーブル名を設定します。アウトプットを追加し、データをリスト形式で取得する設定をします。JSONPath には「$.value[*].カラム名」を指定します。
5. データ取得設定を保存し、ループ処理（同じ処理を繰り返す）を追加します。

ループで利用したデータを元に他カラムのデータを取得

ループで利用した一意のデータをキーにして、Paylocity の他カラムのデータを取得します。

1. ループ分岐の右側のフローでアプリ連携のプロセスを追加し、「特定のレコードを取得」アクションを設定します。
2. プライマリーキーの値を設定します。「アウトプットを入力」から「ループ変数」を選択します。
3. アウトプットを設定します。入力形式はテキスト、JSONPath は「value[0].カラム名」を設定します。

Yoom データベースに追加

Yoom データベースに取得したデータを追加する処理を作成します。

1. オペレーションタイプの選択から「データベースを操作する」を選択し、データベース一覧からYoom データベースを選択します。
2. データベースとテーブルを指定し、実行アクションで「レコードを追加する」を選択します。
3. データ取得時に設定したアウトプットを、データベースのカラムに設定します。

フローボットの完成

Paylocity データをYoom データベースに追加するフローボットが完成しました。

1. フローボットを実行し、Yoom データベースにPaylocity データが追加されることを確認します。

このように、CData Connect Cloud を経由することで、API 側の複雑な仕様を意識せずにSaaS と連携したフローボットをYoom で作成できます。。他にも多くのデータソースに対応するCData Connect Cloud の詳細をこちらからご覧ください。