Add Type Definitions for Work Item Categories to a Process Template

You can add categories to your process template. A category associates a group label with one or more types of work items. Categories are useful when your team projects contain similar work item types that are named differently. You specify the category definitions in one file, and then you specify that file to upload within the taskxml element of the WorkItemTracking plug-in.

In this topic

• Defining Categories

• Specifying a Category Definition File to Upload

• CATEGORIES Element Reference

After a team project is created from the process template, you can export and import categories for a team project collection by using the witadmin command-line tool. For more information, see Customizing Categories for Work Item Types [witadmin].

Defining Categories

The file that defines the categories must conform to the schema definition for categories, defined in the categories-01.xsd file, and must be specified in its own file in the WITD container element. You can download the schema files for tracking work from the following page on the Microsoft website: Process Template and Work Item Schemas for Visual Studio Team Foundation.

The following example shows the syntax structure that defines a category that is named Requirement Category and that is associated with the User Story work item type.

<CATEGORIES>
   <CATEGORY refname="Microsoft.RequirementCategory" name="Requirement Category">
      <DEFAULTWORKITEMTYPE name="User Story" />
   </CATEGORY>
   . . . 
</CATEGORIES>

You can customize or create a category definition file. For the MSF process templates, the category file is defined in the WorkItem Tracking folder. For more information about how to define categories, see Define Categories to Group Work Item Types.

Back to top

Specifying a Category Definition File to Upload

To upload a set of category definitions, you specify the CATEGORIES element within the taskxml element. The filename attribute is a relative path of the category definition file. For example, the following syntax specifies that the categories.xml file will be uploaded.

<CATEGORIES fileName="WorkItem Tracking\categories.xml" />

The following example shows how to specify a task that uploads a categories file. Because each category specifies a default work item type, the task to upload the category definition file depends on the successful completion of the WITs task which uploads the type definitions for work items.

<task id="Categories" name="Categories definitions" plugin="Microsoft.ProjectCreationWizard.WorkItemTracking" completionMessage="Work item type categories created">
   <dependencies>
      <dependency taskId="WITs" />
   </dependencies>
   <taskXml>
      <CATEGORIES fileName="WorkItem Tracking\Categories.xml" />
   </taskXml>
</task>

Back to top

CATEGORIES Element Reference

The following table describes the CATEGORIES element that you use to upload the category definition file. You specify this element within a taskXml container element in the WorkItemTracking plug-in file.

<CATEGORIES fileName="CategoriesFilePathName" />

Back to top

See Also

Reference

Customizing Categories for Work Item Types [witadmin]

Concepts

Define and Customize Objects for Tracking Work Items By Using the Work Item Tracking Plug-in

Other Resources

Work Item Type Categories Element Reference