Share via

Adding Dashboards and Reports to Upgraded Team Projects

  • Article

You can provision your upgraded team project by using the dashboards and reports that are provided with version 5.0 of the Microsoft Solutions Framework (MSF) process templates. You can also add dashboards or reports to an existing team project when resources for SharePoint Products or SQL Server Reporting Services become available. For more information about dashboards and reports, see Dashboards (Agile) and Reports (Agile).

Note

If your upgraded team project was based on version 4.2 of an MSF process template, you have access to a set of post-upgrade reports. These reports are upgraded versions of the reports that were provided with version 4.2 of the MSF process templates. These reports support your upgraded team project and connect to the data warehouse for Visual Studio Team Foundation Server 2010. You can access these reports from the Report Reports node in Team Explorer or from the Reports link in Team Web Access. For more information, see Locating Reports After the Upgrade to Team Foundation Server 2010.

To provision your upgraded team project by using the dashboards and the latest version of reports that were provided with the MSF process templates, you create a batch file and run it from the Visual Studio command window. The batch file command provisions features in the same way that the New Team Project Wizard provisions features. When you run the batch file to add dashboards and Excel reports, the command uploads all documents that are provided with the process template that you specify and provisions the dashboards and Excel reports. The command also activates the SharePoint site and dashboard features that are specified in the process template.

When you run the batch file to create a report site, the command provisions a report site for the team project. You can add all reports that are defined for the process template that you specify to the server that hosts Reporting Services for your team project.

In this topic

  • Adding Dashboards and Excel Reports to an Upgraded Team Project

  • Adding MSF Version 5.0 Reports to an Upgraded Team Project

  • Running the Team Project Batch File Command

  • Specifying the Parameters for the Batch File

Prerequisites

The following table indicates the servers that must be provisioned in your Team Foundation deployment for you to provision your team project with the corresponding feature.

Feature

Windows SharePoint Services 3.0

Microsoft Office SharePoint Server 2007 Standard Edition

Microsoft Office SharePoint Server 2007 Enterprise Edition

SQL Server 2008 Analysis Services

SQL Server 2008 Reporting Services

Project portal

 check mark check mark check mark

My Dashboard and Project Dashboard

 check mark check mark check mark check mark check mark

Enterprise dashboards

check mark check mark check mark

Excel reports

 check mark check mark check mark check mark check mark

Report Reports

check mark check mark

To access dashboards, your team project must have a project portal enabled and be associated with a SharePoint site. The dashboards and dashboard customization features that are available to you depend on the version of SharePoint Products that is provisioned for your team project.

Before you can access reports that you manage through Reporting Services, the team project collection that contains your team project must be provisioned with SQL Server Analysis Services and Reporting Services.

Important

If you update your upgraded team project to use enterprise dashboards, a SharePoint Web application must be created where you have permissions to add your site. For more information, see Add a SharePoint Web Application to a Team Project Collection.

For more information about resource requirements to support team projects, see Launching a New Team Project.

Required Permissions

To perform this procedure, you must be a member of the following security groups:

  • For the project collection on the application tier for Team Foundation: Team Foundation Administrators or Project Administrators group. In addition, your Create new projects permission must be set to Allow for the team project collection where the team project is defined. Also, you must be a project administrator for the team project that you are updating.

  • On the server that will host SharePoint Products for your team project: the appropriate groups in SharePoint Central Administration. These groups vary depending on your version of SharePoint Products.

    If the portal site is being created under a site collection for the team project collection, you must have Full Control permissions set for the site collection. If the project site is created as a site collection itself, you must have farm administrator permissions.

  • On the server that will host Reporting Services for your team project: SQL Server Reporting Services Team Foundation Content Managers group.

For more information, see Set Administrator Permissions for Team Project Collections.

Adding Dashboards and Excel Reports to an Upgraded Team Project

You can provision a project portal site for an upgraded or existing team project by using the following procedure.

To add dashboards, Excel reports, and a project portal

  1. Click Start, right-click Visual Studio, and then click Run as administrator.

  2. Open a new file and copy and paste the following code into the file:

    <?xml version="1.0" encoding="utf-8"?> 
<Project xmlns="ProjectCreationSettingsFileSchema.xsd"> 
<TFSName>CollectionURI</TFSName> 
<LogFolder>LogFolderName</LogFolder> 
<ProjectName>TeamProjectName</ProjectName> 
<AddFeaturesToExistingProject>true</AddFeaturesToExistingProject> 
<ProjectReportsEnabled>false</ProjectReportsEnabled> 
<ProjectSiteEnabled>true</ProjectSiteEnabled> 
<ProjectSiteWebApplication>SharePointWebApp</ProjectSiteWebApplication> 
<ProjectSitePath>PortalSitePath</ProjectSitePath> 
<ProjectSiteTitle>ProjectSiteTitle</ProjectSiteTitle> 
<ProjectSiteDescription>SiteDescription</ProjectSiteDescription> 
<ProcessTemplateName>ProcessTemplate</ProcessTemplateName>
</Project>

  3. Replace the placeholder attributes with values that meet your project criteria.

    For more information, see Specifying the Parameters for the Batch File later in this topic.

  4. Save the file as an XML file.

  5. Run the File.BatchNewTeamProject command, and specify the file that you saved in the previous step.

    For more information, see Running the Team Project Batch File Command later in this topic.

  6. To verify that the dashboards are available, from Team Explorer, right-click your team project, and then click Open Team Project Portal Show Project Portal.

    A Web browser opens and displays the default dashboard for your team project.

    Note

    If you have a problem opening the dashboard, verify that your team project is enabled with a portal. For more information, see Access a Team Project Portal and Process Guidance.

  7. In the navigation pane, click the title of the dashboard that you want to open.

