Vorlagen mit IBM Rational Team Concert als Datenquelle entwerfen

Berichtsdesigner können die Anwendung "Document Studio" verwenden, um Datenquellenschemas zu importieren und Berichtsvorlagen zu erstellen.

Vorbereitende Schritte

Tipp: Die Installation von Rational Publishing Engine umfasst eine Reihe von Beispielberichten. Bevor Sie mit der Veröffentlichung von Dokumenten beginnen, können Sie dieses Beispielszenario einer Dokumentgenerierung ansehen. Weitere Informationen finden Sie unter REST-Beispielvorlage erstellen.
Machen Sie sich mit dem REST-Service von Rational Team Concert und mit den verschiedenen URLs vertraut, die erforderlich sind, um Daten aus Rational Team Concert zu extrahieren, wenn Sie Rational Publishing Engine verwenden. Weitere Informationen finden Sie unter Reportable REST API wiki: Resources provided by Rational Team Concert.
Rational Team Concert Reportable REST API (Berichtsfähige REST-API von Rational Team Concert) unterscheidet sich von vielen traditionellen Domänen-APIs. Sie stellt keine Ressourcen-URLs bereit, die auf bestimmte Elemente (z. B. ein einzelnes Arbeitselement oder ein einzelnes Buildergebnis) verweisen, sondern sie ermöglicht den Zugriff auf monolithische Ressourcen. Jede monolithische Ressource ist ein Container, der das Ergebnis einer Abfrage nach einem oder mehreren Elementen darstellt.
  • foundation: Allgemeine Artefakte wie Projektbereiche, Teambereiche, Mitarbeiter, Iterationen und Links.
  • workitem: Arbeitselementartefakte wie Arbeitselemente, Kategorien, Wertigkeiten und Prioritäten.
  • apt: Artefakte für die agile Planung wie Teamkapazität, Ressourcenzeitpläne und Abwesenheiten.
  • generic: Generische Artefakte.
  • build: Buildartefakte wie Buildergebnisse, Buildergebnisbeiträge, Builddefinitionen und Build-Engines.
  • scm: Artefakte für die Quellcodeverwaltung wie Datenströme und Komponenten sowie Deltas zur Datenstromdimensionierung.
Diese Ressourcen bieten Flexibilität bei der Filterung und Abfrage, wenn Daten für einen Bericht zusammengestellt werden. Beispielsweise kann eine Arbeitselementressource abhängig von der Abfrage oder dem Filter, der an die REST-API übergeben wurde, ein oder mehrere Elemente enthalten, die sich auf Arbeitselemente beziehen.

Informationen zu diesem Vorgang

Die Daten werden über die REST-API extrahiert. Diese Schnittstelle wird mit der Datenquellenanwendung installiert und implementiert und arbeitet unabhängig von Rational Publishing Engine. Weitere Informationen zur REST-API für eine Datenquelle finden Sie in der Dokumentation zur entsprechenden Datenquelle.

Vorgehensweise

  1. Eine Übersicht über den Entwicklungsprozess für Vorlagen finden Sie unter Dokumentvorlagen entwerfen. Planen Sie die Struktur Ihres Dokuments und die Daten, die darin enthalten sein können. Legen Sie beispielsweise fest, ob das endgültige Dokument aus einer Vorlage generiert wird oder aus mehreren Vorlagendateien mit wiederverwendbarem Inhalt.
  2. Erstellen Sie eine Dokumentvorlage in der Anwendung "Document Studio".
  3. Fügen Sie das Datenquellenschema Ihrer Dokumentvorlage hinzu. Das Datenquellenschema für Rational Team Concert können Sie erkennen, wenn Sie die Basis-URL zur Anwendung eingeben.
    1. Klicken Sie in Document Studio auf Daten > Datenquellenschema hinzufügen.
    2. Wählen Sie unter Schematyp den Typ des Schemas aus der Liste aus. Für Rational Team Concert wählen Sie REST aus.
    3. Fügen Sie im Feld Schemadatei die URL ein, die Sie als Datenquellenschema ermittelt haben.
      • https://Server:Port/ccm/rpt/repository/foundation
      • https://Server:Port/ccm/rpt/repository/workitem
      • https://Server:Port/ccm/rpt/repository/apt
      • https://Server:Port/ccm/rpt/repository/generic
      • https://Server:Port/ccm/rpt/repository/scm
      • https://Server:Port/ccm/rpt/repository/build
    4. Fügen Sie am Ende der URI die Angabe ?metadata=schema hinzu.
      • Beispiel: https://Server:Port/ccm/rpt/repository/workitem?metadata=schema
    5. Geben Sie im Feld Datenquellen-ID einen Namen für die Datenquelle in der Vorlage ein. Klicken Sie auf Weiter.
    6. Wenn sich die Ressource in einem sicheren Server befindet, geben Sie den Namen des Benutzers an.
    7. Wenn sich die Ressource in einem sicheren Server befindet, geben Sie das Kennwort an.
    8. Wählen Sie den Authentifizierungstyp in der Liste aus. Für Rational Team Concert lautet der Authentifizierungstyp OAuth. Wenn Sie OAuth nicht auswählen, wird jeder Authentifizierungstyp getestet, bis der richtige Typ gefunden wird. Dies kann die Dokumentgenerierungszeit verlängern.
    9. Klicken Sie auf Fertigstellen. Das ausgewählte Datenquellenschema wird in der Sicht "Datenquellenschema" angezeigt.
  4. Fügen Sie Elemente zur Vorlage hinzu. Rational Publishing Engine verfügt über eine umfassende Menge an Vorlagenelementen, die Sie zum Strukturieren Ihres Dokuments verwenden können. Sie können die Elemente in den Vorlageninhaltseditor ziehen. Beispielsweise können Sie ein Containerelement für mehrere Absätze hinzufügen. Jeder Absatz kann von einer Testbedingung gesteuert sein, die ihm nur spezifische Daten zuordnet. Weitere Informationen finden Sie unter Vorlagenelemente in der Sicht "Palette" und Elemente einer Vorlage hinzufügen.
  5. Verwenden Sie Abfragen, Attribute und Variablen, um Daten in eine Vorlage aufzunehmen. Diese Abfragen legen fest, welche Informationen im Bericht generiert werden.
  6. Fügen Sie den Elementen Formatierung und Stile hinzu, um festzulegen, wie sie in der Ausgabe angezeigt werden.
  7. Erstellen Sie Filter, um die Daten einzugrenzen, die in den Bericht aufgenommen werden. Mit Hilfe von Filtern, bei denen es sich um detaillierte Versionen der allgemeinen Datenquellen-URI handelt, können Sie auf bestimmte Untergruppen von Daten verweisen, um zu vermeiden, dass Rational Publishing Engine während der Berichterstellung mehr Informationen als nötig aus der Datenquelle abruft. Diese Filter müssen umfassend genug sein, um alle erforderlichen Daten, die von der Vorlage referenziert werden, abzurufen. Andernfalls ist der generierte Bericht nicht vollständig. Rational Team Concert unterstützt die Verwendung von Reporatable-Rest-v1-Datenquellen in nativen Filtern. Weitere Informationen finden Sie unter Reportable REST API auf Jazz.net. Beispiel:
    projectArea/name="Rational Publishing Engine"  and target/name="1.2.1"
    Aufgelöste Anforderung:
    fields=workitem/workItem[projectArea/name="Rational Publishing Engine" and target.name="1.2.1"]/(@href|summary)
    Anmerkung: Nicht alle Felder können für native Filter verwendet werden.
  8. Erstellen Sie Sortierungen, um die Daten in Ihrem Bericht zu strukturieren.

Feedback