グローバル リストの定義Define global lists

Azure DevOps Server 2020 |Azure DevOps Server 2019 |TFS 2018-TFS 2013Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018 - TFS 2013

重要

この記事は、ホストされている XML およびオンプレミスの XML プロセスモデルのプロジェクトカスタマイズに適用されます。This article applies to project customization for Hosted XML and On-premises XML process models. ホストされた XML カスタマイズでは、プロセス更新を使用したグローバルリストの追加と更新がサポートされています。Hosted XML customization supports adding and updating global lists with a process update. 詳細については、「 プロセステンプレートのカスタマイズの違い」を参照してください。To learn more, see Process template customization differences.

継承プロセスモデルでは、グローバルリストはサポートされていません。The Inheritance process model doesn't support global lists. プロセスモデルの概要については、「 作業追跡エクスペリエンスのカスタマイズ」を参照してください。For an overview of process models, see Customize your work tracking experience.

グローバルリストを使用すると、複数の作業項目の種類 (Wit) の定義に表示されるリストを更新するために必要な作業を最小限に抑えることができます。By using global lists, you can minimize the work that is required to update a list that appears in the definitions of several work item types (WITs). グローバル リストは、1 つ以上のフィールドや WIT 定義に組み込むことのできる選択リストです。Global lists are pick lists that you can include within one or more fields and WIT definitions.

リスト項目を1つ以上の要素に含めることにより、コレクションの複数の Wit 間でリスト項目を共有でき GLOBALLIST ます。You can share list items among several WITs for a collection by including the list items in one or more GLOBALLIST elements.

WIT を定義する際に、いくつかのフィールドが同じ値を共有することに気付くことがあります。As you define WITs, you might find that some fields share the same values. 多くの場合、複数の Wit 間で共有したり、複数のプロジェクト間で共有したりすることができます。Frequently, you can share across several WITs and even across several projects. これらの値の一部 (夜間ビルドのビルド番号など) は頻繁に変更されるため、管理者は多くの場所でこれらのリストを頻繁に更新する必要があります。Some of these values, such as the build number of nightly builds, change frequently, which requires an administrator to frequently update these lists in many locations. リストを外部システムから派生させる必要がある場合に、グローバル リストは特に役立ちます。Global lists can be especially useful when a list must be derived from an external system. たとえば、企業が別個の顧客データベースを維持しているとします。For example, suppose a company maintains a separate customer database. 顧客が発見したバグをファイルに登録すると、顧客の名前がカスタムフィールドに入力され Found By Customer ます。When you file a bug that a customer discovered, the customer's name is entered into a custom Found By Customer field.

コレクションのグローバル リストは、一覧表示、インポート、エクスポート、および削除できる XML ファイルとして管理できます。You can manage global lists for a collection as an XML file that you can list, import, export, and delete. 各グローバル リストの名前は最大 254 文字の Unicode 文字で、コレクション内において一意である必要があります。The name of each global list can have up to 254 Unicode characters and must be unique within a collection.

注意

既定のプロセスまたはプロセステンプレートに用意されているシステム定義のグローバルリストや定義済みのグローバルリストはありません。There are no system-defined nor predefined global lists specified in the default processes or process templates provides.

必要条件Requirements

グローバルリストが定義されているプロジェクトコレクションでは、次のアクセス許可が設定されている必要があります。For the project collection where the global lists are defined, you must have the following permissions set:

  • グローバルリストをエクスポートまたは一覧表示するには、 プロジェクトコレクションの有効なユーザー グループのメンバーであるか、[ コレクションレベル情報の表示 ] アクセス許可が [ 許可] に設定されている必要があります。To export or list global lists, you must be a member of the Project Collection Valid Users group or have your View collection-level information permission set to Allow.

  • グローバルリストをインポートするには、 プロジェクトコレクション管理者 セキュリティグループのメンバーである必要があります。To import global lists, you must be a member of the Project Collection Administrators security group.

グローバルリストを追加または変更するには、 witadmin コマンドラインツールを使用して、グローバルリストの定義をインポートおよびエクスポートします。To add or modify a global list, use the witadmin command-line tool to import and export the definition for global lists. グローバルリストの管理」を参照してください。See Manage global lists. グローバルリストを使用するには、 FIELD 作業項目の種類内の定義に追加します。To use a global list, add it to the FIELD definition within a work item type. すべてのフィールド要素を参照してください。See All FIELD elements.

グローバル リストの追加と管理Add and manage global lists

グローバルリストは、 LISTITEM コレクション内のすべてのプロジェクトによってグローバルに格納および使用される要素のセットです。A global list is a set of LISTITEM elements that is stored and used globally by all projects in a collection. グローバルリストは、複数の種類の作業項目 (オペレーティングシステム、ビルド内の検出、ビルドでの修正など) 内で定義されたフィールドに便利です。Global lists are useful for fields that are defined within several types of work items, such as Operating System, Found in Build, and Fixed in Build.

使用するプロセスモデルに基づいて、次の方法のいずれかを使用して、1つ以上のグローバルリストとその項目を定義できます。You can define one or more global lists and their items by using one of the following methods in the following ways based on the process model you use:

  • プロジェクトまたはプロセステンプレートに追加する WIT XML 定義内 (ホストされている XML およびオンプレミス XML)Within a WIT XML definition that you add to a project or process template (Hosted XML and On-premises XML)
  • グローバルリストの XML 定義ファイル内で、プロジェクトコレクション (オンプレミス XML) にインポートします。Within a global list XML definition file that you import to a project collection (On-premises XML)
  • グローバルワークフロー xml 定義ファイル内で、プロジェクトコレクション (オンプレミス XML) にインポートします。Within a global workflow XML definition file that you import to a project collection (On-premises XML).

