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

杉本和也
杉本和也
リードエンジニア
CData API Server を使ってSharePoint Excel Services のデータの仮想OData API エンドポイントを作成して、SAP Build Apps からSharePoint Excel Services のデータを使ったアプリを作成する方法。



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

CData API Server は、SharePoint Excel Services のデータの仮想OData インターフェースを提供し、SAP Build Apps からリアルタイムにSharePoint Excel Services のデータへ連携することができます。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなSharePoint Excel Services OData サービスを作成していきましょう。

SharePoint Excel Services への接続

SAP Build Apps からSharePoint Excel Services のデータを操作するには、まずSharePoint Excel Services への接続を作成・設定します。

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「SharePoint Excel Services」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、SharePoint Excel Services への接続設定を行っていきましょう! 接続設定
  5. ワークブックへの接続

    どちらのSharePoint エディションをお使いでも、File を Excel ワークブックに設定してください。このパスは以下のプロパティからの相対パスになります。

    • Library:デフォルトではShared Documents ライブラリが使用されます。このプロパティを使って、組織内の別のドキュメントライブラリを指定してみてください。例えば、OneDrive for Business に接続する場合は、このプロパティを"Documents" に設定します。
    • Folder:このプロパティを使って、ライブラリ内のサブフォルダへのパスを指定できます。パスはLibrary で指定されたライブラリ名に関連します。

    テーブルとしてのスプレッドシートデータへの接続

    CData 製品では、基底API で利用可能なオブジェクトに基づいて、使用可能なテーブルを検出していきます。

    API では異なるAPI オブジェクトを表示します。スプレッドシートの構成とSharePoint のバージョンに基づいてAPI を選択しましょう。

    • OData: OData API を使用すると、Excel で[挿入]->[テーブル]をクリックして作成されたExcel テーブルオブジェクト(範囲やスプレッドシートではありません)から定義されたテーブルにアクセスできます。OData API に接続する際、ワークブックにテーブルオブジェクトが定義されていない場合は、CData 製品がテーブルを返さないことがあります。テーブルとしてスプレッドシートまたは範囲に接続するには、UseRESTAPI をtrue に設定してください。
    • REST: REST API を使用すると、Excel テーブルオブジェクト、範囲、およびスプレッドシートから定義されたテーブルへアクセスできます。これがデフォルトの API です。範囲およびスプレッドシートから多数の行をリクエストすることは REST API によって制限されており、CData 製品では返される行数をデフォルトで 100 に制限しています。また CData 製品では、デフォルトで1行目からカラム名を検出します。これを無効にするには、Header を設定してください。

    DefineTables を追加設定すると、Excel の範囲の構文を使用して、範囲に基づいてテーブルを定義できます。大きすぎる範囲は、API によって制限されます。

    SharePoint オンプレミスへの接続

    URL をサーバー名もしくはIP アドレスに設定しましょう。さらに、SharePointVersion と認証値を設定します。

    SharePoint OnPremises を認証するには、AuthScheme を認証タイプに設定し、必要に応じてUserPassword を設定してください。

    Note:SharePoint On-Premises 2010 に接続する場合は、 UseRESTAPI をtrue に設定する必要があります。

      Windows(NTLM)

      最も一般的な認証タイプです。CData 製品では NTLM をデフォルトとして使用するよう事前設定されています。Windows のUserPassword を設定して接続してください。

      その他の認証方法については、ヘルプドキュメントの「はじめに」をご覧ください。

    • 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

ワークブックへの接続

どちらのSharePoint エディションをお使いでも、File を Excel ワークブックに設定してください。このパスは以下のプロパティからの相対パスになります。

  • Library:デフォルトではShared Documents ライブラリが使用されます。このプロパティを使って、組織内の別のドキュメントライブラリを指定してみてください。例えば、OneDrive for Business に接続する場合は、このプロパティを"Documents" に設定します。
  • Folder:このプロパティを使って、ライブラリ内のサブフォルダへのパスを指定できます。パスはLibrary で指定されたライブラリ名に関連します。

