向过程模板添加报告

项目
02/21/2013

通过使用“报表”插件，可以指定出现在新团队项目的 **“报表”**节点下的文件夹结构和报表集合。

重要

“报表”插件要求从中创建团队项目的团队项目集合已配置了 SQL Server Analysis Services 和 SQL Server Reporting Services。有关更多信息，请参见向团队项目集合添加报表服务器。

通过使用“报表”插件来指定两项主要任务。首先，通过使用 site 元素创建报告站点。其次，通过使用 folder 元素和 report 元素指定要上载到网站的文件夹结构和报表。您上载的报表的扩展名为 .rdl，它们专用于 Reporting Services。有关 Microsoft Solutions Framework (MSF) 的过程模板提供的报表的概述，请参见报表 (Agile)或报表 (CMMI)。

主题内容

“报表”插件的名称和位置
“报表”插件的语法结构
创建报告站点
定义文件夹
指定要上载的报表
ReportingServices 元素参考

从过程模板创建团队项目后，您可以添加、删除、重命名和更改报表的文件夹结构。有关更多信息，请参见管理报表。

“报表”插件的名称和位置

下表总结了 MSF 过程模板的文件名、文件夹名称和插件名称。

文件名：	ReportsTasks.xml
文件夹名称：	报告
插件名称：	Microsoft.ProjectCreationWizard.Reporting

备注

可以更改 XML 文件和文件夹的名称，但不能更改插件名称。Visual Studio Team Foundation Server 并不包括用于部署客户端插件、策略或其他修改的机制。如果您希望部署此类功能，则必须使用您自己的分发和安装程序。

在 XML 文件中，指定一个或多个任务以及它们的依赖项。有关指定一组报表的任务的示例，请参见 MSF for Agile Software Development 过程模板中的 ReportsTasks.xml 文件。

返回页首

“报表”插件的语法结构

“报表”插件文件必须符合 Rosetta.xsd 文件中定义的 ReportingServices 架构定义，并且在自己的文件中指定。您可以从 Microsoft 网站上的以下页面下载过程模板的架构文件：Process Template and Work Item Schemas for Visual Studio Team Foundation（Visual Studio Team Foundation 的过程模板和工作项架构）。

下面的语法演示了“报表”插件的结构。有关每个元素的说明，请参见本主题后面的 ReportingServices 子元素。

<?xml version="1.0" encoding="utf-8"?>
<tasks>
  <task id="Site" plugin="Microsoft.ProjectCreationWizard.Reporting" completionMessage="Project Reporting site created.">
    <dependencies />
    <taskXml>
      <ReportingServices>
        <site> </site>
      </ReportingServices>
    </taskXml>
  </task>
  <task id="Populate Reports" plugin="Microsoft.ProjectCreationWizard.Reporting" completionMessage="Project reports uploaded.">
    <dependencies>
      <dependency taskId="Site" />
    </dependencies>
    <taskXml>
      <ReportingServices>
        <folders> . . . </folders>
        <reports> . . . </reports>
      </ReportingServices>
    </taskXml>
  </task>
</tasks>

返回页首

创建报告站点

要正确运行报表，必须创建一个报告站点。该报告站点在项目门户网站主页上具有一个指向自身的链接，该链接标记为 “报表”。若要创建报告站点，请使用 site 元素，如以下示例所示：

<taskXml>
   <ReportingServices>
        <site></site>
   </ReportingServices>
</taskXml>

返回页首

定义文件夹

可以使用 folder 元素在报告站点上创建文件夹。使用 path 特性指定新文件夹的相对路径名称。新建的文件夹显示在项目站点上和团队资源管理器中的 Reports 文件夹下。

下面的示例在报告站点上创建四个顶级文件夹和两个子文件夹。顶级文件夹分别标记为“Bugs”、“Builds”、“Project Management”和“Tests”。两个子文件夹位于“Project Management”下，且分别标记为“Visual Studio”和“Visual Studio ALM”。

<taskXml>
   <ReportingServices>
      <folders>
         <folder path="Bugs" />
          <folder path="Builds" />
          <folder path="Project Management" />
          <folder path="Project Management/Visual Studio" />
          <folder path="Project Management/Visual Studio ALM" />
          <folder path="Tests" />
      </folders>
   </ReportingServices>
</taskXml>

返回页首

指定要上载的报表

报表由 .rdl 文件定义。若要向报告站点添加报表，请将 .rdl 报表文件复制到过程模板中的 Reports 文件夹下的某个文件夹中。然后使用 report 元素描述用于报表的必要属性和数据源。

