Customize your work tracking experience

Last Update: 3/28/2017

Team Services | TFS 2017 | TFS 2015 | TFS 2013

As you plan and track your project, you'll find you may want to customize or configure a feature to meet your team's processes. You configure most features through the web portal administration context. The main customization options available to you include:

  • Team project and process, which include adding or modifying work item types, data fields, backlogs, and other objects shared across teams
  • Teams and Agile tools, which includes adding teams, configuring what appears on each team's backlogs and boards, adding work item templates, and more
  • Grant or restrict access to work tracking tools, which includes setting permissions for objects and the team project and assigning users or groups to specific access levels.
NOTE

If you're new to tracking work in Team Services or TFS, see Get started with Agile tools to plan and track work.

Team project and process customizations

Your team project determines the objects available to tracking work and the configuration of Agile tools. Specifically, the team project determines the work item types (WITs)—user stories, tasks, bugs— and the data fields used to capture information. Customized objects are shared across teams added to the team project.

NOTE

The method you use to customize work tracking depends on the process model you subscribe to:

  • Inheritance: Supports WSIWIG customization, available for Team Services only
  • Hosted XML: Supports customization through import/export of process templates, available for Team Services only
  • On-premises XML: Supports customization through import/export of XML definition files for work tracking objects

The following table summarizes the differences between the three supported process models. For definitions of the main work tracking objects, see Definitions.

Feature Inheritance Hosted XML On-premises XML
WYSIWYG editing checkmark
Create inherited custom processes checkmark
Create custom process templates (see note 1) checkmark checkmark
Inherit changes in system processes (Agile, Scrum, CMMI) checkmark
Updated process changes automatically apply to team projects checkmark checkmark
Basic customizations supported (fields, workflow, work item types, backlog levels) checkmark checkmark checkmark
Advanced customizations supported (custom link types, global lists, global workflow, team fields) (see note 2) checkmark
Use the witadmin command-line tools to edit team projects checkmark
Use the witadmin command-line tools to list information about team projects checkmark checkmark checkmark
REST API (read) checkmark checkmark checkmark
REST API (write) checkmark

Notes:

  1. A process determines the building blocks used to track work. A process template specifies an interdependent-related set of XML definition files that provide the building blocks and initial configuration for tracking work and other functional areas.
  2. Hosted XML supports updates to values of existing global lists (subject to limits on maximum size of each list), but doesn't support adding new global Lists with a process update. To learn more, see Differences between Team Services and TFS process template customizations.

Inheritance process model

You can perform the following tasks with the Inheritance process model.

NOTE

With the Inheritance process model, you can't modify the pick-lists of pre-defined fields—such as Activity, Automation Status, Discipline, Priority, plus others.

Customization sequence for Inheritance process model

Use this sequence when you manage your Team Services customization through the Inherited process model. You belong to this phase when your Process user interface appears as shown under Manage processes.

Create an inherited processCustomize the inherited processApply inherited process to team project(s)Refresh and verify changes

Hosted XML process model

You can perform the following tasks with the Hosted XML process model.

Customization sequence for Hosted XML process model

Use the following sequences when you manage your Team Services through the Hosted XML process model. This sequence requires you to update your team project by updating the process template that it uses. We recommend that you maintain your process templates in a repository for version control.

Export processEdit XML definition file(s)Import processRefresh and verify changes

On-premises XML process model

You can perform the following tasks when you work with the On-prem XML process model.

Customization sequence for On-premises XML process model

When you manage an on-premises TFS, you perform most customizations using the following sequence. This sequence supports updating the XML definition for WIT, global lists, process configuration, and categories. This sequence supports individual updates through the import of their respective modified XML definition files. We recommend that you maintain your XML definition files in a repository for version control.

Export XML definition fileEdit XML definition fileImport WIT definition fileRefresh and verify changes

In addition, you can use the witadmin tool to list objects, rename WITs, permanently remove WITs, and more.

