プロセス テンプレートのプロジェクト ポータル プラグインの定義

  • [アーティクル]

ポータル プラグインを使用すると、チーム プロジェクトのポータルの初期のドキュメント ライブラリ、ライブラリ構造、およびドキュメントを定義できます。 また、Team Foundation Server (TFS) プロセス テンプレートと連携するように設計されたダッシュボードおよび Excel レポートを作成するタスクも含めることができます。

SharePoint 製品用のプラグインで指定したタスクは、チーム プロジェクトの作成時に SharePoint サイトを作成した場合にのみ実行されます。 サイトの要件と管理の詳細については、「Team Foundation Server 用の SharePoint 製品の要件」を参照してください。

ポータル プラグインの名前と場所

次の表に、TFS プロセス テンプレートのポータル プラグイン ファイル、フォルダー、およびプラグインの名前を示します。

ファイル名:

WssTasks.xml

フォルダー名:

Windows SharePoint Services

プラグイン名:

Microsoft.ProjectCreationWizard.Portal

注意

この XML ファイルとフォルダーの名前は変更できますが、プラグインの名前は変更できません。TFS には、クライアント側のプラグイン、ポリシー、その他の変更を配置する機構は含まれていません。このような機能を配置するには、配布とインストールを行う独自のプログラムを使用する必要があります。

ポータル作成のタスクと依存関係

ポータル プラグイン ファイルでは、1 つまたは複数のタスクとその依存関係を指定します。 指定する主要なタスクは次のとおりです。

  • 指定したサイト テンプレートによるサイトの作成

  • ドキュメント ライブラリの作成

  • フォルダーの作成とドキュメント ライブラリへのファイルのアップロード

  • ダッシュボード機能のアクティブ化

単純なプロジェクト ポータルを指定するタスクの例については、TFS プロセス テンプレートの 1 つにある WssTasks.xml ファイルを参照してください。 TFS から最新のプロセス テンプレートをダウンロードできます。

サイトの作成とサイト テンプレートの指定

プロジェクト ポータルの基になるサイト テンプレートを指定する必要があります。 サイト テンプレートは、Team Foundation Server SharePoint ポータルでも使用できる必要があります。 サイト テンプレートは、プロセス テンプレートに含まれません。

サイト テンプレートの指定には、site 要素を使います。

<site template="" language=""/>

site 要素の属性を次の表に示します。

属性

説明

template

使用するテンプレートを指定します。 作成するチーム プロジェクトの SharePoint 製品をホストするサーバーで定義されたテンプレートを指定する必要があります。

MSF 用の最新バージョンのプロセス テンプレートで利用可能な機能を使用するには、次の文字列を指定します。Team Foundation Server Project Portal.

language

使用するサイト テンプレートの言語バージョンを示すロケール ID を指定します。 英語バージョンは 1033 です。

ダッシュボードをサポートする最新バージョンの MSF Agile プロセス テンプレートの英語バージョンを参照する方法を次の例に示します。

<tasks>
  <task id="SharePointPortal" name="Create Sharepoint Portal" plugin="Microsoft.ProjectCreationWizard.Portal" completionMessage="Project portal site created.">
    <dependencies />
    <taskXml>
        <Portal>
           <site template="Team Foundation Server Project Portal" language="1033" />  
       . . . 
        </Portal>

注意

ポータル プラグインで定義される他のすべてのタスクは、サイト作成タスクに依存します。プロジェクト ポータルを作成した後でなければ、ドキュメント ライブラリの作成やファイルのコピーは実行できないからです。

プロセス テンプレートのパフォーマンス

WssTasks.xml 内に指定されたファイルは、プロセス テンプレートをアップロードするときにその一部としてアップロードされます。 プロセス テンプレートのサイズは、新しいチーム プロジェクトの作成にかかる時間に影響します。 プロセス テンプレートが大きいほど、新しいチーム プロジェクトの作成にかかる時間が長くなります。 したがって、プロセス テンプレートのパフォーマンスが低下する場合は、別の方法でファイルを提供することを検討する必要があります。