下面的示例指定将 Remaining Work.rdl 文件上载到 Project Management 文件夹。您必须为每个报表指定 ExplicitProject 参数和数据源。下面的示例中的数据源对应于自动分配给 Analysis Services 多维数据集和 Team Foundation Server 2010 的数据仓库关系数据库的名称。

<taskXml>
   <ReportingServices>
     <reports>
        <report name="Remaining Work" filename="Reports\Remaining Work.rdl" folder="Project Management" cacheExpiration="30">
       <parameters>
          <parameter name="ExplicitProject" value="" />
       </parameters>
       <datasources>
          <reference name="/Tfs2010OlapReportDS" dsname="TfsOlapReportDS" />
          <reference name="/Tfs2010ReportDS" dsname="TfsReportDS" />
       </datasources>
    </report>
 . . . 
     </reports>
   </ReportingServices>
</taskXml>

返回页首

ReportingServices 元素参考

下面的语法演示了 ReportingServices 元素及其子元素的结构。在 taskXml 容器元素中指定这些元素，并且只为“报表”插件指定这些元素。

<ReportingServices>
   <folders>
      <folder />
 . . . 
   </folders>
   <reports>
      <report>
         <parameters>
            <parameter />
         </parameters>
         <datasources>
            <reference />
         </datasources>
      </report>
 . . . 
   </reports>
</ReportingServices>

下表介绍了一些元素，这些元素用于指定要上载到团队项目的报表，可通过 SQL Server Reporting Services 访问这些元素。

元素	语法	说明
datasources	`<datasources> <reference /> </datasources>`	report 的必需子元素。包含 reference 元素的集合，每个元素指定报表使用的一个数据源。
folder	`<folder path="FolderName" />`	folders 的必需子元素。定义要在团队项目的“报表”节点下创建的文件夹的名称。
folders	`<folders> <folder path="FolderName" /> </folders>`	ReportingServices 的可选子元素。包含 folder 元素的集合，每个元素指定要创建的文件夹的名称。
parameter	`<parameter name="ParameterName" value="ParameterValue" />` 其中，每个特性具有以下定义： name：要指定的参数的名称。 value：要分配给参数的值。您必须至少定义以下参数，以使您的报表自动使用包含您的报表项目： `<parameter name="ExplicitProject" value="" />`	parameters 的必需子元素。指定报表参数的名称以及分配给该参数的值。
parameters	`<parameters> <parameter /> </parameters>`	report 的必需子元素。定义报表的 parameter 元素集合。
properties	`< properties > < property /> </ properties >`	report 的可选子元素。
property	`<property name="PropertyName" value="PropertyValue" />` 其中，每个特性具有以下定义： name：要指定的属性的名称。有关更多信息，请参见使用 Visual Studio ALM 报表管理器查看、组织和配置报表。 value：要分配给属性的值。	properties 的必需子元素。
reference	`<reference name="RelationalDBName" dsname="OLAPDBName" />` 其中，每个特性具有以下定义： name：Team Foundation Server 中的数据源的名称。在 Team Foundation Server 2010 中，此值为 Tfs2010OlapReportDS（对于 Analysis Services 多维数据集）或 Tfs2010ReportsDS（对于关系数据仓库）。 dsname：数据库资源的名称。为 Analysis Services 多维数据集指定 TfsOlapReportDS，为关系数据仓库指定 TfsReportsDS。有关报表数据源的名称的更多信息，请参见Locating Reports After the Upgrade to Team Foundation Server 2010。	datasources 的必需子元素。为数据仓库关系数据库和 Analysis Services 多维数据集指定在 Team Foundation Server 中分配的名称。
report	`<report name="ReportName" filename="ReportFilePathName" folder="FolderName" cacheExpiration="CacheDuration"> <folders> <parameters>. . .</parameters> <datasources>. . .</datasources> <properties>. . .</properties > </report>` 其中，每个特性具有以下定义： name：要在报告站点上和团队资源管理器中显示的报表的名称。 filename：从本地 Reports 文件夹下获取 .rdl 报表文件的相对路径。 folder：将报表添加到报告站点上的位置的相对路径名。 cacheExpiration：缓存报表的默认分钟数。	reports 的必需子元素。指定报表的名称、包含 .rdl 定义的文件以及将报表上载到的文件夹。 Team Foundation Server
reports	`<reports> <report /> . . . </reports>`	ReportingServices 的必需子元素。包含 report 元素的集合，每个元素指定要上载的报表文件的名称。
ReportingServices	`<ReportingServices> <folders>. . .</folders> <reports>. . .</reports> </ReportingServices>`	“报表”插件的 taskXml 元素的必需子元素。介绍定义 SQL Server Reporting Services 的报表和文件夹所需的任务。
site	`<site> </site>`	“报表”插件的必需元素。指定将创建团队项目的报告站点。