ローコードアプリ開発プラットフォームOutSystems でSharePoint Excel Services 連携アプリを作成

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



OutSystemsは、アプリケーションをUI 上で開発できるローコード開発プラットフォームです。この記事では、CData API Server を経由して OutSystems からSharePoint Excel Services に連携するアプリを作成する方法を説明します。

CData API Server は、SharePoint Excel Services のデータのクラウド to クラウドの仮想OData インターフェースを提供し、OutSystems からリアルタイムにSharePoint Excel Services のデータへ連携することができます。さらに、CData API Server は OpenAPI の定義ファイルを取得できるため、OutSystems で自動的にREST API Method を定義してスムーズにアプリ開発を行うことができます。

API Server の設定

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

SharePoint Excel Services への接続

OutSystems から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 を認証タイプに設定し、必要に応じてUser と Password を設定してください。

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

      Windows（NTLM）

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

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

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

ワークブックへの接続

どちらの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 を認証タイプに設定し、必要に応じてUser と Password を設定してください。

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

    Windows（NTLM）

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

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

    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. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
    4. 併せて OutSystemsにAPIリクエストの仕様を取り込むためにAPI ページ（https://myserver/api.rst#oas）にある「Open API」のファイルを以下から保存しておきましょう。

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

    以上でSharePoint Excel Services への接続を設定してユーザーを作成し、API Server でSharePoint Excel Services データのAPI を追加しました。これで、OData 形式のSharePoint Excel Services データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

    OutSystems にCData API Server のコネクションを追加

    続いてCData API Server への接続をOutSystems に追加します。OutSystems では RESTインターフェースを用いてCData API Server に接続します。

    1. 「Logic」タブから「Integrations」→「REST」を右クリックし「Consume REST API…」を選択します。ここから外部のREST APIのメソッドをコールする処理・Logic を登録できます。
      2. Consume REST API
    2. 今回は先程取得したOpen API Spec の情報を元に Logic を登録するので「ADD MULTIPLE METHODS」を選択し
      3. ADD MULTIPLE METHODS
    3. 保存したOpen API Spec のファイルを「UPLOAD FILE」から選んで「ADD METHODS」をクリックして登録します。
      4. Open API Spec ファイルのアップロード
    4. すると以下のようにOpen API Spec のファイルを元に、メソッド一覧が出てくるので任意のメソッドを選択して「FINISH」をクリックします。
      5. REST API Method 一覧
    5. これで CData API Server へのLogic を登録できました。
      6. Logicの登録を確認
    6. Logic の登録が完了すると、併せて Data のタブのStructures にデータモデルが登録されます。
      7. Structures データモデルの確認
    7. なお、これだけでは認証が通らないので、先程 CData API Server で登録したユーザーのID とToken をBasic Authentication のUsername とPassword に登録しましょう。
      8. 認証情報の設定

    一覧画面を作成

    それでは実際に CData API Server と連携した画面を作成していきましょう。

    1. 「Interface」タブに移動して「Add Screen」をクリックします。
      2. Screen の追加
    2. Screenのテンプレートは「Empty」で進めます。
      3. Screen テンプレートの選択
    3. Screenを登録したら、登録した対象のScreenから右クリックで「Fetch Data from Other Source」を選択します。これを先程登録したCData API Server の Logic と紐付けて、画面上からAPIをコールしてデータを表示します。
      4. Fetch Data From Other Source
    4. まず、利用するData Type を関連付けましょう。Out1のパラメータを選択して「Data Type」から CData API Server のAPI から生成されている Structures にあった一覧画面を取得するメソッドのレスポンスにあたるデータモデルを関連付けます。
      5. Data Type の関連付け
    5. そして、「Fetch Data from Other Source」のフローにCData API Server から全データを取得するメソッドをドラッグアンドドロップで配置します。
      6. メソッドを配置
    6. 取得したレスポンスは「Assign」機能を使って、Out1のパラメータに格納します。
      7. レスポンスをアサイン
    7. これでデータ取得周りの処理が完成です。あとはUI 部品として「Table」をScreen 上に配置し
      8. Table の配置
    8. Out1で定義したレスポンスデータモデルをドラッグ・アンド・ドロップで配置します。
      9. レスポンスデータモデルをTable と紐付け
    9. 「Sort Attribute」にある「value.」の部分は不要なので消してしまいましょう。
      10. 不要なAttribute の削除
    10. これだけで、CData API Server と連携した画面が作成できました。それでは画面中央上にある「Publish」ボタンをクリックして、動かしてみましょう。
      11. Publish ボタンのクリック
    11. 正常に起動すると、以下のような画面がブラウザで表示するので、登録したアカウントでログインします。
      12. OutSystems へのログイン
    12. 一覧画面が表示されて、以下のようにCData API Server 経由で取得したSharePoint Excel Services のデータがきれいに表示されました。
      13. 作成した画面のプレビュー

    クラウドアプリケーションからSharePoint Excel Services のデータにOData API アクセスを実現

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

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

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

CData API Server お問い合わせ

この記事の内容

関連記事