TN1501: Configuring Windows SharePoint Services 3.0 on the Visual Studio 2005 Team Foundation Server Application Tier

Introduction

Visual Studio 2005 Team Foundation Server uses Windows SharePoint Services (WSS) 2.0 to enable team project portal functionality. Since the release of WSS 3.0, customers have wanted to know how to integrate it with Team Foundation Server. This document shows you how to do that by installing WSS 3.0 on the Team Foundation Server application tier. However, if you want to configure WSS 3.0 to run from a separate computer to which you are directed by Team Foundation Server, see TN1502: Configuring Windows SharePoint Services 3.0 on a Remote Server to work with Visual Studio 2005 Team Foundation Server.

Team Foundation Server requires the installation of WSS 2.0 on the Team Foundation Server application tier for installation and serviceability. You need to keep WSS 2.0 installed and configured on the default Web site on the Team Foundation Server application tier. To enable WSS 3.0 on the Team Foundation Server application tier, install WSS 3.0 to run side-by-side with WSS 2.0. Then you can create a new Web application to host the team project portals.

Installation Checklist

The following checklist summarizes what you need to enable Team Foundation Server to work with WSS 3.0 on the Team Foundation Server application tier.

When you complete this procedure, install a hotfix on all the Team Explorer clients that will be creating new team projects. To get this hotfix, contact Microsoft Support and reference KB Article 932544. Since it takes time to process your request, get the hotfix before you make any changes.
Be sure your Team Foundation Server installation includes WSS 2.0 with Service Pack 2 and ASP.NET 2.0.
Install WSS 3.0 side-by-side with WSS 2.0. Important: Do not remove WSS 2.0 from the Team Foundation Server application tier.
Create a new Web application for the WSS 3.0 sites. This Web application enables you to use a port other then 80.
Upgrade the WSS 2.0 content database to WSS 3.0.
Be sure the WSS 3.0 administration port is open on the Windows Firewall and any other firewall. This enables Team Explorer to access the site when it creates a new project through the Project Creation Wizard.
Change the Team Foundation Server registration entries to use the new SharePoint location (instead of the default Web site on the Team Foundation Server application tier).
Be sure that users who want to create new team project instances understand they must have STS Administrator privileges on the new WSS 3.0 instance.

Procedures

Run and Test Full Backup in SQL Server. Before you perform these steps, be sure you back up your Team Foundation Server databases. For backup instructions, see How to: Back Up a Team Foundation Server.
Install all pre-requisites for WSS 3.0. For detailed instructions, see Install all pre-requisites (Windows SharePoint Services).
Install WSS 3.0.
1. Download WSS 3.0. See Windows SharePoint Services 3.0.
2. Run SharePoint.exe.
3. On the Read the Microsoft Software License Terms page, review the terms, select the I accept the terms of this agreement checkbox, and then click Continue.
4. On the Upgrade Earlier Versions page, click No, do not upgrade at this time.
5. On the Server Type tab, select your server type: Web Front End.
6. Click Install Now. Setup runs and installs WSS 3.0.
7. On the completion page, clear the Run the SharePoint Products and Technologies Configuration Wizard now check box, and then click Close.
Run the pre-upgrade scan tool (Windows SharePoint Services). The pre-upgrade scan tool corrects any reported problems.
cd "%ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\12\Bin”
prescan /all
For more information about correcting problems, see Run the pre-upgrade scan tool (Windows SharePoint Services).
Run the SharePointProducts and Technologies Configuration Wizard.
1. Click Start, point to All Programs, point to Administrative Tools, and then click SharePoint Products and Technologies Configuration Wizard.
2. In the SharePoint Products and Technologies Configuration Wizard, on the Welcome to SharePoint Products and Technologies page, click Next. A message appears, notifying you that you may need to restart or reset the Internet Information Services (IIS), the SharePoint Administration Service, and the SharePoint Timer Service during the configuration.
3. Click Yes.
4. On the Connect to a server farm page, click No, and then click Next.
5. On the Specify Configuration Database Settings page, specify the following fields:
  - Database Server – This should be the Team Foundation Server data tier computer name. For single-server Team Foundation Server deployments, this will be the same as the application tier computer name.
  - Database Name – You can keep the default setting. You will need to include this new database in your Team Foundation Server database back-up strategy moving forward.
  - User Name – Enter the domain/username of the Team Foundation Server service account.
  - Password – Enter the password of the Team Foundation Server service account.
