作業を追跡するためのフィールドの追加または変更Add or modify a field to track work

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

重要

この記事は、オンプレミスの XML プロセスモデルのプロジェクトカスタマイズに適用されます。This article applies to project customization for On-premises XML process models. プロセスモデルの概要については、「 作業追跡エクスペリエンスのカスタマイズ」を参照してください。For an overview of process models, see Customize your work tracking experience.

プロジェクトには、 — プロジェクトの作成に使用されたプロセスアジャイル、スクラム、またはCMMIに基づく100以上のデータフィールドが含まれてい — ます。Your project contains 100 or more data fields, based on the process—Agile, Scrum, or CMMI—used to create the project. データを更新するには、 作業項目内のデータフィールドを変更します。You update data by modifying the data field within a work item. 各作業項目は作業項目の種類 (WIT) に関連付けられており、追跡できるデータは WIT に割り当てられたフィールドに対応しています。Each work item is associated with a work item type (WIT), and the data you can track corresponds to the fields assigned to the WIT.

既存のフィールドを変更するか、または追加データ要件の追跡をサポートするカスタム フィールドを追加できます。You can modify an existing field or add a custom field to support tracking additional data requirements. たとえば、ドロップダウン メニューの選択リストのカスタマイズ、既定値を指定するか取得可能値を制限する規則の追加、フィールド属性の変更を行うことができます。For example, you can customize the pick list within a drop-down menu, add a rule to specify a default value or restrict the value it can take, or change a field attribute.

すべての選択リストが同じ方法で定義されているわけではありません。Not all pick lists are defined in the same way. 一部の一覧は、ユーザーインターフェイス、WIT のワークフロー、または次の表に示すように、プロジェクトにユーザーアカウントを追加することによって定義されています。Some lists are defined through the user interface, the workflow for a WIT, or by adding user accounts to a project as indicated in the following table.

注意

利用可能な機能: 一部の機能は、オンプレミスの TFS からのみ使用でき、そのように記載されています。Feature availability: You can exercise some features only from an on-premises TFS and are noted as such.

作業項目フィールドを追加するためのメソッドMethods by which work item fields get added

作業項目フィールドは、作業項目の種類のデータの追跡、クエリのフィルター条件の定義、およびレポートの生成に使用します。You use work item fields to track data for a work item type and to define the filter criteria for queries as well as to generate reports. システムフィールドを除くすべてのデータ要素は、作業項目フィールドとして定義する必要があります。Any data element, except for system fields, that you want to track must be defined as a work item field. 作業項目フィールドは、作業項目の種類の定義、またはグローバル ワークフロー内で定義できます。You can define work item fields within the definition of a work item type or global workflow.

作業項目フィールドは、プロジェクトコレクションに対して保持されます。Work item fields are maintained for a project collection. フィールドを追加するには、次のいずれかの操作を実行します。You add fields when you perform one of the following tasks:

  • プロジェクトを作成 します。Create a project. 作業項目の種類またはグローバル ワークフローの定義内で定義されたすべてのフィールドと、選択されたプロセス テンプレートに対して定義されたすべてのフィールドが作成されます。All fields that are defined within the definitions for work item types or global workflow and that are defined for the selected process template are created. コアシステムフィールドは、プロジェクトに対して定義されているすべての作業項目の種類に対して自動的に定義されます。The core system fields are automatically defined for every work item type that is defined for a project. これらのフィールドの一覧については、「 作業項目フィールドのインデックス」を参照してください。For a list of these fields, see Work item field index.

  • WIT 定義をインポート します。Import a WIT definition. 作業項目の種類の定義内で定義されたすべての新しいフィールドが、コレクションに追加されます。All new fields that are defined within the definition for a type of work item are added to the collection. 詳細については、「 すべての WITD XML 要素のリファレンス」を参照してください。For more information, see All WITD XML elements reference.

  • グローバルワークフロー定義をインポート します。Import a global workflow definition. グローバル ワークフロー内で定義されたすべての新しいフィールドが、コレクションに追加されます。All new fields that are defined within the global workflow are added to the collection. 複数の作業項目の種類で共有する一連の作業項目フィールドを保持する場合は、グローバル ワークフローを定義します。You define a global workflow when you want to maintain a set of work item fields that several types of work items share. 詳細については、「 グローバルワークフローのカスタマイズ」を参照してください。For more information, see Customize global workflow.

  • プロジェクト コレクションを Project Web App (PWA) のインスタンスにマップ します。Map a project collection to an instance of Project Web App (PWA). Project Server の Team Foundation Server 拡張機能をインストールした後、Team Foundation のさまざまなコンポーネントをマッピングすることによって統合を構成します。After you install the Team Foundation Server Extensions for Project Server, configure the integration by mapping various components of Team Foundation. コレクションをマップする場合に、Project Server フィールドのいくつかのフィールドをサポートするグローバル ワークフロー定義がインポートされます。When you map a collection, a global workflow definition that supports several fields in Project Server fields is imported. 詳細については、「 データ同期をサポートするために TFS に追加された Project Server のフィールド」を参照してください。For more information, see Project Server fields added to TFS to support data synchronization.

