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
Design
Management und den verschiedenen URLs vertraut, die erforderlich sind, um Daten aus
Design
Management zu extrahieren, wenn Sie
Rational Publishing Engine verwenden.
Angaben zum Information Center für Ihre Version von
Design
Management finden Sie in den
Information Center der Rational Software
Architect-Produktfamilie.
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 sollen. 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".
- Fügen Sie ein Datenquellenschema Ihrer Dokumentvorlage mithilfe des POX-Profils (CLM ab Version 6.0.2) hinzu: Weitere Informationen zum POX-Profil finden Sie unter Rückverfolgbarkeitsdokumente aus CLM-Anwendungen mithilfe des POX-Profils erstellen
- Kopieren Sie in Design
Management die URL des Artefakts, indem Sie im Breadcrumb auf das Symbol Permalink anzeigen klicken.
- Klicken Sie in Document Studio auf .
- Wählen Sie im Feld Vordefiniert den Eintrag DS1 aus.
- Wählen Sie unter Typ den Eintrag REST aus.
- Fügen Sie die URL in das Feld Schema ein und hängen Sie die Angabe &metadata=schema an das Ende der URL an.
- Wählen Sie im Feld Zusätzliche Header den POX-Profilheader aus.
- Klicken Sie auf Weiter und dann auf Fertigstellen. Das ausgewählte Datenquellenschema wird in der Sicht "Datenquelle" angezeigt.
- Fügen Sie ein Datenquellenschema Ihrer Dokumentvorlage mithilfe der REST-Schemaerkennung (CLM ab Version 6.0.1) hinzu: Das Datenquellenschema für Design
Management können Sie
erkennen, wenn Sie die Basis-URL zur Anwendung eingeben.
- Klicken Sie in
Document Studio auf .
- Geben Sie einen Namen für die Datenquelle ein.
- Geben Sie eine Beschreibung für die Datenquelle ein.
- Geben Sie die Basis-URL für die Ressource an. Die Basis-URL für
Design
Management lautet wie folgt:
https://Server:Port/dm/reporting
- Wählen Sie den Authentifizierungstyp in der Liste aus.
Wichtig: Für Design
Management müssen Sie einen
Authentifizierungstyp eingeben, um auf die Daten für Ihren Bericht zuzugreifen.
Der Authentifizierungstyp kann nicht automatisch von
Rational Publishing Engine erkannt werden.
- 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.
- Klicken Sie auf Weiter. An die Basis-URL, die Sie eingegeben haben, wird automatisch ?metadata=schema angefügt. Beispiel: https://Server:Port/dm/reporting?metadata=schema
- Klicken Sie auf Fertigstellen. Das ausgewählte Datenquellenschema wird in der Sicht "Datenquelle" angezeigt.
- 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 Datenteilmengen 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. Design
Management 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.
- Erstellen Sie
Sortierungen,
um die Daten in Ihrem Bericht zu strukturieren.