Adicionar relatórios ao modelo de processo

Artigo
06/09/2015

Usando o plug-in de geração de relatórios, você pode especificar a estrutura de pastas e os relatórios que aparecem no nó Relatórios para uma nova equipe de projetos.

Importante

O plug-in de geração de relatórios requer que a coleção de projetos na qual você vai criar o projeto de equipe esteja configurada com os serviços de análise SQL Server e de geração de relatórios SQL Server.Para obter mais informações, consulte Adicionar relatórios a um projeto da equipe.

Você especifica duas tarefas principais usando o plug-in de geração de relatórios. Primeiro, você cria o local para geração de relatório usando o elemento site. Depois, você deve especificar a estrutura da pasta e quais relatórios serão enviados para o site por meio dos elementos folder e report. Os relatórios enviados devem ter a extensão .rdl e serão usados no Reporting Services. Para consultar uma visão geral dos relatórios fornecidos pelos modelos de processo do TFS, veja Relatórios (SQL Server Reporting Services).

Depois de criar a equipe do projeto com base no modelo de processo, você pode adicionar, remover, renomear e alterar a estrutura das pastas para os relatórios. Para obter mais informações, consulte Exibir, carregar e organizar relatórios (Reporting Services Reports).

Nome e local do plug-in de geração de relatórios

A tabela a seguir resume os nomes do arquivo, da pasta e do plug-in para os modelos de processo do MSF.

Nome do arquivo:	ReportsTasks.xml
Nome da pasta:	Relatórios
Nome do plug-in:	Microsoft.ProjectCreationWizard.Reporting

Dica

Você pode alterar os nomes do arquivo XML e da pasta, mas não do plug-in.O Visual Studio Team Foundation Server não inclui um mecanismo para a implantação de plug-ins do lado do cliente, políticas ou outras modificações.Para implantar esse tipo de funcionalidade você tem que usar seu próprio programa de instalação e distribuição.

No arquivo XML, você especifica uma ou mais tarefas e suas dependências. Como exemplo de tarefa que especifica um conjunto de relatórios, consulte o arquivo ReportsTasks.xml bi MSF param ver o modelo de processo de desenvolvimento de software Agile.

Estrutura da sintaxe do plug-in de geração de relatórios

O plug-in file de geração de relatórios deve adequar-se à definição de esquema para o Reporting Services, que é definida no arquivo Rosetta.xsd, além de ser especificado em seu próprio arquivo.

A sintaxe a seguir mostra a estrutura do plug-in de geração de relatórios. Para ver a descrição de cada elemento, confira Elementos filhos do Reporting Services mais adiante, neste tópico.

<?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>

Como criar o site de relatórios

Para que a execução dos relatórios não apresente problemas, você tem que criar um site de relatórios. O site de relatórios contém um link Relatórios que leva à página inicial do portal do projeto. Para criar esse site, use o elemento site, como mostra o exemplo a seguir:

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

Como definir pastas

Você pode criar as pastas no site de geração de relatório usando o elemento folder. Use o atributo de caminho para especificar o nome de caminho relativo da nova pasta. A pasta aparece no site do projeto e na pasta Relatórios, em Team Explorer.

O exemplo a seguir cria quatro pastas de nível superior e duas subpastas no site de geração de relatórios. As pastas de nível superior recebem os nomes de Bugs, Builds, Project Management e Tests. As duas subpastas ficam dentro da pasta Project Management e recebem os nomes de Visual Studio e 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>

Especifique os relatórios a serem enviados

Os relatórios são definidos por arquivos .rdl. Para adicionar relatórios a um site, copie os arquivos .rdl para uma pasta dentro da pasta Relatórios do modelo de processos. Em seguida, use o elemento do relatório para descrever as propriedades e fontes de dados necessárias.

O exemplo a seguir especifica que o arquivo Remaining Work.rdl seja enviado para a pasta Project Management. Você tem que especificar o parâmetro ExplicitProject e as fontes de dados de cada relatório. As fontes de dados do exemplo a seguir correspondem aos nomes que são atribuídos automaticamente ao cubo Analysis Services e ao banco de dados relacional do data warehouse.

Dica

Os nomes das fontes de dados dos serviços de geração de relatórios são Tfs2010ReportsDS e Tfs2010OlapReportsDS.Mesmo que você tenha instalado ou atualizado para o TFS 2012 ou TFS 2013, esses nomes, que foram atribuídos às fontes de dados na instalação do TFS 2010, continuam a ser usados.

<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>

