Process template plug-ins: Index to XML element definitions

VSTS (Hosted XML) | TFS 2018 | TFS 2017 | TFS 2015 | TFS 2013

Important

This topic applies to team project customization for Hosted XML and On-premises XML process models. For the Inheritance process model, see Customize a process. For an overview of process models, see Customize your work tracking experience.

By using the index of elements in this topic, you can look up the syntax structure and find examples of how to use each element of the schema definition for process templates.

Important

The schema definition for process templates uses a mix of camel-case and all capitalized elements. If you encounter errors when validating your type definition files, check the case structure of your elements. Also, the case structure of opening and closing tags must match according to the rules for XML syntax.

Alphabetical index

- activateFeatures
- CATEGORIES
- CATEGORY
- checkin_note
- Children
- Datasources
- DEFAULTWORKITEMTYPE (category)
- Dependencies (ProcessTemplate)
- dependencies (task)
- dependency (ProcessTemplate)
- dependency (task)
- description
- documentLibraries
- documentLibrary
- exclusive_checkout
- feature
- FIELD (work item instance)
- FIELD
- FIELDS
- File
- files
- folder (portal)
- folder (reporting)
- folders (portal)
- folders (reporting)
- get_latest_on_checkout
- Group
- group (ProcessTemplate)
- Groups (groups)
- groups (ProcessTemplate)
- HYPERLINK
- LINKTYPE
- LINKTYPES
- member
- members
- Metadata
- name
- Node
- Nodes
- parameter
- parameters
- permission
- Permission (query)
- permissions
- plugin
- plugins
- Portal
- ProcessTemplate (root)
- ProcessTemplate (taskXml)
- Properties (classification)
- properties (reporting)
- property (classification)
- property (reporting)
- QUERIES
- Query
- QueryFolder
- Reference
- report
- ReportingServices
- reports
- site (reporting)
- site (portal)
- task
- tasklist
- taskXml
- TeamFoundationServer
- TeamProject
- TestConfigurations
- TestResolutionStates
- TestSettings
- TestVariables
- WI
- Wiql
- WorkItemQuery
- WORKITEMS
- WORKITEMTYPE (category)
- WORKITEMTYPE (definition)

Elements that define the root plug-in for process templates

The ProcessTemplate file contains two main parent elements within the ProcessTemplate root element: metadata and groups. The syntax for each of the following elements and their child elements is described in Process template XML elements reference.

  • metadata: description, nnname, plugin, plugins
  • groups: dependencies, dependency, group, tasklist

Elements that define plug-in tasks

You use the tasks element and its child elements to define the artifacts to be uploaded or specific elements to be created for each plug-in. You can access the topic that provides detailed information and examples for each plug-in and element in the following table.

Plug-in Related topic Elements
All Define the tasks to process a plug-in dependencies, dependency, ProcessTemplate, task, tasks, taskXml
Build Define the initial configuration of Team Foundation Build Permission, ProcessTemplate
Classification Define initial areas, iterations, and Project mapping file Children, Node, Nodes, properties, property
Groups and Permissions Configure initial groups, teams, members, and permissions group, groups, member, members, permission, permissions
Lab Define the initial configuration of Lab Management Permission, ProcessTemplate
Portal Define the project portal activateFeatures, documentLibraries, documentLibrary, feature, file, files, folder, folders, Portal, site
Reports Add reports datasources, folder, folders, parameter, parameters, properties, property, reference, report, reports, ReportingServices, site
Test Management Define the initial configuration of Test Manager dependencies, dependency, TestConfigurations, TestResolutionState, TestSettings, TestVariables
Version Control Define the initial configuration of Team Foundation version control checkin_note, exclusive_checkout, get_latest_on_checkout, permission
Work Item Tracking Define objects for tracking work items CATEGORIES, FIELD, GLOBALLISTS, HYPERLINK, LINKTYPE, LINKTYPES, Permission, Query, QueryFolder, QUERIES, WI, WORKITEMS, WORKITEMTYPE, WORKITEMTYPES

Type definition elements that define objects for tracking work

In the Work Item Tracking plug-in, you can specify several type definition files and query definition files to upload. You can access the topic that provides detailed information and examples for each object and element in the following table:

Object Related topic Elements
Categories Categories XML element reference CATEGORIES, CATEGORY
Global lists GLOBALLIST XML element reference GLOBALLIST, GLOBALLISTS, LISTITEM
Link types Define a custom link type LinkType, LinkTypes
Work item queries Define a work item query TeamFoundationServer, TeamProject, Wiql, WorkItemQuery
Work item types All WITD elements Top level elements only: DESCRIPTION, FIELDS (Definition), FORM, GLOBALLISTS, WITD, WORKFLOW, WORKITEMTYPE