EC 特化ノーコードツール TēPs（テープス）を使ってPaylocity のデータをkintone に連携：CData Connect Cloud

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

TēPsは、API を介して EC モール、受注管理システム、Google スプレッドシートやチャットツールなど、日々の業務で利用するさまざまなサービスや機能を自由に組み合わせ、プログラミングの知識や経験がなくても、自社独自の業務を自動化できるiPaaS です。

そんなTēPs はAmazon セラーセントラルやYahoo! ショッピング、ShopifyといったEC 系のコネクタが多数提供されていましたが、CData Connect Cloud 向けのコネクターを提供しています。本記事ではこのCData Connect Cloud のコネクタを使ってPaylocity のデータをkintone に連携する手順を解説します。

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

CData Connect Cloud の設定

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

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

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

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

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

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

1. Connect Cloud アプリの右上にあるユーザー名をクリックし、User Profile をクリックします。
2. User Profile ページでPersonal Access Token セクションにスクロールし、 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 エンドポイントを設定したら、TēPs からPaylocity データに接続できます。

フレーズを作成

それではTēPs 側で連携用のフレーズ（一連の処理をまとめたもの）を作成していきましょう。

1. フレーズ一覧画面で「＋」ボタンをクリックし
2. 任意の名前のフレーズを作成します。今回は定期的に実行するフレーズとして構成していきます。

CData Connect Cloud の接続を追加する

フレーズを作成したら処理を追加していきます。

1. 最初にPaylocity からデータを取得するので「＋」ボタンから「CData Connect Cloud」→「OData テーブルを検索」を指定します。ちなみに「OData テーブルレコードを取得」はキーを元に1レコードだけ取得する処理になります。
2. 「OData テーブルを検索」を追加したらコネクションを追加します。
3. 以下の画面でCData Connect Cloud のメールアドレスとPATを指定して「アカウントを追加」をクリックしましょう。
4. コネクションを設定するとOData テーブルが選択できるようになります。一覧から先程追加したテーブルを指定しましょう。
5. ちなみに「OData テーブルを検索」は様々な条件でデータが取得できます。

ループ処理の追加

次に取得したテーブルデータをループする処理を追加します。

1. 新しい処理から「フロー」→「ループ」を選択します。
2. ループを追加したら、シーケンスで「OData テーブルを検索」からループする対象のリストを選びましょう。

kintone への登録処理を作成

最後にループの中でkintone への登録処理を作成します。

1. 新しい処理として「キントーン」→「レコードを登録」を追加します。
2. キントーンへのコネクションを追加します。
3. 「サブドメイン」「アプリID」「APIトークン」を指定してコネクションを作成します。
4. コネクションを作成すると、以下のようにkintone のアプリに存在する項目が表示されるので、CData Connect Cloud の項目をマッピングしていきましょう。

フレーズの実行

これでフレーズの作成は完了です。それでは画面右上の再生ボタンからフレーズを実行してみましょう。

1. 画面右上の再生ボタンをクリックします。
2. 以下のようにメッセージが表示されるので内容を確認して「実行」をクリックします。
3. 以下のように実行ログが表示されていき、無事kintone にデータが登録できました！

このように、CData Connect Cloudを経由することで、API 側の複雑な仕様を意識せずにTēPs 各種クラウドサービスと連携できます。他にも多くのデータソースに対応するCData Connect Cloud の詳細をこちらからご覧ください。