すべての Wit およびすべてのプロジェクトのすべてのグローバルワークフローで定義されているすべてのフィールドは、コレクション内で定義されているフィールドの完全なセットを構成します。All fields that are defined in all WITs and all global workflows for all projects make up the complete set of fields defined within the collection. 既存のフィールドの属性の変更、名前の変更、および削除を実行できます。You can change the attribute of, rename, and delete existing fields. ただし、これらの種類の変更 (特にオンプレミスのサーバーとレポート) を行う場合は、一定のコストが発生します。However, you incur certain costs when you make these kinds of changes, specifically for on-premises server and reporting.

コレクションのフィールドを追加またはカスタマイズするには、WIT 定義の XML コンテンツを変更します。To add or customize a field for a collection, modify the XML content for the WIT definition. WIT 定義の フィールド セクション内の field 要素を使用して各フィールドを定義します。Define each field through a FIELD element within the FIELDS section of the WIT definition. これらのファイルの構造と場所については、「 すべてのフィールド XML 要素のリファレンス」を参照してください。For information about the structure and location of these files, see All FIELD XML elements reference.

フィールドの追加、ルールの適用、または属性の変更を行います。Add a field, or apply a rule, or change an attribute

カスタムフィールドの追加、フィールド規則の追加、または作業項目フォームのフィールドのラベルの変更を行うには、そのフィールドを使用する作業項目の種類 (WIT) または種類を変更します。To add a custom field, add field rules, or change the label of a field on a work item form, you modify the work item type (WIT) or types that use the field. プロセスモデルと一致する カスタマイズシーケンス に従います。Follow the customization sequence that matches your process model.

フィールド属性を変更したり、フィールドの名前を変更したりするには、 witadmin コマンドラインツールを使用します。To change a field attribute or rename a field, use the witadmin command line tool. それ以外の場合、フィールドを変更するには、WIT 定義内のフィールドに関連付けられている規則を追加または変更します。Otherwise, to modify a field, you add or modify the rules associated with the field within a WIT definition.

フィールド属性とフィールド規則の概要Summary of field attributes and field rules

WIT 定義ファイルを編集するにはTo edit a WIT definition file

規則を追加するか、またはカスタム フィールドを追加するには、WIT 定義ファイルのエクスポート、編集、およびインポートを行います。To add rules or add a custom field, export, edit, and then import the WIT definition file.

ヒント

Witadmin を使用すると、定義ファイルをインポートおよびエクスポートできます。With witadmin, you can import and export definition files. 使用できるその他のツールには、プロセスエディターがあります (Visual Studio のバージョンがインストールされている必要があります)。Other tools you can use include the Process Editor (requires that you have installed a version of Visual Studio). Visual Studio Marketplace からプロセステンプレートエディターをインストールします。Install the Process Template editor from the Visual Studio Marketplace.

または、 TFS チームプロジェクトマネージャー(GitHub から入手できるオープンソースクライアント) を使用することもできます。Or, you can use the TFS Team Project Manager, an open-source client available from GitHub.

ヒント

Witadmin を使用すると、定義ファイルをインポートおよびエクスポートできます。With witadmin, you can import and export definition files. 使用できるその他のツールには、プロセスエディターがあります (Visual Studio のバージョンがインストールされている必要があります)。Other tools you can use include the Process Editor (requires that you have installed a version of Visual Studio). Visual Studio Marketplace から TFS プロセステンプレートエディターをインストールします。Install the TFS Process Template editor from the Visual Studio Marketplace. このバージョンのプロセスエディターを使用して、旧形式の作業項目フォームを変更できます。You can use this version of the Process Editor to modify the old-style work item forms. 新しい web フォームに関連付けられているフォームを編集するために使用することはできません。You can't use it to edit forms associated with the new web forms.

または、 TFS チームプロジェクトマネージャー(GitHub から入手できるオープンソースクライアント) を使用することもできます。Or, you can use the TFS Team Project Manager, an open-source client available from GitHub.

ヒント

Witadmin を使用すると、定義ファイルをインポートおよびエクスポートできます。With witadmin, you can import and export definition files. 使用できるその他のツールには、プロセスエディターがあります (Visual Studio のバージョンがインストールされている必要があります)。Other tools you can use include the Process Editor (requires that you have installed a version of Visual Studio). TFS パワーツールをインストールします。Install TFS Power Tools. または、 TFS チームプロジェクトマネージャー(GitHub から入手できるオープンソースクライアント) を使用することもできます。Or, you can use the TFS Team Project Manager, an open-source client available from GitHub.

