ノーコードアプリ開発ツールSAP Build Apps（AppGyver）でPaylocity 連携アプリを作成

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

SAP Build Apps（旧：AppGyver） は コーディングスキルを持たないユーザーでもWeb・モバイルアプリケーションを構築できるノーコード開発プラットフォームです。この記事では、CData Connect Server を経由して SAP Build Apps からPaylocity に連携するアプリを作成する方法を説明します。

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

Paylocity の仮想OData API エンドポイントを作成

まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。

1. CData Connect Server にログインして、Databases をクリックします。
2. 利用できるデータソースアイコンから"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. Test Database をクリックします。
5. Permission -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
6. API タブをクリックして OData API エンドポイントが生成されていることを確認します。

SAP Build Apps でアプリを作成する

それではSAP Build Apps 側でアプリ開発を開始します。

1. 「CREATE NEW」をクリックし、
2. 任意の名前でアプリを作成します。
3. これで以下のようにアプリの開発画面が立ち上がります。

OData Integration の登録

アプリを作成したら、まず SAP Build Apps アプリでAPI 連携処理を行うための設定を追加します。

1. 「DATA」タブから「OData Integration」を追加しましょう。
2. 「Authentication Type」は「Basic authentication」を選択し、先ほど作成したCData Connect Server User のID とToken をそれぞれUsername・Passwordに入力します。 Base API URL はCData Connect Server のAPI タブにある「Base URL」で確認できます。これらを設定して「Verify URL」のボタンをクリックしましょう。
3. すると自動的にCData Connect Server に登録されているAPI データモデルを読み取って、SAP Build Apps が扱いやすい形で「list」、「retreve」、「create」、「update」、「delete」処理が生成されます。
4. 通常のREST API だと一つ一つ仕様を読み取って、登録していかなければいけないのですが、OData インターフェースに統一してくれるCData Connect Server を挟むことで、API の仕様を意識せず、SAP Build Apps で扱えるようになります。

変数の定義

それでは作成した OData Integration 機能を使ってアプリを作っていきます。とはいえ画面を作成する前に、API 経由で取得したデータを格納する変数を登録しておきましょう。

1. 画面デザインページから「VARIABLES」に移動します。
2. CData Connect Server から取得するデータ構造に合わせて変数を定義します。List とObject 構造の組み合わせで構成しましょう。

一覧画面の構成

変数を定義したら一覧画面を構成しましょう。

1. 今回はCard 形式の画面を作成しますが、カードを繰り返し表示するためにまず「Container」を配置します。
2. このContainer の中にCard を配置することで、カードが繰り返し表示される画面が構成できます。
3. Card を配置後、Properties タブから「Repeat with」で先ほど作成した変数をバインドします。
4. 「Data and Vaiables」を選択し
5. 先ほど作成しておいたList の変数をバインドします。
6. List の変数をバインドすると、Card にあるTitle やContent にもバインドできるようになります。
7. 「Data item in repeat」でそれぞれの変数をバインドしましょう。

Logic の記述

最後にAPI から取得したデータを変数に格納するLogic を記述していきます。

1. 画面下にあるLogic タブを開いて、ページを開いたときのLogic にAPI からデータを取得する「Get record collection」の処理を追加します。
2. 「Get record collection」の処理には認証情報を設定する必要があるので「Authentication」をクリックします。
3. 今回は固定値として設定するので「Obejct with properties」を選択し
4. 「Authentication Type」から「basic」を選択した上で、CData Connect Server のID とAPI Token をそれぞれ設定して保存します。
5. 次に取得したレコードを変数に格納します。「Set page variable」をLogic に配置しましょう。
6. 「Set page variable」を配置したら一旦Logic のコンポーネントをそれぞれつなげます。これで値を「Get record collection」から引き継げるようになります。
7. それでは「Set page variable」の値の設定を行いましょう。「Assigned value」のボタンをクリックし、
8. 「Mapping」を選択します。
9. デフォルトでは以下のような画面になっているので「no value」のボタンをクリックし、
10. 「Output value of another node」をクリック。
11. 前のLogic から引き継いだ「Get record collection」を選択します。
12. これでMapping が行えるようになります。
13. ドラッグアンドドロップで取得したデータと変数をマッピングしましょう。ここで予め変数をList とObject 形式で構成していたことが活きてきます。

実行してみる

それでは作成したアプリを実際に動かしてみましょう。

1. 「LAUNCH」タブから「Open App Preview Portal」をクリックします。
2. 以下のようにアプリ一覧画面が立ち上がるので「CDataSample」をクリックします。
3. すると、Paylocity からCData Connect Server 経由でデータを取得してきて、一覧表示を行った画面が表示されます。

このように、CData Connect Server を経由することで、API 側の複雑な仕様を意識せずにAPI 連携をしたアプリをSAP Build Apps で開発できます。他にも多くのデータソースに対応するCData Connect Server の詳細を、こちらからご覧ください。