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
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.
20
+
In this quickstart, you create a custom work item type (WIT). In Azure Boards, You use different work item types 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.
For example, you may want to capture customer issues in a custom WIT labeled Ticket.
24
+
For example, you might want to capture customer issues in a custom WIT labeled Ticket.
24
25
25
-
> [!div class="mx-imgBorder"]
26
-
> 
26
+
:::image type="content" source="media/process/custom-wit-new-ticket-form.png" alt-text="Screenshot shows a custom Ticket work item form.":::
27
27
28
28
To learn more about what you can customize, see [About process customization and inherited processes](inheritance-process-model.md).
29
29
30
30
> [!TIP]
31
-
> To customize a single project, always start by [creating an inherited process and migrating project(s) to that process](manage-process.md). Then, all the customizations that you make to the inherited process automatically appear for the project you migrated.
31
+
> To customize a single project, always start by [creating an inherited process and migrating projects to that process](manage-process.md). Then, all the customizations that you make to the inherited process automatically appear for the project you migrated.
32
32
33
33
## Prerequisites
34
34
@@ -44,103 +44,94 @@ For more information, see [Create inherited process](manage-process.md#create-an
44
44
45
45
## Add a work item type
46
46
47
-
1. From the **Work Item Types** page, choose the :::image type="icon" source="../../../media/icons/blue-add-icon.png" border="false"::: **New work item type**.
47
+
1. From the **Work Item Types** page, choose the :::image type="icon" source="../../../media/icons/blue-add-icon.png"::: **New work item type**.
48
48
49
-
49
+
:::image type="content" source="media/process/cpwit-add-new-wit.png" alt-text="Screenshot shows the All processes page for the MyAgile process, with Add new work item type highlighted.":::
50
50
51
-
1. 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.
51
+
1. 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, and query results.
52
52
53
-
53
+
:::image type="content" source="media/process/cwit-create-wit-ticket.png" alt-text="Screenshot shows Create new work item type dialog where you can enter a name and other values.":::
54
54
55
55
Choose **Create** to save.
56
56
57
-
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. For more information, see [About work items](../../../boards/work-items/about-work-items.md).
57
+
Each new WIT comes predefined with a **Details** page with the **Description** field, and **Discussion**, **Development**, and **Related Work** groups. Standard elements are also added, but not shown or editable. These elements are included with the header of the form as shown in the following image, and the history, links, and attachment pages. For more information, see [About work items](../../../boards/work-items/about-work-items.md).
:::image type="content" source="media/process/weblayout-system-controls-details-page.png" alt-text="Screenshot shows the WIT header details for the new work item.":::
60
60
61
-
2. 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?](inheritance-process-model.md#field-reference). Optionally, add a description.
61
+
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.
62
62
63
-
Here we add an Integer field labeled Customer Ticket.
63
+
This example adds an Integer field labeled **Customer Ticket**.
64
64
65
-
65
+
:::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.":::
66
66
67
-
Additional data types you can add include: [Picklist](customize-process-field.md#pick-list), [Identity](customize-process-field.md#identity), [Rich-text, HTML](customize-process-field.md#html), and [Checkbox](customize-process-field.md#boolean-field).
67
+
Other data types you can add include: [Picklist](customize-process-field.md#pick-list), [Identity](customize-process-field.md#identity), [Rich-text, HTML](customize-process-field.md#html), and [Checkbox](customize-process-field.md#boolean-field).
68
68
<a id="options"> </a>
69
-
3. (Optional) On the **Options** tab, indicate if the field is required and specify a default value. Or leave these blank.
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
-
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.
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
75
<aid="layout"> </a>
76
-
4. (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.
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
-
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).
78
+
This example adds a new field. Choose the :::image type="icon" source="media/process/new-field-icon.png" border="false"::: (**New Field** icon).
:::image type="content" source="media/process/cpwit-new-ticket-define.png" alt-text="Screenshot shows the new field option for your new Ticket work item.":::
82
81
83
-
5. Here, we add the Customer Ticket field to a new group labeled Customer focus.
82
+
1. Here, we add the Customer Ticket field to a new group labeled **Customer focus**.
84
83
85
-
84
+
:::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.":::
86
85
87
-
6. 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.
86
+
1. 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.
88
87
89
88
> [!TIP]
90
-
> 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](customize-process-form.md) and then add your fields.
89
+
> 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.
91
90
92
91
## Verify the customization you made
93
92
94
-
We recommend that you create a test project and apply your customized inherited process to it to verify the changes you've made.
93
+
We recommend that you create a test project and apply your customized inherited process to it to verify the changes you made.
95
94
96
-
1. Open the **All processes** page, and choose the … context menu for the process you want to use, and then select **New team project**.
95
+
1. Open the **All processes** page, and choose the … context menu for the process you want to use. Then select **New team project**.
97
96
98
97
::: moniker range="azure-devops"
99
-
> [!div class="mx-imgBorder"]
100
-
> 
98
+
:::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.":::
> 
101
+
:::image type="content" source="media/add-custom-field/choose-new-team-project.png" alt-text="Screenshot shows the Create a project option for your modified process.":::
105
102
::: moniker-end
106
-
107
103
108
-
1. The Create new project page opens. Fill out the form.
104
+
1. The **Create new project** page opens. Fill out the form.
109
105
110
106
::: moniker range="azure-devops"
111
-
> [!div class="mx-imgBorder"]
112
-
> 
107
+
:::image type="content" source="media/process/create-test-project-sprint166.png" alt-text="Screenshot shows the Create new project form.":::
:::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.":::
124
116
125
-
3. Select the WIT you customized. Here we choose**Ticket**.
117
+
1. Select the WIT you customized, in this example,**Ticket**.
126
118
127
-
> [!div class="mx-imgBorder"]
128
-
> 
119
+
:::image type="content" source="media/process/add-custom-wit-verify-ticket.png" alt-text="Screenshot shows Work Items with New Work Item selected and the custom Ticket item highlighted.":::
129
120
130
-
If you don't see the custom WIT, refresh your browser to make sure it registers all the custom changes you've made.
121
+
If you don't see the custom WIT, refresh your browser to make sure it registers all the custom changes.
131
122
132
-
4. 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.
123
+
1. Verify that the field you added appears on the form. The :::image type="icon" source="../../../media/icons/required-icon.png" border="false"::: (exclamation mark) icon indicates the field is required.
133
124
134
-
> [!div class="mx-imgBorder"]
135
-
> 
125
+
:::image type="content" source="media/process/add-custom-field-verify-ticket-form.png" alt-text="Screenshot shows the Ticket form, with the Customer Ticket field added in the Customer Focus group.":::
Copy file name to clipboardExpand all lines: docs/organizations/settings/work/includes/qa-custom-work-item-on-backlog.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ ms.date: 04/20/2021
9
9
10
10
### Q: How do I get my custom work item type to show up on my backlog?
11
11
12
-
**A:** Modify your requirement backlog to include the custom work item type. For details, see [Customize your backlogs or boards, Edit or rename the requirement backlog](../customize-process-backlogs-boards.md#edit-or-rename-the-requirement-backlog).
12
+
**A:** Modify your requirement backlog to include the custom work item type. For more information, see [Edit or rename the requirement backlog](../customize-process-backlogs-boards.md#edit-or-rename-the-requirement-backlog).
13
13
14
14
> [!NOTE]
15
-
> The backlog level to which you add a custom work item type determines the parent work item type(s) for the work item type.
15
+
> The backlog level to which you add a custom work item type determines the parent work item types for the work item type.
0 commit comments