OutSystems でPaylocity に接続されたエンタープライズアプリケーションを作成

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

OutSystems は、企業がオムニチャネルのエンタープライズアプリケーションを開発、展開、管理するためのツールを提供するローコードプラットフォームです。CData Connect Cloud と組み合わせると、ビジネスアプリケーション用にPaylocity データにクラウド上でアクセスできます。この記事では、Connect Cloud にPaylocity の仮想データベースを作成し、OutSystems でPaylocity データから単純なアプリを構築する方法を説明します。

Connect Cloud からPaylocity に接続する

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. Add Paylocity Connection ページのPermissions タブに移動し、ユーザーベースのアクセス許可を更新します。

パーソナルアクセストークンを追加する

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

1. User Profile ページでPersonal Access Token セクションにスクロールし、 Create PAT をクリックします。
2. PAT の名前を入力して Create をクリックします。
3. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

コネクションが構成されたら、OutSystems からPaylocity に接続できるようになります。

OutSystems からPaylocity に接続する

以下のステップでは、OutSystems からCData Connect Cloud に接続して新しいPaylocity データベース接続を作成する方法の概要を説明します。

1. OutSystems Service Studio を開きます。
2. 歯車アイコン をクリックし、Service Center のEnvironment Management を開きます。
3. Administration をクリックして「Database Connections」を選択します。
4. 「New Database Connection」をクリックします。
5. データベース接続を設定します。
   • Name：接続の名称（例：CData Connect Cloud Paylocity）
   • DBMS：SQL Server またはAzure SQL
   • Username：Connect Cloud ユーザー（例：user@mydomain.com）
   • Password：Connect Cloud ユーザーのPAT
   • Server：tds.cdata.com,14333
   • Schema：Paylocity コネクションの名前（例： Paylocity1）
6. 「Test Connection」をクリックします。
7. 「Create」をクリックします。

Paylocity テーブルまたはビューを拡張モジュールのエンティティにマップする

Paylocity のデータベース接続を作成したら、テーブルまたはビューをOutSystems のエンティティにマップする拡張機能を作成できます。作成していない場合は、Service Studio でアプリケーションを作成します。

1. Service Studio を開き、既存のアプリケーションを開きます。
2. 「Add Module」をクリックし、「Module Name」（例：paylocity_db_extension）を設定し、「Module Type」を「Extension」に設定して、「Create Module」をクリックします。
3. Integration Studio で、環境に接続します。
4. 拡張ツリーで「Entities」を右クリックし、「Connect to External Table or View...」を選択します。
5. ウィザードのステップに従って、使用するテーブルおよびビューを選択します。
6. Integration Studio で「1-Click Publish」をクリックします。
7. 「1-Click Publish」ウィザードでプロセスが完了したら、「Configure」をクリックします。
   • Service Center で、拡張機能の論理データベース名を、拡張機能が使用するデータベース接続に関連付け、「Apply」をクリックします。
8. アプリケーションで「Manage Dependencies...」をクリックします。
9. 拡張機能に依存関係を追加し、アプリケーションで使用するエンティティを選択します。

これで、標準のOutSystems エンティティと同じように、Paylocity データにアクセスして操作できます。

詳細と無償トライアル

Connect Cloud とOutSystems を使用すると、Paylocity に接続されたアプリケーションを簡単に構築できます。今すぐOutSystems のPaylocity データで作業を開始するには、Connect Cloud の無償トライアルにサインアップしてください。