Add a custom field to a work item type (Inheritance process)

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

You add a custom field to support tracking data requirements you have that aren't met with the existing set of fields. For example, you can add a custom field to track a customer ticket number. For a list of all fields defined for your organization—which includes all fields defined for system and inherited processes—see View work item fields and attributes. For a description of each field defined with a system process, see Work item field index.

To learn more about what you can customize, see About process customization and inherited processes.

Prerequisites

Prior to customizing a process, we recommend that you review Configure and customize Azure Boards, which provides guidance on how to customize Azure Boards to meet your business needs. For a description of the different backlogs and boards, see Tasks supported by Backlogs, Boards, Taskboards, and Plans.

Create an inherited process

The first step is to create an inherited process that you can customize. The default, system processes are locked from being customized.

1. From the Process page, open the … context menu of the process you'll use to create an inherited process, and then choose Create inherited process. Choose the same system process—Agile, Basic, Scrum, or CMMI—that was used to create the project that you want to customize.

   Here, we create an inherited process from the Agile system process.

   

   

   

   Important

   If you don't see the Create inherited process menu option, then the collection you've selected is set to work with the On-premises XML process model. You can import and export process templates and use the features supported for the On-premises XML process model.

2. Enter a name for your process and optionally a description. Process names must be unique and no more than 128 characters. For additional restrictions, see Create and manage inheritance processes, Process name restrictions. Optionally, add a description.

   

Add a field

You always add a field to an existing work item type.

1. From the Process page of the selected inherited process, choose the work item type you want to add the custom field to.

   Here we choose the Bug WIT. Note the breadcrumb links that allow you to move back to the All Processes and MyAgile process page.

   

   If the New field and other options are disabled, you don't have the necessary permissions to edit the process. See Set permissions and access for work tracking, Customize an inherited process.

2. With the WIT selected, choose the New field.

   

3. Name the field and select the field type from one of the supported data types. Field names must be unique and no more than 128 characters. For additional restrictions, see What is a field? How are field names used?. Optionally, add a Description.

   Note

   Once created, you can't change the field name or data type.

   Here we add an Integer field labeled Customer Ticket.

   

   Additional data types you can add include: Picklist, Identity, Rich-text, HTML, and Checkbox.

4. (Optional) On the Options tab, indicate if the field is required and specify a default value. Or leave these blank.

   

   By making a field Required, users must specify a value for the field in order to save it. The default value you specify is set when you create a work item as well as every time a work item is opened and the field is empty.

5. (Optional) On the Layout tab, you can enter a different form label than the name of the field. Also, you can choose the page and group where the field appears on the form.

   Here, we add the Customer Ticket field to a new group labeled Customer focus.

   

6. Choose Add field to complete adding the field. If you haven't specified it's layout location, it is added to the first group of fields on the layout form.

   Tip

   Once you've added a field, you can drag-and-drop it within a page to relocate it on the form. If you have several fields you want to add to a custom page or group, then you may want to add those elements first and then add your fields. You can't add a field to the gray area within the form where the Assigned To, State, and Reason fields are located.

Verify the customization you made

We recommend that you create a test project and apply your customized inherited process to it to verify the changes you've made.

1. Open the All processes page, and choose the … context menu for the process you want to use, and then select New team project.

   

   

   

2. The Create new project page opens. Fill out the form.

   

   

   

3. Open Work Items. (1) Check that you have selected the right project, then (2) choose Work>Work Items.

   

4. Select the WIT you customized. Here we choose Bug.

   

5. Verify that the field you added appears on the form. Note that the (exclamation mark) icon indicates the field is required.

   

Apply the customized process to your project

After you've verified your customizations, you can now apply the process to your existing project.

Try this next

Related articles

• View work item fields and attributes
• Add and manage fields for an inherited process
• Customize a project using an inherited process
• Create and manage inherited processes