TIP

With witadmin, you can import and export definition files. Other tools you can use include the Process Editor (requires that you have installed a version of Visual Studio):

Or, you can use the TFS Team Project Manager, an open-source client available from github.

Shared resources

Each team project provides a number of shared resources that support all teams added to the project. You configure these features through the user interface or the admin context of the web portal.

Area path pick lists

Change the pick list of area paths to support grouping work items by team, product, or feature area.

Hierarchical area paths

Sprint/iteration pick lists

Change the pick list of iteration paths to support grouping work into sprints, milestones, or other event-specific or time-related period. Activate sprints for each team.

Iterations or sprints

Shared queries

Open shared queries or create your own query using the query editor to list work items or show hierarchical or dependent items.

Shared queries

Tags

Add tags to work items to filter backlogs and queries

Add tags to filter backlogs, boards, and queries

Teams and Agile tools customization

Each team can configure and customize their Agile tools. Teams are associated with one or more area paths which determine what items will appear on their backlogs and boards.

For details on adding and configuring teams, see the following topics.

You plan and track your project using the set of Agile tools managed and configurable for each team. You access these tools from the web portal.

Agile tools, team assets

The following tools are team specific, that is, when you add another team, you create another variant of the tool that is configurable and customizable by the team. For details on configuring and customizing team assets, see Manage team assets.

Grant or restrict access to work tracking tools

You can grant or restrict access to select features and functions through the web portal. When you add user accounts to your team, they're automatically added to the Contributor group. They then have access to most of the features they'll need to contribute to code, work item tracking, builds, and test. However, the Contributor group doesn't allow users to create shared queries or to add area or iteration paths. You have to grant these permissions separately.

For a simplified view of the most common, default permissions and access assignments, see Permissions and access. Otherwise, to grant or restrict access to select features or functions, review one of these topics:

If you're new to managing permissions, see Permissions, permissions states.

Learn more about how to use work tracking to plan, manage, and monitor your projects:

Customize the test experience (TFS)

Several WITs support the test experience within the web portal Test hub and Test Manager client. You can customize these WITs as you would any other WIT. The following image illustrates the support link relationships.

Test management work item types

See the following resources for additional usage and customization information:

Change the pick list for a person-name field

To add values for fields associated with user accounts such as Assigned To add users to a TFS security group or by restricting access to a group or set of users. By default, the list for the Assigned To field contains the account names for all users and groups that have been added to TFS. These accounts are often synchronized with Active Directory. See Set up groups for use in TFS deployments. To limit the names of accounts in a list, see Limit the number of names that appear in the Assigned To field.

Maintenance and upgrade implications (TFS)

Before you customize, you should understand how your customizations may impact your team project when you upgrade your application-tier server.

Upgrades to an on-premises TFS can introduce new features that require updates to the objects used to track work. These objects include work item types, categories, and process configuration. Minimizing changes to the workflow for a WIT or the process configuration can help minimize the work you must do when you upgrade your TFS.

To minimize the amount of manual work you'll need to do after a TFS upgrade, understand which customizations support an easy update path and which do not.

Compatible for quick updating

With the following customizations, you can use the Configure Features Wizard to automatically apply any changes to your team project required for new features.

  • Fields: Add custom fields, customize a pick list, add or modify area and iteration paths, add rules to a field
  • WITs: Add custom WITs, change the form layout
  • Categories: Add custom categories
  • Agile tools: Customize the columns on the Kanban board, customize the quick add panel
  • Office integration: Add or change how Project fields map to TFS fields

To learn more about the Configure Features Wizard, see Configure features after an upgrade.

Compatible, but may require manual updates

