Defining the Tasks to Process a Plug-in
Updated: April 2011
You use the tasks element and its child elements to define the artifacts to be uploaded or specific elements to be created for a plug-in. A task specifies work that must occur to configure something specific to the process in a new team project. A number of the tasks that you define configure the default structure of a team project as shown in the following illustration. Other tasks that you can define configure other areas of Visual Studio Application Lifecycle Management, such as Team Foundation Build, Visual Studio Lab Management, Test Manager, and Team Foundation version control.
In this topic
You can specify several tasks within a plug-in, and these tasks may have dependencies on one another. The tasks that you define for each plug-in must conform to the schema definition for tasks, defined in the Tasks.xsd file, and be specified in its own file using the tasks container element. You can download the schema files for process templates from the following page on the Microsoft website: Process Template and Work Item Schemas for Visual Studio Team Foundation.
The following syntax shows the high-level structure of the tasks element and its child elements.
<tasks> <task> <dependencies> <dependency /> . . . </dependencies /> <taskXml> . . . </taskXml> <task/> </tasks>
The following table describes each element that can define the tasks for a plug-in.
<dependencies> <dependency>. . . </dependency> </dependencies>
Optional child element of task.
Specifies other groups on which a group depends.
<dependency taskId="taskId" />
Optional child element of dependencies.
Specifies the ID of another task on which this task depends. The other task must complete before this task can start.
<ProcessTemplate Type="FileType" Filename="LocalPathAndFileName" Description="FileDescription" ServerPath="UploadLocation" />
Where each attribute is defined as follows:
Optional child element of taskXml element for the Build and Lab plug-ins.
Specifies the name, location, and destination of a file to upload to support build processes for a team project.
<task id="task id" name="name of task" plugin="Microsoft.ProjectCreationWizard.<PluginName>" completionMessage="SuccessfulCompletionMessage" completionDescription="InProcessMessage"> <dependencies>. . . </dependencies> <taskXml>. . . </taskXml> </task>
Required child element of tasks.
Specifies work that must occur to configure something specific to the process in a new team project.
<tasks> <task>. . . </task> </tasks>
Required child element of taskXml.
Contains a collection of task elements that each specify work that must occur to configure something specific to the process in a new team project.
<taskXml> . . . </taskXml>
Required root element for a plug-in file.
Describes the work that is required to complete this task. The XML inside this element block varies and is specific to each plug-in.
The XML processor does not try to validate the content within the element.
For more information about the specifics of the XML markup elements that you can specify for each plug-in, see one of the following topics:
Groups and Permissions: Configuring Initial Groups, Members, and Permissions
Test Management: Defining the Initial Configuration of Test Manager
The following example shows a task that creates six types of work items by referencing the definition files for each type.
<task id="WITs" name="WorkItemType definitions" plugin="Microsoft.ProjectCreationWizard.WorkItemTracking" completionMessage="WorkItemTypes created" completionDescription = "Processing work item types used by work item tracking"> <taskXml> <WORKITEMTYPES> <WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\Bug.xml" /> <WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\SharedStep.xml" /> <WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\Task.xml" /> <WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\TestCase.xml" /> <WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\UserStory.xml" /> <WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\Issue.xml" /> </WORKITEMTYPES> </taskXml> </task>