プロセステンプレート XML 要素のリファレンス

[アーティクル]
11/30/2015

プロセステンプレートのルートファイルをカスタマイズして、プラグインファイルの追加または削除を行うことができます。ルートファイルでは、Visual Studio Online またはオンプレミスの Team Foundation Server でのチームプロジェクトの作成に使用するすべてのプラグインとすべてのタスクを定義します。ルートファイルは ProcessTemplate という名前で、プロセステンプレートファイルのコンテナーフォルダー内にあります。詳細については、「プロセステンプレートファイルの概要」を参照してください。

ルートプラグインファイルの親要素は ProcessTemplate 要素です。この要素には 1 つの metadata 要素と 1 つの groups 要素が定義され、含まれている必要があります。チームプロジェクトコレクション内の各プロセステンプレートには、最大 124 字の Unicode 文字で一意の名前を割り当てる必要があります。

注意

Visual Studio Online の場合、名前と GUIDE が既存のプロセスと同じになっているプロセステンプレートをインポートすると、既存のプロセスは、そのプロセスを参照するすべてのチームプロジェクトと共に更新されます。

オンプレミスの TFS の場合、既存のテンプレートと同じ名前のプロセステンプレートをアップロードすると、既存のテンプレートが上書きされます。

このトピックの内容

プロセステンプレートの構文構造
メタデータ要素リファレンス
グループ要素リファレンス

プロセステンプレートの構文構造

プロセステンプレートのルートプラグインは、ProcessTemplate コンテナー要素内の独自のファイルで指定します。その際、ProcessTemplate.xsd ファイルおよび ProcessTemplateItem.xsd ファイルで定義されているプロセステンプレートのスキーマに従う必要があります。プロセステンプレートのスキーマファイルは、Microsoft Web サイトの「Process Template and Work Item Schemas for Visual Studio Team Foundation (Visual Studio Team Foundation のプロセステンプレートスキーマと作業項目スキーマ)」でダウンロードできます。

次の例は、ProcessTemplate 要素のルートの構造を示しています。これよりも広範な例については、「プロセステンプレートプラグインファイルを使用したルートタスクの定義」を参照してください。

<?xml version="1.0" encoding="utf-8"?>
<ProcessTemplate>
   <metadata> . . . </metadata>
   <groups> . . .</groups>
</ProcessTemplate>

メタデータ要素リファレンス

次の構文は、metadata 要素およびその子要素の構造を示しています。

<metadata>
    <name>ProcessTemplateName</name>
    <description>ProcessTemplateDescription </description>
    <version type="ID" major="Number1" minor="Number2" />
    <plugins>
      <plugin name="Microsoft.ProjectCreationWizard.pluginID" wizardPage="true | false" />
. . .
    </plugins>
</metadata>

要素	構文	説明
description	`<description>ProcessTemplateDescription</description>`	metadata の子要素です (必須)。新しいチームプロジェクトウィザードでプロセステンプレートに表示する説明のテキストを定義します。
metadata	`<metadata> <name> . . . </name> <description> . . . </description> <version type="ID" major="Number1" minor="Number2/> <plugins> . . . </plugins> </metadata>`	ProcessTemplate の子要素です (必須)。プラグインとして必要な情報を指定するためのコンテナー要素は、新しいチームプロジェクトウィザードによって処理されます。
name	`<name>ProcessTemplateName</name>`	metadata の子要素です (必須)。プロセステンプレートの名前を定義します。この名前はチームプロジェクトコレクション間で一意である必要があります。名前の最大長は 124 文字です。
plugin	`<plugin name="Microsoft.ProjectCreationWizard.PluginName wizardPage="true \| false" />`	plugins の子要素です (必須)。プロセステンプレートの作成時に含めるプラグインファイルの名前を指定し、そのプラグラインが新しいチームプロジェクトウィザードにページを表示するかどうかを指定します。
plugins	`<plugins> <plugin> . . . </plugin> </plugins>`	metadata の子要素です (必須)。プロセステンプレート用のプラグインを定義するコンテナー要素です。
version	`<version type="ID" major="Number1" minor="Number2 " />`	metadata の子要素です (必須)。プロセステンプレートのバージョンを識別する一意の ID とメジャーおよびマイナーリビジョン番号を指定します。

グループ要素リファレンス

次の構文は、groups 要素およびその子要素の構造を示しています。

<groups>
   <group id="groupId" description="GroupDescription" completionMessage="SuccessMessage">
      <dependencies> 
         <dependency groupId="dependentGroupId" />
. . .
      </dependencies>
      <taskList filename="RelativePathAndFileName" />
   </group>
. . .
</groups>

要素	構文	説明
dependencies	`<dependencies> <dependency>. . . </dependency> </dependencies>`	group の子要素です (必須)。グループから他のグループへの依存関係を指定します。
dependency	`<dependency groupId="groupId" />`	dependencies の子要素です (省略可能)。このグループが依存する別のタスクグループの ID を指定します。このタスクグループが開始する前に、別のグループがそのタスクを完了する必要があります。
group	`<group id="TaskGroupId" description="TaskGroupDescription" completionMessage="SuccessMessage" failureMessage="FailureMessage"> <dependencies> . . . <dependencies> <taskList> . . . </taskList> </group>`	groups の子要素です (必須)。プロジェクトの作成時に実行するプラグインのタスクのセットを識別します。各属性の有効な値を次に示します。 id: タスクグループを識別する名前を指定します。別のタスクグループがこのグループに依存する場合は、この ID が参照されます。プラグインファイルの中で ID に一意の値を割り当てる必要があります。 description: チームプロジェクトの作成時に表示する、タスクグループの処理を表すメッセージを指定します。 completionMessage: チームプロジェクトの作成時に表示する、タスクグループの処理が正常に完了したことを表すメッセージを指定します。最大長は 256 文字です。 failureMessage: チームプロジェクトの作成時に表示する、タスクグループの処理が正常に完了しなかったことを表すメッセージを指定します。
groups	`<groups> <group> . . . </group> </groups>`	ProcessTemplate の子要素です (必須)。プロジェクト作成時に実行するタスクグループのセットを定義するコンテナー要素です。
tasklist	`<taskList filename="filePath" />`	実行するタスクのリストが含まれている XML ファイルを指定します。グループのタスクリストは、常に別個の XML ファイルにある必要があります。これらのファイルを指定する方法の詳細については、「プラグインを処理するタスクの定義」を参照してください。