サンドボックス ソリューションを SharePoint アドイン モデルに変換する

サンドボックス ソリューションの SharePoint アドイン モデルへの変換には、既存の拡張機能の分析、新しい SharePoint アドインの設計と開発、および運用環境でのアドインのテストと展開が含まれます。

SharePoint のコードベースのサンドボックス ソリューション

サンドボックス ソリューションとは、サイト コレクション レベルで SharePoint にカスタマイズを展開するために使用できる、カスタマイズ パッケージのことです。 サンドボックス ソリューションにコードが含まれている場合、そのコードは、SharePoint のサービスとコンテンツにアクセスする API の限定されたセットを使用して、特別に分離されたプロセスで実行されます。

サンドボックス ソリューションには、2 つの種類があります。

• コードベースのサンドボックス ソリューション (パッケージ内にカスタム アセンブリが含まれているもの)
• 宣言的なサンドボックス ソリューション (XML ベースの構成と関連アセットのみが含まれているもの)

宣言的な (XML ベースの) サンドボックス ソリューションは、ユース ケースに応じて、次の種類にさらに分割できます。

• サイト テンプレート: 「テンプレートとしてサイトを保存」機能を使用して既存のサイトから生成されます。
• デザイン パッケージ: デザイン マネージャーを使用して、発行サイトから生成されます。
• カスタム サンドボックス ソリューション: アセットのブランド化などを目的として、Visual Studio で作成されます (アセンブリは含まれていません)。

コードベースのサンドボックス ソリューションは、ユース ケースに応じて、次の種類にさらに分割できます。

• 空のアセンブリを含む宣言型サンドボックス ソリューション
• コード使用した InfoPath フォームを含むサンドボックス ソリューション
• Web パーツ、イベント レシーバー、フィーチャー レシーバーなどのカスタマイズを含むコードベースのサンドボックス ソリューション
• カスタム ワークフロー アクションを含むサンドボックス ソリューション

サンドボックス ソリューションからの移行を計画している場合は、特定のソリューションの機能要件とビジネス要件を評価し、その評価に基づいて今後の設計方針を決定する必要があります。

変換プロセスの計画

サンドボックス ソリューションを SharePoint アドイン モデルに変換する場合は、ユーザーへの影響が最小限に抑えられるようにします。 現在のサンドボックス ソリューションを慎重に分析してから、組織のニーズを満たすように新しい SharePoint 用アドインを設計します。 次に示すプロセスで、変換が成功したことを確認するようお勧めします。

準備状況

以下について調べます。

• SharePoint アドイン モデル、さまざまな種類のアドイン、およびホスティング オプション。 詳細については、「SharePoint アドイン」および「Office 365開発」および「SharePoint PnP ソリューションのガイダンス」を参照してください。

ソリューションの評価

以下のようにして、機能要件とビジネス要件を分析します。

• 現在の環境に展開済みのサンドボックス ソリューションを特定します。SharePoint PnP チームからオープン ソースとして提供されている次のツールのいずれかを使用することができます。

  • SharePoint サンドボックス ソリューション スキャナーまたはビデオ: さまざまなオプションと詳細なインベントリを提供するツール。
  • 特定のサンド ボックス ソリューションのインベントリ スクリプト: 基本的なインベントリを提供する PowerShell スクリプト。

• ユーザーとともに要件を確認します。 日常業務を実行するために、既存のサンドボックス ソリューションをどのように使用しているかについて、ユーザーに示してもらうことを検討します。

• Identifying, documenting, and designing new functionality to include in the new SharePoint アドイン . Consider reviewing your list of new feature requests from your users for additional ideas.

• 未使用の機能を特定し、新しい SharePoint アドインではその機能を省略することをユーザーと合意します。

• ソリューションごとに、SharePoint アドインに置き換えるか、すぐに使用できる機能または代替ソリューションを使用して実装するかを決定します。

ソリューションの計画

以下に基づき、SharePoint アドイン モデルを使用して新しいアプリケーションを設計します。

• ソリューションの評価手順で収集した要件。

• 既存コードの分析。 コード分析の実行中に、削除可能なコード部分を特定することを検討します (コードが使用されなくなった、または要件が変更されたなど)。

アプリケーションの SharePoint アドイン モデル バージョンの開発とテスト

これは通常、変換プロセスにおいて最も時間のかかる手順です。

新しいアドインの展開

展開が安定していることを確認し、適切な情報をユーザーに送信します。

サンドボックス ソリューションのカスタマイズを置き換える

サンドボックス ソリューションに含まれている一般的なカスタマイズと、使用可能な変換オプションを以下に示します。 変換オプションの実例を確認できるように、カスタマイズの種類ごとに詳細が追加されています。

サイトからサンドボックス コードを削除する

既存のサンドボックス ソリューションをサイトで非アクティブにしても、宣言オプションを使用して展開されたアセットやファイルは削除されません。 サンドボックス ソリューションを使用して新しいコードベースの Web パーツを導入した場合、該当する機能はサイトから無効にされます。 つまり、ページは通常どおりに表示されます。そのため、ソリューションを非アクティブにしても、Web パーツなどのコードベースの機能を削除しなければ、エンド ユーザーに直接的な影響はありません。

コードベースのサンドボックス ソリューションのサポートを削除する

コードベースのサンドボックス ソリューションのサポートは、サンド ボックス ソリューション ベースのコードから実行するコードベースの操作を無効にすることにより、SharePoint Online から削除されます。 つまり、ご使用のサンドボックス ソリューションがソリューション ストアで明示的に非アクティブになるわけではありませんが、コードベースの操作すべてが実行できなくなります。 サンドボックス ソリューションは、ソリューション ギャラリーでは引き続きアクティブな状態のままです。 サンドボックス ソリューションを使用して展開された機能は自動的に非アクティブになります。つまり、機能の非アクティブ化やアンインストール ハンドラーに関連付けられたコードが動作しない可能性があります。

サンドボックス ソリューション内のすべての宣言型定義は、SharePoint Online にこの変更が適用された後も引き続き動作します。

このセクションの内容

• Web パーツを置き換える
• イベント レシーバーを置き換える
• フィーチャー レシーバーを置き換える
• コードベースの InfoPath フォームを修正する

関連項目

• SharePoint Online のコードベース サンドボックス ソリューションを削除する
• Office 365 開発および SharePoint PnP ソリューション ガイダンス