Mendix で Paylocity 連携アプリを構築

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
CData Connect AI を使って Paylocity のデータ用の OData フィードを作成し、Mendix でカスタムアプリを構築できます。

Mendix は、モバイルアプリとWeb アプリの両方を大規模に構築・保守できる高生産性アプリプラットフォームです。CData Connect AI と組み合わせることで、Mendix からクラウド間で即座にPaylocity のデータにアクセスできるようになります。この記事では、Mendix からCData Connect AI のデータソースに接続する方法を説明します。

CData Connect AI は Paylocity 専用のクラウド間インターフェースを提供し、ネイティブでサポートされているデータベースにデータをレプリケートすることなく、Mendix でリアルタイムのPaylocity のデータをインポートできます。Mendix でWeb およびモバイルアプリを構築する際、CData Connect AI はサポートされているすべてのSQL 操作（フィルター、JOIN など）を Paylocity に直接プッシュし、サーバーサイド処理を活用して必要なPaylocity のデータを迅速に返します。

Mendix 用に Paylocity への接続を設定

Mendix からPaylocity のデータを操作するには、Connect AI から Paylocity に接続し、接続へのユーザーアクセスを付与し、Paylocity のデータ 用のワークスペースを作成する必要があります。

Connect AI から Paylocity に接続

CData Connect AI は、シンプルなポイント＆クリック操作でデータソースに接続できるインターフェースを提供しています。

  1. Connect AI にログインして「Sources」をクリックし、 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. Save & Test をクリックします
  5. Add Paylocity Connection ページの「Permissions」タブに移動し、ユーザーベースの権限を更新します。

Personal Access Token の追加

REST API、OData API、またはVirtual SQL Server 経由でConnect AI に接続する場合、Personal Access Token（PAT）を使用してConnect AI への接続を認証します。アクセス管理の粒度を維持するために、サービスごとに個別のPAT を作成することをお勧めします。

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

Mendix 用に Paylocity エンドポイントを設定

Paylocity への接続後、対象テーブル用のワークスペースを作成します。

  1. 「Workspaces」ページに移動し、 Add をクリックして新しいワークスペースを作成します（または既存のワークスペースを選択します）。
  2. Add をクリックしてワークスペースに新しいアセットを追加します。
  3. Paylocity 接続（例：Paylocity1）を選択し、「Next」をクリックします。
  4. 操作したいテーブルを選択し、「Confirm」をクリックします。
  5. ワークスペースのOData サービスURL をメモしておきます。例：https://cloud.cdata.com/api/odata/{workspace_name}

接続、PAT、ワークスペースの設定が完了したら、Mendix からPaylocity のデータに接続する準備が整いました。

Paylocity 連携アプリの構築

OData メタデータファイルのダウンロード

Mendix で接続を作成する際、接続フローにはData Source Contract File が必要です。以下の手順に従って、curl（コマンドラインツール）を使用してCData Connect AI のOData メタデータファイルをダウンロードします：

  1. お使いのOS 用のコマンドラインウィンドウを開きます。Windows では、スタートメニューを開いて「cmd」と入力し、Enter キーを押してコマンドプロンプトを開きます。macOS およびLinux では、ターミナルウィンドウを開きます。
  2. curl がシステムにインストールされているか確認するには、「curl -help」と入力してEnter キーを押します。インストールされていない場合は、curl のWeb サイトからインストールしてください。
  3. 以下のcurl コマンドを実行します。USER をCData Connect AI のユーザー名に、PAT を先ほど生成したPAT に置き換えてください： 
    curl -u USER:PAT https://cloud.cdata.com/api/odata/{workspace_name}/$metadata -o metadata.xml
  4. curl コマンドで作成されたmetadata.xml ファイルを探し、アクセスしやすい場所に移動します。

Mendix からCData Connect AI に接続

以下の手順に従って、Mendix からCData Connect AI への接続を確立します：

  1. Mendix にログインし、Data Hub ページを開きます。
  2. 「Register a Data Source」セクションで「OData」を選択します。
  3. 上記の手順で取得したmetadata.xml ファイルをアップロードし、「Next」をクリックします。
  4. 「Data Source Name」と「Data Source Version」に希望する値を入力します。 「Data Source Relative Path」フィールドに「/api/odata/{workspace_name}」と入力し、「Next」をクリックします。
  5. 「Application information」ページで「Register a new application」をクリックします。
  6. 「Application Name」に名前を入力し、テクニカルオーナーを選択します（デフォルトでは現在ログインしているユーザーになります）。
  7. 「Next」をクリックします。「Environment Name」フィールドに希望する名前を入力します（例：CData Connect AI）。 「Environment Location」フィールドに「https://cloud.cdata.com」と入力し、必要に応じて適切な「Environment Type」（例：Production）を選択します。
  8. 「Done!」をクリックして接続を作成します。

これで、Mendix Studio Pro で接続を使用して、リアルタイムのPaylocity のデータにアクセスするアプリケーションを簡単に作成できるようになりました。

CData Connect AI の入手

クラウドアプリケーションから300以上のSaaS、Big Data、NoSQL ソースへのリアルタイムデータアクセスを実現するために、CData Connect AI を今すぐお試しください！

はじめる準備はできましたか？

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル お問い合わせ

この記事の内容

関連記事