The Configure Features Wizard requires that specific work item types, workflow states, and fields exist in the team project. When you make the following customizations, you might need to modify your custom process for the wizard to run, or you might have to update your team project manually.

  • Fields: Change attributes of an existing field, remove fields that are referenced in the process configuration
  • WITs: Change the workflow
  • Agile tools: Change the WITs defined for the Requirement Category, Task Category, or Feature Category.
  • Agile tools: Change the metastate mapping defined in the process configuration.
  • Agile tools: Change a field specified for a TypeField in the process configuration.

In addition, changes you make to WITs or the workflow could require updates to other artifacts provided with your process, such as Excel or SQL Server Reporting Services reports.

Customizations to avoid

You should avoid making the following customizations because they can result in schema conflicts in the data warehouse or cause problems when updating team projects after a TFS upgrade.

  • Fields:
    • Change the friendly name of a field (a field specified within a WIT definition file)
    • Change one or more reporting attributes, or the attribute to synchronize person names with Active Directory of a default field
  • WITs: Rename or delete WITs
  • Categories: Change the name of default categories, or change the WITs specified within default categories

To learn more about reporting attributes, see Add or modify work item fields to support reporting.

  • Identify the best options for customizing WITs that support your tracking requirements. When you change objects that track work items, you should identify how these changes will affect existing and future team projects.
  • Put processes and all XML definition files under version control. Do not deploy objects that you define but have not stored in a repository.
  • Test your customized objects just as you would test your software.
  • Minimize the number of custom fields that you introduce. Minimize the number of fields that you make reportable.

Definitions of key work tracking objects

Your work tracking experience is managed and customized primarily through the objects defined in the following table.

Object Definition
Category Defines groups that associate a type of work item with a category. Categories support the process configuration used by the web portal backlog and task board page. For example, you can add custom work item types to the Requirements category and manage them using the product backlog and Kanban boards. To learn more, see Use categories to group work item types.
Field Supports tracking a piece of information about the work to perform. Values you assign to a field are stored in the work tracking data store which you can query and generate charts to view status and trends. Your team project contains 100 or more data fields. You update data by modifying the data field within a work item. Each work item is associated with a work item type (WIT), and the data you can track corresponds to the fields assigned to the WIT. For a definition of each predefined field, see Work item field index.
Global list Defines a list of menu items or pick list items that are shared across WITs and team projects within a team project collection. Global lists help to minimize the work that is required to update lists. You can define global lists within WITs that you upload with your process template. To learn more, see Manage global lists for work item types. (Only supported for Hosted XML and On-premises XML process models)
Global workflow Specifies both work item fields and global lists that multiple team projects and types of work items can share. To learn more, see Manage global workflow (Only supported for On-premises XML process model).
Link type Specifies an object used to form link relationships between different WITs. To learn more about link relationships and link types, see Link work items to support traceability and manage dependencies and LinkTypes elements reference.
Pick list Specify an enumerated set of values that appear within a drop-down menu in a work item form and the Value column within the query editor. The method you use to customize a pick list varies depending on the field and the process model.
Process Defines the building blocks of the work item tracking system. To customize a process, you first create an inherited process from one of the default system processes—Agile, Scrum, or CMMI. Changes you make to a process are seen by all team projects that use it. (Only supported for Inheritance process model)
Process configuration Specifies the default configuration and functional capabilities that your teams can access using the Agile tools. These web portal tools include the product backlog, sprint backlogs, Kanban board, and task board. Each team can configure and customize these tools. (Only supported for Hosted XML and On-premises XML process models)
Process template Specifies an inter-related set of files that contain the XML definitions for tracking work and defining the initial configuration of other functional areas. The system provides three default process templates—Agile, Scrum, or CMMI. You can create a team project and then customize it, or customize a process template that you then use to create a team project. (Only supported for Hosted XML and On-premises XML process models)
Work item type (WIT) Specifies the fields, workflow, and form used to track an item of work. Each WIT is associated with 30+ system fields and several more type-specific fields. You use work items to plan and track the work required to develop your project. For an overview of predefined WITs provided with the default processes, see Choose a process.