Adding Reports and Provisioning a Report Site for an Upgraded Team Project

By using the following procedure, you can provision a report site for an upgraded or existing team project, and you can upload the most recent versions of reports that are defined in the process template.

To provision a report site and optionally add reports

  1. Click Start, right-click Visual Studio, and then click Run as administrator.

  2. Create a file, and copy and paste the following code into it:

    <?xml version="1.0" encoding="utf-8"?> 
<Project xmlns="ProjectCreationSettingsFileSchema.xsd"> 
<TFSName>CollectionURI</TFSName> 
<LogFolder>LogFolderName</LogFolder> 
<ProjectName>TeamProjectName</ProjectName> 
<AddFeaturesToExistingProject>true</AddFeaturesToExistingProject> 
<ProjectReportsEnabled>true</ProjectReportsEnabled> 
<ProjectReportsForceUpload>false</ProjectReportsForceUpload> 
<ProjectSiteEnabled>false</ProjectSiteEnabled> 
<ProcessTemplateName>ProcessTemplate</ProcessTemplateName>
</Project>

  3. Replace the placeholder attributes with values that meet your project criteria.

    For more information, see Specifying the Parameters for the Batch File later in this topic.

  4. To upload the most recent versions of the reports that are provided in the process template, specify true for the ProjectReportsForceUpload tag.

    <ProjectReportsForceUpload>true</ProjectReportsForceUpload>

  5. Save the file as an XML file.

  6. Run the File.BatchNewTeamProject command, and specify the file that you saved in the previous step.

    For more information, see Running the Team Project Batch File Command later in this topic.

  7. To verify that the reports are available, from Team Explorer, expand your team project node, expand Report Reports, and then expand Bugs, Build, Project Management, or Test. 

  8. Double-click a report that you want to view.

Running the Team Project Batch File Command

To run the team project batch file command

  1. On the View menu, click Team Explorer.

  2. On the View menu, point to Other Windows, and then click Command Window.

  3. In the Command Prompt window, type the following command, specifying the path and file name of the file that you saved earlier in this topic. For example, type the following command:

    File.BatchNewTeamProject C:\File.xml

  4. To determine the outcome of running the command, view the contents of the log file. This file is written to the location that you specified for LogFolderPathName in the File.xml file.

    Review the messages in the log file to determine whether the command was successful. If error messages occur, correct the parameters, and rerun the command. In addition, verify that you have the necessary permissions that were described earlier in this topic.

Specifying the Parameters for the Batch File

The following table describes the parameters that you must define in the batch file.

Note

You can specify parameters to provision both a SharePoint site and Reporting Services in one batch file.

XML Tag

Parameter

Description

TFSName

CollectionURI

The uniform resource identifier (URI) of the team project collection. The format for the URI is as follows: https://ServerName:Port/VirtualDirectoryName/CollectionName

If no virtual directory is used, the format for the URI is as follows:

https://ServerName:Port/CollectionName

LogFolder

LogFolderName

The location of the folder where you want the log file to be written. The log file that will be created is named TEAMPROJECT.log, and it will contain the events from running the batch file command. For example, you can specify "C:\" for the log folder name. If you leave the value for the folder location blank, the log file will be written to %temp% and will be named following the naming conventions for logs that the New Project Creation Wizard generates. You can locate the log file by navigating to the following directory: $:\Documents and Settings\user name\Local Settings\Temp\VSTS_TeamProjectCreation_yyyy_mm_dd_hh_mm_ss.log.

ProjectName

TeamProjectName

The name of the upgraded team project to be provisioned. You must specify the name of a team project that is defined in the project collection that you specified in the CollectionURI parameter.

AddFeaturesToExistingProject

true | false

Specify true to indicate that you are adding features to an existing team project and false to indicate that you are creating a team project.

ProjectReportsEnabled

true | false

Specify true to provision a report site and false to exclude provisioning a report site.

ProjectReportsForceUpload

true | false

Specify true to cause reports in the process template to be uploaded to the report site and false to exclude the upload of reports.

ProjectSiteEnabled

true | false

Specify true to enable the team project portal site and false to maintain the site as disabled for the team project.

ProjectSiteWebApplication

SharePointWebApp

Specifies the friendly name (not the URL) to the SharePoint Web application (for example, Team Project Portal). By default, the URL and the friendly name are the same.

ProjectSitePath

PortalSitePath

The relative site path where you want the project portal site to be created (for example, sites/DefaultCollection/MyProject).

NoteNote
The site path that you specify must correspond to a Web site application that has been added to the team project collection where the team project is defined. For more information, see Add a SharePoint Web Application to Your Deployment.

The relative site path corresponds to the home page of the project portal.

ProjectSiteTitle

ProjectSiteTitle

(Optional) If you want a project portal name that differs from the team project name, you can type a name that is easily identified by your team members.

ProjectSiteDescription

SiteDescription

(Optional) The site description for the team project portal (for example, The "My Project" Portal Site).

ProcessTemplateName

ProcessTemplate

The name of the process template to use to create the project portal. To specify a version 5.0 MSF process template, enter one of the following values:

  • MSF for Agile Software Development v5.0

  • MSF for CMMI Process Improvement v5.0

NoteNote
If you want to use another process template, you must first make sure that it is uploaded to Team Foundation Server. For more information, see Upload a Process Template.

See Also

Tasks

Add a Team Project Portal

Add Reports and Dashboards to an Upgraded Team Project Portal

Access a Team Project Portal and Process Guidance

Concepts

Updating an Upgraded Team Project to Access New Features

Other Resources

Launching a New Team Project