Sie können Rational Quality Manager als Datenquelle
in Rational Publishing Engine definieren. Die Daten werden
über die REST-API von Rational Quality Manager extrahiert.
Diese Schnittstelle wird von der Anwendung installiert und implementiert und arbeitet unabhängig von
Rational Publishing Engine.
Tipp: Im Lieferumfang von
Rational Publishing Engine ist eine
Reihe von Beispielberichten enthalten.
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.
Vorbereitende Schritte
- 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.
- Stellen Sie eine Verbindung zu einem Datenquellenschema her. Weitere Informationen finden Sie unter Datenquellenschema hinzufügen.
- Das Schema kann sich im lokalen Dateisystem befinden. Beispiel:
https://Server:Port/jazz/service/com.ibm.rqm.integration.service.IntegrationService/schema/feed.xsd ist
eine Schemadatei, die das Argument feed verwendet. Sie können dieses Schema verwenden, um
bestimmte Daten, z. B. Testfalldetails oder Testscripts, aus Ihrem Rational-Quality-Manager-Projekt
hinzuzufügen oder um auf eine einzelne Ressource mit einem bekannten URL zuzugreifen.
- Wenn Sie die REST-V2-APIs für die Generierung des Dokuments verwenden, müssen Sie
einen Datenquellenschema-URL zum Service-Provider und nicht zum Stammeintrag angeben. Beispiel:
- Falsch: https://Server:Port/qm/oslc_qm/catalog
- Richtig: https://Server:Port/qm/oslc_qm/catalog/Repository/db/Schemarepository/
Sie können die Elemente im Datenquellenschema verwenden, um Abfragen in Ihre Vorlagen aufzunehmen.
Diese Abfragen legen fest, welche Informationen
im Bericht generiert werden. Um sicherzustellen, dass Sie eine vollständige Ergebnisliste von einer Feeddatenquelle vom Typ
Rational Quality Manager erhalten, müssen Sie den Schematyp
auf "Generische XML" festlegen, und ?abbreviate=false am Ende des URI hinzufügen. Beispiel:
https://rqmserver:9443/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE
Banking (Quality Management)/testcase?abbreviate=false
- Nachdem Sie eine Verbindung zum Datenquellenschema hergestellt haben, können Sie ein Vorlagendesign erstellen oder importieren.
Mit Rational Publishing Engine Document
Studio können Sie ein Design für eine Berichtsvorlage erstellen. Dieses Design legt das Berichtslayout fest. Weitere Informationen finden Sie unter Vorlagen mit Document Studio erstellen.
- Planen Sie die Struktur Ihres Dokuments, und definieren Sie den Inhalt, um Daten zu extrahieren.
Eine Übersicht über den Entwicklungsprozess für Vorlagen finden Sie unter
Dokumentvorlagen entwerfen.
Bei großen Dokumenten können Sie für jeden Dokumentblock eigene Vorlagen erstellen.
- 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.
Ausführliche Informationen hierzu finden Sie unter Vorlagenelemente in der Sicht "Palette".
- Verwenden Sie
Abfragen,
Attribute und
Variablen, um Daten in die Vorlage aufzunehmen.
- Sie können das Datenquellenkonfigurationselement verwenden, um einige Eigenschaften zu definieren, die zur Ausführungszeit nicht bekannt sind.
Weitere Informationen finden Sie unter Datenquellenkonfigurationselement hinzufügen.
Beispielsweise wird ein Datenschema des Typs qm auf der Basis des Datenschemas
feed dynamisch festgelegt.
Dieses Datenschema verwenden Sie immer und konfigurieren es dynamisch für bestimmte Daten in Ihrer Vorlage aus dem Rational-Quality-Manager-Projekt.
- Mit Filtern, die spezifischere Versionen des allgemeinen Datenquellen-URI darstellen, 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 dem Repository von Rational Quality Manager 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.
Weitere Informationen finden Sie unter Daten mit einem RPE-Filter extrahieren.
- Nachdem Sie die Berichtsvorlage erstellt und mit
Daten von Rational Quality Manager gefüllt haben, können Sie einen Bericht in verschiedenen Formaten generieren.
Beim Generieren eines Berichts müssen Sie mit der
Datenquelle verbunden sein, die die Informationen enthält, für die der Bericht ausgeführt werden soll.
Geben Sie dazu einen URI an, der auf das Repository von
Rational Quality Manager mit den relevanten Daten verweist.
Unter
Verbindung zu einer Datenquelle herstellen ist beschrieben, wie Sie auf die relevanten Daten verweisen.
Anmerkung: Für die OSLC-API von IBM Rational Quality Manager
gibt Rational Quality Manager
standardmäßig die HTML-Darstellung der Ressourcen zurück, falls in der Dokumentspezifikation kein Accept-Header angegeben ist.
Sie müssen den Accept-Header auf application/xml setzen, um die
XML-Daten abzurufen.
- Werden einer Vorlage Datenquellenschemas hinzugefügt, nachdem die Vorlage einer Dokumentspezifikation zugeordnet wurde,
ist die Dokumentspezifikation nicht mehr synchron.
Sie können die Dokumentspezifikation manuell
synchronisieren oder eine Vorgabeoption auswählen, damit die Dokumentspezifikation automatisch mit der aktuellen Vorlage synchronisiert wird.
Informationen zum Festlegen der Vorgabe
Dokumentspezifikation mit aktueller Vorlage synchron halten? finden Sie unter
Vorgaben für das Dokumentdesign festlegen.
- Bevor Sie Ihr Dokument veröffentlichen, lesen Sie unter
Ausgabeeigenschaften angeben
die Informationen zu den verfügbaren Ausgabeoptionen, unter denen Sie auswählen können, und zu der Ausgabeoption, die für die in dieser Vorlage
verwendeten Elemente am besten geeignet ist.
- Jetzt können Sie Ihr Dokument veröffentlichen. Weitere Informationen finden Sie unter Dokument generieren.