6. On the Configure SharePoint Central Administration Web Application page, select the Specify port number check box if you want to use a specific port number for SharePoint Central Administration. Type the port number you want to use. A valid example would be 17013, assuming this port is not already in use on this computer.
7. Note: Do not specify the same port used by Windows SharePoint Service 2.0 Administration Web site.
8. In the Configure Security Settings section, click NTLM, and then click Next.
9. In the Completing the SharePoint Products and Technologies Configuration Wizard page, verify the settings, and then click Next. The configuration wizard runs. It configures the configuration database and Central Administration Web application for WSS 3.0. If you have a server farm with multiple servers, a message directs you to run setup on each server. These setups install new binary files before running the configuration wizard and starting the upgrade process.
10. Click OK to continue with the wizard.
11. On the Configuration Successful page, review the configured settings, and then click Finish. The WSS 3.0 Central Administration site will open. Keep this page open for the next step.
Create a new Web application.
1. If the WSS 3.0 Central Administration site is not open, open it by clicking Start, pointing to All Programs, pointing to Administrative Tools, and clicking SharePoint 3.0 Central Administration.
2. Click the Application Management tab.
3. Under the SharePoint Web Application Management section, click the Create or extend Web application link.
4. Click Create a new Web application.
5. On the Create New Web Application page, in the IIS Web Site section, perform the following:
  - Confirm that Create a new IIS Web site is selected.
  - In the Description box, provide a useful description (e.g., SharePoint v3).
  - In the port field, change the value from 80 to any port number you like. A valid example would be 81, assuming this port is not already in use on the computer.
    Warning: The port cannot be 80. The default Web site uses 80 for WSS 2.0. You cannot service Team Foundation Server if you overwrite the default Web site.
6. In the Application Pool section, check the following:
  - Confirm Create new application pool is selected.
  - In Application pool name, provide a name (e.g., TFSWSS3).
  - Confirm that Configurable is selected under the Select a security account for this application pool heading.
  - User Account – Enter the Team Foundation Server service Account.
  - Password – Enter the password of the Team Foundation Server service Account.
7. Under the Reset Internet Information Server section, click Restart IIS Automatically.
8. Under the Database Name and Authentication section, confirm the selection of Windows Authentication and that the database name is the same as the Team Foundation Server data tier computer name. For single-server deployments of Team Foundation Server, this will be the same name as the Team Foundation Server application tier.
Back up the WSS 2.0 Content Database.
1. Set the existing WSS 2.0 Content Database to read-only in SQL Server 2005. This keeps users from making changes to the SharePoint site during the migration.
  1. Click Start, point to All Programs, point to Microsoft SQL Server 2005, and then click SQL Server Management Studio.
  2. In the Connect to Server box, fill in the connection information for your Team Foundation Server data tier, and then click Connect.
  3. After connecting to the Team Foundation Server database engine, in Object Explorer, click the server name to expand the server tree.
  4. Expand the Databases node, right-click the STS_Content_TFS database, and then click Properties.
  5. In the left pane, select the Options page.
  6. In the right pane, under State, next to Database Read-Only, click True.
  7. Click OK. Leave SQL Server Management Studio open for the next section.
2. Back up your WSS 2.0 content database.
  1. Right-click the STS_Content_TFS database, point to Tasks, and then click Back Up. The Back Up Database dialog box appears.
  2. In the Source section, in the Database box, verify the database name.
  3. In the Backup type box, click Full.
  4. Under Backup component, click Database.
  5. In the Name text box, either accept the default backup set name that is suggested or type a different name for the backup set.
  6. In the Destination section, select the type of backup destination by clicking Disk or Tape, and then select a destination. To create a different destination, click Add.
  7. Click OK to start the backup process. Leave SQL Server Management Studio open for the next section.
