Power Apps でSharePoint のデータを連携利用
MS PowerApps は、データに連携するモバイルおよびタブレット向けアプリをドラッグ&ドロップとリッチな関数で実現します。CData API ServerとADO.NET Provider for SharePoint (もしくは250+ の他のADO.NET Providers)を組み合わせて使い、PowerApps のリモートデータソースへの連携機能を拡張することができます。PowerApps のCommon Data Service に別途データをコピーする必要はありません。CData API Server は、SharePoint のデータにデータベースのようなアクセスを可能にし、SaaS API やNoSQL をインメモリのSQL-92 エンジンで操作できるようにします。
CData API Server は、Swagger のメタデータ標準をサポートします。Azure App Service、Microsoft Flow、およびPowerApps でSwagger メタデータからのUI 生成やコード生成が可能です。Swagger 定義を使えば、PowerApps からSharePoint に連携する関数が生成できます。本記事では、それらの関数をPowerApps から使って、リモートのSharePoint に連携する方法を説明します。
SharePoint データ連携について
CData を使用すれば、SharePoint のライブデータへのアクセスと統合がこれまでになく簡単になります。お客様は CData の接続機能を以下の目的で利用しています:
- Windows SharePoint Services 3.0、Microsoft Office SharePoint Server 2007 以降、SharePoint Online を含む、幅広い SharePoint バージョンのデータにアクセスできます。
- 非表示カラムとルックアップカラムのサポートにより、SharePoint のすべてにアクセスできます。
- フォルダを再帰的にスキャンして、すべての SharePoint データのリレーショナルモデルを作成できます。
- SQL ストアドプロシージャを使用して、ドキュメントや添付ファイルをアップロード・ダウンロードできます。
多くのお客様は、SharePoint データをデータベースやデータウェアハウスに統合するために CData ソリューションを活用していますが、Power BI、Tableau、Excel などのお気に入りのデータツールと SharePoint データを統合しているお客様もいます。
お客様が CData の SharePoint ソリューションで問題を解決している方法については、ブログをご覧ください:Drivers in Focus: Collaboration Tools
はじめに
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなSharePoint OData サービスを作成していきましょう。
SharePoint への接続
PowerApps からSharePoint のデータを操作するには、まずSharePoint への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「SharePoint」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、SharePoint への接続設定を行っていきましょう!
-
Microsoft SharePoint への接続
URL の設定:
Microsoft SharePoint では、2つの範囲でデータを操作できます。グローバルなMicrosoft SharePoint サイト全体を対象にするか、個々のサイトのみを対象にするかを選択できます。
グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作したい場合は、URL 接続プロパティをサイトコレクションURL に設定しましょう。以下のような形式です。
https://teams.contoso.com
個々のサイトのリストおよびドキュメントのみを扱いたい場合は、URL 接続プロパティを個々のサイトURL に設定してください。以下のような形式です。
https://teams.contoso.com/TeamA
続いて、お使いの環境に適した認証プロパティを設定していきましょう。詳細な設定手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご参照ください。
Microsoft SharePoint Online
SharePointEdition を"SharePoint Online" に設定し、User およびPassword にはSharePoint へのログオンで使用するクレデンシャル(例:Microsoft Online Services アカウントのクレデンシャル)を設定します。
Microsoft SharePoint Online は様々なクラウドベースアーキテクチャをサポートしており、それぞれ異なる認証スキームが利用できます。
- Microsoft Entra ID(Azure AD)
- ADFS、Okta、OneLogin、またはPingFederate SSO ID プロバイダーを介したシングルサインオン(SSO)
- Azure MSI
- Azure パスワード
- OAuthJWT
- SharePointOAuth
Microsoft SharePoint オンプレミス
Microsoft SharePoint オンプレミスでは、多くのオンプレミス環境に対応した認証方式をサポートしています。
- Windows(NTLM)
- Kerberos
- ADFS
- 匿名アクセス
まずSharePointEdition を"SharePoint On-Premises" に設定しましょう。
Windows(NTLM)認証
これは最も一般的な認証方式です。そのため、CData 製品ではNTLM をデフォルトとして使用するよう事前設定されています。Windows のUser およびPassword を設定するだけで接続できます。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
Microsoft SharePoint への接続
URL の設定:
Microsoft SharePoint では、2つの範囲でデータを操作できます。グローバルなMicrosoft SharePoint サイト全体を対象にするか、個々のサイトのみを対象にするかを選択できます。
グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作したい場合は、URL 接続プロパティをサイトコレクションURL に設定しましょう。以下のような形式です。
https://teams.contoso.com
個々のサイトのリストおよびドキュメントのみを扱いたい場合は、URL 接続プロパティを個々のサイトURL に設定してください。以下のような形式です。
https://teams.contoso.com/TeamA
続いて、お使いの環境に適した認証プロパティを設定していきましょう。詳細な設定手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご参照ください。
Microsoft SharePoint Online
SharePointEdition を"SharePoint Online" に設定し、User およびPassword にはSharePoint へのログオンで使用するクレデンシャル(例:Microsoft Online Services アカウントのクレデンシャル)を設定します。
Microsoft SharePoint Online は様々なクラウドベースアーキテクチャをサポートしており、それぞれ異なる認証スキームが利用できます。
- Microsoft Entra ID(Azure AD)
- ADFS、Okta、OneLogin、またはPingFederate SSO ID プロバイダーを介したシングルサインオン(SSO)
- Azure MSI
- Azure パスワード
- OAuthJWT
- SharePointOAuth
Microsoft SharePoint オンプレミス
Microsoft SharePoint オンプレミスでは、多くのオンプレミス環境に対応した認証方式をサポートしています。
- Windows(NTLM)
- Kerberos
- ADFS
- 匿名アクセス
まずSharePointEdition を"SharePoint On-Premises" に設定しましょう。
Windows(NTLM)認証
これは最も一般的な認証方式です。そのため、CData 製品ではNTLM をデフォルトとして使用するよう事前設定されています。Windows のUser およびPassword を設定するだけで接続できます。
API Server のユーザー設定
次に、API Server 経由でSharePoint にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
SharePoint 用のAPI エンドポイントの作成
ユーザーを作成したら、SharePoint のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でSharePoint への接続を設定してユーザーを作成し、API Server でSharePoint データのAPI を追加しました。これで、OData 形式のSharePoint データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
また、CORS を有効にして[Server]とクリックして次のセクションを定義する必要があります。[*]なしですべてのドメインを許可するオプションを選択することもできます。
- Access-Control-Allow-Origin:値を[*]またはAPI Server を呼び出すドメインに設定します。
- Access-Control-Allow-Methods:値を[GET,PUT,POST,OPTIONS]または使用する必要のあるHTTP メソッドに設定します。
- Access-Control-Allow-Headers:[x-ms-client-request-id, authorization, content-type]に設定します。
最後に、URL の一部としてauthtoken を渡すことにより、ユーザーが認証できるようにAPI Server を構成する必要があります。そのために、インストール先のwww/app_data フォルダに移動し、settings.cfg ファイルを変更して[Application] セクションに次の行を追加します。
AllowAuthTokenInURL = true
Swagger メタデータの取得
メタデータを使用してCustom API 接続を作成します。Swagger 定義を取得するには、ブラウザで次の要求を行い、結果のJSON ファイルを保存します。
http://MySite:MyPort/api.rsc/$oas?version=2
API Server を介してSharePoint に接続
以下のステップで、リモートSharePoint を検索する簡単なアプリを作成する方法を説明します。
- Microsoft Power Apps で、[Custom connectors]をクリックします。
- [Create custom connector]をクリックし、[Import an OpenAPI]ファイルを選択します。
- コネクタに名前を付け、JSON ファイルを参照して[Continue]をクリックします。
- 関連する一般情報を入力し、ベースURL が/api.rsc/@myauthtoken (myauthtoken はconfigure API Server ユーザーのAuthToken) の形式であることを確認して[Continue]をクリックします。
- Authentication タイプには[No authentication]を選択します。[Continue]をクリックします。
- アクションと参照の定義を確認し、[Create connector]をクリックします。
- コネクタをテストするには、新しい接続を作成する必要があります。[Test]をクリックし、[Connections]の下の[New Connection]をクリックして[Create]を選択します。
- [Custom connectors]メニューからコネクタに戻り、[Test]をクリックします。ここから使用可能な操作をテストできます。
データソースをPowerApp に接続
以下のステップに従って、PowerApp からSharePoint に接続します。
- Power Apps のメインメニューから[Create an app]をクリックし、オンプレミスまたはクラウドのPowerApp Studio を選択します。
- 空のアプリを選択し、携帯レイアウトまたはタブレットレイアウトのどちらかを選択します。
- [View]タブで[Data Sources]をクリックし、[Add Data Source]をクリックします。
- 作成した接続をクリックしてコネクタをテストします。
ギャラリーの事前設定
以下のステップに従って、SharePoint を検索できる簡単なアプリを作成します。Power Apps の数式を使用してSharePoint の行をギャラリーコントロールの行にバインドします。
[View]タブで[Gallery]->[Vertical]をクリックしてギャラリーを追加します。
-
ギャラリーを選択し、ギャラリー設定の[Advanced]タブでギャラリーの[Items]プロパティをSharePoint に割り当てます。以下の式を使用すると、MyCustomList テーブルの例にアクセスできます。
ForAll(CDataSwaggerAPI.getAllMyCustomList().value, {myName: Name, myRevenue: Revenue}) -
要素をクリックし、[Text]プロパティ(UI 要素の[Advanced]タブ) をThisItem.myName またはThisItem.myRevenue に設定してSharePoint 列をUI 要素に割り当てます。
SharePoint のデータの検索
ギャラリーに表示されるレコードをフィルタリングするには、[Screen]にTextInput を追加し、TextInput の[Text]プロパティをクリアしてギャラリーの[Items]プロパティを以下のような式にます。また、必要に応じてTextInput1 をギャラリーのTextInput コントロール名に置き換えます。
If(IsBlank(TextInput1.Text),
ForAll(CDataSwaggerAPI.getAllMyCustomList().value, {myName: Name, myRevenue: Revenue}),
ForAll(CDataSwaggerAPI.getAllMyCustomList({'$filter':Concatenate("contains(Name,",TextInput1.Text,")")}).value, {myName: Name, myRevenue: Revenue}))
この式は、API Server がリモートSharePoint に対して実行するOData クエリを作成し、最初にすべてのレコードをアプリに取り込むことをせずに現在のデータに対して検索が実行されるようにします。 サポートされているOData の詳細については、API Server のヘルプドキュメントを参照してください。
SharePoint のデータの編集
以下のステップに従って、ギャラリーで選択されたSharePoint レコードのフィールドを表示する編集可能な画面をロードします。
- [Insert]タブで、[New Screen]->[Blank]とクリックし、スクリーンの名前を[Details]に設定します。
- ギャラリーを新しいスクリーンに結び付けます。ギャラリーの最初のエントリで矢印ボタンを選択し、[Advanced]プロパティの[OnSelect]フィールドに以下のように入力します。
Navigate( Details, None )
- [Details]スクリーンの[Insert]タブで、[Id]と[Id]値の別のラベルを追加します。[Text]プロパティをBrowseGallery.Selected.Id に設定します。
各カラムについて、以下のことを行う必要があります。Custom API の場合、フォーム要素はAPI Server に対してどのリクエストを作成する必要があるかを検出できないため、データ変更式を手動で書く必要があることに注意してください。
- フィールドのラベルを追加します。
- [Text]メニューからのテキスト入力を画面に追加し、text プロパティをギャラリーから選択したアイテムの値に設定します。(例: BrowseGallery.Selected.myName).
アプリに基本的な更新機能とナビゲーションを提供するには、[Submit]ボタンと[Back]ボタンを追加します。
- [Submit]ボタンでOnChange プロパティを以下のように設定します。
CDataSwaggerAPI.updateMyCustomList(BrowseGallery.Selected.myId,BrowseGallery.Selected.myId,{Name:TextInput1.Text,Revenue:TextInput2.Text}) - [Back]ボタンの場合は、[OnSelect]フィールドを以下のように設定します。
Navigate( BrowseScreen, None )
これで、モバイルアプリまたはタブレットアプリでSharePoint を参照、検索、更新できるようになりました。