Hinzufügen von Berichten zur Prozessvorlage

Mit dem Berichterstellungs-Plug-In können Sie die Ordnerstruktur und den Satz der Berichte angeben, die unter dem Knoten BerichtBerichte für ein neues Teamprojekt angezeigt werden.

Wichtiger Hinweis Wichtig

Das Berichterstellungs-Plug-In setzt voraus, dass die Teamprojektsammlung, in der ein Teamprojekt erstellt wird, mit SQL Server Analysis Services und SQL Server Reporting Services konfiguriert wurde. Weitere Informationen finden Sie unter Hinzufügen von Berichten zu einem Teamprojekt.

Geben Sie mit dem Berichterstellungs-Plug-In zwei Hauptaufgaben an. Erstellen Sie zuerst die Berichterstellungs-Website mithilfe des site-Elements. Geben Sie im zweiten Schritt die Ordnerstruktur und die Berichte an, die auf die Website hochgeladen werden sollen. Verwenden Sie dazu das folder-Element und das report-Element. Die Berichte, die Sie hochladen, besitzen die Erweiterung "RDL" und sind für die Verwendung mit Reporting Services vorgesehen. Eine Übersicht über die Berichte, die TFS-Prozessvorlagen bereitstellen, finden Sie unter Berichte (SQL Server Reporting Services).

Nach dem Erstellen eines Teamprojekts anhand der Prozessvorlage können Sie die Ordnerstruktur für Berichte hinzufügen, entfernen, umbenennen und ändern. Weitere Informationen finden Sie unter Anzeigen, Hochladen und Organisieren von Berichten (Reporting Services-Berichte).

In der folgenden Tabelle sind die Namen der Datei, des Ordners und des Plug-Ins für die MSF-Prozessvorlagen zusammengefasst.

Dateiname:

ReportsTasks.xml

Ordnername:

Berichte

Plug-In-Name:

Microsoft.ProjectCreationWizard.Reporting

Hinweis Hinweis

Sie können die Namen der XML-Datei und des Ordners, jedoch nicht den Namen des Plug-Ins ändern. Visual Studio Team Foundation Server enthält keinen Mechanismus für die Bereitstellung clientseitiger Plug-Ins, Richtlinien oder anderer Änderungen. Wenn Sie diese Art von Funktion bereitstellen möchten, verwenden Sie Ihr eigenes Verteilungs- und Installationsprogramm.

In der XML-Datei werden mindestens eine Aufgabe und die zugehörigen Abhängigkeiten angegeben. Ein Beispiel einer Aufgabe, mit der ein Berichtssatz angegeben wird, finden Sie in der Datei "ReportsTasks.xml" in der Prozessvorlage für MSF for Agile Software Development.

Die Berichterstellungs-Plug-In-Datei muss der Schemadefinition für ReportingServices entsprechen, die in der Rosetta.xsd-Datei enthalten ist, und in der eigenen Datei angegeben werden.

Die folgende Syntax zeigt die Struktur des Berichterstellungs-Plug-Ins an. Eine Beschreibung der einzelnen Elemente finden Sie im weiteren Verlauf des Themas unter Untergeordnete ReportingServices-Elemente.

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

Damit die Berichte ordnungsgemäß ausgeführt werden, müssen Sie eine Berichterstellungssite erstellen. Die Berichterstellungs-Website enthält auf der Startseite des Projektportals einen entsprechenden Link mit der Bezeichnung BerichtBerichte. Um die Berichterstellungs-Website zu erstellen, verwenden Sie das site-Element (siehe folgendes Beispiel).

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

Sie können Ordner auf der Berichterstellungs-Website mit dem folder-Element erstellen. Verwenden Sie das path-Attribut, um den relativen Pfadnamen des neuen Ordners anzugeben. Der Ordner wird auf der Projektsite und unter dem Ordner Berichte in Team Explorer angezeigt.

Im folgenden Beispiel werden vier Ordner der obersten Ebene und zwei Unterordner auf der Berichterstellungs-Website erstellt. Die Namen der Ordner der obersten Ebene sind "Fehler", "Builds", "Projektmanagement" und "Tests". Die beiden Unterordner befinden sich unter "Projektmanagement" und tragen die Bezeichnung "Visual Studio" und "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>

Berichte werden durch RDL-Dateien definiert. Um der Berichterstellungssite Berichte hinzuzufügen, kopieren Sie die RDL-Dateien des Berichts in einen Ordner unterhalb des Ordners Berichte in der Prozessvorlage. Verwenden Sie dann das report-Element, um die notwendigen Eigenschaften und die Datenquellen für den Bericht zu beschreiben.

Im folgenden Beispiel wird angegeben, dass die Datei "Verbleibende Arbeit.rdl" in den Projektverwaltungsordner hochgeladen wird. Sie müssen den ExplicitProject-Parameter und die Datenquellen für jeden Bericht angeben. Die Datenquellen im folgenden Beispiel entsprechen den Namen, die automatisch dem Analysis Services-Cube und der relationalen Datenbank des Data Warehouse zugewiesen werden.