Restore a backup copy oftheWSS 2.0 Content database. Restore the same database you just backed up under a new name to the same database server.
1. Right-click the Databases node, and click Restore Database.
2. On the General page, in the To database field, enter a new name for the database you want to restore. For example, WSS_Content_TFS.
3. In the To a point in time text box (if using SQL Server 2005 Enterprise Edition), ensure the selection of Most recent state possible.
4. To specify the source and location of the backup sets to restore, click From database, and then specify the original content database name in the list box. For example, STS_Content_TFS.
5. In the Select the backup sets to restore grid, select the most recent full backup for restoration.
6. Click OK to start the restore process. Leave SQL Server Management Studio open for the next section.
Set the content databases to read-write. Perform this step for both the newly-restored content database (e.g., WSS_Content_TFS) and the original WSS 2.0 content database (e.g., STS_Content_TFS).
1. Right-click the name of the database you want to set to read-write, and then click Properties.
2. In the left pane, click Options.
3. In the right pane, under State, next to Database Read-Only, click False.
4. Click OK. Close SQL Server Management Studio.
Add the new database to the WSS 3.0 Web application.
Note: If you customized the WSS templates installed with Team Foundation Server, review the detailed instructions at Migrate content databases. For the next steps, be sure you are using the default WSS 2.0 templates that were installed by Team Foundation Server.
- Open a Command Prompt window and execute the following commands. The example below assumes that your Team Foundation Server application tier is called [myATserver], that you selected port 81 for your WSS 3.0 Web application port, and that the database you created was called [WSS_Content_TFS]. If any of these values is different for your configuration, modify the command accordingly.
  cd "%ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\12\Bin”
  stsadm –o addcontentdb –url http://[myATserver]:81 –databasename [WSS_Content_TFS]
  stsadm –o deletecontentdb –url http://[myATserver]:81 –databasename WSS_Content
  stsadm -o enumcontentdbs –url http://[myATserver]:81
Configure Window SharePoint Services 3.0 to use the Team Foundation Server site templates.
1. Obtain the WSS 3.0 MSF Templates (MSFAgileWSS3.stp & MSFCMMIWSS3.stp).
2. Open a Command Prompt window and execute the following commands. Be sure to modify [ShareLocation] accordingly based on where you copied the template files to.
  cd "%ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\12\Bin”
  stsadm -o addtemplate -filename "[ShareLocation]\MSFAgileWSS3.stp" -title VSTS_MSFAgile
  stsadm -o addtemplate -filename "[ShareLocation]\MSFCMMIWSS3.stp"-title VSTS_MSF_CMMI
  stsadm -o enumtemplates //Note: To see if the templates are added correctly
  iisreset
Update the Team Foundation Server application-tier SharePoint Service Registration location entry to point to the new WSS 3.0 location.
1. Modify the sample XML below. Substitute the entries for [protocol], [serverName], [port] and [adminPort] with those of the new WSS 3.0 instance. Typically protocol will refer to http or https, whereas the port number will be the port number you specified for the new Web application during the previous steps. You must check the port number of the SharePoint 3.0 Central Administration site to replace the [adminPort] value. You can find this by clicking Start, pointing to All Programs, pointing to Administrative Tools, and clicking SharePoint 3.0 Central Administration. The port number will be listed in the URL of the page that opens. Also note that the SharePoint default “sites” value may also be changed, depending on how you have configured the new Web application (SharePoint managed URL paths).
  <RegistrationEntries> <RegistrationEntry> <Type>Wss</Type> <ChangeType>Change</ChangeType> <ServiceInterfaces> <ServiceInterface> <Name>WssAdminService</Name> <Url>[protocol]://[serverName]:[adminPort]/_vti_adm/admin.asmx</Url> </ServiceInterface> <ServiceInterface> <Name>BaseServerUrl</Name> <Url>[protocol]://[serverName]:[port]</Url> </ServiceInterface> <ServiceInterface> <Name>BaseSiteUrl</Name> <Url>[protocol]://[serverName]:[port]/sites</Url> </ServiceInterface> <ServiceInterface> <Name>BaseSiteUnc</Name> <Url>\\[serverName]\sites</Url> </ServiceInterface> </ServiceInterfaces> </RegistrationEntry> </RegistrationEntries>
2. Save your changes to the sample as WSS_registration.xml. Make sure the file can be accessed by the Team Foundation Server application tier computer.
3. Open a Command Prompt window on the Team Foundation Server application tier computer and execute the following commands (substituting your Team Foundation Server data-tier computer name for[myDTserver] in the TFSReg.exe command here):
  iisreset /stop
  cd “%programfiles%\Microsoft Visual Studio 2005 Team Foundation Server\Tools”
  TFSReg.exe WSS_registration.xml [myDTserver]
  iisreset /start
