Sample Script to Enable New Features in Upgraded Team Projects (TFS 2010 RTM)


Important: The instructions in this post only apply to the RTM version of Team Foundation Server 2010. For older versions, see RC, Beta2, or Beta1.

Introduction

When you upgrade your existing Team Foundation Server to version 2010, upgraded team projects will work as before. However, you need to make some manual changes to these team projects if you want to enable the following features:

  • Test Case Management
  • Agile Planning Workbooks
  • Lab Management
  • Dashboards

The guidance documents that explain how to update your upgraded Team Projects is now available at MSDN:

 MSDN Library

Updating an Upgraded Team Project to Access New Features

http://msdn.microsoft.com/en-us/library/ff432837(v=VS.100).aspx

In addition to the official guidance documents, a sample script is also available to help you automate some of these steps if you were using a non-modified Agile 4.2 process template before the server upgrade.

Summary of Required Changes

Refer to the table below for a summary of the required changes to enable the new features for upgraded team projects. Note that these changes are only necessary for the team projects that existed before the upgrade. If you are creating new team projects, all of these features are enabled by default.

Feature Requirements
Test Case Management
  • Add Test Case and Shared Step work item types (*)
  • Update existing Bug and Scenario work item types (*)
  • Add new link types (*)
  • Add work item categories (*)
Agile Planning Workbooks
  • Update existing Task and Scenario work item types (*)
  • Create iteration and product backlog queries
  • Bind workbooks against the queries
  • Modify workbook document properties
Lab Management
  • Grant lab management permissions to user groups
  • Provision lab resources
Reports
  • Update your existing reports to work against the new warehouse
Dashboards
  • Run the Team Project Batch File command

(*): You can use the sample script attached to this article to make these changes marked with (*) in the table above.

You can use the sample script as is, if:

  • You are using the RTM (English) version of Team Foundation Server 2010
  • Your team project was created with the English language version of “MSF for Agile Software Development – v4.2” process template before you upgraded your Team Foundation Server
  • No modifications have been made to the work item type definitions on your team project before or after the upgrade
  • You are running the script on an English operating system that has Visual Studio Team Explorer 2010 RTM

You need to either modify the sample script, or create your own if:

  • Your team project was created with a process template other than “MSF for Agile Software Development v4.2” (English)
  • You have made modifications to the out of box work item type definitions on your team project
  • Your team project already has an existing Test Case work item type
  • You want to use the existing “Repro Steps” field on your Bug work item type
  • You are using a non-English language version of Team Foundation Server

Sample Script

The attached ZIP file contains the script and updated MSF for Agile 4.2 work item type definitions. You must be a project collection administrator to run this script. The script requires the witadmin.exe utility which is installed by Team Explorer and Team Foundation Server.

To use the script, download and extract it to a local directory such as C:\Upgrade. Before you run the script, open “EnableFeatures.bat” in a text editor and complete the configuration by specifying values for the following:

  • Team Foundation Server URL
  • Name of the team project collection
  • Name of the team project
  • Path to witadmin.exe utility
  • Set ConfigComplete = 1 to indicate that you’ve completed the configuration

Important: This script will only work against “unmodified” team projects created with “MSF for Agile Software Development – v4.2” process templates on the RTM version of Team Foundation Server 2010.

What does the script do?

The script is a simple batch file that uses the witadmin.exe utility to make the following changes:

  • Saves a backup of your existing Bug, Task and Scenario work item types
  • Adds new link types (Test Case / Shared Steps and Tests / Tested By)
  • Adds new work item types (Test Case and Shared Step)
  • Overwrites Bug, Task and Scenario work item types
  • Adds work item categories

Questions?

Take a look at the following blog post for frequently asked questions:

Download the Sample Script
Download the Sample Script

For any other questions or comments, feel free to contact me.

SampleScript(RTM).zip

Comments (9)

  1. Kevin says:

    Thanks Hakan! I haven't tried the sample script yet, but it looks like a good starting point that may save me a lot of time and effort.

    Suggestions: Make it available on CodePlex, and consider morphing it into the next batch of TFS Power Tools.

  2. Ken says:

    I'm upgrading from TFS 2005, and I ran "tfsconfig import" to import my team project into my TFS 2010 installation.

    I believe that my projects were created using MSF Agile 4.0, not 4.2. Can you give me some guidance on how to made the relevant adjustments for my project? I'm just looking for the easiest way to get the team up and running on TFS 2010, including usage of the new features.

    Thanks!

  3. Hakan Eskici says:

    @Ken: The sample script would be incompatible in your case, so I'd recommend following the individual steps explained at msdn.microsoft.com/…/ff432837(v=VS.100).aspx to enable the new features on an upgraded Agile 4.0 team project.

  4. Chris Rigter says:

    There is some date time formatting that breaks on non-us locales.  I corrected the code immediately after the "REM The below line will only work on en-us locale" comment to read:

    for /f "tokens=1-5 delims=/ " %%d in ("%date%") do SET myDate=%%d-%%e-%%f

    for /f "tokens=1-5 delims=:" %%d in ("%time%") do SET myTime=%%d-%%e

    SET BackupName=%myDate%-%myTime%

    echo %BackupName%

    And all works fine, I am guessing this will work on US locale too.

  5. Horst Wutscher says:

    Hello Hakan,

    I have migrate from tfs 2008 to 2010 with backup and restore from database..

    The old projects now available at new server, what did i have to do after your script at projects?

    What did i have to do with the CMMI projects, can i also run your script.

    I hope you can explain me that the next steps, thank you very much Hakan,

    Thanks Horst

  6. Tim says:

    Does Microsoft have plans on supporting those of us who had CMMI templates in some of their TFS 2008 projects and would like to have these new features available to use in 2010? Nice to support Agile, but why leave out CMMI?

  7. MariusM says:

    How I can get the upgrade JUST for Sharepoint Site?

    I had two instances of TFS (2005 and 2008). I migrated 2005 to 2010. All are set. How I can get the upgrade from Agile 4.0 to 4.2 or better than that to 5.0.

    On the instance of TFS 2008, the users use some projects just Sharepoint Site, without any source code.  I would like to make empty projects on TFS2010 and import / export the content from the 2008 site to 2010 site.

    On the Sharepoint Farm where I want to import, I got to have the same template of the site.

    the template of the site on tfs2008 is agile4.2 and on tfs2010 is 5.0. could anyone advise me about how I can do?

  8. Radhika says:

    Very good stuff. Really it saved my time and work.

  9. Radhika says:

    Hi Hakan,

    Do we script to add features to upgraded team project (2012) ?

    Thanks in advance.