XML element reference
Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018 - TFS 2013
This article applies to project customization for On-premises XML process models. For an overview of process models, see Customize your work tracking experience.
You can customize your project to support specific processes and practices that your team uses, and to design your workflow, work item forms, and data fields. Customization requires modifying one or more XML definition files. Each file corresponds to a work item tracking object. You can look up the syntax structure of each XML element from the topics provided in this section.
This illustration shows that you can create or customize eight types of objects. For projects, you can customize categories, work item types, and process configuration. For project collections, you can customize global lists, link types, and work item fields. You can customize global workflow for a project or for a project collection. For a description of these objects and other customization options, see Agile glossary and Customize your work tracking experience.
By using the index of elements in this topic, you can look up the syntax structure and find examples of how to use each element of the schema type definition for work item tracking. Elements are organized alphabetically and by the following four major groups:
WITD: The root element of the definition schema for types of work items.
FIELD (Definition): You use this element and its child elements to define a work item field and to specify the rules and conditions that apply to it. See Modify a field or add a custom field. To access descriptions for all fields defined within the default process templates, including system fields, see Index of work item fields.
WORKFLOW: You use this element and its child elements to define the states, transitions, and reasons that compose the workflow of a type of work item. In addition to the following elements, you can use most of the elements listed under FIELD to reference a field and apply conditions to it when a user changes its state. For more information, see Change the workflow.
Changes you make to the workflow can affect the operation of the Agile planning tools, the backlog and task board pages, and other tools. You might need to customize the process configuration. See Process configuration.
FORM: You use this element and its child elements to specify the fields that appear on the work item form and the layout or design of the form. For more information, see Design the work item form.
Index of WITD XML elements
The following table provides an index to the reference topics for all child elements of the parent container element. Also, you can access the topic that provides detailed information and examples for each child element.
The new form elements (FORM-WebLayout) and its corresponding features are available from the web portal for TFS 2017 and later versions. To learn more about the new for, see enable the new form
- For users of Azure DevOps Services working with hosted XML customization, an admin is required to enable the new form.
- For TFS 2017 users, the new form is automatically available when you add projects to a new collection. For existing projects, an admin is required to enable the new form.
- For TFS 2015 users, the new form isn't available. Use the (FORM-Layout) elements to customize your WIT definitions. You must upgrade to TFS 2017 or later version to access the new form.
- Extension - Extensions
- Link (Hyperlink)
- Link (Label Text)
- Link (Web page)
Index of other work tracking object XML elements
The following table provides an index to the reference topics for the elements used to define categories, global lists, link types, and process configuration.