グローバル リストの定義
Team Foundation Server (TFS) でグローバル リストを使用すれば、複数の作業項目の種類 (WIT) の定義に含まれているリストの更新に必要な作業を最小限に抑えることができます。 グローバル リストは、1 つ以上のフィールドや WIT 定義に組み込むことのできる選択リストです。 グローバル リストは、チーム プロジェクトに追加した WIT 内でチーム プロジェクト コレクションのグローバル リストとして定義することも、グローバル ワークフロー内で定義することもできます。 リスト項目を 1 つ以上の GLOBALLIST 要素に含めることにより、コレクションの複数の WIT でリスト項目を共有できます。
WIT を定義する際に、いくつかのフィールドが同じ値を共有することに気付くことがあります。 複数の WIT や複数のチーム プロジェクトで共有することもしばしばあります。 これらの値の一部 (夜間ビルドのビルド番号など) は頻繁に変更されるため、管理者は多くの場所でこれらのリストを頻繁に更新する必要があります。 リストを外部システムから派生させる必要がある場合に、グローバル リストは特に役立ちます。 たとえば、企業が別個の顧客データベースを維持しているとします。 顧客が発見したバグを登録する時に、顧客名がカスタムの Found By Customer フィールドに入力されます。
コレクションのグローバル リストは、一覧表示、インポート、エクスポート、および削除できる XML ファイルとして管理できます。 各グローバル リストの名前は最大 254 文字の Unicode 文字で、コレクション内において一意である必要があります。
注意
TFS が提供する既定のプロセス テンプレートには、システム定義グローバル リストや定義済みグローバル リストはありません。
要件
グローバル リストをエクスポートしたり一覧表示したりするには、プロジェクト コレクションの有効なユーザー グループのメンバーであるか、[コレクションレベル情報の表示] のアクセス許可が [許可] に設定されている必要があります。
グローバル リストを定義したり編集したりするには、プロジェクト管理者グループのメンバーであるか、[コレクションレベル情報の編集] のアクセス許可が [許可] に設定されている必要があります。
グローバル リストを追加または変更するには、witadmin コマンド ライン ツールを使用して、グローバル リストの定義をインポートおよびエクスポートします。 「作業項目の種類のグローバル リストの管理 [witadmin]」を参照してください。 グローバル リストを使用するには、作業項目の種類内の FIELD 定義に追加します。 「すべての FIELD XML 要素のリファレンス」を参照してください。
グローバル リストの追加と管理
グローバル リストは、コレクション内のすべてのチーム プロジェクトによりグローバルに保存および使用される LISTITEM 要素のセットです。 グローバル リストは、複数の作業項目の種類内で定義されたフィールド (オペレーティング システム、発見されたビルド、修正されたビルド) に役立ちます。
次の方法を使用して、グローバル リストとその項目を定義できます。
チーム プロジェクト コレクション: チーム プロジェクト コレクションで定義されたグローバル リストをエクスポート、変更、削除、およびインポートできます。 これらのグローバル リストは、コレクション内のすべてのチーム プロジェクトで使用可能です。
作業項目の種類の定義: チーム プロジェクトの作成後、作業項目の種類が使用可能なグローバル リストを定義に追加できます。
グローバル ワークフロー定義: チーム プロジェクトの作成後、すべての作業項目の種類が使用可能なグローバル リストをチーム プロジェクトまたはコレクションのグローバル ワークフロー定義に追加できます。 詳細については、「グローバル ワークフローのカスタマイズ」を参照してください。
構文構造
GLOBALLIST および LISTITEM 要素について次の表で説明します。 これらの要素を使用して、ユーザーに選択リストまたは項目のドロップダウン メニューとして表示される値のリストを列挙できます。
要素 |
構文 |
説明 |
|---|---|---|
GLOBALLIST |
|
コレクション用に保存してコレクション内のすべてのチーム プロジェクトが使用できる LISTITEM 要素のセットを定義します。 globalListName: 1 ～ 255 文字のテキスト文字列。 GLOBALLIST は、GLOBALLISTS 要素の必須の子要素、および ALLOWEDVALUES 要素、SUGGESTEDVALUES 要素、PROHIBITEDVALUES 要素の省略可能な子要素です。 詳細については、「選択リストの定義」を参照してください。 |
LISTITEM |
|
有効なリスト値を定義します。 注意 グローバル リストはプロジェクトにスコープされていないため、プロジェクト スコープのグループを含めることはできません。 LISTITEM は、GLOBALLIST の必須の子要素、および ALLOWEDVALUES 要素、SUGGESTEDVALUES 要素、PROHIBITEDVALUES 要素の省略可能な子要素です。 |
サンプル グローバル リスト
次の構文を追加することにより、作業項目の種類またはグローバル ワークフローの XML 定義ファイル内でグローバル リストを定義できます。
<GLOBALLISTS>
<GLOBALLIST name="name of global list">
<LISTITEM value="List item 1" />
<LISTITEM value="List item 2" />
<LISTITEM value="List item 3" />
<LISTITEM value="List item 4" />
. . .
<LISTITEM value="List item n" />
</GLOBALLIST>
</GLOBALLISTS>
次の構文を追加することにより、作業項目の種類の XML 定義ファイル内でグローバル リストを参照できます。
<GLOBALLISTS>
<GLOBALLIST name=" name of global list 1" />
<GLOBALLIST name=" name of global list 2" />
. . .
<GLOBALLIST name=" name of global list n" />
</GLOBALLISTS>
作業項目の種類またはグローバル ワークフローの定義ファイルの構造および場所については、それぞれ「すべての WITD XML 要素のリファレンス 」または「グローバル ワークフローに関する XML 要素のリファレンス」を参照してください。
プロジェクト コレクションに対して保持されたサンプル グローバル リスト
グローバル リストをプロジェクト コレクションに追加するには、witadmin importgloballist コマンドを使用することにより次の構文をインポートできます。
<gl:GLOBALLISTS xmlns:gl="https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/globallists">
<GLOBALLIST name="NameOfGlobalList">
<LISTITEM value="ListItem1" />
<LISTITEM value="ListItem2" />
<LISTITEM value="ListItem3" />
<LISTITEM value="ListItem4" />
. . .
<LISTITEM value="ListItemN" />
</GLOBALLIST>
</gl:GLOBALLISTS>
グローバル リストを空にすることはできません。 各 GLOBALLIST 要素には、少なくとも 1 つの LISTITEM 要素が定義されている必要があります。
Q & A
Q: データが自動設定されるグローバル リストがありますか。
A: はい、できます。 Builds – TeamProjectName という名前のグローバル リストは、ビルドが実行されるたびに追加されます。 時間の経過に伴い、リストは非常に長くなることがあります。 ベスト プラクティスとして、定期的に未使用の項目をリストから削除してください。
このリストの使用方法の詳細については、「テスト、ビルド、バージョン管理との統合をサポートするフィールド」を参照してください。
参照
関連項目
作業項目の種類のグローバル リストの管理 [witadmin]