注意

ホストされた XML プロセスモデルの場合、グローバルリストのインポートには次の制限が適用されます。For the Hosted XML process model, the following limits are placed on global list import:

  • グローバルリストの合計64Total of 64 global lists
  • リストあたり512項目の合計Total of 512 items per list
  • すべての Wit で指定されているすべてのグローバルリスト内で、合計10,000 項目を定義できます。Approximately 10K items can be defined total within all global lists specified across all WITs.

構文構造Syntax structure

次の表では、 GLOBALLIST 要素と LISTITEM 要素について説明します。The following table describes the GLOBALLIST and LISTITEM elements. これらの要素を使用して、ユーザーに選択リストまたは項目のドロップダウン メニューとして表示される値のリストを列挙できます。You can use these elements to enumerate a list of values that is presented to the user as a pick list or drop-down menu of items.

要素Element

説明Description

GLOBALLISTGLOBALLIST

コレクションに格納され、コレクション内のすべてのプロジェクトで使用できる LISTITEM 要素のセットを定義します。Defines a set of LISTITEM elements that are stored for a collection and that all projects in a collection can use.

<GLOBALLIST name="globalListName">
<LISTITEM> . . . </LISTITEM>
</GLOBALLIST>

globalListName: 1 ~ 255 文字の文字列。globalListName: A string of text that contains between 1 and 255 characters.

GLOBALLIST は、 globallists 要素の必須の子要素で ALLOWEDVALUES あり、、、およびの各要素の省略可能な子要素 SUGGESTEDVALUES PROHIBITEDVALUES です。GLOBALLIST is a required child element of the GLOBALLISTS element and an optional child element of the ALLOWEDVALUES, SUGGESTEDVALUES, and PROHIBITEDVALUES elements. 詳細については、「 Allowedvalues、SUGGESTEDVALUES、および PROHIBITEDVALUES XML 要素」を参照してください。For more information, see ALLOWEDVALUES, SUGGESTEDVALUES, and PROHIBITEDVALUES XML elements.

アイテムLISTITEM

有効なリスト値を定義します。Defines a valid list value. グローバル リストはプロジェクトにスコープされていないため、プロジェクト スコープのグループを含めることはできません。Global lists must not include project-scoped groups because they are not scoped to a project.

<LISTITEM value="Name" />

LISTITEM は、 GLOBALLIST の必須の子要素で ALLOWEDVALUES あり、、、およびの各要素の省略可能な子要素です SUGGESTEDVALUES PROHIBITEDVALUESLISTITEM is a required child element of GLOBALLIST and an optional child element of the ALLOWEDVALUES, SUGGESTEDVALUES, and PROHIBITEDVALUES elements.

サンプル グローバル リストSample global list

次の構文を追加することにより、作業項目の種類またはグローバル ワークフローの XML 定義ファイル内でグローバル リストを定義できます。By adding the following syntax, you can define a global list within an XML definition file for a type of work item or a global workflow:

<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 定義ファイル内でグローバル リストを参照できます。By using the following syntax, you can reference a global list within an XML definition file for a type of work item:

<GLOBALLISTS>  
      <GLOBALLIST name=" name of global list 1" />  
      <GLOBALLIST name=" name of global list 2" />  
      . . .  
      <GLOBALLIST name=" name of global list n" />  
</GLOBALLISTS>  

作業項目の種類またはグローバルワークフローの定義ファイルの構造と場所については、それぞれ「 WITD 要素 」または「 globalworkflow」を参照してください。For information about the structure and location of definition files for types of work items or global workflow, see All WITD elements or GLOBALWORKFLOW, respectively.

プロジェクトコレクション用に保持されたサンプルグローバルリストSample global list maintained for a project collection

グローバルリストをプロジェクトコレクションに追加するには、 witadmin importgloballist コマンドを使用して次の構文をインポートします。To add a global list to a project collection, you can import the following syntax by using the witadmin importgloballist command:

<gl:GLOBALLISTS xmlns:gl="http://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>  

グローバル リストを空にすることはできません。A global list cannot be empty. GLOBALLIST 要素には、少なくとも1つの要素が定義されている必要があり LISTITEM ます。Each GLOBALLIST element must have at least one LISTITEM element defined.

すべてのグローバルリストにデータが自動的に設定されますか。Are any global lists auto-populated with data?

はい (オンプレミスの TFS の場合)。Yes for on-premises TFS. ビルド という名前のグローバルリスト。TeamProjectName は、ビルドが実行されるたびに追加されます。The global list named Builds.TeamProjectName gets appended each time a build is run. 時間の経過に伴い、リストは非常に長くなることがあります。Over time, the list can become very long. ベスト プラクティスとして、定期的に未使用の項目をリストから削除してください。Best practice is to routinely remove unused items from the list.

この一覧の使用方法の詳細については、「 ビルドとテストの統合フィールドに基づくクエリ」を参照してください。To learn more about using this list, see Query based on build and test integration fields.