データの追跡に使用するフィールドはすべて WIT 定義ファイルに追加する必要があります。Any field that you want to use to track data must be added to the WIT definition file. これは、すべてのシステムフィールド (参照名が system で始まるフィールド) に対しても当てはまります。This is true for all but system fields (fields whose reference name start with System.). WIT 定義に含めるかどうかにかかわらず、すべての WIT に対してすべてのシステム フィールドが定義されます。All System fields are defined for all WITs, whether or not you include them in WIT definition. 各フィールドの詳細については、「 作業項目フィールドのインデックス」を参照してください。To learn more about each field, see Work item field index.

チェックボックスまたはブール値のフィールドを追加するAdd a checkbox or Boolean field

WIT 定義の フィールド セクション内にブール型フィールドを追加するには、次の構文を使用します。Use the following syntax to add a Boolean field within the FIELDS section of the WIT definition.

WIT 定義の フィールド セクション内にブール型フィールドを追加するには、次の構文を使用します。Use the following syntax to add a Boolean field within the FIELDS section of the WIT definition. TFS 2017.2 以降のバージョンが必要です。Requires TFS 2017.2 or later version.

<FIELD name="Triage" refname="Fabrikam.Triage" type="Boolean" >
   <DEFAULT from="value" value="False" />
   <HELPTEXT>Triage work item</HELPTEXT>
</FIELD>

に、form セクション内 に次の構文を追加して、フィールドがフォームに表示されるようにします。And then add the following syntax within the FORM section to have the field appear on the form.

<Control Label="Triage" Type="FieldControl" FieldName="Fabrikam.Triage" />

フィールドは、フォームにチェックボックスとして表示されます。The field will appear as a checkbox on the form.

選択リストをカスタマイズするCustomize a pick list

選択リストは、作業項目フォームのドロップダウンメニューおよびクエリエディター内の [ ] 列に表示される列挙値です。Pick lists are the enumerated values that appear within a drop-down menu in a work item form and the Value column within the query editor. 選択リストのカスタマイズに使用する方法はフィールドによって異なります。The method you use to customize a pick list varies depending on the field.

作業項目フォームの大半の文字列または整数フィールドの選択リストを変更する場合には、WIT 定義を編集します。To modify the pick list for most string or integer fields within a work item form, edit the WIT definition. たとえば、カスタムの "解決策" フィールドおよび選択リストを追加するには、次のような XML コードを指定します。For example, to add a custom Resolution field and pick-list, specify the XML code as shown.

カスタム フィールドと選択リストCustom field and pick list

Custom pick list
<FIELD name="Resolution" refname="MyCompany.Resolution" type="String">    
<ALLOWEDVALUES>
   <LISTITEM value="By Design" />
   <LISTITEM value="Duplicate" />
   <LISTITEM value="External" />
   <LISTITEM value="Fixed" />
   <LISTITEM value="Not Repro" />
   <LISTITEM value="Postponed" />
   <LISTITEM value="Won't Fix" />
</ALLOWEDVALUES>
</FIELD>

規則では、リストの組み合わせ、リストの適用対象の制限、作業項目フォームにリストを表示する条件の設定がサポートされます。Rules support combining lists, restricting to whom a list applies, and setting conditions on when a list appears on the work item form. ルールでは、配布リストを展開して個々のメンバーを表示するか、オプションの expanditems および filteritems 属性を使用してリストをフィルター処理するかを制御します。Rules control whether a distribution list is expanded to show its individual members or a list is filtered by using the optional expanditems and filteritems attributes. グローバルリストを使用して、Wit またはプロジェクト間で共有されているリストを更新するために必要な作業を最小限に抑えます。Use global lists to minimize the work that is required to update a list that is shared across WITs or projects.

複数の Wit または複数のプロジェクトにわたってリストを使用する場合、グローバルなリストとして管理することで、メンテナンス要件を最小限に抑えることができます。When you use a list in several WITs or across several projects, maintaining it as a global list minimizes your maintenance requirements. また、リストの一部を Wit またはプロジェクト間で異なる方法で表示する必要がある場合は、選択リストの一部に対してグローバルリストを定義できます。Also, if you need to have parts of lists show up as different across WITs or projects, you can define a global list for part of a pick list. 選択リストの定義 」および「 グローバルリストの定義」を参照してください。See see Define pick lists and Define global lists.

フィールドに規則を追加するAdd rules to a field

カスタム フィールドを追加するか、またはフィールドに規則を追加する場合は、WIT 定義を編集します。To add a custom field or add rules to a field, edit the WIT definition. 規則の適用対象を特定のユーザーまたはグループに制限できます。You can limit rules to apply to specific users or groups. ほとんどのルールでは、ルールが適用される対象ではなく、適用されないユーザーに 対して、for 属性または not 属性がサポート れます。Most rules support the for or not attributes to focus who the rule does and doesn't apply to.

