Vorlagen mit Rational ClearQuest 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 Rational ClearQuest-REST-Service und mit den verschiedenen URLs vertraut, die erforderlich sind, um Daten aus Rational Publishing Engine zu extrahieren, wenn Sie Rational ClearQuest verwenden. Weitere Informationen finden Sie unter About the Rational ClearQuest Information Center.

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 ClearQuest können Sie erkennen, wenn Sie die Basis-URL zur Anwendung eingeben.
    1. Öffnen Sie den Assistenten "Schemaerkennung" für Ihre Version von Rational ClearQuest
      • Für frühere Versionen von Rational ClearQuest, die REST v1 verwenden, klicken Sie auf Daten > Schemaerkennung > REST-Schemaerkennung.
      • Für höhere Versionen von Rational ClearQuest, die REST v2 verwenden, klicken Sie auf Daten > Schemaerkennung > REST-v2-Schemaerkennung.
    2. Geben Sie die Basis-URL für die Ressource an.
      • Für REST-v1-Versionen von Rational ClearQuest verwendet Rational Publishing Engine das Produkt Rational Data Services für die Schemaerkennung und die Datenabfrage. Die Basis-URL für Data Services lautet wie folgt: https://Server:Port/DataServices/ClearQuest
      • REST-v2-Versionen von Rational ClearQuest werden über eine ServiceProvider-URL gestartet. Benutzer können die ServiceProvider-URL abrufen, indem Sie die ServiceCatalog-URL für Rational ClearQuest REST v2 aufrufen, z. B. https://Server:Port/context/oslc. Setzen Sie die OSLC-Core-Version für HTTP-Header auf 2.0, und akzeptieren Sie application/rdf+xml. Im zurückgegebenen Ergebnis finden Sie die ServiceProvider-URL rdf:about.
        Wenn Sie die REST-V2-APIs für die Generierung des Dokuments verwenden, müssen Sie eine Datenquellenschema-URL zum Service-Provider anstatt zum Stammeintrag angeben. Beispiel:
        • Falsch: https://Server:Port/cqweb/oslc
        • Richtig: https://Server:Port/cqweb/oslc/repo/Repository/db/Schemarepository/
    3. Wählen Sie einen Authentifizierungstyp in der Liste aus. Ohne Auswahl eines Typs wird jeder Typ getestet, bis der richtige Typ gefunden wird. Dies kann die Dokumentgenerierungszeit verlängern.
    4. Wenn sich die Ressource in einem sicheren Server befindet, geben Sie den Namen des Benutzers an.
    5. Wenn sich die Ressource in einem sicheren Server befindet, geben Sie das Kennwort an.
    6. Klicken Sie auf Weiter. An die Basis-URL, die Sie eingegeben haben, wird automatisch ?metadata=schema angefügt. Beispiel: https://Server:Port/service/cq/records/defects?metadata=schema
    7. 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.

    Der Adapter von Rational ClearQuest unterstützt die native Filterung aus Reportable-Rest-v1-Datenquellen. In nativen Filtern für Reportable Rest v1 müssen Sie lediglich den Text zwischen den eckigen Klammern eingeben. Der Rest des Filters wird von Rational Publishing Engine generiert. Weitere Informationen finden Sie unter Reportable Rest v1.

    Rational ClearQuest Version 8 ohne Adapter unterstützt die native Filterung aus Reportable-Rest-v2-Datenquellen. Weitere Informationen finden Sie unter Rational ClearQuest OSLC CM REST API .

    Beispiel eines Filters für Variablen:
    cq:Product{cq:Product="${productName}") 
    Beispiel für einen aufgelösten Filter, in dem productName gleich Rational Publishing Engine ist:
    cq:Product{cq:Product="Rational Publishing Engine")
    Anmerkung:
    • Anforderungen für eine Datenquelle erfolgen nur dann, wenn sie erforderlich sind. Sie können z. B. Bedingungen verwenden, damit ein Element nur dann in der Ausgabe angezeigt wird, wenn es Daten enthält. Die Bedingung für ein Containerelement könnte Variable == "true" lauten. Wenn diese Bedingung nicht erfüllt wird und keine Daten die Variablenbedingung erfüllen, wird die Datenquelle nicht angefordert.
    • Sie können native Filter berechnen, bevor Sie die Anforderung stellen. Der native Filter wird dann berechnet, wenn die Abfrage vorgefunden wird, und für die Berechnung werden die zu diesem Zeitpunkt definierten Variablenwerte verwendet. Auf diese Weise können Sie Berechnungen in der Vorlage durchführen, die sich auf die nativen Filter auswirken.
  8. Erstellen Sie Sortierungen, um die Daten in Ihrem Bericht zu strukturieren.

Feedback