ドキュメント セット
最終更新日: 2013年6月24日
適用対象: SharePoint Server 2010
この記事の内容
機能の概要
コンテンツ タイプとオプション
設定
ウェルカム ページ
Microsoft Office SharePoint Server 2007 コンテンツ管理では、単一の文書よりも大きなコンテンツを管理する組み込みの方法はありません。Office SharePoint Server 2007 は、フォルダー、ドキュメント ライブラリなどの基本的なコンテンツ包含関係を提供します。しかし、これらは複数の文書を含む (あるいは複数の文書に及ぶ) 単一の成果物である作業生産物を管理するというよりも、リポジトリを整理し構成するよう意図されています。
ドキュメント セットは、作業生産物のすべての側面を管理するよう設計された、Microsoft SharePoint Server 2010 の新しい機能です。ドキュメント セットには、ドキュメントとサイトのコンテナーの階層構造のギャップを埋めるオブジェクト モデル要素、ユーザー インターフェイス (UI)、メタデータ オプション、動作が含まれます。DocumentSet オブジェクトをアップロードすると、ドキュメント ライブラリと同じように機能する Web パーツに表示されます。
作業生産物の例として、SharePoint Server 2010 で使用するカスタム Web パーツを作成する手順を挙げます。ビジネス要件の収集、仕様の作成、開発計画およびテスト計画の作成、UI 設計プロトタイプの作成などです。カスタム Web パーツは実体のある "マスター" 成果物アイテムですが、仕様、開発者計画およびテスト計画、UI 設計プロトタイプなどのすべての要件が成果物の重要な要素です。実体のある成果物は、Web パーツ開発プロセスの一部として作成される計画ドキュメントなしには、最終的な形になりません。ドキュメント セット機能は、"マスター" 成果物アイテムとともに、そのすべてが作業生産物の不可欠な要素である計画ドキュメントを管理するために使用することができます。
多くの組織がコンテンツを中心としたカスタム アプリケーションを作成していますが、ドキュメント セット機能は、組織がカスタム アプリケーションを置き換えることや可能であれば最小限のカスタマイズで済ませることができるように設計されています。要件としては、レコード管理、バージョン管理、リボンとの統合、テンプレート、ワークフロー、カスタム ドキュメント セット コンテンツ タイプを作成する方法などが含まれます。
ドキュメント セットは拡張することができます。SharePoint Server 2010 には、カスタム ドキュメント セット コンテンツ タイプを作成するための UI や、ドキュメント セットを表示および作成するためのユーザー設定可能なユーザー エクスペリエンス、およびドキュメント セットでのワークフローを作成するための機能が含まれます。
機能の概要
Microsoft SharePoint Server 2010 は、ドキュメント セットに対する組み込みサポートを提供します。これには、適切に作業生産物を管理するために必要なすべてのツールが既定で含まれます。ドキュメント セットはそのままで使用できるコンテンツ タイプであり、サイト コンテンツ ギャラリーの設定が変更、あるいはドキュメント セットがドキュメント ライブラリに追加されるときにカスタマイズできます。ドキュメント セットは、カスタム ドキュメント セット テンプレートのための基盤として使用することができます。
表 1. 機能のハイライト
機能のハイライト |
説明 |
|---|---|
新規ページ (newdocset.aspx)。 |
既定のドキュメント セット コンテンツ タイプのためのページ。既定の新規ページを使用するか、ドキュメント セットで使用する新規ページを作成して準備します。 |
ウェルカム ページ |
ドキュメント セットの内容とプロパティを表示します。現状のまま、あるいはカスタマイズして使用できる Web パーツ ページです。 |
バージョン管理 |
セットに含まれるドキュメントに対して使用可能なバージョン管理機能とは独立した、しかし相互運用できるバージョン管理機能が含まれます。ドキュメント セットは、通常のバージョン管理を使用し、ドキュメント セットのプロパティの現在の値を保存することにより、ドキュメントの現在のバージョンを示すスナップショットを取得します。 ドキュメント セットバージョン管理は加算的であり、個別のアイテムに対するバージョン管理を置換しません。その代わりに、ドキュメント セットのライフ サイクルを表示および管理する目的専用に設計された、追加のサポート層を提供します。 SharePoint Server 2010 リストのアイテムで、ユーザーがバージョン履歴を参照し、以前のバージョンのアイテムを操作できるようにするバージョン履歴ページがあるのと同じように、ドキュメント セットには、ユーザーがバージョン履歴を参照し、以前のバージョンのドキュメント セットに対して操作できるようにするバージョン履歴ページがあります。ドキュメント セット バージョンは、ドキュメント セットに関連付けられた一連の単純なメタデータで、[チェックインのコメント] テキスト フィールド、ドキュメント セットプロパティの概要ビュー、ドキュメント セットのプロパティに対する変更の概要ビューを含みます。また、ドキュメント セット バージョンが取得された時点の、選択された文書のどのバージョンが "最新" だったかを追跡します。 |
ワークフロー |
ドキュメント セットでのワークフローを作成するために使用するワークフロー アクティビティ。 SharePoint Designer 2010 では、ユーザーは SharePoint Server 2010 フォルダーに基づいてワークフローを関連付けて、実行することができます。ドキュメント セットは SPFolder オブジェクトの拡張機能なので、ユーザーはそれらにワークフローを関連付けて、実行することができます。SharePoint Server 2010 の共有フォルダーを表示中にドキュメント セットを使用する場合、ドキュメント セット ウェルカム ページ リボンの [ワークフロー] ボタンで処理するか、それぞれのドキュメント セット リスト アイテムの横のドロップダウン リストから [ワークフロー] を選択します。次に、ドキュメント セットに関連付けられているワークフローを実行して、ドキュメント セットについて、どのワークフローが現在実行中か、どのワークフローが完了しているかといった、ワークフローの詳細を表示することができます。ドキュメントを含むドキュメント セットに対してワークフローを実行することで、ドキュメント セットに含まれるその他のアイテムへのワークフローの実行が妨げられたり、干渉を受けたりすることはありません。SharePoint Server 2010 は、ドキュメント セットに対して動作する SharePoint Designer 2010 のワークフローを作成するのに役立つ組み込みワークフロー アクティビティと、セット内で複数のシナリオの要件を満たすアイテムを提供します。たとえば、コンテンツの作成、確認、承認などのドキュメント セットのためのアクティビティを管理するために組み込みのワークフローを使用することができます。さらに、これらのワークフローは、セット内の個別のアイテムに対してのみ作業する参加者と、ドキュメント セット全体で作業するワークフロー オーナーのための、適切なワークフロー状態とエクスペリエンスを可能にします。 |
フォルダー |
ドキュメント セットは、特殊な種類の SharePoint Server 2010 フォルダーで、SPFolder の機能とプロパティを継承し、使用します。ドキュメント セットは、一般的なフォルダーのプロパティと動作のすべてを継承し、基本的なフォルダー機能および動作に加えて、作業生産物管理のサポートのロジックが追加されています。フォルダーについての詳細は、SPFolder トピックを参照してください。ユーザーがドキュメント セットで作業する方法は、通常の SharePoint フォルダーで作業する方法に似ています。ドキュメント セットにアクセスできるユーザーは、ドキュメント セットで使用するために準備されたコンテンツ タイプに基づく任意のドキュメント、既定あるいはカスタマイズされた新規ページあるいはウェルカム ページ、関連付けられたメタデータを含め、セットのコンテンツを操作することができます。 |
コンテンツ タイプとオプション
新しいドキュメント セットを作成するとき、ドキュメント セット コンテンツ タイプのインスタンスを使用します。ドキュメント セット コンテンツ タイプは、以下を定義します。
DocumentSet オブジェクトのインスタンスで使用可能な動作と機能。
どの新規ページとウェルカム ページを使用するべきか、そのコンテンツ タイプとあわせてその他のどのコンテンツ タイプを使用するかなど、ドキュメント セットに関連付けられているコンテンツ タイプに固有の詳細。
カスタム ドキュメント セット コンテンツ タイプを作成するには、既定のドキュメント セット コンテンツ タイプの子を作成します。
表 2. ドキュメント セット コンテンツ タイプ要素
要素 |
説明 |
|---|---|
ドキュメント セット メタデータ スキーマ |
任意の SPFolder オブジェクトに対して指定されているルート DocumentSet オブジェクトで必須あるいは省略可能の列のセット。オブジェクト モデルあるいはコンテンツ タイプ [設定] ページを使用してこの要素をカスタマイズすることができます。 |
ワークフローの関連付け |
ルート DocumentSet オブジェクトのためのワークフロー関連付け。Microsoft SharePoint Designer 2010 を使用して、これらの関連付けを設定し、ドキュメント セットに対してワークフローを実行する機能を追加します。 オブジェクト モデルあるいはコンテンツ タイプ [設定] ページを使用してこの要素をカスタマイズすることができます。 |
ドキュメント セットのすべてのアイテムに同期させるメタデータのリスト |
セットのそれぞれのアイテムにコピーする必要があるドキュメント セット メタデータ スキーマの一部である列への参照。オブジェクト モデルあるいは [ドキュメント セット] コンテンツ タイプ [設定] ページを使用してこの要素をカスタマイズすることができます。 |
ドキュメント セットのアイテムで使用できるコンテンツ タイプのリスト |
このドキュメント セット コンテンツ タイプのアイテムのインスタンスで使用可能なコンテンツ タイプへの参照。 オブジェクト モデルあるいは [ドキュメント セット] コンテンツ タイプ [設定] ページを使用してこの要素をカスタマイズすることができます。 |
ドキュメント セット作成時にドキュメント セットで作成された既定のコンテンツ |
ドキュメント セットのすべてのインスタンスに対して、それが作成されるときに自動的にコピーあるいは追加される一連のファイル。 それぞれのファイルについて、SharePoint Server 2010 は、使用する適切なコンテンツ タイプを保存します。このコンテンツ タイプは、この DocumentSet オブジェクトに対して "許可された" コンテンツ タイプの 1 つとして UI で使用可能になります。 オブジェクト モデルあるいは [ドキュメント セット] コンテンツ タイプ [設定] ページを使用してこの要素をカスタマイズすることができます。 |
カスタム新規ページ URL |
指定された種類のドキュメント セットの [新規] ボタンをユーザーがクリックしたときに表示されるカスタム ページに使用する URL。 この要素は、オブジェクト モデルを使用することによってのみカスタマイズすることができます。 |
(省略可能) カスタムウェルカム ページ URL |
ユーザーがドキュメント セットのトップレベル (ルート) フォルダーに移動するときに表示される、ウェルカム ページを示す URL。 カスタムウェルカム ページがある場合は、SharePoint Server 2010 は Web パーツ ページ オブジェクトをウェルカム ページとして準備しません。その代わりに、カスタムウェルカム ページを示す URL を場所として使用します。 この要素は、オブジェクト モデルを使用することによってのみカスタマイズすることができます。 |
ドキュメント セットのために許可するコンテンツ タイプとして、フォルダー コンテンツ タイプあるいはその子は追加しないでください。UI を使用してドキュメント セットにサブフォルダーを作成することは推奨しません。
設定
SharePoint Server 2010 は、ドキュメント セットと専用のドキュメント セット コンテンツ タイプ設定ページを支援するために以下を提供します。
標準的な SharePoint Server 2010設定ページは、ドキュメント セット コンテンツ タイプが SharePoint Server 2010 のその他の種類のオブジェクトと共有するメタデータを保存します。これらの設定ページでは、ワークフロー設定の変更、フィールドの追加、ドキュメント セット コンテンツ タイプのその他の必須あるいは省略可能のタスクを支援します。また以下の操作を実行するために、設定ページを使用することができます。
ドキュメント セット内部で、どの列が共有されるかを指定します。
許可されるコンテンツ タイプを選択します。
ウェルカム ページにどのプロパティが表示されるかを指定します。
リスト レベルでユーザー設定のビューを指定します。
設定ページには、新しいドキュメント セットと既定のコンテンツで使用するためにどのコンテンツ タイプが許可されるかなど、新しい要素をカスタマイズするコントロールが含まれます。
ドキュメント セット コンテンツ タイプのいくつかのより高度な要素は、オブジェクト モデルを使用することによってのみ設定できます。これらの要素には、カスタム新規ページあるいはウェルカム ページを指定するなどの、SharePoint Server 2010 にユーザー設定コードあるいはファイルの実装を必要とする操作が含まれます。プログラミング上は、ドキュメント セット コンテンツ タイプには 2 つの部分があります。
コンテンツ タイプ オブジェクト。コンテンツ タイプ オブジェクトを操作するために SPContentType クラスとそのメソッドおよびプロパティを使用します。
DocumentSetTemplate クラス。ドキュメント セットの動作と機能に固有の特性を操作するために、このクラスのメソッドとプロパティを使用します。
DocumentSetTemplate を使用して操作できる、ドキュメント セットに固有の特性には、以下が含まれます。
AllowedContentTypeCollection コレクション。このドキュメント セットでの使用が認められているコンテンツ タイプを指定します。
DefaultDocumentCollection コレクション。このドキュメント セットに既定で含めるドキュメントを指定します。
SharedFieldCollection コレクション。ドキュメント セットのすべてのドキュメントにわたって共有されるフィールド値を指定します。
SharePoint Server 2010 は、既定のドキュメント セット コンテンツ タイプを提供します。このコンテンツ タイプを使用して、特定のシナリオでカスタマイズおよび使用できる子ドキュメント セット コンテンツ タイプを作成することができます。コンテンツ タイプは、Windows SharePoint Services 3.0 で導入されました。ドキュメント セットを使用する場合は、コンテンツ タイプの機能、オブジェクト モデル、基本的なプログラミングの概念について、概要を理解している必要があります。
ウェルカム ページ
ウェルカム ページは Web パーツ ページの一種で、既定では、ドキュメント セットに属しているドキュメントのメタデータ、詳細、リストを示すために使用されます。また、その他の情報を表示するように、ウェルカム ページをカスタマイズすることもできます。
それぞれのドキュメント セット コンテンツ タイプは、それ自身のウェルカム ページを持つことができます。このページは、コンテンツ タイプのその他の側面をカスタマイズするのと同じ方法でカスタマイズすることができます。以下に例を示します。
リスト オーナーは、リストが使用しているドキュメント セット コンテンツ タイプを使用しているすべてのドキュメント セットのウェルカム ページを変更することができます。
ドキュメント セットのウェルカム ページに行われた変更は、そのコンテンツ タイプの子、そしてそのコンテンツ タイプが使用される場所までプッシュダウンされます。これにより、リスト、ドキュメント セット インスタンス、およびドキュメント セット コンテンツ タイプが使用される場所が、コンテンツ タイプのコピーで最新のウェルカム ページを含むことが保証されます。
ドキュメント セット コンテンツ タイプは、フェデレーションをサポートします。ドキュメント セット コンテンツ タイプがフェデレーション対象の場合、ドキュメント セットに属するウェルカム ページもまたフェデレーション対象となります。
ブランド設定とテーマ性を考慮して、ウェルカム ページは、その他すべての SharePoint Server 2010 ページとまったく同様に動作します。
以下を使用して、ウェルカム ページをカスタマイズすることができます。
ウェルカム ページの基本的な側面をカスタマイズするドキュメント設定 UI。
ページに定義された Web パーツ領域に Web パーツを追加する、ドキュメント セット設定 UI。
ウェルカム ページに Web パーツとコントロールを追加することで、より高度な方法で Web パーツ ページをカスタマイズする Microsoft SharePoint Designer 2010。
ウェルカム ページ全体を所有して、Web パーツを使用したくない場合は、SharePoint Server 2010 オブジェクト モデル。オブジェクト モデルには、組み込みの Web パーツに基づいたウェルカム ページの代わりに、ユーザー自身のウェルカム ページを使用するように SharePoint Server 2010 で指定する機能があります。
ウェルカム ページは Web パーツ ページです。SharePoint Server 2010 には、以下のように、カスタマイズできる 2 つの新しい Web パーツが含まれます。
ドキュメント セット プロパティ Web パーツ: フォームの表示 Web パーツに似ていますが、どのアイテムのプロパティをレンダリングするか決定するために、それがあるページへの URL の一部としてパラメーターを設定できます。
ドキュメント セット コンテンツ Web パーツ: リスト ビュー Web パーツに似ていますが、どのフォルダーをレンダリングするか決定するために、それがあるページへの URL の一部としてパラメーターを設定できます。