Customize an Agile tool
Team Services | TFS 2015 | Previous versions
Your team project contains an array of tools shown below to support your Agile processes and your team to plan, track and monitor work. To get the most out of using these Agile planning tools, you’ll want to configure them to support your team’s processes.
You can customize most tools through the web portal. Other features can be customized only for TFS on-premises deployments by changing an XML definition. See Add or modify a field and Add or modify a work item type for customizations you can make specific to data fields and work item types (WITs).
Feature availability: Some tasks are only available from the cloud service or from an on-premises deployment. These are annotated as follows:
- Team Services - Visual Studio Team Services only (cloud service)
- TFS - Team Foundation Server only (on-premises)
|Task||Team Services||TFS 2015||TFS 2015.1|
|Plan and track work1|
Backlogs and boards
|Monitor and learn|
Scrum and Kanban charts
Lightweight charts and dashboards
- Check out Marketplace extensions: Plan and track for additional tools you can use to augment those available.
- Each team can choose which backlogs are enabled for their tracking purposes: product backlog, Features, and Epics. By default, only the product backlog and Features backlogs display for each team.
- The Kanban board supports two levels of customization: adding columns and customizing the workflow. Currently, you can only customize the workflow for on-premises TFS deployments. If you want your Kanban columns or task board columns to correspond to a custom workflow, you must perform these two modifications:
- The Kanban board supports two levels of customization: adding columns and customizing the workflow. Currently, you can only customize the workflow For on-premises TFS deployments, if you customize the workflow for tasks, you must also customize the process configuration as follows:
- Check out Marketplace extensions: Collaborate for additional collaboration tools.
Categories and process configuration (TFS)
Agile planning tools reference the configuration of the categories and process configuration XML definition files for the team project. Categories group WITs that are used to determine what will appear on the portfolio backlog, backlog, and task backlog pages. Process configuration defines how categories and their workflow states map to backlogs and boards.
Edit Agile planning tool definition files
To edit an XML definition file, you export, edit, and then import the file.
Tip: With witadmin, you can import and export definition files. Other tools you can use include the Process Editor, available with the download of TFS Power Tools, or TFS Team Project Manager, a community resource project available on CodePlex.
To edit process configuration using the witadmin command line tool, follow these steps.
If you don't have administration permissions for your team project, get them.
Open a Command Prompt window where either Visual Studio or Team Explorer is installed and enter:
cd %programfiles%\\Microsoft Visual Studio 14.0\\Common7\\IDE
On a 64-bit edition of Windows, replace %programfiles% with %programfiles(x86)%. Go here to download Visual Studio Community for free.
Export the process configuration file.
witadmin exportprocessconfig /collection:CollectionURL /p:ProjectName /f:"DirectoryPath/ProcessConfiguration.xml"
An example of a CollectionURL is http://MyServer:8080/tfs/TeamProjectCollectionName.
Edit the file. For details, see Process configuration XML element reference.
Import the process configuration file.
witadmin importprocessconfig /collection:CollectionURL /p:ProjectName /f:"DirectoryPath/ProcessConfiguration.xml"
Open the web portal to view the changes. If it is already open, refresh the page.
Customize default columns and sequence
Each team member can customize the set of columns and column sequence displayed on their backlogs. The Agile tools remember their settings from one session to the next.
However, if you want to define the default set of columns displayed, you can do that by modifying the
<Columns> section for each backlog within the ProcessConfiguration file.
Customize the quick add panel
You can add fields to a quick add panel for any backlog. For example, the following example adds Business Value to the product backlog panel.
You do this by modifying the
<AddPanel> section for each backlog within the ProcessConfiguration file.
The panel only displays fields that are included in the FIELDS section of the WIT definition for the WIT selected. For example, if you select the bug WIT, then only Title displays, because Business Value isn’t defined for bugs.
To add another team, understand who can view, contribute to, or manage a team asset, or learn more about customization options available to you, see these topics:
- Multiple teams
- Manage team assets
- Customize work tracking
- Add or modify a field
- Add or modify a work item type
Team favorites are a quick way for members of your team to quickly access shared resources of interest. You can defined team favorites for the following:
- Code hub/Explorer: Add repos or folders to team favories
- Work hub/Queries: A hared work item queries to team favories
- Build hub/Explorer: Add build definitions to team favories
From your team context, drag shared queries, builds, and folders to Team favorites to provide quick access to those items.
Or, choose the Add to team favorites option from the context menu for the item. You must be added as a team admin to manage team favorites.
When you create a team, you automatically create a team group, which contains the accounts of all members you add to the team. You can manage permissions for team members by setting the permissions of the team group.
You can use this group to filter queries. The name of team groups follows the pattern [Team Project Name]\Team Name. For example, the following query finds work assigned to members of the [Fabrikam Fiber]\Email team group.
Do you want to customize your tools in a way that's not supported?
Here are a few options available to you:
- Check out the planned updates for features that will become available soon
- Check out Marketplace extensions (VS Team Services) to see if there's a tool available for your purposes
- Determine if a Service hook (VS Team Services) will satisfy your needs
- Create your own tool using REST APIs
- Add your feature request to our Team Services user voice page page.
Feature enablement after upgrade (TFS)
What customizations can you make and still use the Configure Features Wizard to update my team project after a TFS upgrade?
If you make no customizations, you can use the Configure Features Wizard to update your team projects after you have upgraded TFS. To learn about which customizations you can safely make and which you should avoid, see Customize the work tracking experience: Before you customize, understand the maintenance and upgrade implications.
Less common customizations (TFS)
You can only perform the following customizations when working on-premises.
Change the color for a WIT
In the web portal, work items appear in query results and on the backlog and board pages of the Agile planning tools. To change the color associated with an existing WIT or add the color to use for a new WIT, edit the process configuration.
Backlog and board limits
To limit the display load time to acceptable parameters, the task board is restricted to a maximum of 1000 work items.
For TFS on-premises deployments, you can increase this value up to a maximum of 1500 by specifying a value for the
workItemCountLimit attribute of the TaskBacklog element.
<TaskBacklog category="Microsoft.TaskCategory" pluralName="Tasks" singularName="Task" workItemCountLimit="800" > . . . </TaskBacklog>
Change field assignments
You can change the work item fields that are used in calculating capacity, burndown charts, forecasting, and velocity. Any change you make to one of the default assignments should correspond to a change made to the WIT used to define and capture information for that value.
For example, if you change the
refname assigned to
type="Activity" then you should include the same field in the WIT definition assigned to the Task Category which captures the activity information. See Process configuration XML element reference for details.
The fields you assign are used by the following tools:
|Task board, capacity tools, sprint burndown||Remaining work|
|Product and portfolio backlogs||Backlog priority|
|Velocity and forecast||Effort (maps to Story Points, Effort, or Size)|
|Task board, capacity tools||Remaining work|
|Capacity tools||Activity (Task Activity or Discipline)|
Use a team field
Do you want to organize your teams using a team field instead of the area path?
For TFS on-premises deployments you can. If your organization has several teams that work from a common backlog and across many product areas, you might want to customize the team project to support team fields. This configuration will still allow teams to work independently, but work can be assigned to teams instead of by product area path.