サイト テンプレートの使用

ファイルを SharePoint サイト テンプレートの一部として含めることができます。 これにより、ファイルはプロセス テンプレートからサイト テンプレートに移動し、新しいチーム プロジェクトの作成時のパフォーマンスが向上します。

ただし、ファイルを WssTasks.xml に記述することには利点があります。 前記の queryid 属性を使って、Microsoft Project ファイルと Microsoft Excel ファイルをクエリにバインドできます。 その結果、ファイルを開いた時点で正しい Team Foundation Server とクエリに接続されるので、チーム メンバーは作業が省けます。

代替 Web サイトの使用

複数のチーム プロジェクトで共有される大量のファイルがある場合は、代替 Web サイトを使ってファイルをホストし、プロジェクト ポータルまたは Web ページからファイルにリンクすることができます。 この方法を使うと、ファイルをプロジェクト ポータルにコピーする必要がないため、チーム プロジェクト作成時のパフォーマンスも向上します。 詳細については、「プロジェクト ポータルの構成または追加」を参照してください。

ドキュメント ライブラリの作成

プロジェクト ポータルの作成後に、追加で作成するドキュメント ライブラリを指定できます。 ドキュメント ライブラリを指定するには、documentLibrary 要素を使用します。

<documentLibraries>
   <documentLibrary name="" description="" isProcessGuidance="true | false" />
</documentLibraries>

注意

ドキュメント ライブラリのバージョン コントロールをプロセス テンプレート内で有効または無効に設定することはできません。バージョン コントロールの有効または無効の設定は、Windows SharePoint Services サイト テンプレートを使って、プロジェクトの作成後に実行できます。

documentLibrary 要素に含まれる属性を次の表に示します。

属性

説明

name

プロジェクト ポータルに表示されるドキュメント ライブラリの名前を指定します。

description

プロジェクト ポータルに表示されるドキュメント ライブラリの説明を指定します。

isProcessGuidance

このドキュメント ライブラリをプロセス ガイダンスのコンテンツをサポートするために使用するかどうかを指定します。

次の例では、開発チームがドキュメントの保存に使用できる Development という名前のドキュメント ライブラリを作成します。

<documentLibraries>
. . .
   <documentLibrary name="Process Guidance" description="How to make best use of the Team Foundation Server tools and process" isProcessGuidance="true" />
. . .
</documentLibraries>

ドキュメント ライブラリのフォルダー構造の作成

プロジェクト ポータルの作成後に、追加で作成するフォルダーを指定できます。 また、テンプレート ファイルなどのコピーするファイルを指定できます。

新しいフォルダーを作成するには、folder 要素を使用します。

<folders>
   <folder documentLibrary="" name=""/>
</folders>

folder 要素に含まれる属性を次の表に示します。

属性

説明

documentLibrary

フォルダーを作成するドキュメント ライブラリを指定します。

name

フォルダーの名前を指定します。

次の例では、Trip Reports という名前のフォルダーを Development ドキュメント ライブラリに作成します。開発者は、このフォルダーに会議または顧客先への訪問に関する出張報告書を保存できます。

<folders>
   <folder documentLibrary="Development"
           name="Trip Reports"/>
</folders>

ドキュメント ライブラリにアップロードするファイルの指定

また、ファイルをドキュメント ライブラリとフォルダーにコピーする必要があります。 ソース ファイルは、Windows SharePoint Services フォルダーに格納します。 プロジェクト ポータル上のターゲットを指定する必要があります。

<files>
   <file source="" documentLibrary="" target="" queryId="" /> 
</files>

file 要素の属性を次の表に示します。

属性

説明

source

ファイルのローカル コピーへの相対パスを指定します。 一般に、ソースのパス名は常に Windows SharePoint Services で始まります。これは、ポータル プラグインが定義されたフォルダーの名前です。

