Добавление отчетов в шаблон процесса

Статья
06/09/2015

С помощью подключаемого модуля отчетов можно задавать структуру папок и настраивать отчеты, которые будут отображаться в узле Отчеты нового командного проекта.

Важно!

Для использования подключаемого модуля отчетов необходимо, чтобы для коллекции командных проектов, в которой будет создаваться командный проект, были настроены службы анализа SQL Server и службы отчетов SQL Server.Для получения дополнительной информации см. Добавление отчетов в командный проект.

С помощью подключаемого модуля отчетов задаются две основные задачи. Во-первых, с помощью элемента site создается сайт отчетов. Во-вторых, с помощью элементов folder и report задается структура папок и отчеты, которые будут переданы на сайт. Передаваемые отчеты имеют расширение RDL и предназначены для использования со службами отчетов. Обзор отчетов, предусмотренных в шаблонах процессов TFS, см. в разделе Отчеты (SQL Server Reporting Services).

После создания командного проекта из шаблона процесса появляется возможность добавлять, удалять, переименовывать и изменять структуру папок для отчетов. Для получения дополнительной информации см. Просмотр, отправка и организация отчетов (отчеты служб отчетов).

Имя и расположение подключаемого модуля отчетов

В следующей таблице приведены имена файла, папки и подключаемого модуля для шаблонов процессов MSF.

Имя файла:	ReportsTasks.xml
Имя папки:	Отчеты
Имя подключаемого модуля:	Microsoft.ProjectCreationWizard.Reporting

Примечание

Имена XML-файла и папки можно изменить, а имя подключаемого модуля изменить нельзя.Visual Studio Team Foundation Server не содержит механизма развертывания клиентских подключаемых модулей, политик или других модификаций.Если требуется развернуть функциональность этого типа, необходимо использовать собственную программу распространения и установки.

В XML-файле укажите одну или несколько задач и их зависимости. Пример задачи, задающей набор отчетов, см. в файле ReportsTasks.xml в шаблоне процесса MSF для гибкой разработки программного обеспечения.

Структура синтаксиса подключаемого модуля отчетов

Файл подключаемого модуля отчетов должен удовлетворять определению схемы ReportingServices, заданному в файле Rosetta.xsd, а сам подключаемый модуль должен быть задан в собственном файле.

В следующем фрагменте синтаксиса показана структура подключаемого модуля отчетов. Описание каждого элемента см. ниже в подразделе Дочерние элементы элемента 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 в Team Explorer.

В следующем примере показано создание на сайте отчетов четырех папок верхнего уровня и двух подпапок. Папки верхнего уровня имеют метки 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 и источники данных. Источники данных в следующем примере соответствуют именам, автоматически присваиваемым кубу служб аналитики и реляционной базе данных хранилища.

Примечание

Имена источников данных служб отчетов — Tfs2010ReportsDS и Tfs2010OlapReportsDS.Даже если вы установили TFS 2012 или TFS 2013 либо провели обновление до этих версий, эти имена, присвоенные источникам данных при установке 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 и только для подключаемого модуля отчетов.

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

В следующей таблице описаны элементы, используемые для задания отчета, который должен быть передан в командный проект и должен быть доступным через службы отчетов SQL Server.

Элемент	Синтаксис	Описание
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: имя свойства, которое требуется указать. Для получения дополнительной информации см. Просмотр, организация и настройка отчетов с помощью диспетчера отчетов. value: присваиваемое свойству значение.	Обязательный дочерний элемент элемента properties.
reference	`<reference name="RelationalDBName" dsname="OLAPDBName" />` Здесь к каждому атрибуту применяются следующие определения: name: имя источника данных в Team Foundation Server. В Team Foundation Server 2010 это значение равняется Tfs2010OlapReportDS для куба служб анализа и Tfs2010ReportsDS для реляционного хранилища данных; dsname: имя ресурса базы данных. Укажите TfsOlapReportDS для служб анализа и TfsReportsDS для реляционного хранилища данных. Дополнительные сведения об именах источников данных для отчетов см. в разделе Обнаружение отчетов после обновления до Team Foundation Server 2010.	Обязательный дочерний элемент элемента datasources. Задает имена, назначаемые реляционной базе данных хранилища и кубу служб анализа в Team Foundation Server.
report	`<report name="ReportName" filename="ReportFilePathName" folder="FolderName" cacheExpiration="CacheDuration"> <folders> <parameters>. . .</parameters> <datasources>. . .</datasources> <properties>. . .</properties > </report>` Здесь к каждому атрибуту применяются следующие определения: name: имя отчета, отображаемого на сайте отчетов в Team Explorer; filename: путь к RDL-файлу отчета относительно локальной папки Reports; folder: относительный путь к папке, в которую добавляется отчет на сайте отчетов; cacheExpiration: время в минутах по умолчанию, в течение которого кэшируется отчет.	Обязательный дочерний элемент элемента reports. Задает имя отчета, файл, содержащий определение RDL и папку, в которую передается отчет. Team Foundation Server
reports	`<reports> <report /> . . . </reports>`	Обязательный дочерний элемент элемента ReportingServices. Содержит коллекцию элементов report, каждый из которых определяет имя файла отчета для передачи.
ReportingServices	`<ReportingServices> <folders>. . .</folders> <reports>. . .</reports> </ReportingServices>`	Обязательный дочерний элемент элемента taskXml для подключаемого модуля отчетов. Содержит задачи, необходимые для определения отчетов и папок служб отчетов SQL Server.
site	`<site> </site>`	Обязательный элемент подключаемого модуля отчетов. Указывает, что будет создан сайт отчетов для командного проекта.

См. также

Основные понятия

Настройка шаблона процесса

Общие сведения о файлах шаблонов процессов

Поделиться через