たとえば、次のコード スニペットを使用すると、作業項目の作成後に "スタック順位" フィールドを変更できるのは、顧客定義の TFS グループである管理チームのメンバーのみであるという規則を適用できます。For example, with the following code snippet, you can enforce the rule that only members of the Management Team, a customer defined TFS group, can modify the Stack Rank field once a work item has been created.

<FIELD name="Stack Rank" refname="Microsoft.VSTS.Common.StackRank" type="Double" reportable="dimension">  
   <FROZEN not="[project]\Management Team" />  
   <HELPTEXT>Work first on items with lower-valued stack rank. Set in triage.</HELPTEXT>
</FIELD>  

次の操作を実行するための規則を適用します。You apply rules to accomplish the following actions:

目的To accomplish this action: 使用する XML 要素Use this XML element:
ツール ヒントを指定します。Specify a tool-tip. HELPTEXTHELPTEXT
フィールドに指定できる値を修飾します。Qualify the value a field can have. CANNOTLOSEVALUEEMPTY凍結NotsameasREADONLY、および REQUIREDCANNOTLOSEVALUE, EMPTY, FROZEN, NOTSAMEAS, READONLY, and REQUIRED
値をコピーするか、既定値を指定します。Copy a value or specify a default. COPYDefault、および serverdefaultCOPY, DEFAULT, and SERVERDEFAULT
フィールドを変更できるユーザーを制限します。Restrict who can modify a field. Validuserfor 、および not フィールド規則の属性VALIDUSER, for and not field rule attributes
パターン マッチを文字列フィールドに適用します。Enforce pattern matching on a string field. MATCHMATCH
その他のフィールドの値に基づいて規則を条件付きで適用します。Conditionally apply rules based on values in other fields. WHENWHENNOTWHENCHANGED、および whennotchangedWHEN, WHENNOT, WHENCHANGED, and WHENNOTCHANGED

"System" プレフィックス (たとえば、System.ID) で始まる名前を持つシステムフィールドは、それらに適用できるルールに基づいて制限されます。System fields, whose names all start with the "System" prefix (for example, System.ID), are limited in terms of the rules you can apply to them. たとえば、作業項目を作成、変更、または終了したユーザーや、システムによって使用されている日付/時刻フィールドを追跡するために使用する、空のフィールドをコピーしたり、設定したりすることはできません。For example, you can't copy or set to empty fields used to track who created, changed, or closed a work item, or date-time fields used by the system.

フィールドの規則と制限の適用の詳細については、「 作業項目フィールドへの規則の適用」を参照してください。For more information about applying field rules and restrictions, see Apply a rule to a work item field.

カスタム フィールドを追加するにはTo add a custom field