Referência do elemento ReportingServices

A sintaxe a seguir mostra a estrutura do elemento ReportingServices e seus elementos filho. Você especifica esses elementos no elemento de contêiner taskXml e somente para o plug-in de geração de relatórios.

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

A tabela a seguir descreve os elementos que você usa para especificar um relatório a ser enviado para um projeto de equipe e que pode ser acessado pelo SQL Server Reporting Services.

Elemento	Sintaxe	Descrição
datasources	`<datasources> <reference /> </datasources>`	Elemento filho de report obrigatório. Contém uma coleção de elementos reference que especificam fontes de dados usadas pelos relatórios.
folder	`<folder path="FolderName" />`	Elemento filho de folders obrigatório. Define o nome de uma pasta a ser criada no nó Relatórios para um projeto de equipe.
folders	`<folders> <folder path="FolderName" /> </folders>`	Elemento filho opcional de ReportingServices. Contém uma coleção de elementos folder que especificam os nomes das pastas a serem criadas.
parameter	`<parameter name="ParameterName" value="ParameterValue" />` Em que cada atributo tem a seguinte definição: name: o nome do parâmetro que você quer especificar. value: o valor a ser atribuído ao parâmetro. Você deve, no mínimo, definir os parâmetros a seguir para que o relatório use automaticamente o projeto que contém o relatório: `<parameter name="ExplicitProject" value="" />`	Elemento filho de parameters obrigatório. Especifica o nome de um parâmetro do relatório e o valor a ser atribuído a ele.
parameters	`<parameters> <parameter /> </parameters>`	Elemento filho de report obrigatório. Define uma coleção de elementos parameter para um relatório.
properties	`< properties > < property /> </ properties >`	Elemento filho opcional de report.
property	`<property name="PropertyName" value="PropertyValue" />` Em que cada atributo tem a seguinte definição: name: o nome da propriedade que você quer especificar. Para obter mais informações, consulte Exibir, organizar e configurar relatórios usando o Gerenciador de Relatórios. value: o valor a ser atribuído à propriedade.	Elemento filho de properties obrigatório.
reference	`<reference name="RelationalDBName" dsname="OLAPDBName" />` Em que cada atributo tem a seguinte definição: name: o nome da fonte de dados em Team Foundation Server. Para o Team Foundation Server 2010, esse valor é Tfs2010OlapReportDS para o cubo Analysis Services ou Tfs2010ReportsDS para o data warehouse relacional. dsname: o nome do recurso do banco de dados. Especifique TfsOlapReportDS para o cubo Analysis Services e TfsReportsDS para o data warehouse relacional. Para saber mais sobre os nomes das fontes de dados da geração de relatórios, confira Localize relatórios após a atualização para o Team Foundation Server 2010.	Elemento filho de datasources obrigatório. Especifica os nomes atribuídos no Team Foundation Server para o banco de dados relacional do data warehouse e para o cubo Analysis Services.
report	`<report name="ReportName" filename="ReportFilePathName" folder="FolderName" cacheExpiration="CacheDuration"> <folders> <parameters>. . .</parameters> <datasources>. . .</datasources> <properties>. . .</properties > </report>` Em que cada atributo tem a seguinte definição: name: o nome do relatório a ser exibido no site de geração de relatórios e no Team Explorer. filename: um caminho relativo na pasta Relatórios local ondem o arquivo de relatório .rdl pode ser obtido. folder: um nome de caminho relativo do local para adicionar o relatório ao site de geração de relatórios. cacheExpiration: o tempo padrão, em minutos, do armazenamento do relatório em cache.	Elemento filho de reports obrigatório. Especifica o nome do relatório, o arquivo que contém a definição .rdl e a pasta à qual o relatório é enviado. Team Foundation Server
reports	`<reports> <report /> . . . </reports>`	Elemento filho de ReportingServices obrigatório. Contém uma coleção de elementos report que especificam os nomes dos arquivos de relatórios a serem criados.
ReportingServices	`<ReportingServices> <folders>. . .</folders> <reports>. . .</reports> </ReportingServices>`	Elemento filho necessário do elemento taskXml para o plug-in de geração de relatórios. Descreve as tarefas necessárias para definir os relatórios e as pastas para o SQL Server Reporting Services.
site	`<site> </site>`	Elemento necessário para o plug-in de geração de relatórios. Especifica que um site de geração de relatórios será criado para o projeto de equipe.

Consulte também

Conceitos

Personalizar um modelo de processo

Visão geral de arquivos de modelo de processo

Share via