Connect Cloud 経由でRunMyProcess のPaylocity のデータに接続

こんにちは！テクニカルディレクターの桑島です。

Akorbi Digital RunMyProcess は、予算申請や契約管理などの複雑な業務アプリケーションを簡単に作成することができます。CData Connect Cloud は、Paylocity へのリアルタイム接続を作成し、Paylocity のOData API（RunMyProcess でネイティブにサポート）を生成するために使用できます。RunMyProcess をCData Connect Cloud と組み合わせすることで、すべてのSaaS およびクラウドベースのビッグデータとNoSQL データソースへ、データを移行したり統合したりする必要なくクラウドベースの接続が可能になります。ほかのREST サービスと同様に、RunMyProcess からConnect Cloud に接続するだけで、Paylocity のデータに瞬時にリアルタイムでアクセスできます。

この記事では、CData Connect Cloud からPaylocity に接続し、RunMyProcess でOData フィードを通じてPaylocity にアクセスする手順を説明します。

Connect Cloud を構成する

RunMyProcess で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 フィードのサンプルURL

Paylocity への接続を構成してユーザーを作成し、Connect Cloud でOData エンドポイントを作成すると、Paylocity のデータのOData フィードにアクセスできるようになります。 以下は、テーブルにアクセスするためのURL とテーブルのリストです。テーブルへのアクセスについては、Connect Cloud のOData ページを参照してください。URL については、Connect Cloud のURL が必要になります。（例： https://cloud.cdata.com/api/odata/service）

通常のOData フィードについては、返されるフィールドを制限したい場合は、クエリに$select パラメータと$filter、$orderby、$skip、$top といった他の一般的なOData URL パラメータを組み合わせて追加できます。 サポートされているOData クエリの詳細についてはヘルプドキュメントを参照してください。

コネクションとOData エンドポイントを設定したら、RunMyProcess からPaylocity のデータに接続できます。

RunMyProcess DigitalSuite Studio からPaylocity のデータを取得する

Paylocity への接続と構成されたOData エンドポイントがあれば、RunMyProcess にPaylocity のデータを追加して取得することができます。

Provider を作成する

1. RunMyProcess にログインしDigitalSuite Studio を開きます。
2. 「Resources」をクリックしてResources ページを立ち上げ、「CONNECTORS」タブを選択します。
3. 新規プロバイダーを作成する場合は、「+（New Provider）」ボタンをクリックし、使用するアカウントを選択し、「Confirm」をクリックします。
4. 設定ページで次のプロパティを設定します。
   • URL：Connect Cloud OData ページのOData エンドポイントを設定します。https://cloud.cdata.com/api/odata/service
   • Authentication Schema：ログイン / パスワードを選択します。
   • Login：Connect Cloud のユーザー名を指定します。（例：user@mydomain.com）
   • Password：Connect Cloud ユーザーのPAT を指定します。
   
5. 「ACCEPTANCE」、「TEST」タブにも同じ情報を入力します。Note：その際、「Copy this configuration button」ボタンをクリックすることで設定をコピーでき、コピー先のタブで「Paste previously copied configuration」をクリックして内容をペーストできます。
6. 「Save」をクリックしてプロパティを保存します。

コネクタを作成してPaylocity のデータを取得する

1. 「CONNECTOR」タブで三点リーダーをクリックし、プロバイダーを作成します。メニューからAdd を選択します。
2. 次に示すページでは、Connect Cloud で設定されたOData エンドポイントにConnector URL を設定する方法を説明します。（例： https://cloud.cdata.com/api/odata/service）
3. 「Save」、「Launch」の順でクリックし接続の実行をテストします。「Launch test」をクリックして実行します。設定したテーブル情報のJSON レスポンスが得られれば、処理は成功です。

詳細と無料トライアル

これで、Paylocity のデータを取得するためのプロバイダーとコネクタが作成されました。Paylocity（および100を超えるほかのデータソース）からのOData フィードの作成方法の詳細については、Connect Cloud ページにアクセスしてください。無償トライアルにサインアップして、RunMyProcess でリアルタイムPaylocity のデータの操作をはじめましょう。