カスタムフィールドを追加するには、WIT 定義を編集し て、フィールドセクション内field 要素を追加し、フォーム セクション内に コントロール 要素を追加します。To add a custom field, edit the WIT definition to add a FIELD element within the FIELDS section and a Control element within the FORM section.

  1. 使用するプロセスモデルに基づいて WIT 定義ファイルをエクスポートします。Export the WIT definition file based on the process model you use.

  2. で始まる XML ファイルのセクションを探し FIELDS ます。Locate the section of the XML file that begins with FIELDS.

  3. FIELD追加するカスタムフィールドの名前を指定する要素を追加します。Add the FIELD element that specifies the name of the custom field to add. 次の必須属性を指定する必要があります: フレンドリ namerefname (参照名)、および typeYou must specify the following required attributes: friendly name, refname (reference name), and type. 詳細については、「 FIELD (定義) 要素リファレンス」を参照してください。For more information, see FIELD (Definition) element reference.

    次のコードでは、カスタムフィールドの要求元を指定しています。これは、参照名がで FabrikamFiber.MyTeam.Requestor あり、使用可能な値の選択リストと、既定値は Customer です。The following code specifies the custom field, Requestor, with a reference name of FabrikamFiber.MyTeam.Requestor and a pick list of allowed values, with the default value of Customer.

    <FIELD name="Requestor" refname="FabrikamFiber.MyTeam.Requestor" type="String" reportable="Dimension">
       <ALLOWEDVALUES>
          <LISTITEM value="Customer" />
          <LISTITEM value="Executive Management" />
          <LISTITEM value="Other" />
          <LISTITEM value="Support" />
          <LISTITEM value="Team" />
          <LISTITEM value="Technicians" />
          <DEFAULTVALUE value="Customer" />
        </ALLOWEDVALUES>
    </FIELD>
    

    ヒント

    リスト内の要素は、XML 定義ファイルでの入力方法には関係なく、常にアルファベット順に表示されます。Elements within the list always appear in alphanumeric order, regardless of how you enter them in the XML definition file. 参照名 () は、 refname フィールドのプログラム名です。The Reference Name, or refname, is the programmatic name for the field. 他のすべてのルールは、を参照する必要があり refname ます。All other rules should refer to the refname. 詳細については、「 名前付けの制限と規則」を参照してください。For more information, see Naming restrictions and conventions.

  4. セクション内に要素を追加し Control FORM て、カスタムフィールドを表示する要素のグループ内のフォームに表示されるようにします。Add the Control element within the FORM section so that the custom field appears on the form within the group of elements where you want it to appear.

    たとえば、次のコード スニペットでは、作業項目フォームで理由のフィールドの下に要求元のフィールドが追加されて表示されます。For example, the following code snippet adds the Requestor field to appear below the Reason field on the work item form.

    <Column PercentWidth="50">
       <Group Label="Status">
          <Column PercentWidth="100">
             <Control FieldName="System.AssignedTo" Type="FieldControl" Label="Assi&amp;gned To:" LabelPosition="Left" />
             <Control FieldName="System.State" Type="FieldControl" Label="&amp;State:" LabelPosition="Left" />
             <Control FieldName="System.Reason" Type="FieldControl" Label="Reason:" LabelPosition="Left" ReadOnly="True" />
             <Control FieldName="FabrikamFiber.MyTeam.Requestor" Type="FieldControl" Label="Requestor:" LabelPosition="Left" ReadOnly="True" />
          </Column>
       </Group>
    </Column>
    

    ヒント

    作業追跡のスキーマ定義では、要素のすべての子要素が FORM camel 形式で、その他すべての要素がすべて大文字で定義されます。The schema definition for work tracking defines all child elements of the FORM element as camel case and all other elements as all capitalized. 種類の定義ファイルの検証中にエラーが発生した場合は、要素の大文字と小文字の構造を確認してください。If you encounter errors when validating your type definition files, check the case structure of your elements. また、開始タグと終了タグの大文字と小文字の構造は、XML 構文の規則に従って一致する必要があります。Also, the case structure of opening and closing tags must match according to the rules for XML syntax. 詳細については、「 CONTROL XML 要素 reference」を参照してください。For more information, see Control XML element reference.

  5. 使用するプロセスモデルに従って、WIT 定義ファイルをインポートします。Import the WIT definition file according to the process model you use.

  6. Web ポータルまたはチームエクスプローラーを開いて、変更を表示します。Open either the web portal or Team Explorer to view the changes. クライアントが既に開いている場合は、ページを最新の情報に更新します。If the client is already open, refresh the page.

    次の図に示すように、プロダクト バックログ項目の作業項目フォームに、新しいフィールドが表示されました。The following illustration shows that the work item form for the product backlog item now contains the new field.

    フォームの新しいフィールド

作業項目フォームのフィールド ラベルを変更するにはTo change the field label on a work item form

フィールドラベルを変更するには、要素の属性に割り当てられている値を変更し Control Label ます。To modify the field label, change the value assigned to the Control element Label attribute. 作業項目フォームからフィールドを削除するには、 Control フィールドに関連付けられている要素を削除します。To remove a field from the work item form, delete the Control element associated with the field.

  1. プロセスモデルに従って、WIT 定義ファイルをエクスポートします。Export the WIT definition file according to your process model.

  2. FORM Layout セクションとセクションで、変更するフィールドの定義を見つけます。In the FORM and Layout sections, find the definition of the field you want to modify. 次の例では、 Title フィールドのラベルを変更します。This example modifies the label for the Title field:

    <Column PercentWidth="70">  
       <Control Type="FieldControl" FieldName="System.Title" Label="Title" LabelPosition="Left" />  
    </Column>
    
  3. フィールドのラベルを変更します。これにより、この特定のプロジェクトで作業するポルトガルのブランチオフィスは、作業項目フォームを操作するときに タイトル フィールドの名前を読み取ることができます。Change the label for the field so that the Portuguese branch office working on this particular project can read the name of the Title field when they work with the work item form. "タイトル" フィールドに、タイトルを意味するポルトガル語 (Titulo) を含めます。Include the Portuguese word for title (Titulo) in the Title field.

    <Column PercentWidth="70">  
       <Control Type="FieldControl" FieldName="System.Title" Label="Title (Titulo):" LabelPosition="Left" />  
    </Column>
    
  4. 変更した WIT 定義をインポートします。Import the modified WIT definition.

カスタムコントロールを追加するAdd a custom control

作業項目の追跡にオブジェクトモデルを使用すると、バグ、タスク、およびその他の wit をプログラムで作成、変更、および検索できます。Using the object model for tracking work items, you can programmatically create, change, and find bugs, tasks, and other WITs. 作業項目フォームに機能を追加する独自のカスタム コントロールを作成することもできます。You can also create your own custom controls that add functionality to a work item form.

作業項目の追跡に REST apiを使用すると、バグ、タスク、およびその他の wit をプログラムで作成、変更、および検索できます。Using REST APIs for tracking work items, you can programmatically create, change, and find bugs, tasks, and other WITs. 作業項目フォームに機能を追加する独自のカスタム コントロールを作成することもできます。You can also create your own custom controls that add functionality to a work item form.

または、 Visual Studio Marketplaceで使用できるカスタムコントロールを追加することもできます。Or, you can add a custom control which is available through the Visual Studio Marketplace. 次に例を示します。For example:

新しい web フォームにカスタムコントロールを追加する方法については、「 WebLayout And control elements」を参照してください。To add a custom control to the new web form, see WebLayout and Control elements.

既存のフィールドの属性を変更するChange an attribute of an existing field

既存のフィールドの属性を変更するには、 witadmin changefield を使用します。You use witadmin changefield to change the attributes of an existing field. たとえば次のコマンドでは、MyCompany.Type の表示名を Evaluation Method に変更します。For example, the following command changes the friendly name defined for MyCompany.Type to Evaluation Method.

witadmin changefield /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /n:MyCompany.Type /name:"Evaluation Method"

次の表は、 witadmin changefieldを使用して変更できる属性をまとめたものです。The following table summarizes the attributes you can change using witadmin changefield.

属性Attribute 説明Description
データ型Data type フィールドに設定できるデータの種類を指定します。Specifies the type of data that the field accepts. 一般に、フィールドのデータ型は、いったん定義されると変更できません。In general, you cannot change the field data type once it is defined. フィールドのデータ型は、 HTML または プレーンテキスト 型のフィールドに対してのみ切り替えることができます。You can switch the field data type only for fields of type HTML or PlainText.
フレンドリ名Friendly name 表示名は作業項目クエリのドロップダウンメニューに表示され、プロジェクトコレクション内で定義されているすべてのフィールドで一意である必要があります。The friendly name appears in the drop-down menus of work item queries and it must be unique across all fields that are defined within a project collection. 表示名は、作業項目フォームに表示されるフォーム ラベルとは異なる場合があります。The friendly name may differ from the form label that appears on the work item form.
レポート属性Reporting attributes レポートに表示されるフィールドの名前、レポートの参照名、レポートの種類を変更できます。You can change the name of the field as it appears in a report, the report reference name, and the reporting type. レポートの表示名はローカライズ可能です。You can localize the reporting friendly name.

レポートの種類で、OLAP キューブを処理するときにフィールドのデータをリレーショナル ウェアハウス データベースまたはリレーショナル ウェアハウス データベースと OLAP キューブの両方に書き込むかどうか、または事前に計算した値の合計を生成するかどうかが決定されます。The reporting type determines whether the field's data is written to the relational warehouse database, to both the relational warehouse database and to the OLAP cube, or to generate a pre-calculated sum of values when processing the OLAP cube.

既定のレポート可能フィールドの完全な一覧については、「 レポート可能フィールドリファレンス」を参照してください。For a complete list of the default reportable fields, see Reportable fields reference. レポート可能な属性の詳細については、「 作業項目フィールドと属性、レポート可能属性」を参照してください。For more information about reportable attributes, see Work item fields and attributes, Reportable attributes.
SynchronizationSynchronization Active Directory では、人名フィールドの同期を有効または無効にすることができます。You can enable or disable synchronization for person-name fields with Active Directory.

フィールドのインデックス属性を変更するChange the index attribute of a field

フィールドをフィルター処理する際にクエリの応答時間が改善されるように、フィールドのインデックス作成を有効にすることができます。You can enable indexing for a field to improve query response times when filtering on the field. 既定では、"担当者"、"作成日"、"変更者"、"状態"、"理由"、"区分 ID"、"イテレーション ID"、"作業項目の種類" の各フィールドにインデックスが付けられます。By default, the following fields are indexed: Assigned To, Created Date, Changed By, State, Reason, Area ID, Iteration ID, and Work Item Type.

フィールドのインデックス作成を有効または無効にするには、 witadmin indexfield コマンドを使用します。To enable or disable indexing for a field, use the witadmin indexfield command.

このトピックでは、ホストされている XML およびオンプレミスの XML プロセスモデルのフィールドを追加およびカスタマイズする方法について説明します。This topic addressed how to add and customize fields for Hosted XML and On-premises XML process models. ホストされる XML およびオンプレミスの XML プロセスモデルの Wit の追加とカスタマイズの詳細については、「 作業項目の種類を追加または変更する」を参照してください。For information on adding and customizing WITs for Hosted XML and On-premises XML process models, see Add or modify a work item type. 継承プロセスモデルについては、「 プロセスをカスタマイズする」を参照してください。For the Inheritance process model, see Customize a process.

