Configure features after an upgrade
TFS 2018 | TFS 2017 | TFS 2015 | TFS 2013
Feature availability: This topic applies only to team projects hosted on an on-premises Team Foundation Server (TFS). Team projects on VSTS update automatically with each service upgrade.
After a TFS upgrade, you'll want to use the new features that were installed. Some of these features might require updates to your team project. The Configure Features wizard is the easiest way to make this happen.
If you're upgrading from TFS 2010 or an earlier version, review the steps outlined in When upgrading from TFS 2008 or TFS 2010.
If you need to upgrade TFS, go to the downloads page.
If you have several team projects to update, you can apply updates programmatically.
Run the Configure Features wizard
From the web portal home page, open the administration context.
If you're not a team project administrator, get added as one. Only project administrators or TFS administrators can run the wizard.
If you see a Configure Features link, run the wizard.
If Portfolio Backlogs shows as Not configured, then the wizard will add the Feature and Epic WIT and categories to the team project and modify the process configuration to support portfolio backlogs. However, if it shows as Previously configured (will be skipped), the wizard won't add the Epic WIT and portfolio backlog. To add the Epic portfolio backlog, you'll need to add it manually.
The features listed depend on the TFS version of software installed. To get the latest features, upgrade your server to the latest version.
If Test Plan and Test Suite are not configured, you'll need to manually import the WIT definitions and migrate data.
If you don't see the Configure Features link, you can start using the new features as they're already enabled.
If you receive a message similar to the one shown below, you can configure your team project. If more than one process template is available, accept the recommended version.
If the dialog box doesn't contain a Configure option, then you'll need to apply the updates manually.
In most cases, the wizard will configure all the new features and you'll receive a success message.
Occasionally, the wizard will partially update your team project and return error messages that require resolution. Make a note of the errors that you receive and perform manual updates to resolve each error.
Apply updates manually
When the wizard can't update a team project, it returns a message indicating that there are no process templates available to support the update.
When this occurs, you'll need to perform some manual updates according to one of the following options:
If your team project is based on a process template other than those that TFS provides, update the customized process template used to create the team project, and then run the Configure Features wizard.
TFS process templates correspond to Scrum, Agile, and CMMI as described in Choose a process.
If your team project has been heavily customized, but not the process template, add the new features manually.
If your team project was based on a v4.2 or earlier process template version, first apply the updates to comply with TFS 2012 manually. Then run the Configure Features wizard.
Try this next
You'll be able to start using several of the new features after they've been enabled. However, a few features require additional configuration, or provide configuration options.
- To view and work with Epic and Feature portfolio backlogs, you may need to select them for your team
- To add the Epic portfolio backlog to your team project or additional portfolio backlog levels, you can add them manually.
- To use Code Review and Feedback Request, you need to configure an SMTP server for TFS.
- To use Bugs Behavior, you must configure this option as described in Show bugs on backlogs and boards feature.
- To fully manage Epic and Feature portfolio backlogs or web-based test plans, you need to have Advanced access.
Related upgrade notes
The Configure Features wizard will work in most cases to update your team project. In the event that you are upgrading from a much earlier version of TFS or you've customized your team project, you'll need to make some manual updates.
See the following resources as they relate to updating your team project:
- New features added when you update TFS
- Update a customized process template to access new features
- Add features using a manual update process
- Before you upgrade TFS
- Additional configuration options
- Changes made to process templates to support new features
If you have additional questions, you can post one or search for answers in the Team Foundation Server - work tracking forum.
Programmatically update several team projects (TFS 2015, TFS 2013)
If the team projects were created from the same process template, you should be able to modify the source process template, upload it, and then batch update all team projects defined for a team project collection. Review the following resources:
- Update a customized process template to access new features
- How to Configure Features for dozens of team projects
- Features4tfs CodePlex solution.
Resolve warning or error messages related to the update of test management artifacts
Understand how the Configure Features wizard works
The Configure Features wizard adds new objects to your team project and might update a few existing objects, but does not change your data or the workflow. It adds the new objects based on the best match of settings defined within the installed process templates and your team project. The wizard references both updated customized process templates and the latest version of Microsoft process templates installed to your team project collection and added during the upgrade process. If the wizard determines that there is more than one process template that could be used to configure features, it selects the one that best matches your existing team project and that is the latest version.
Here's what the Configure Features wizard does:
- Scans the definitions in the team project to determine which features are and aren't configured.
- Determines which process template stored in the team project collection contains the best match of definitions to configure missing features.
- For each feature that can be configured, uploads the definitions for new objects or modifies existing definitions. To learn how the wizard configures each specific feature, see Changes made to process templates.
Required objects used by the Configure Features wizard
The Configure Features wizard depends on the following objects to run and to successfully update your team projects:
The ProcessTemplate file must include the version statement. If the version statement is not present, the Configure Features wizard cannot select the process template for updating a team project. Also, the highest version number must be unique for each template ID. If more than one process template that specifies the same highest version number for the same template ID has been uploaded to TFS, then none of the process templates can be selected for updating a team project.
For each field defined for a team project collection, the following attributes must match:
Assignment to synchronize personal names with Active Directory (syncnamechanges).
Reporting attributes: reporting reference name, reporting name, reporting type, and reporting format
Reference names assigned to fields and link types must be unique within a team project collection.
Friendly names of the categories must be unique within a team project.
Certain work item types (WITs) and categories are required for the wizard to configure a feature. If you have renamed or deleted any of these WITs or categories, the wizard will return the following messages:
There are no process templates available with valid configuration settings for this team project.
Your team project cannot be configured automatically.
You will have to rename or reinstate the missing WITs or categories to your team project, and then rerun the wizard. Or, you can modify the process templates to add the features and then rerun the wizard.
If any conflicts occur, you will need to resolve the error message you receive.