SharePoint アドインの展開とインストール: 方法とオプション
この記事では、SharePoint アドインの公開のオプションと、インストールやアンインストールの方法の詳細について説明します。
Office ストアまたは組織のアドイン カタログに発行する
SharePoint アドインは、パブリック Office ストアまたは組織のプライベート アドイン カタログにアップロードできます。 プライベート アドイン カタログは、SharePoint アドインと Office アドインのドキュメント ライブラリをホストする SharePoint Web アプリケーション (または SharePoint Online テナント) の専用サイト コレクションです。カタログを独自のサイト コレクションに配置すると、Web アプリケーション管理者またはテナント管理者がカタログへのアクセス許可を制限しやすくなります。
アドインを Office ストアにアップロードする場合は、Microsoft がそのアドインについていくつかの検証チェックを実施します。 たとえば、アドイン マニフェストのマークアップが有効かつ完全であるかどうかをチェックし、アドインに含まれる SharePoint ソリューション パッケージ (.wsp ファイル) がある場合は、許可されていない要素や、スコープが Web よりも広い機能が含まれていないかを検証します。 パッケージのコンテンツについても、好ましくない内容が含まれていないか調べます。 アドインがすべてのテストに合格すると、アドイン パッケージは 1 つのファイルにラップされ、Microsoft によって署名されます。
注:
アドインを開発し、Microsoft Office Developer Tools for Visual Studio を使用して展開する場合、アドインはターゲットのテスト SharePoint サイトに直接インストールされます。 Office ストアを通過しないため、前述の検証チェックは行われません。
組織のアドイン カタログに SharePoint アドインをアップロードすることは、ファイルを SharePoint Foundation ドキュメント ライブラリにアップロードすることと同様に簡単です。 アドイン パッケージのローカル URL と、アドインの名前などの情報を、ポップアップ フォームに記入します。 アドインを組織のアドイン カタログにアップロードすると、同様のチェックが行われ、ここで不合格になったアドインは無効のマークが付けられるか、カタログで無効にされます。
テナント管理者や SharePoint Web アプリケーションの管理者は、Office ストアの SharePoint アドインを購入できます。 Office ストアを開くには、管理者が [サイト コンテンツ] ページの [アドインの追加] を選択し、[自分のアドイン] ページで [SharePoint ストア] を選択します。 これにより、[SharePoint ストア] ページが開き、管理者はこのページを使用して、ベンダーが提供している SharePoint アドインを探して調べることができます (これは office.com でも可能です)。
管理者の Web アプリケーションまたはテナントにインストールされていない前提条件を必要とするアドインは、アドイン ストアでは淡色表示され、選択できない状態になります。 たとえば、アドインが検索サービスを必要としており、これがインストールされていない場合は、そのアドインは淡色表示されます。 管理者は、アドインのリストの並べ替え、フィルター、参照、アドインについての確認、アドインのレビューの確認、アドインのライセンスの購入を行うことができます。
管理者がライセンスの購入を決定したときは、購入の契約条件に同意し、一覧への読み取りアクセスやサイト コレクションへのフル コントロールのアクセス許可など、アドインの実行に必要なアクセス許可に同意する必要があります。
1 つのアドインについて 1 つ以上のライセンスを購入すると、ライセンスは Web アプリケーションまたはテナントにダウンロードされます。 ライセンスを購入するときに、ライセンスの購入とインストールを組み合わせるオプションが提示されていても、アドインのダウンロードとインストールは自動的には行われません。
ユーザーは [ 自分のアドイン] ページからアドインをインストールします。 このページには、次の項目がマージされた一覧が表示されます。
- Web アプリケーション (またはテナント) の組織のアドイン カタログからの SharePoint アドイン。
- 組織またはテナントが既にサイト ライセンスまたはライセンスを所有しておりユーザーに割り当ててある、Office ストアの SharePoint アドイン。
ユーザーがすぐにインストールできるアドインがすべて一覧表示されます。 ユーザーは、ページに表示されるアドインをフィルター処理して、組織のアドイン カタログにあるアドインだけを表示することができます。 アドインがインストールされると、そのアドインがインストールされた Web サイトの [サイト コンテンツ] ページのアドインの一覧に表示されます。
SharePoint アドインをインストールする
Web サイトの所有者は、このトピックですでに説明したように、[ 自分のアドイン] ページから SharePoint アドインをインストールします。 インストールによって、アドインのインスタンスが作成されます。 アドインのインストールの詳細については、「 SharePoint サイトに SharePoint アドインを追加する」を参照してください。
注:
ネットワーク接続が一時的に失われた場合、インストールが妨げられることがあります。 何らかの理由でインストールが失敗した場合、インストール インフラストラクチャは 3 回再試行します。 それでも成功しない場合、失敗を表す表示が UI に表れます。 ユーザーは、後でインストールを再試行できます。
SharePoint アドインをアンインストールする
Web サイトの所有者は、SharePoint の UI を通じて SharePoint アドインのインスタンスをアンインストールできます。 SharePoint アドインのインスタンスのアンインストールはクリーンです。 つまり、アドインによってインストールされたものはすべてアンインストールされます。
ただし、アドインが使用するものの、アドインのインストールとは別にインストールされるコンポーネントは削除されません。 たとえば、アドインがリモート Web ページを持っており、ホスト Web にリストを作成するボタンがそのページに配置されているとします。 アドインをアンインストールすると、アドインのタイルが [サイト コンテンツ] ページから削除され、これによりエンド ユーザーがリモート ページにアクセスしたりこれを利用したりすることが事実上できなくなりますが、アドインと共に作成された一覧は削除されません。 SharePoint では、アドインと共に作成されたホスト Web 上の一覧や、SharePoint の UI でユーザーによって作成された一覧のレコードは保持されません。このため、アドインと共に作成された一覧を削除することはできません。 通常、一覧にはその一覧を作成したアドインを削除した後もユーザーに役立つデータが含まれている場合があるため、これは望ましい動作と言えます。
SharePoint アドインにアドイン Web が含まれる場合、そのアドイン Web は削除されます。 これにより、機能を体系的に非アクティブ化し、アドインの内部 .wsp ファイルの展開を元に戻すよりも、さらにクリーンなアンインストールが実現します。
注:
ユーザーがアドインを削除すると、第 1 段階のごみ箱に移動されます。 そこから削除すると、第 2 段階のごみ箱に移動されます。 第 2 段階のごみ箱から削除されると、完全にアンインストールされて復元できません。
次のルールに従って、アドインが削除 (リサイクル) された時点でそのアクセス許可も取り消されます。
- Web を対象範囲とするアクセス許可は必ず無効になります。
- サイト コレクション内にアドインの他のインスタンスが存在しない場合は、サイト コレクションを対象範囲とするアクセス許可も無効になります。
- サイト購読 (テナンシー) 内にアドインの他のインスタンスが存在しない場合は、テナント スコープ アクセス許可も取り消されます。
アドインのアドイン マニフェストに登録している場合、UninstallingEventEndpoint Web サービスが、アンインストール プロセス (アドインが第 2 段階のごみ箱から削除されたときに発生) の最初に実行されます。 ベスト プラクティスとしては、InstalledEventEndpoint Web サービスを使用している場合には UninstallingEventEndpoint Web サービスを使用し、UninstallingEventEndpoint サービスを設計して、ご使用の InstalledEventEndpoint サービスで実行されたことをすべて元に戻します。 詳細については、「SharePoint アドインのイベントを処理する」を参照してください。