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 Quality Manager und den verschiedenen URLs vertraut, die erforderlich sind, um Daten aus
Rational Quality Manager zu extrahieren, wenn Sie
Rational Publishing Engine verwenden.
Weitere Informationen finden Sie in der
Dokumentation zur REST-API von Rational Quality Manager.
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
- 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.
- Erstellen Sie eine Dokumentvorlage in der Anwendung "Document Studio".
- Bestimmen Sie ein Datenquellenschema in Ihrer Datenquelle.
- Wenn Sie bestimmte Daten aus einer
Sammlung aus Ihrem Rational Quality Manager-Projekt
hinzufügen möchten, z. B. Testfalldetails oder Testscripts,
oder wenn Sie auf eine einzelne Ressource mit einer bekannten URL zugreifen möchten, erstellen Sie eine URL, die das Argument
feed verwendet. Dieses Datenschema verwenden Sie immer und konfigurieren es dynamisch für bestimmte Daten in Ihrer Vorlage aus dem Rational Quality Manager-Projekt.
- Beispiel: https://Server:Port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/feed.xsd
- Wenn Sie bestimmte Daten aus einer
einzelnen Ressource aus Ihrem Rational Quality Manager-Projekt
hinzufügen möchten, z. B. Testfalldetails oder Testscripts,
oder wenn Sie auf eine einzelne Ressource mit einer bekannten URL zugreifen möchten, erstellen Sie eine URL, die das Argument
qm verwendet:
- Beispiel: https://Server:Port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/qm.xsd
- 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/qm/oslc_qm/catalog
- Richtig: https://Server:Port/qm/oslc_qm/catalog/Repository/db/Schemarepository/
- Fügen Sie das Datenquellenschema Ihrer Dokumentvorlage hinzu. Für
Rational Quality Manager können die folgenden Schritte ausgeführt werden:
- Klicken Sie in Document Studio auf .
- Wählen Sie unter Schematyp den Typ des Schemas aus der Liste aus. Für Rational Quality Manager wählen Sie
Generic XML aus.
- Fügen Sie im Feld
Schemadatei die URL ein, die Sie als Datenquellenschema ermittelt haben.
- Fügen Sie am Ende der
URI die Angabe ?abbreviate=false hinzu.
- Beispiel: https://Server:Port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE
Banking (Quality Management)/testcase?abbreviate=false
- Geben Sie im Feld Datenquellen-ID einen Namen für die Datenquelle in der Vorlage ein. Klicken Sie auf Weiter.
- Wenn sich die Ressource in einem sicheren Server befindet, geben Sie den Namen des Benutzers an.
- Wenn sich die Ressource in einem sicheren Server befindet, geben Sie das Kennwort an.
- Wählen Sie den Authentifizierungstyp in der Liste aus. Für Rational Quality Manager 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.
- 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.
- Verwenden Sie
Abfragen,
Attribute und
Variablen, um Daten in eine Vorlage aufzunehmen.
Diese Abfragen legen fest, welche Informationen
im Bericht generiert werden.
- Fügen Sie den Elementen
Formatierung und Stile hinzu, um festzulegen, wie sie in der Ausgabe angezeigt werden.
- 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.
- Erstellen Sie
Sortierungen,
um die Daten in Ihrem Bericht zu strukturieren.