Agregar informes a la plantilla de proceso

  • Artículo
  • 7 minutos para leer

Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018 - TFS 2013
Azure DevOps Server anteriormente se denominaba Visual Studio Team Foundation Server.

Al crear un proyecto, el complemento Informes crea un sitio de informe y especifica la estructura de carpetas y el conjunto de informes que aparecerán en el nodo Informes informes en Team Explorer. Este complemento requiere que haya configurado la instancia de TFS local y la colección de proyectos donde creará un proyecto con SQL Server Analysis Services y SQL Server Reporting Services.

Importante

Al crear un proyecto desde el portal web, el ReportsTasks.xml
Se omite el archivo de complemento. Para agregar informes después de crear el proyecto, vea Agregar informes a un proyecto.
Los clientes que admiten la creación de proyectos varían en función de la versión de TFS. Para más información, consulte Plantilla de proceso y archivos de complemento, Compatibilidad de cliente para la creación de proyectos.

Se especifican dos tareas principales mediante el complemento de informes. En primer lugar, cree el sitio de informes mediante el elemento de sitio . En segundo lugar, especifique la estructura de carpetas y los informes que se cargarán en el sitio mediante la carpeta y los elementos de informe. Los informes que carga tienen una extensión .rdl y están diseñados para su uso con  Reporting Services. Para obtener información general sobre los informes que proporcionan las plantillas de proceso de TFS, vea Reporting Services Reports.

Después de crear un proyecto a partir de la plantilla de proceso, puede agregar, quitar, cambiar el nombre y cambiar la estructura de carpetas de los informes. Para obtener más información, vea Ver, cargar y organizar informes.

Nombre y ubicación del complemento de informes

En la tabla siguiente se resumen los nombres del archivo, la carpeta y el complemento para las plantillas de proceso agile y CMMI.

Nombre de archivo:ReportsTasks.xml
Nombre de carpeta:informes
Nombre del complemento:Microsoft.ProjectCreationWizard.Reporting

Nota

Puede cambiar los nombres del archivo XML y de la carpeta pero no el del complemento. TFS no incluye un mecanismo para la implementación de complementos del lado cliente, directivas u otras modificaciones. Si desea implementar este tipo de funcionalidad, debe utilizar su propio programa de instalación y distribución.

En el archivo XML, puede especificar una o más tareas y sus dependencias. Para obtener un ejemplo de una tarea que especifica un conjunto de informes, consulte el archivo ReportsTasks.xml en la plantilla de proceso agile.

Estructura de la sintaxis del complemento de informes

El archivo del complemento de informe se debe ajustar a la definición de esquema de ReportingServices, que se define en el archivo Rosetta.xsd y se especifica en su propio archivo.

La sintaxis siguiente muestra la estructura del complemento de informes. Para obtener una descripción de cada elemento, vea Elementos secundarios reportingServices más adelante en este tema.

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

Creación del sitio de informes

La primera tarea consiste en crear el sitio de informes. El sitio de informes tendrá un vínculo a él en la página principal del portal del proyecto y el vínculo se etiquetará como Informe informes. Use el elemento site para crear el sitio, como se muestra en el ejemplo siguiente:

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

Definición de las carpetas de informes

El elemento folder se usa para crear carpetas en el sitio de informes. Utilice el atributo path para especificar el nombre de ruta de acceso relativa de la nueva carpeta. La carpeta aparece en el sitio del proyecto y en la carpeta Informes de Team Explorer.

En el ejemplo siguiente se crean cuatro carpetas de nivel superior y dos subcarpetas en el sitio de informes. Las carpetas del nivel superior se denominan Bugs, Builds, Project Management y Tests. Las dos subcarpetas se encuentran bajo Project Management y están etiquetadas como Visual Studio y 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

Especificar los informes que se van a cargar

Para agregar los informes .rdl al sitio de informes, copie cada archivo .rdl en una carpeta de la carpeta Informes de la plantilla de proceso. A continuación, utilice el elemento report para describir las propiedades y los orígenes de datos necesarios para el informe.