Hinweis Hinweis

Die Namen der Reporting Services-Datenquellen lauten Tfs2010ReportsDS und Tfs2010OlapReportsDS. Obwohl Sie möglicherweise eine höhere Version von TFS installiert oder ein Upgrade darauf durchgeführt haben, werden diese Namen weiterhin verwendet, die den Datenquellen für eine TFS 2010-Installation zugewiesen wurden.

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

Die folgende Syntax zeigt die Struktur des ReportingServices-Elements und der untergeordneten Elemente. Sie geben diese Elemente innerhalb des taskXml-Containerelements und ausschließlich für das Berichterstellungs-Plug-In an.

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

In der folgenden Tabelle werden die Elemente beschrieben, mit denen Sie einen Bericht angeben, der in ein Teamprojekt hochgeladen werden soll und auf den mit SQL Server Reporting Services zugegriffen werden kann.

Element

Syntax

Beschreibung

datasources

<datasources>
   <reference />
</datasources>

Erforderliches untergeordnetes Element von report.

Enthält eine Sammlung von reference-Elementen, die jeweils eine Datenquelle angeben, die im Bericht verwendet wird.

folder

<folder path="FolderName" />

Erforderliches untergeordnetes Element von folders.

Definiert den Namen eines Ordners, der unter dem Knoten Berichte für ein Teamprojekt erstellt werden muss.

folders

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

Optionales untergeordnetes Element von ReportingServices.

Enthält eine Sammlung von folder-Elementen, die jeweils den Namen eines zu erstellenden Ordners angeben.

parameter

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

Dabei weist jedes Attribut die folgende Definition auf:

  • name: Der Name des Parameters, den Sie angeben möchten.

  • value: Der dem Parameter zuzuweisende Wert.

Sie müssen mindestens den folgenden Parameter definieren, damit vom Bericht automatisch das Projekt verwendet wird, das den Bericht enthält:

<parameter name="ExplicitProject" value="" />

Erforderliches untergeordnetes Element von parameters.

Gibt den Namen eines Berichtsparameters und des Werts an, der dem Parameter zugewiesen werden soll.

parameters

<parameters>
   <parameter />
</parameters>

Erforderliches untergeordnetes Element von report.

Definiert eine Sammlung von parameter-Element für einen Bericht.

properties

< properties >
   < property />
</ properties >

Optionales untergeordnetes Element von report.

Property

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

Dabei weist jedes Attribut die folgende Definition auf:

Erforderliches untergeordnetes Element von properties.

reference

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

Dabei weist jedes Attribut die folgende Definition auf:

  • name: Der Name der Datenquelle in Team Foundation Server. Für Team Foundation Server 2010 ist dieser Wert entweder Tfs2010OlapReportDS für den Analysis Services-Cube oder Tfs2010ReportsDS für das relationale Data Warehouse.

  • dsname: Der Name der Datenbankressource. Geben Sie für den Analysis Services-Cube TfsOlapReportDS und für das relationale Data Warehouse TfsReportsDS an.

Weitere Informationen zu den Namen von Berichtsdatenquellen finden Sie unter Suchen von Berichten nach dem Upgrade auf Team Foundation Server 2010.

Erforderliches untergeordnetes Element von datasources.

Gibt die Namen an, die in Team Foundation Server für die relationale Datenbank des Data Warehouse und des Analysis Services-Cubes zugewiesen werden.

report

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

Dabei weist jedes Attribut die folgende Definition auf:

  • name: Der Name des Berichts, der auf der Berichterstellungswebsite und in Team Explorer angezeigt werden soll.

  • filename: Ein relativer Pfad unter dem lokalen Ordner Berichte, über den die RDL-Berichtdatei abgerufen wird.

  • folder: Der Name eines relativen Pfads des Speicherorts, an dem der Bericht auf der Berichterstellungswebsite hinzugefügt werden soll.

  • cacheExpiration: Die Standarddauer in Minuten, für die der Bericht zwischengespeichert wird.

Erforderliches untergeordnetes Element von reports.

Gibt den Namen des Berichts, der Datei, die die RDL-Definition enthält, und des Ordners an, in den der Bericht hochgeladen wird. Team Foundation Server

reports

<reports>
   <report />
   . . .
</reports>

Erforderliches untergeordnetes Element von ReportingServices.

Enthält eine Sammlung von report-Elementen, die jeweils den Namen einer hochzuladenden Berichtsdatei angeben.

ReportingServices

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

Erforderliches untergeordnetes Element des taskXml-Elements für das Berichterstellungs-Plug-In.

Beschreibt die Aufgaben, die erforderlich sind, um die Berichte und Ordner für SQL Server Reporting Services zu definieren.

site

<site> </site>

Erforderliches Element für das Berichterstellungs-Plug-In.

Gibt an, dass eine Berichterstellungswebsite für das Teamprojekt erstellt wird.

Anzeigen: