Work item field index
Azure Boards | TFS 2018 | TFS 2017 | TFS 2015 | TFS 2013
Use this index to look up a description of each field used to track work items. This reference includes all fields defined within the core system processes/process templates: Agile, Scrum, and CMMI. The fields and work item types (WITs) available to you depend on the process you chose when you created your project.
To support additional tracking needs, you can define your own custom work item fields.
To support additional tracking needs, you can modify or add a custom field.
Values in parenthesis indicate the following:
- System: Core system field assigned to all work item types for all processes
- Agile: Used only by the Agile process
- CMMI: Used only by the CMMI process
- Scrum: Used only by the Scrum process
- TCM: Used to support Test case management
By using the system fields or other fields you have added to your project collection, you can enable meaningful cross-project reports and queries. In addition, any non-system field that is referenced in the workflow or forms section of the work item type definition must have a FIELD element that defines it in the FIELDS section of the work item type definition XML file. Also, you must specify any non-system field that you might want to use to generate a query or report in the FIELDS section.
Field reference topics
The following articles describe fields that are used in common by several WITs, or those that are functionally specific to just one or a few WITs.
Fields common to many work types
- Titles, IDs, and descriptive fields
- History and revision changes
- Areas and iterations
- Assignments and account-specific fields
- Planning, ranking, and priorities
- Work estimates, activity, and other numeric fields
- Build and test integration fields
- Links and attachment related fields
Fields used by specific work item types
Fields used to track CMMI work items
What is a field? How are field names used?
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
- Field names must be 128 or fewer Unicode characters
- Field names can't contain any leading or trailing spaces, nor two or more consecutive spaces
- 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.
When adding custom fields, note the following limits:
- A maximum of 256 fields can be defined for each WIT
- A maximum of 512 fields can be defined per process
Add and modify fields
To add fields to a process, modify select field attributes, and review fields added to a process, see Customize a process.
Also, you can view the list of fields defined for an organization and the WITs which reference them.
Modify the field name and other field attributes
You can change the field name, the index, and the report attributes for any field except system fields by using the witadmin command-line tool. For more information, see Manage work item fields-witadmin.
Hidden field attributes and the Work Item Field Explorer
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 this post: Work Item Field Attributes - What You Can and Can't Change.
To access the Work Item Field Explorer, you must install the Process Editor (requires that you have installed a version of Visual Studio):
- For TFS 2017 and later versions, 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. You can't use it to edit forms associated with the new web forms.
- For TFS 2015 and earlier versions, install TFS Power Tools.
- Create managed queries
- Define a query
- Choose a process
- Reportable fields reference (on-premises TFS only)
You can list the attributes of fields using the witadmin listfields command.