向过程模板添加报告

Azure DevOps Server 2022 - Azure DevOps Server 2019 |TFS 2018

创建项目时,报表插件将创建报表站点,并指定将在团队资源管理器中的 “报表“报表 ”节点下显示的文件夹结构和报表集。 此插件要求你已配置本地 TFS 实例和项目集合,你将在其中创建具有SQL Server Analysis Services和SQL Server Reporting Services的项目。

重要

从 Web 门户创建项目时,ReportsTasks.xml
插件文件将被忽略。 若要在创建项目后添加报表,请参阅 向项目添加报表
支持项目创建的客户端因 TFS 版本而异。 有关详细信息,请参阅 进程模板和插件文件、客户端对项目创建的支持

通过使用“报表”插件来指定两项主要任务。 首先,使用 站点 元素创建报告网站。 其次,使用文件夹和报表元素指定要上传到网站的 文件夹 结构和 报表 。 你上载的报表的扩展名为 .rdl,它们专用于 Reporting Services。 有关 TFS 进程模板提供的报表的概述,请参阅Reporting Services报表

从进程模板创建项目后,可以添加、删除、重命名和更改报表的文件夹结构。 有关详细信息,请参阅 查看、上传和组织报表

报告插件名称和位置

下表汇总了敏捷和 CMMI 进程模板的文件、文件夹和插件的名称。

文件名:ReportsTasks.xml
文件夹名称:报表
插件名称:Microsoft.ProjectCreationWizard.Reporting

注意

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

在 XML 文件中,指定一个或多个任务以及它们的依赖项。 有关指定一组报表的任务的示例,请参阅敏捷流程模板中的ReportsTasks.xml文件。

报告插件语法结构

“报表”插件文件必须符合 Rosetta.xsd 文件中定义的 ReportingServices 架构定义,并且在自己的文件中指定。

下面的语法演示了“报表”插件的结构。 有关每个元素的说明,请参阅本主题后面的 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 

创建报表网站

第一个任务是创建报告站点。 报告网站将在项目门户主页上具有指向它的链接,该链接将标记为 “报表报表。 使用 站点 元素创建网站,如以下示例所示:

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

定义报告文件夹

使用 文件夹 元素在报告网站上创建文件夹。 使用 path 特性指定新文件夹的相对路径名称。 该文件夹显示在项目网站和团队资源管理器的 “报表 ”文件夹下。

下面的示例在报告站点上创建四个顶级文件夹和两个子文件夹。 顶级文件夹分别标记为“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 多维数据集和数据仓库关系数据库的名称。

注意

Reporting Services 数据源的名称和 Tfs2010ReportsDSTfs2010OlapReportsDS。 即使你可能已安装或已升级到更新版本的 TFS,仍将继续使用分配给数据源用于 TFS 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 容器元素中指定这些元素,并且仅针对 Reporting 插件。

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

下表描述了用于指定要上传到项目的报表的元素,以及可通过SQL Server Reporting Services访问的报表。

元素

说明和语法

数据源

报表的必需子元素。 包含每个 引用 元素的集合,每个元素指定报表使用的数据源。

<datasources>
<reference />
</datasources>

文件夹

文件夹的必需子元素。 定义要在项目“报表”节点下创建的文件夹的名称。

<folder path="FolderName" />

文件夹

ReportingServices 的可选子元素。 包含 文件夹 元素的集合,每个元素指定要创建的文件夹的名称。

<folders>
<folder path="FolderName" />
</folders>

参数

参数的必需子元素。 指定报表参数的名称以及分配给该参数的值。

<parameter name="ParameterName" value="ParameterValue" />

其中,每个特性具有以下定义:

  • name:要指定的参数的名称。
  • :要分配给参数的值。 你必须至少定义以下参数,以使你的报表自动使用包含你的报表项目:
    <parameter name="ExplicitProject" value="" />.

parameters

报表的必需子元素。 定义报表 的参数 元素的集合。

<parameters>
<parameter />
</parameters>

properties

报表的可选子元素。 提供 属性的容器元素。

<properties>
<property />
</properties>

property

属性的必需子元素。

<property name="PropertyName" value="PropertyValue" />

其中,每个特性具有以下定义:

reference

数据源的必需子元素。 指定在 Team Foundation Server 中为数据仓库关系数据库和 Analysis Services 多维数据集分配的名称。

<reference name="RelationalDBName" dsname="OLAPDBName"  />

其中,每个特性具有以下定义:

  • 名称:TFS 数据源的名称。 对于 Team Foundation Server 2010 及更高版本,此值为 Analysis Services 多维数据集的 Tfs2010OlapReportDS 或关系数据仓库的 Tfs2010ReportsDS。
  • dsname:数据库资源的名称。 为 Analysis Services 多维数据集指定 TfsOlapReportDS,为关系数据仓库指定 TfsReportsDS。

有关报告数据源的名称的详细信息,请参阅 升级到 TFS 2010 后查找报表

report (报表)

报表的必需子元素。 指定报表的名称、包含 .rdl 定义的文件以及将报表上载到的文件夹。

<report name="ReportName" filename="ReportFilePathName"  folder="FolderName" 
cacheExpiration="CacheDuration">
<parameters> . . . </parameters>
<datasources> . . . </datasources>
<properties> . . . </properties>
</report>

其中,每个特性具有以下定义:

  • 名称:要显示在报告站点和团队资源管理器中的报表的名称。
  • 文件名:从中获取 .rdl 报表文件的本地 Reports 文件夹下的相对路径。
  • cacheExpiration:缓存报表的默认分钟数。

reports

ReportingServices 的必需子元素。 包含 报表元素的 集合,每个元素指定要上传的报表文件的名称。

<reports>
<report />
</reports>

ReportingServices

Reporting 插件 的 taskXml 元素的必需子元素。 描述定义SQL Server Reporting Services报表和文件夹所需的任务。

<ReportingServices>
<folders> . . . </folders>
<reports> . . . </reports>
<properties> . . . </properties>
</ReportingServices>

网站

“报表”插件的必需元素。 指定将创建项目的报表网站。

<site>
. . . 
</site>