テーブルとしてのスプレッドシートデータへの接続

CData 製品では、基底API で利用可能なオブジェクトに基づいて、使用可能なテーブルを検出していきます。

API では異なるAPI オブジェクトを表示します。スプレッドシートの構成とSharePoint のバージョンに基づいてAPI を選択しましょう。

  • OData: OData API を使用すると、Excel で[挿入]->[テーブル]をクリックして作成されたExcel テーブルオブジェクト(範囲やスプレッドシートではありません)から定義されたテーブルにアクセスできます。OData API に接続する際、ワークブックにテーブルオブジェクトが定義されていない場合は、CData 製品がテーブルを返さないことがあります。テーブルとしてスプレッドシートまたは範囲に接続するには、UseRESTAPI をtrue に設定してください。
  • REST: REST API を使用すると、Excel テーブルオブジェクト、範囲、およびスプレッドシートから定義されたテーブルへアクセスできます。これがデフォルトの API です。範囲およびスプレッドシートから多数の行をリクエストすることは REST API によって制限されており、CData 製品では返される行数をデフォルトで 100 に制限しています。また CData 製品では、デフォルトで1行目からカラム名を検出します。これを無効にするには、Header を設定してください。

DefineTables を追加設定すると、Excel の範囲の構文を使用して、範囲に基づいてテーブルを定義できます。大きすぎる範囲は、API によって制限されます。

SharePoint オンプレミスへの接続

URL をサーバー名もしくはIP アドレスに設定しましょう。さらに、SharePointVersion と認証値を設定します。

SharePoint OnPremises を認証するには、AuthScheme を認証タイプに設定し、必要に応じてUserPassword を設定してください。

Note:SharePoint On-Premises 2010 に接続する場合は、 UseRESTAPI をtrue に設定する必要があります。

    Windows(NTLM)

    最も一般的な認証タイプです。CData 製品では NTLM をデフォルトとして使用するよう事前設定されています。Windows のUserPassword を設定して接続してください。

    その他の認証方法については、ヘルプドキュメントの「はじめに」をご覧ください。

    API Server のユーザー設定

    次に、API Server 経由でSharePoint Excel Services にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

    1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
    2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
    3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

    SharePoint Excel Services 用のAPI エンドポイントの作成

    ユーザーを作成したら、SharePoint Excel Services のデータ用のAPI エンドポイントを作成していきます。

    1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
    2. アクセスしたい接続を選択し、次へをクリックします。
    3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

    OData のエンドポイントを取得

    以上でSharePoint Excel Services への接続を設定してユーザーを作成し、API Server でSharePoint Excel Services データのAPI を追加しました。これで、OData 形式のSharePoint Excel Services データをREST API で利用できます。API Server の「API」ページから、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 API Server User のID とToken をそれぞれUsername・Passwordに入力します。 Base API URL はCData API Server のAPI タブにある「Base URL」で確認できます。これらを設定して「Verify URL」のボタンをクリックしましょう。
    3. すると自動的にCData API Server に登録されているAPI データモデルを読み取って、SAP Build Apps が扱いやすい形で「list」、「retreve」、「create」、「update」、「delete」処理が生成されます。
    4. 通常のREST API だと一つ一つ仕様を読み取って、登録していかなければいけないのですが、OData インターフェースに統一してくれるCData API Server を挟むことで、API の仕様を意識せず、SAP Build Apps で扱えるようになります。

    変数の定義

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

    1. 画面デザインページから「VARIABLES」に移動します。
    2. CData API 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 API 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. すると、SharePoint Excel Services からCData API Server 経由でデータを取得してきて、一覧表示を行った画面が表示されます。

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

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

詳細はこちら、または無料トライアルにお申し込みください:

CData API Server お問い合わせ