SharePoint アドインモデルにおける Feature Stapling

[アーティクル]
04/08/2023

新しい SharePoint アドインモデルにおいて、SharePoint サイトがプロビジョニングされているときにコードの実行や成果物の展開に使用するアプローチは、完全信頼コードの場合とは異なります。一般的な完全信頼コード (FTC) / ファームソリューションシナリオでは、機能の関連付けによって標準のサイト定義を変更していました。 SharePoint サイトに関連する成果物、構成、およびブランド化資産は機能によってパッケージ化および展開され、機能はサイト定義に関連付けられました。その後、関連付けられた機能はサイトプロビジョニングによって自動的にインストールされ、アクティブ化されました。

SharePoint アドインモデルシナリオでは、機能の関連付け、アドインの関連付け、または SharePoint クライアント側オブジェクトモデル (CSOM) を使用して、サイトコレクションとサブサイトを作成および構成した後、成果物、構成、およびブランド化資産をそこに展開することができます。このパターンは、一般的にリモートプロビジョニングパターンと呼ばれます。

基本ガイドライン

サイトコレクションとサブサイトを作成および構成した後、成果物、構成、およびブランド化資産をそこに展開する方法については、経験に基づく次のような大まかなガイドラインが提供されています。

機能の関連付けを引き続き使用する唯一の方法は、機能をサイトコレクションに関連付け、サイト定義および関連付けられた機能をサンドボックスソリューションによって展開することです。
テナント展開型モデルで機能の関連付けに似た機能を実装するには、アドインの関連付けを使用できます。
リモートプロビジョニングパターンを使用して機能の関連付けに似た機能を実装するには、リモート API によって標準のサイト定義上で追加の機能をアクティブ化します。

サイトコレクションとサブサイトを作成および構成した後、成果物、構成、およびブランド化資産をそこに展開するためのオプション

サイトコレクションとサブサイトを作成および構成した後、成果物、構成、およびブランド化資産をそこに展開するためのオプションは複数あります。

機能を関連付ける
アドインを関連付ける
リモートプロビジョニングパターンを使用する

機能を関連付ける

このパターンでは、機能をサイト定義に関連付けます。

このパターンは、サイトコレクションレベルでのみ行うことができます。
機能をサブサイトに関連付けることはできません。
廃止されたサンドボックスソリューションが使用され、アップグレードに対応できないため、これは推奨される最適なアプローチではありません。

適切な場合

オンプレミス SharePoint 環境でレガシーコードを移行しており、コードを適切に書き直す時間がない場合。

作業の開始

次の記事では、サイト定義に機能を関連付ける方法について説明しています。

SharePoint アドインモデルにおける Feature Stapling

アドインを関連付ける

このパターンでは、アプリカタログに保存されているアドインを、特定のサイトコレクション、管理パス、サイトテンプレートに展開します。

アドインの関連付けモデルの詳細については、「"アプリの関連付け" による SharePoint 2013 アプリの展開 (MSDN ブログ記事 - Richard DiZerega)」を参照してください。
アドインは管理者によってプッシュされるため、サイト所有者は展開の基準を満たすサイトからアドインを削除することはできません。サイトコレクション管理者であっても、アドインを削除することはできません。
この一元的な展開では、同じ一元的なアドインリソース (アドイン Web とリモート Web) も共有されます。基本的に、アドインは展開されますが、サイトにはインストールされません。すべてのサイトで、アプリカタログにインストールされたインスタンスからアドイン Web とリモート Web が利用されます。
一元的な展開のため、HandleAppInstalled、HandleAppUninstalled、HandleAppUpgrade などのリモートイベントは、1 回のみ (アドインがアプリカタログにインストールされる際に) 起動されます。
- アドインの関連付けパターンを使用して変更をアドインの展開先のサイトに自動的に適用することは、サイトへのアドインの展開時にこれらのイベントが起動されないため、難しくなる可能性があります。
アドインがサイトに関連付けられている場合、アドインパーツはサポートされません。
このパターンでは、ユーザーの手動アクションによってアドインを配置する必要があります。

リモートプロビジョニングパターンを使用する

このパターンでは、SharePoint クライアント側オブジェクトモデル (CSOM) を使用して、サイトコレクションとサブサイトを作成および構成した後、成果物、構成、およびブランド化資産をそこに展開します。

このパターンでは、成果物、構成、ブランド化資産を個別の機能やアドインにパッケージ化する必要はありません。すべてが 1 つのアドインにパッケージ化される場合があります。
このパターンをサイトプロビジョニングに使用する場合、通常は標準のページをオーバーライドして新しいサイトを作成します。
このパターンの詳細については、「サイトプロビジョニング (SharePoint アドインレシピ)」を参照してください。
アドインを SharePoint サイトに配置するには、CSOM を使用することができます。 .app マニフェストファイルを使用して Office アドインを読み込んで SharePoint サイトにインストールする例を以下に示します。
```
//Create a FileStream object to access the Mail Office Add-in .app file
using (FileStream fsSource = new FileStream(System.Web.Hosting.HostingEnvironment.ApplicationPhysicalPath + "Innovation.Management.AFO.app",
  FileMode.Open, FileAccess.Read))
  {
//Return the subweb where you want to install the Add-in
      var subweb = ctx.Web;
      ctx.Load(subweb);
      ctx.ExecuteQuery();

//Load and Install the Add-in on the subweb
      AppInstance appInstance = subweb.LoadAndInstallApp(fsSource);
      ctx.Load(appInstance);
      ctx.ExecuteQuery();
  }
```
- サイトプロビジョニングでこのアプローチを使用して Office アドインを SharePoint サイトにインストールする方法については、「Office、O365、Azure、および WP8 用のアドインによるクラウドホスト型の基幹業務アプリケーションの作成 (Todd Baginski、Michael Sherman - SharePoint Conference 2014)」ビデオをご覧ください。
- 完全な自動化は、完全なテナントアクセス許可を持つ信頼済みのアドインでのみ可能です。
- 例については、Core.Sideloading (O365 PnP サンプル) をご覧ください。

PnP サンプル

適用対象

Office 365 マルチテナント (MT)
Office 365 専用 (D)
SharePoint 2013 オンプレミス

SharePoint アドイン モデルにおける Feature Stapling