You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: In this quickstart, learn how to add a custom field to the web form of a work item type for an Inheritance process model and apply it to a project.
4
+
description: Learn how to add a custom field to the web form of a work item type for an Inheritance process model and apply it to a project.
5
5
ms.custom: inherited-process
6
6
ms.service: azure-devops-boards
7
7
ms.assetid: D6616411-43D4-4A81-8951-772D98BD1569
8
8
ms.author: chcomley
9
9
author: chcomley
10
10
ms.topic: quickstart
11
11
monikerRange: '<= azure-devops'
12
-
ms.date: 07/31/2025
12
+
ms.date: 08/13/2025
13
13
#customer intent: As a team leader, I want to know how to add a custom field to my work items in Azure Boards.
14
14
---
15
15
16
16
# Quickstart: Add a custom field to a work item type (Inheritance process)
In this quickstart, 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 [List work item fields and attributes](../../../boards/work-items/work-item-fields.md). For a description of each field defined with a system process, see [Default and work item fields used in process templates](../../../boards/work-items/guidance/work-item-field.md).
20
+
In this quickstart, you add a custom field to support tracking data requirements 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 [List work item fields and attributes](../../../boards/work-items/work-item-fields.md). For a description of each field defined with a system process, see [Default and work item fields used in process templates](../../../boards/work-items/guidance/work-item-field.md).
For more information, see [About process customization and inherited processes](inheritance-process-model.md).
25
25
26
-
> [!TIP]
26
+
> [!TIP]
27
27
> To customize a single project, always start by [creating an inherited process and updating your project to that process](manage-process.md). Then, all the customizations that you make to the inherited process automatically appear for the project you migrated.
28
28
29
29
## Prerequisites
@@ -36,61 +36,61 @@ For more information, see [About process customization and inherited processes](
36
36
37
37
For more information, see [Create an inherited process](manage-process.md#create-an-inherited-process).
38
38
39
-
<aid="add-wit"></a>
39
+
<aid="add-wit"></a>
40
40
41
41
## Add a field
42
42
43
-
Do the following steps to add a field to an existing work item type. You can't use the **Steps** control on a custom work item type based on the Test Case work item type.
43
+
Follow these steps to add a field to an existing work item type. You can't use the **Steps** control on a custom work item type (WIT) based on the **Test Case** work item type.
44
44
45
-
1. From the **Process** page of the selected inherited process, choose the work item type (WIT) you want to add the custom field to.
45
+
1. From the **Process** page of the selected inherited process, choose the work item type you want to add the custom field to.
46
46
47
47
This example uses the Bug WIT. The breadcrumb links allow you to move back to the **All Processes** and **MyAgile** process page.
48
48
49
49
:::image type="content" source="media/field/breadcrumbs-bug-wit.png" alt-text="Screenshot shows the process page for MyAgile, showing a bug.":::
50
50
51
51
If the **New field** and other options are disabled, you don't have the necessary permissions to edit the process. See [Customize an inherited process](../../../organizations/security/set-permissions-access-work-tracking.md#customize-an-inherited-process).
52
-
53
-
1. With the WIT selected, choose the :::image type="icon" source="media/process/new-field-icon.png":::**New field**.
52
+
53
+
1. With the WIT selected, select**New field**.
54
54
55
55
:::image type="content" source="media/field/bug-new-field.png" alt-text="Screenshot shows the process page for a WIT with New field highlighted.":::
56
56
57
57
1. 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 other restrictions, see [What is a field? How are field names used?](inheritance-process-model.md#field-reference) Optionally, add a description.
58
58
59
-
> [!NOTE]
59
+
> [!NOTE]
60
60
> Once created, you can't change the field name or data type.
61
61
62
-
This example adds an Integer field labeled Customer Ticket.
62
+
This example adds an **Integer** field labeled *Customer Ticket*.
63
63
64
64
:::image type="content" source="media/process/cpfield-add-field-to-bug-type-integer-up1.png" alt-text="Screenshot shows the Create a field option for a Bug.":::
65
65
66
66
Other data types you can add include: [Picklist](customize-process-field.md#add-a-picklist), [Identity](customize-process-field.md#add-an-identity-field), [Rich-text, HTML](customize-process-field.md#add-a-rich-text-html-field), and [Checkbox](customize-process-field.md#add-a-checkbox-field).
67
67
68
-
<a id="options"></a>
68
+
<a id="options"></a>
69
69
1. (Optional) On the **Options** tab, indicate if the field is required. Specify a default value.
70
70
71
71
:::image type="content" source="media/process/cpfield-bug-customer-ticket-options.png" alt-text="Screenshot shows the Options page where you can make the field required and specify a default value.":::
72
72
73
73
If a field is 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 and every time a work item is opened and the field is empty.
74
74
75
-
<a id="layout"></a>
75
+
<a id="layout"></a>
76
76
1. (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.
77
77
78
-
This example adds the Customer Ticket field to a new group labeled Customer focus.
78
+
This example adds the *Customer Ticket* field to a new group labeled *Customer focus*.
79
79
80
80
:::image type="content" source="media/process/cpfield-customer-ticket-layout.png" alt-text="Screenshot shows the Layout page where you can specify how the field is displayed.":::
81
81
82
82
1. Choose **Add field** to complete adding the field. If you don't specify its layout location, it's added to the first group of fields on the layout form.
83
83
84
-
> [!TIP]
84
+
> [!TIP]
85
85
> After you add 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, [add those elements first](customize-process-form.md) 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.
86
86
87
-
<aid="verify"></a>
87
+
<aid="verify"></a>
88
88
89
89
## Verify the customization you made
90
90
91
91
We recommend that you create a test project and apply your customized inherited process to it to verify the changes you made.
92
92
93
-
1. Open the **All processes** page, and choose the … context menu for the process you want to use. Then select **New team project**.
93
+
1. Open the **All processes** page, and choose the **...** context menu for the process you want to use. Then select **New team project**.
94
94
95
95
::: moniker range="azure-devops"
96
96
:::image type="content" source="media/process/new-team-project-from-inherited-process-menu.png" alt-text="Screenshot shows the create a project option for a selected process.":::
@@ -108,15 +108,15 @@ We recommend that you create a test project and apply your customized inherited
108
108
:::image type="content" source="media/add-custom-field/create-new-project-2020.png" alt-text="Screenshot shows the Create new project page.":::
109
109
::: moniker-end
110
110
111
-
1.Open **Work Items**. Select your project, then choose **Work** > **Work Items**.
111
+
1. Open **Work Items**. Select your project, then choose **Work** > **Work Items**.
112
112
113
113
:::image type="content" source="../../../boards/work-items/media/view-add/open-work-items-agile.png" alt-text="Screenshot shows Azure Boards with Work items selected.":::
114
114
115
115
1. Select the WIT you customized, in this example, **Bug**.
116
116
117
117
:::image type="content" source="media/process/add-custom-field-verify-bug.png" alt-text="Screenshot shows New Work Item with the Bug item selected.":::
118
118
119
-
1.Verify that the field you added appears on the form. The :::image type="icon" source="../../../media/icons/required-icon.png"::: (exclamation mark) icon indicates the field is required.
119
+
1. Verify that the field you added appears on the form. The :::image type="icon" source="../../../media/icons/required-icon.png"::: (exclamation mark) icon indicates the field is required.
120
120
121
121
:::image type="content" source="media/process/add-custom-field-verify-bug-form.png" alt-text="Screenshot shows the New Bug with the Customer Ticket field added.":::
122
122
@@ -126,14 +126,17 @@ We recommend that you create a test project and apply your customized inherited
126
126
127
127
> [!div class="nextstepaction"]
128
128
> [Add a custom work item type](add-custom-wit.md)
129
-
> Or
130
-
> [Add or manage fields](customize-process-work-item-type.md)
129
+
130
+
OR
131
+
132
+
> [!div class="nextstepaction"]
133
+
> [Add and manage work item types](customize-process-work-item-type.md)
0 commit comments