documentLibrary

ファイルのコピー先のドキュメント ライブラリの名前です。

target

ファイルのコピー先となるプロジェクト ポータル上のターゲットへの相対パスです。

queryId

ファイルにバインドする作業項目クエリを指定します。 ファイルを最初に開いた時点で、このクエリの実行結果がファイルに読み込まれます。 この属性は省略可能です。指定するクエリは、workitems.xml ファイルに存在する必要があります。

注意

queryId は、.xls ファイルだけに適用されます。

次の例では、Project Checklist という名前のテンプレート ファイルを Project Management フォルダーにコピーします。 また、この例では、ファイルを最初に開いたときに Project Checklist 作業項目クエリの結果が読み込まれます。

<files>
   <file source="Windows SharePoint Services\Templates\Project Checklist.xls" 
      documentLibrary="Project Management" 
      target="Project Checklist.xls" 
      queryId="Project Checklist" />
</files>

注意

フォルダーとファイルをサイト テンプレートの一部に含めることもできます。その場合、フォルダーとファイルを XML に記述する必要はありません。

注意

SharePoint サイトで .exe ファイルがサポートされていない場合に .exe ファイルを指定すると、プロセス テンプレートを使ってチーム プロジェクトを正しく作成することはできません。

プロセス ガイダンスのコンテンツ ファイルとサポート ファイル

プロセス ガイダンスは、ソフトウェア プロジェクトで作業するチーム メンバーが従うプロセスを文書化したコンテンツです。 プロジェクトの作業項目、レポート、およびクエリは、すべてチーム プロジェクトのライフ サイクル中に変更される可能性があり、チーム プロジェクト間で異なる場合もあります。 プロセス ガイダンスのコンテンツには、作業項目フィールドを完成させる方法、正常なレポートと問題のあるレポートの例、クエリの説明など、チーム プロジェクトについての詳細情報が記載されています。 また、プロセス ガイダンスには、担当するロールや実行するアクティビティなど、チーム プロジェクトで行うプロセスの詳細も記載されています。

MSDN ライブラリでは、既定の TFS プロセス テンプレートのそれぞれで定義されている、ほとんどの成果物のプロセス ガイダンス コンテンツにアクセスできます。 MSDN のコンテンツは、Visual Studio Scrum、MSF for Agile、および MSF for CMMI のいずれかのトピックからも参照できます。

チーム エクスプローラーの作業項目フォームからプロセス ガイダンスへのアクセスをサポートするために、一連の .htm ファイルが、ドキュメント SharePoint ライブラリ内のプロセス ガイダンス フォルダーにアップロードされます。 このファイルでは、チーム メンバーが作業項目フォーム内のプロセス ガイダンス 作業項目のプロセス ガイダンスへの表示 アイコンを選択したときに開かれる MSDN コンテンツの URL を指定します。 これらのファイルは、ポータル プラグイン内で定義される file タスクに基づいてアップロードされます。 たとえば、アジャイル プロセス テンプレートでは、次の file タスクを定義します。