関連するその他のトピックまたはリソース:Other related topics or resources:

必要なアクセス許可Required permissions

  • フィールドを一覧表示するには、コレクション内のプロジェクトの [ プロジェクトレベル情報の表示 ] アクセス許可が [ 許可] に設定されている必要があります。To list fields, you must have your View project-level information permission for the project in the collection set to Allow.
  • TFSフィールドを追加またはカスタマイズするには、プロジェクト管理者グループのメンバーであるか、または [ プロジェクトレベル情報の編集 ] のアクセス許可が [許可] に設定されている必要があります。(TFS) To add or customize a field, you must be a member of the Project Administrators group or have your Edit project-level information permission set to Allow.
  • TFSフィールドの削除または名前の変更、またはフィールドの属性の変更を行うには、 Team Foundation 管理者 セキュリティグループまたは プロジェクトコレクション管理者 セキュリティグループのメンバーである必要があります。(TFS) To delete or rename fields or change an attribute of a field, you must be a member of the Team Foundation Administrators security group or the Project Collection Administrators security group.

管理者として追加するには、 管理者を追加します。To get added as an administrator, Add administrators.

フィールドとは何ですか。What is a field? フィールド名はどのように使用されますか。How are field names used?

作業項目の種類 は、31のシステムフィールドと、いくつかの種類固有のフィールドに関連付けられています。Each work item type is associated with 31 system fields and several more type-specific fields. プロジェクトを計画および追跡するには、作業項目を使用します。You use work items to plan and track your project.

各フィールドは、実行する作業に関する情報の追跡をサポートしています。Each field supports tracking a piece of information about the work to perform. フィールドに割り当てる値は、作業追跡データストアに格納されます。このストアを使用して、状態と傾向を判断するためのクエリを作成できます。Values you assign to a field are stored in the work tracking data store which you can create queries to determine status and trends.

コアシステム用に定義されている各フィールドの説明と使用方法については、 — スクラム、アジャイル、および CMMI のシステムプロセスを — 参照してください。作業項目フィールドのインデックスを参照してください。For descriptions and usage of each field defined for the core system processes—Scrum, Agile, and CMMI system processes—see Work item field index.

フィールド名Field names

作業項目のフィールド名は、各作業項目フィールドを一意に識別します。A work item field name uniquely identifies each work item field. フィールド名が次のガイドラインに収まることを確認します。Make sure your field names fall within these guidelines:

  • フィールド名は、アカウントまたはプロジェクトコレクション内で一意である必要がありますField names must be unique within the account/project collection
  • フィールド名は128以下の Unicode 文字でなければなりませんField names must be 128 or fewer Unicode characters
  • フィールド名に先頭または末尾のスペースを含めることはできません。また、2つ以上の連続するスペースも使用できませんField names can't contain any leading or trailing spaces, nor two or more consecutive spaces
  • フィールド名には少なくとも1つのアルファベット文字を含める必要がありますField names must contain at least one alphabetic character
  • フィールド名に次の文字を含めることはできません: .,;'`:~\/\*|?"&%$!+=()[]{}<>Field names can't contain the following characters: .,;'`:~\/\*|?"&%$!+=()[]{}<>.

カスタムフィールドはアカウントコレクションに対して定義されているので、別の継承されたプロセスに追加したのと同じフィールド名を持つプロセスにカスタムフィールドを追加することはできません。Because custom fields are defined for the account collection, you can't add a custom field to a process with the same field name that you add to another inherited process.

フィールドの一覧表示または確認List or review fields

フィールドを一覧表示または確認するには、使用するプロセスモデルの — 継承、ホストされた xml、またはオンプレミスの xml に応じて、次のいずれかのツールを使用でき — ます。To list or review fields, you can use one of the following tools, depending on the process model—Inheritance, Hosted XML, or On-premises XML—you use. 既定のプロセス内で定義されているフィールドのインデックスについては、「 作業項目フィールドのインデックス」を参照してください。For an index of fields defined within the default processes, see Work item field index.

ツールTool 継承Inheritance ホストされた XMLHosted XML オンプレミス XMLOn-premises XML
Web ポータル: 継承およびカスタム定義のフィールドの一覧表示Web portal: List inherited and custom-defined fields ✔️✔️ ✔️1✔️1
作業項目フィールド エクスプローラーWork item field explorer ✔️✔️ ✔️✔️ ✔️✔️
witadmin listfields コマンドラインツールwitadmin listfields command line tool ✔️✔️ ✔️✔️ ✔️✔️

注:Notes:

  1. 既定のプロセス (アジャイル、CMMI、スクラム) でのみサポートされます。Only supported for default processes (Agile, CMMI, Scrum).

