title | titleSuffix | description | ms.custom | ms.service | ms.assetid | ms.author | author | ms.topic | monikerRange | ms.date |
---|---|---|---|---|---|---|---|---|---|---|
Add custom work item type to inherited process |
Azure DevOps Services |
Learn how to add a custom work item type for an Inheritance process model and apply it to a project. |
inherited-process |
azure-devops-boards |
DBF41880-62A4-43A9-9A31-8DB701EB888E |
chcomley |
chcomley |
quickstart |
>= azure-devops-2019 |
08/03/2022 |
[!INCLUDE version-gt-eq-2019]
You use different work item types (WITs) to plan and track different types of work. The main reason you add a custom WIT is to customize the web form and workflow states to meet specific business use cases. Or, you can customize an existing WIT. Your project contains 9 or more WITs that you can customize, based on the process used to create your project.
[!INCLUDE temp]
For example, you may want to capture customer issues in a custom WIT labeled Ticket.
To learn more about what you can customize, see About process customization and inherited processes.
Tip
To customize a single project, always start by creating an inherited process and migrating project(s) to that process. Then, all the customizations that you make to the inherited process automatically appear for the project you migrated.
[!INCLUDE temp]
[!INCLUDE temp]
For more information, see Create inherited process.
-
From the Work Item Types page, choose the :::image type="icon" source="../../../media/icons/blue-add-icon.png" border="false"::: New work item type.
-
Name the WIT and optionally specify a description, icon and color. The icon and color you specify appear throughout the web portal, including on the work item form and when associated work items appear on a backlog, boards, query results, and more.
Choose Create to save.
Each new WIT comes predefined with a Details page with the Description field, and Discussion, Development, and Related Work groups. Also added, but not shown nor editable, are the standard elements included with the header of the form as shown in the following image, as well as the history, links, and attachment pages. To learn more, see About work items.
-
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.
Here we add an Integer field labeled Customer Ticket.
Additional data types you can add include: Picklist, Identity, Rich-text, HTML, and Checkbox.
-
(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.
-
(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 choose to add a new field. Choose the :::image type="icon" source="media/process/new-field-icon.png" border="false"::: (New Field icon).
-
Here, we add the Customer Ticket field to a new group labeled Customer focus.
-
Choose Add field to complete adding the field. If you didn't specify its layout location, it gets 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.
We recommend that you create a test project and apply your customized inherited process to it to verify the changes you've made.
-
Open the All processes page, and choose the … context menu for the process you want to use, and then select New team project.
::: moniker range="azure-devops"
[!div class="mx-imgBorder"]
::: moniker-end ::: moniker range=">= azure-devops-2020 < azure-devops" [!div class="mx-imgBorder"]
::: moniker-end ::: moniker range="azure-devops-2019" [!div class="mx-imgBorder"]
::: moniker-end
-
The Create new project page opens. Fill out the form.
::: moniker range="azure-devops"
[!div class="mx-imgBorder"]
::: moniker-end ::: moniker range=">= azure-devops-2020 < azure-devops" [!div class="mx-imgBorder"]
::: moniker-end ::: moniker range="azure-devops-2019" [!div class="mx-imgBorder"]
::: moniker-end
-
Open Work Items. (1) Check that you have selected the right project, then (2) choose Work>Work Items.
-
Select the WIT you customized. Here we choose Ticket.
If you don't see the custom WIT, refresh your browser to make sure it registers all the custom changes you've made.
-
Verify that the field you added appears on the form. Note that the :::image type="icon" source="../../../media/icons/required-icon.png" border="false"::: (exclamation mark) icon indicates the field is required.
[!INCLUDE temp]
[!INCLUDE temp]
[!div class="nextstepaction"] Customize the web layout Or Customize the workflow
[!INCLUDE temp]