4. Confirm that your changes succeeded. To do this, follow these steps:
  1. On the application tier computer, open Internet Explorer.
  2. Visit http://localhost:8080/services/v1.0/registration.asmx.
  3. Click GetRegistrationEntries.
  4. On the next page, click Invoke.
  5. Check that the service interface changes you made by running TfsReg.exe are present in the resulting XML.
Configure the Reporting ServerforTeam Foundation Server.
1. Locate the tfsredirect.aspx file. This should be located at “%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\60\TEMPLATE\LAYOUTS”.
2. Copy the tfsredirect.aspx file to “%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE\LAYOUTS”.
Configure Client Computers. Now that you configured your Team Foundation Server application tier to use a new WSS 3.0 Web application, configure the client computers.
1. Check the Team Explorer cache. Team Explorer, which is the add-in within Visual Studio 2005 that provides integration with Team Foundation Server functionality, receives the WSS URL from Team Foundation Server. This value is cached with a default cache timeout of 7200 seconds (two hours). If you perform this update with enough downtime before clients start reconnecting, you do not need to take further action. However, if clients will need to connect to the team project portals before the cache time has expired, you may want to invalidate the cache manually. To do so, each client should close all open instances of Visual Studio 2005, and then delete the following folder: “%USERPROFILE%\Local Settings\Application Data\Microsoft\Team Foundation\1.0”
  When each client opens Visual Studio 2005 again, each client will retrieve the new team project portal URL.
2. Update bookmarks and other links. Typically, users use a bookmark to access a team project portal or follow a link from another location such as a document or another Web page. Be sure to notify clients of the new location for their team project portals. In most cases, this will simply require changing the port number specified in the URL to the new port number defined for the WSS 3.0 Web application (e.g. port 81). Also, you should edit the old WSS 2.0 sites to display a prominent message with a pointer to the new WSS 3.0 version of the site. This way a user accidentally visiting the old location will discover that he or she is accessing the retired site.
3. Install the Project Creation Wizard Hotfix. For clients who need to create new team projects within Team Foundation Server must install the hotfix described in the Checklist at the beginning of this document. After installing the hotfix, it may be necessary to recycle the client-side cache as describe above in step 14a.
4. Test the solution. Perform this step after performing step 14c. Be sure you have refreshed the cache described in 14a.
  1. On a computer that is running Team Explorer, verify that you can access the SharePoint site and that you have STS Administrator permissions for the SharePoint server.
  2. Open Team Explorer, connect to the Team Foundation Server, and try to create a new team project. The new team project portal site should be created on the WSS 3.0 Web application. While this will not test all of the functionality described in this document, this is a good indicator that you are on the right track toward an operable solution.
[Optional] Take advantage of new WSS 3.0 functionality. To take advantage of new WSS 3.0 functionality on the new version of your team project portal sites, you may want to reset the site look and feel of your migrated sites to make the WSS 3.0 features more apparent. In addition, you need to perform this step on existing team project portal sites you migrated from WSS 2.0; however, you do not need to perform this step on new team project portal sites you create moving forward.
1. Open the WSS 3.0 team project portal you would like to upgrade (e.g., http://myATserver:81/sites/MyTeamProject).
2. Click Site Settings.
3. On the Site Settings page, click Reset to site definition under the Look and Feel column.
4. On the Reset Page to Site Definition Version page, either choose to reset an individual page within the site collection or reset all of the pages within a site collection. Once you make your decision, click Reset, then click OK in the confirmation dialog.
  Note: As you will note in the warning dialogs, certain customizations to your team project portal will be lost after performing this reset. Therefore, take care to understand what functionality you need to retain in your team project portal before you perform this optional reset.

Support for this Solution

If you have trouble implementing this solution, you may contact Microsoft Support, or visit the Team Foundation Server – Setup Forum. In addition, support for Windows SharePoint Services 3.0 is built-in to Visual Studio Team System 2008 Team Foundation Server.

Microsoft Services can help you enable this functionality via a services agreement. For more information on this option, please contact your local Microsoft account team.

Other Considerations

The Team Foundation Server backup and restoration guidelines detail a list of databases to back up. After configuring WSS 3.0, be sure to add the additional databases you created to your regular backup plan.

After you completed the installation you may find that Event ID 10017 error messages are logged in the System log. See KB Article 920783 for direction on how to stop these messages.