作業項目フィールドエクスプローラーWork Item Field Explorer

作業項目フィールドの変更できる属性に加えて、各フィールドには変更できず、事実上、非表示の属性がいくつか存在します。In addition to the attributes that you can change for a work item field, there are several non-changeable and virtually hidden attributes for each field. 作業項目フィールド エクスプローラー ツールを使用して、これらのフィールドの割り当てを参照することができます。You can look up the assignments of these fields using the Work Item Field Explorer tool.

作業項目フィールド エクスプローラー

各属性の説明については、「 作業項目フィールドと属性」を参照してください。For a description of each attribute, see Work item fields and attributes.

作業項目フィールドエクスプローラーにアクセスするには、プロセスエディターツールをインストールする必要があります。To access the Work Item Field Explorer, you must install the Process Editor Tool. インストールされている Visual Studio のバージョンに基づいて、次のいずれかの拡張機能からプロセスエディターツールを取得します。Based on the version of Visual Studio you have installed, get the Process Editor Tool from one of the following extensions.

テスト、ビルド、およびバージョン管理の各フィールドTest, build, and version control fields

いくつかの WIT のフィールドには、Team Foundation ビルド、Microsoft テスト マネージャー、Team Foundation バージョン管理と統合される自動化されたプロセスによって生成される情報が含まれます。Several WITs contain fields that provide information that is generated by automated processes that integrate with Team Foundation Build, Microsoft Test Manager, and Team Foundation version control. これらのフィールドのいずれかをカスタム Wit に追加するには、このトピックで既に説明した手順に従って WIT 定義を編集 します。To add one of these fields to your custom WITs, you edit the WIT definition according to the steps outlined previously in this topic.

たとえば、バグの種類の定義に表示される [ 検出 されたビルド] フィールドと [ 統合ビルド ] フィールドを追加できます。For example, you can add the Found In and Integrated in Build fields that appear in the type definitions for bugs. これらのフィールドは、バグをそのバグが発見されたビルドや修正されたビルドと関連付けます。These fields associate bugs with the builds where they were found or fixed. 作業項目の種類の定義にこれらのフィールドを追加するには、次のコード スニペットを使用できます。You can use the following code snippet to add these fields to a work item type definition.

<FIELD name="Found In" refname="Microsoft.VSTS.Build.FoundIn" type="String" reportable="dimension">
    <HELPTEXT>Product build number (revision) in which this item was found</HELPTEXT>
</FIELD>
<FIELD name="Integration Build" refname="Microsoft.VSTS.Build.IntegrationBuild" type="String" reportable="dimension">
    <HELPTEXT>Product build number this bug was fixed in</HELPTEXT>
</FIELD>

詳細については、「 ビルドとテストの統合フィールドに基づくクエリ」を参照してください。For more information, see Query based on build and test integration fields.

フィールド名とレポートField names and reporting

レポートをサポートするために、フィールドを追加したり、既存のフィールドの属性を変更したりできます。You can add fields or change the attributes of existing fields to support reporting. フィールドを追加または変更するときは、系統的な名前を付けて Analysis Services キューブのフィールドを検索できるようにします。これは、フォルダー内でフィールドが論理的にグループ化されるためです。When you add or change fields, you should name them systematically so that you can find the field in the Analysis Services cube because the fields are logically grouped into folders. 詳細については、「 レポートをサポートするための作業項目フィールドの追加または変更」を参照してください。To learn more, see Add or modify work item fields to support reporting.

フィールドの削除Delete a field

特定の種類の作業項目からフィールドを削除しても、そのフィールドは WIT によって参照されなくなった場合でも、コレクションまたはデータベースサーバーからは削除されません。When you remove a field from a specific type of work item, that field is not removed from the collection or the database server, even if it is no longer referenced by any WIT. フィールドを削除するには、次の手順に従います。To remove a field, follow these steps.

  1. すべての FIELD WIT 定義とそれを参照するすべてのグローバルワークフローから定義を削除します。Remove the FIELD definition from all WIT definitions and any global workflows that reference it.

  2. フィールドが使用中でないことを確認します。Verify the field is not in use. 次に例を示します。For example:

    witadmin listfields /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /n:MyCompany.CustomContact
    
    Field: MyCompany.CustomContact
    Name: Custom Contact
    Type: String
    Reportable As: dimension
    Use: Not In Use
    Indexed: False
    
  3. フィールドを削除します。Delete the field. 次に例を示します。For example:

    witadmin deletefield /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /n:MyCompany.CustomContact
    
  4. Deleted フィールドがレポート可能な場合は、 データウェアハウスを再構築して、古いフィールドとその値を消去します。If the deleted field was reportable, rebuild the data warehouse to purge the old field and its values.

詳細については、「 作業項目フィールドの管理」を参照してください。For more information, see Manage work item fields.

::: moniker-end