製品をチェック

製品の詳細・30日間の無償トライアルはこちら

CData Connect

ノーコードアプリ開発ツールSAP Build Apps(AppGyver)でWorkday 連携アプリを作成

CData Connect Server を使ってWorkday データの仮想OData API エンドポイントを作成して、SAP Build Apps からWorkday データを使ったアプリを作成する方法。

杉本和也
リードエンジニア

最終更新日:2023-09-21
workday ロゴ

CData

connect ロゴ画像
SAP AppGyver ロゴ

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

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

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

ホスティングについて

Build Apps からCData Connect Server に接続するには、利用するConnect Server インスタンスをネットワーク経由での接続が可能なサーバーにホスティングして、URL での接続を設定する必要があります。CData Connect がローカルでホスティングされており、localhost アドレス(localhost:8080 など)またはローカルネットワークのIP アドレス(192.168.1.x など)からしか接続できない場合、Build Apps はCData Connect Server に接続することができません。

クラウドホスティングでの利用をご希望の方は、AWS MarketplaceGCP Marketplace で設定済みのインスタンスを提供しています。


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

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

  1. CData Connect Server にログインして、Databases をクリックします。 データベースを追加
  2. 利用できるデータソースアイコンから"Workday" を選択します。
  3. Workday に接続するために必要なプロパティを入力します。

    Workday 接続プロパティの取得・設定方法

    ここでは、4つのWorkday API の接続パラメータを設定する方法、およびTenant とBaseURL を取得する方法について説明します。必要なAPI のパラメータが設定され、カスタムOAuth および / またはAzure AD API クライアントを作成したら、接続の準備は完了です。

    接続の前提条件

    API / 前提条件 / 接続パラメータ
    WQL / WQL サービスを有効化(下記参照) / ConnectionTypeWQL
    Reports as a Service / カタログレポートの設定(ヘルプドキュメントの「データアクセスのファインチューニング」参照) / ConnectionTypeReports
    REST / 自動で有効化 / ConnectionTypeREST
    SOAP / 自動で有効化 / ヘルプドキュメントのWorkday SOAP API への認証を参照

    BaseURL およびTenant の取得

    BaseURL およびTenant プロパティを取得するため、Workday にログインしてView API Clients を検索します。 この画面では、Workday はBaseURLTenant の両方を含むURL であるWorkday REST API Endpoint を表示します。

    REST API Endpoint のフォーマットは、 https://domain.com/subdirectories/mycompany です。ここで、

    • https://domain.com/subdirectories/BaseURL です。
    • mycompany(URL の最後のスラッシュの後の部分)はTenant です。

    例えば、REST API エンドポイントがhttps://wd3-impl-services1.workday.com/ccx/api/v1/mycompany の場合、 BaseURLhttps://wd3-impl-services1.workday.com であり、Tenantmycompany です。

    WQL サービスを有効化

    Workday WQL API を介して接続するには、はじめにWQL Service を有効にする必要があります。

    1. Workday を開きます。
    2. 検索バーにView Domain と入力します。
    3. プロンプトにWorkday Query Language と入力します。
    4. Allowed Security Group Types のいずれかに、接続するユーザーが含まれていることを確認します。

    Workday への認証

    Basic 認証以外のほとんどのWorkday 接続では、認証のためにOAuth ベースのカスタムAPI クライアントアプリケーションを作成する必要があります。これには、ユーザーがAzure AD 資格情報を介して接続するエンタープライズインストールも含まれます。 Workday への認証につての詳細は、ヘルプドキュメントの「Workday への認証」セクションを参照してください。

    接続を設定

  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. すると、Workday からCData Connect Server 経由でデータを取得してきて、一覧表示を行った画面が表示されます。

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

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。