En el ejemplo siguiente se especifica que el archivo Remaining Work.rdl se carga en la carpeta Project Management. Debe especificar el parámetro ExplicitProject y los orígenes de datos de cada informe. Los orígenes de datos del ejemplo siguiente se corresponden con los nombres que se asignan automáticamente a la base de datos relacional del cubo de Analysis Services y del almacén de datos.

Nota

Los nombres de los orígenes de datos de Reporting Services son Tfs2010ReportsDS y Tfs2010OlapReportsDS . Aunque es posible que haya instalado TFS o haya actualizado a la última versión de TFS, estos nombres, que se asignaron a los orígenes de datos para una instalación de TFS 2010, siguen en uso.

<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

Elementos ReportingServices

La sintaxis siguiente muestra la estructura del elemento ReportingServices y sus elementos secundarios. Estos elementos se especifican en el elemento contenedor taskXml y solo para el complemento de informes.

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

En la tabla siguiente se describen los elementos que se usan para especificar un informe que se va a cargar en un proyecto y a los que se puede acceder a través de SQL Server Reporting Services.

Element

Descripción y sintaxis

Datasources

Elemento secundario requerido del informe. Contiene una colección de elementos de referencia que especifican cada uno un origen de datos que usa el informe.

<datasources>
<reference />
</datasources>

Carpeta

Elemento secundario requerido de las carpetas. Define el nombre de una carpeta que se creará en el nodo Informes de un proyecto.

<folder path="FolderName" />

Carpetas

Elemento secundario opcional de ReportingServices. Contiene una colección de elementos de carpeta que especifican el nombre de una carpeta que se creará.

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

Parámetro

Elemento secundario requerido de los parámetros. Especifica el nombre de un parámetro de informe y el valor que se le asigna.

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

Donde cada atributo tiene la siguiente definición:

  • name:el nombre de un parámetro que desea especificar.
  • value: valor que se asigna al parámetro. Como mínimo, debe definir el parámetro siguiente para que su informe use automáticamente el proyecto que contiene el informe:
    <parameter name="ExplicitProject" value="" />.

parameters

Elemento secundario requerido del informe. Define una colección de elementos de parámetro para un informe.

<parameters>
<parameter />
</parameters>

properties

Elemento secundario opcional del informe. Proporciona el elemento contenedor para la propiedad.

<properties>
<property />
</properties>

property

Elemento secundario requerido de las propiedades.

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

Donde cada atributo tiene la siguiente definición:

reference

Elemento secundario requerido de orígenes de datos. Especifica los nombres que se asignan en Team Foundation Server para la base de datos relacional de almacenamiento de datos y el cubo Analysis Services datos.

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

Donde cada atributo tiene la siguiente definición:

  • name:el nombre del origen de datos de TFS. Para Team Foundation Server 2010 y versiones posteriores, este valor es Tfs2010OlapReportDS para el cubo Analysis Services o Tfs2010ReportsDS para el almacenamiento de datos relacional.
  • dsname:nombre del recurso de base de datos. Especifique TfsOlapReportDS para el cubo de Analysis Services y TfsReportsDS para el almacenamiento de datos relacional.

Para obtener más información sobre los nombres de los orígenes de datos de informes, vea Buscar informes después de la actualización a TFS 2010.

report (informe)

Elemento secundario requerido de los informes. Especifica el nombre del informe, del archivo que contiene la definición .rdl y de la carpeta en la que el informe está cargado.

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

Donde cada atributo tiene la siguiente definición:

  • name: nombre del informe que se mostrará en el sitio de informes y en Team Explorer.
  • filename:ruta de acceso relativa en la carpeta Reports local desde donde se va a obtener el archivo de informe .rdl.
  • cacheExpiration:número predeterminado de minutos durante los que se almacena en caché el informe.

reports

Elemento secundario requerido de ReportingServices. Contiene una colección de elementos de informe que especifican el nombre de un archivo de informe que se cargará.

<reports>
<report />
</reports>

ReportingServices

Elemento secundario requerido del elemento taskXml para el complemento De informes. Describe las tareas necesarias para definir los informes y carpetas para SQL Server Reporting Services.

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

sitio

Elemento necesario para el complemento de informes. Especifica que se creará un sitio de informes para el proyecto.

<site>
. . . 
</site>