Add Global Lists to a Process Template

You can add global lists to your process template to streamline the definition of a set of values that are used in common with multiple work item types. A global list defines a list of values that you can use to control the value or values to which users can set a field in a work item. A global list defines the entries that are available to pick from a drop-down menu or pick list in a work item form or work item query. You use global lists to quickly update the contents of pick lists that are used for many types of work items.

You specify the file that defines the global lists to upload within the taskxml element of the WorkItemTracking plug-in.

Note

The process templates for Microsoft Solutions Framework (MSF) v5.0 do not specify any global lists.

In this topic

  • Defining Global Lists

  • Specifying a Global List Definition File to Upload

  • GLOBALLIST Element Reference

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

Defining Global Lists

The definition of global lists must be specified in its own file by using the GLOBALLISTS (Definition) parent element and conform to the schema definition as defined by the globalists-01.xsd file. You can download the schema files for tracking work items from the following page on the Microsoft website: Process Template and Work Item Schemas for Visual Studio Team Foundation.

The following example shows an example of a definition file for global lists file that contains one global list that is named Task Type.

<?xml version="1.0" encoding="utf-8"?>
<GLOBALLISTS>
    <GLOBALLIST name="Task Type">
        <LISTITEM value="Writing" />
        <LISTITEM value="Research" />
        <LISTITEM value="Review" />
        <LISTITEM value="Editing" />
        <LISTITEM value="Miscellaneous" />
    </GLOBALLIST>
</GLOBALLISTS>

For more information, see Defining Global Lists.

Back to top

Specifying a Definition File for a Global List to Upload

To upload global list definitions, you specify the GLOBALLISTS element within the taskxml element. The filename attribute is a relative path of the definition file for global lists.

The following example shows how to specify a task that uploads a file that contains global lists.

<task id="GlobalLists" name="Global lists definition" plugin="Microsoft.ProjectCreationWizard.WorkItemTracking" completionMessage="Global lists created">
   <taskXml>
      <GLOBALLISTS fileName="WorkItem Tracking\GlobalLists.xml" />
   </taskXml>
</task>

Back to top

GLOBALLISTS Element Reference

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

Note

You specify a definition file to upload by using the GLOBALLISTS (WorkItemTracking) element. You define global lists by using the GLOBALLISTS (Definition) element. For more information, see Defining Global Lists.

Element

Syntax

Description

GLOBALLISTS

<GLOBALLISTS fileName="GlobalListFilePathName" />

Optional child element of the WorkItemTracking plug-in.

Specifies the path and name of the file that contains the definitions for global lists to be uploaded when the WorkItemTracking plug-in task is processed.

Back to top

See Also

Reference

Managing Global Lists for Work Item Types [witadmin]

Concepts

Defining Global Lists

Defining and Customizing Objects for Tracking Work Items By Using the Work Item Tracking Plug-in