<!-- Process Guidance -->
          <file source="Windows SharePoint Services\Process Guidance\ProcessGuidance.html" documentLibrary="Process Guidance" target="ProcessGuidance.html" />
          <file source="Windows SharePoint Services\Process Guidance\ProcessGuidance.html" documentLibrary="Process Guidance" target="ProcessGuidance.aspx" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\AboutWorkItems.htm" documentLibrary="Process Guidance" target="Supporting Files/AboutWorkItems.htm" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\AboutWorkItems.htm" documentLibrary="Process Guidance" target="Supporting Files/AboutWorkItems.aspx" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\Bug.htm" documentLibrary="Process Guidance" target="Supporting Files/Bug.htm" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\Bug.htm" documentLibrary="Process Guidance" target="Supporting Files/Bug.aspx" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\Issue.htm" documentLibrary="Process Guidance" target="Supporting Files/Issue.htm" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\Issue.htm" documentLibrary="Process Guidance" target="Supporting Files/Issue.aspx" />
          <file source="Windows SharePoint Services\Process Guidance\ProcessGuidance.html" documentLibrary="Process Guidance" target="Supporting Files/ProcessGuidance.htm" />
          <file source="Windows SharePoint Services\Process Guidance\ProcessGuidance.html" documentLibrary="Process Guidance" target="Supporting Files/ProcessGuidance.aspx" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\SharedSteps.htm" documentLibrary="Process Guidance" target="Supporting Files/Shared Steps.htm" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\SharedSteps.htm" documentLibrary="Process Guidance" target="Supporting Files/Shared Steps.aspx" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\Task.htm" documentLibrary="Process Guidance" target="Supporting Files/Task.htm" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\Task.htm" documentLibrary="Process Guidance" target="Supporting Files/Task.aspx" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\TestCase.htm" documentLibrary="Process Guidance" target="Supporting Files/Test Case.htm" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\TestCase.htm" documentLibrary="Process Guidance" target="Supporting Files/Test Case.aspx" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\UserStory.htm" documentLibrary="Process Guidance" target="Supporting Files/User Story.htm" />
          <file source="Windows SharePoint Services\Process Guidance\Supporting Files\UserStory.htm" documentLibrary="Process Guidance" target="Supporting Files/User Story.aspx" />

このファイルは、プロセス ガイダンスの他のリソースを参照するようにカスタマイズできます。 また、チーム用に作成したその他のプロセス ガイダンスにアクセスできるようにファイルを追加することもできます。 詳細については、「プロジェクト ポータルの構成または追加」を参照してください。

ダッシュボード機能のアクティブ化

ダッシュボードは、プロジェクト データを表示し、調査をサポートするので、チームは共通のタスクをすばやく実行できます。 ダッシュボードには、いくつかの Excel レポートと Team Web Access Web パーツが表示されます。

ダッシュボードおよび Excel レポートが作成されるようにするには、activateFeatures 要素を使用します。 チーム プロジェクトに対するダッシュボードおよび Excel レポートの作成をアクティブ化するには、ポータル プラグイン ファイルの Portal 要素内に次のコードを含める必要があります。

Visual Studio Scrum 用のプロセス テンプレートで使用できるように設計されたダッシュボード機能をアクティブ化するには:

      <Portal>
    . . . 
<activateFeatures>
         <!-- TfsDashboardScrumWss -->
          <feature featureId="71EC0D67-21AB-4560-A825-9D976DA09D04" />
          <!-- TfsDashboardAgileQuickLaunch -->
          <feature featureId="1D363A6D-D9BA-4498-AD1A-9874ACA5F827" />
        </activateFeatures>
    . . . 
      </Portal>

MSF アジャイル ソフトウェア開発用のプロセス テンプレートで使用できるように設計されたダッシュボード機能をアクティブ化するには:

      <Portal>
    . . . 
        <activateFeatures>
          <!-- TfsDashboardAgileMoss -->
          <feature featureId="0D953EE4-B77D-485b-A43C-F5FBB9367207" />
          <!-- TfsDashboardAgileQuickLaunch -->
          <feature featureId="1D363A6D-D9BA-4498-AD1A-9874ACA5F827" />
        </activateFeatures>
    . . . 
      </Portal>

MSF CMMI プロセス改善用のプロセス テンプレートで使用できるように設計されたダッシュボード機能をアクティブ化するには:

      <Portal>
    . . . 
<activateFeatures>
          <!-- TfsDashboardCmmiMoss -->
          <feature featureId="3D0BA288-BF8E-47F0-9680-7556EDEF6318" />
          <!-- TfsDashboardCmmiProcessDocLibraries -->
          <feature featureId="8610B95B-063F-4FB5-837C-BCF2FE9423C6" />
        </activateFeatures>
    . . . 
      </Portal>

参照

概念

プロセスのカスタマイズ

プロセス テンプレート ファイルの概要