Dokumentengenerierung.

Im Artikel stelle ich die IBM Engineering Lifecycle Optimization – Publishing (Rational Publishing Engine) Lösung vor. Sie erfahren welche Dokumentationen aus welchen Datenquellen erzeugt werden können.

Begriff Reporting

Der Begriff Reporting hat mehrere Bedeutungen. Im Artikel werde ich nur auf die Dokumentengenerierung von einer Spezifikation zu Ausgabeformate, wie Word oder PDF, eingehen.

Reporting im Sinne von Dokumentengenerierung

Dokumentengenerierung
  • Automatische Erzeugung von Dokumentation
  • aus verschiedenen Datenquellen
  • in verschiedenen Formaten (Word, PDF, CSV, HTML, XML-FO)
  • mit flexibler Formatierung

Reporting für Document Generation (RDG)

Dies ist die wiederverwendbare Berichtskomponente für die einzelnen Jazz-Produkte, um ein dokumentartiges Reporting zu ermöglichen. RDG ist in verschiedenen IBM ELM-Produkten enthalten und bietet eine Teilmenge der Funktionalitäten von IBM Engineering Lifecycle Optimization – Publishing (PUB). Für die kundenspezifische Anpassung von Vorlagen ist IBM Engineering Lifecycle Optimization – Publishing (PUB) erforderlich. Damit können eigene Variablen, eine spezielle Dokumentenstruktur und die Einbindung von diversen Datenquellen abgedeckt werden.

Reporting im Sinne von Dashboarding

Dashboard

Einen anderen Anwendungsfall gibt es ebenfalls im Thema Reporting. Durch Jazz Reporting Service (integriert in die IBM Engineering Management Lösung wird folgendes abgedeckt:

  • Visualisierung von Kennzahlen
  • Online-Statusberichte
  • Trendanalysen / Trendcharts

Datenquellen

Verschiedene Datenquellen können durch die Reporting-Lösungen angebunden werden. Aus folgenden Bereichen können die Daten stammen:

  • Requirements Management
  • Portfolio Management
  • Architecture Management
  • Change Management
  • Configuration Management
  • Quality Management
  • etc.
weiter

IBM Engineering Lifecycle Optimization – Publishing (Rational Publishing Engine)

Die Dokumentengenerierung-Lösung (abgekürzt als PUB), besteht aus folgenden Komponenten:

Launcher

Eclipse-basierte Clientanwendung zum Erstellen von Dokumentspezifikationen und Generieren von Ausgabedokumenten aus diesen Spezifikationen. Der Launcher ist verfügbar als Assistent. Es können Ausgabeformate, Datenquellen, Vorlagen und Variablen definiert werden.

Document Studio

Eclipse-basierte Clientanwendung zum Entwerfen von Dokumentvorlagen über verschiedene Ansichten und Assistenten. Das Document Studio bietet eine leistungsstarke Unterstützung für Skriptsprachen (JavaScript) mit Editor.

Document Builder

Bietet eine Weboberfläche zum Erstellen von Berichten aus Vorlagen und für das Generieren, Planen und Anzeigen von Dokumenten. Im Document Builder wird die Komplexität der Vorlagenerstellung für die regelmäßigen Benutzer ausgeblendet. Es ist eine zentralisierte Weboberfläche für ein Team und / oder das gesamte Unternehmen. Arbeitsaufträge zur Dokumentenerstellung können zeitlich geplant werden (täglich, wöchentlich).

Werkzeugintegrationen

Die Dokumentgenerierung kann durch die Integration innerhalb von Werkzeugen (z. B. DOORS) direkt im Menü gestartet werden. Verfügbar sind native API-Erweiterungen und ein Eclipse-Plug-In.

Verfügbare Ausgabeformate

Architektur Desktop

Die Architektur beim Desktop liegt neben der Dokumentengenerierung über den Launcher und den Werkzeugintegrationen in der Erstellung einer Dokumentenvorlage. Dokumentvorlagen können über Document Studio entworfen und bearbeitet werden.

Architektur Desktop

Architektur Web

Bei der Web Architektur über den Document Builder liegt der Fokus in der einfachen Bedienung für das Generieren, Planen und Anzeigen von Dokumenten.

Architektur Web
weiter

Demo der Dokumentengenerierung mit DOORS Next

In den nachfolgenden Bildern zeige ich eine Dokumentengenerierung einer Spezifikation, die sich in IBM DOORS Next befindet.

Spezifikationsmodul in einem DOORS Next Projekt

Document Studio: Hier wird die Vorlage entsprechend angefertigt. Es können Stammseiten erstellen werden, um eine Kopfzeile, eine Fußzeile und Eigenschaften, wie z. B. die Seitenausrichtung und die Rahmenart, zu definieren. Durch Datenquellenschemas werden Abfragen und Attribute zur Definition der Datenstruktur definiert. Besonders hilfreich für die spezifische Konfiguration ist der Einsatz von Variablen und JavaScript. Dadurch können dynamische Werte zur Laufzeit konfiguriert werden.

Document Studio: Anfertigen der Vorlage

Im Launcher werden die Parameter der Ausgabe festgelegt. Es werden die gewünschten Ausgabeformate, der Ausgabepfad und entsprechende Makros oder Stylesheets definiert.

Launcher: Definieren der Ausgabe

OSLC-Konfigurationsauswahl im Launcher: Im Auswahlmenü der Datenquelle kann die Spezifikation im DOORS Next Projekt bzw. im gewünschten Datenstrom ausgewählt werden.

Launcher: OSLC-Konfigurationsauswahl

Die OSLC-Ressourcenerkennung hilft beim Bestimmen des gewünschten Datenstroms.

Auswahl des Basis-Datenstroms

Die URI zur Datenquelle in DOORS Next Generation wird durch die Dialogauswahl bestimmt und im Feld URI hinzugefügt. Keine manuelle Bestimmung der Datenquelle ist mit der PUB 7.0 Version mehr nötig.

Auswahl der Datenquellen-URI

Nach dem Klick auf die Generierung ist nach kurzer Zeit der Prozess abgeschlossen. Im Dialogfenster sind die gewünschten Ausgabeformate mit Links abrufbar.

Abschluss der Dokumentengenerierung

Das nachfolgende Bild zeigt die Ausgabe der Spezifikation als Worddokument, als PDF und als Excel-Format.

Ausgabe als Worddokument, PDF und Excel

Falls benötigt, kann die IBM Engineering Lifecycle Optimization – Publishing auch die Spezifikation als HTML oder XSL-FO ausgeben.

Ausgabe als HTML und XSL-FO
weiter

Demonstration – Dokumentvergleich im Desktop-Client

Mit der 7.0 Version von IBM Engineering Lifecycle Optimization – Publishing können Sie jetzt eine andere Konfiguration als Basisdokument unter derselben Datenquelle angeben. Die Anwendung PUB generiert das Zieldokument sowie das Basisdokument und vergleicht sie dann, um ein Vergleichsdokument zu generieren.

Über das Kontextmenü der Datenquelle können die entsprechenden Spezifikationen ausgewählt werden.

Konfiguration der OSLC-Basiskonfigurationsauswahl

Nach der Eingabe des OSLC-Ressourcenerkennung kann über die OSLC Delegated UI der entsprechende Datenstrom ausgewählt werden.

Auswahl des Ziel-Datenstroms

Der OSLC-Konfigurationskontext wird über den Dialog kopiert und in das entsprechende Feld im Launcher eingefügt.

Kopieren des Links

Im Launcher kann die Dokumentengenerierung gestartet werden. Nach dem erfolgreichen Beenden werden im Dialogfenster die Links zu dem Basis-, Ziel- und Vergleichsdokument angezeigt.

Generierung und Ausgabe von drei Dokumenten

Im Vergleichsdokument sind die Unterschiede zwischen bei beiden Spezifikationsversionen farbig dargestellt.

Ausgabe des Vergleichsdokuments
weiter

Impressum

Hubert Spieß
Reventlowstraße 5
80805 München
Tel. 0175 7281914
Internet: www.hubert-spiess.de
E-Mail: mail@hubert-spiess.de

Datenschutzhinweis

Erhebung und Speicherung personenbezogener Daten sowie Art und Zweck von deren Verwendung beim Besuch der Website. Beim Aufrufen der Website hubert-spiess.de werden durch den auf Ihrem Endgerät zum Einsatz kommenden Browser automatisch Informationen an den Server unserer Website gesendet. Diese Informationen werden temporär in einem sog. Logfile gespeichert. Folgende Informationen werden dabei ohne Ihr Zutun erfasst und bis zur automatisierten Löschung gespeichert:

IP-Adresse des anfragenden Rechners, Datum und Uhrzeit des Zugriffs, Name und URL der abgerufenen Datei, Website, von der aus der Zugriff erfolgt (Referrer-URL), verwendeter Browser und ggf. das Betriebssystem Ihres Rechners sowie der Name Ihres Access-Providers.

Die genannten Daten werden durch uns zu folgenden Zwecken verarbeitet: Gewährleistung eines reibungslosen Verbindungsaufbaus der Website, Gewährleistung einer komfortablen Nutzung unserer Website, Auswertung der Systemsicherheit und -stabilität sowie zu weiteren administrativen Zwecken.

Die Rechtsgrundlage für die Datenverarbeitung ist Art. 6 Abs. 1 S. 1 lit. f DSGVO. Unser berechtigtes Interesse folgt aus oben aufgelisteten Zwecken zur Datenerhebung. In keinem Fall verwenden wir die erhobenen Daten zu dem Zweck, Rückschlüsse auf Ihre Person zu ziehen.

Weitergabe von Daten

Eine Übermittlung Ihrer persönlichen Daten an Dritte zu anderen als den im Folgenden aufgeführten Zwecken findet nicht statt. Wir geben Ihre persönlichen Daten nur an Dritte weiter, wenn: Sie Ihre nach Art. 6 Abs. 1 S. 1 lit. a DSGVO ausdrückliche Einwilligung dazu erteilt haben, die Weitergabe nach Art. 6 Abs. 1 S. 1 lit. f DSGVO zur Geltendmachung, Ausübung oder Verteidigung von Rechtsansprüchen erforderlich ist und kein Grund zur Annahme besteht, dass Sie ein überwiegendes schutzwürdiges Interesse an der Nichtweitergabe Ihrer Daten haben, für den Fall, dass für die Weitergabe nach Art. 6 Abs. 1 S. 1 lit. c DSGVO eine gesetzliche Verpflichtung besteht, sowie dies gesetzlich zulässig und nach Art. 6 Abs. 1 S. 1 lit. b DSGVO für die Abwicklung von Vertragsverhältnissen mit Ihnen erforderlich ist.

Betroffenenrechte

Sie haben das Recht:

gemäß Art. 15 DSGVO Auskunft über Ihre von uns verarbeiteten personenbezogenen Daten zu verlangen. Insbesondere können Sie Auskunft über die Verarbeitungszwecke, die Kategorie der personenbezogenen Daten, die Kategorien von Empfängern, gegenüber denen Ihre Daten offengelegt wurden oder werden, die geplante Speicherdauer, das Bestehen eines Rechts auf Berichtigung, Löschung, Einschränkung der Verarbeitung oder Widerspruch, das Bestehen eines Beschwerderechts, die Herkunft ihrer Daten, sofern diese nicht bei uns erhoben wurden, sowie über das Bestehen einer automatisierten Entscheidungsfindung einschließlich Profiling und ggf. aussagekräftigen Informationen zu deren Einzelheiten verlangen;

gemäß Art. 16 DSGVO unverzüglich die Berichtigung unrichtiger oder Vervollständigung Ihrer bei uns gespeicherten personenbezogenen Daten zu verlangen;

gemäß Art. 17 DSGVO die Löschung Ihrer bei uns gespeicherten personenbezogenen Daten zu verlangen, soweit nicht die Verarbeitung zur Ausübung des Rechts auf freie Meinungsäußerung und Information, zur Erfüllung einer rechtlichen Verpflichtung, aus Gründen des öffentlichen Interesses oder zur Geltendmachung, Ausübung oder Verteidigung von Rechtsansprüchen erforderlich ist;

gemäß Art. 18 DSGVO die Einschränkung der Verarbeitung Ihrer personenbezogenen Daten zu verlangen, soweit die Richtigkeit der Daten von Ihnen bestritten wird, die Verarbeitung unrechtmäßig ist, Sie aber deren Löschung ablehnen und wir die Daten nicht mehr benötigen, Sie jedoch diese zur Geltendmachung, Ausübung oder Verteidigung von Rechtsansprüchen benötigen oder Sie gemäß Art. 21 DSGVO Widerspruch gegen die Verarbeitung eingelegt haben;

gemäß Art. 20 DSGVO Ihre personenbezogenen Daten, die Sie uns bereitgestellt haben, in einem strukturierten, gängigen und maschinenlesebaren Format zu erhalten oder die Übermittlung an einen anderen Verantwortlichen zu verlangen;

gemäß Art. 7 Abs. 3 DSGVO Ihre einmal erteilte Einwilligung jederzeit gegenüber uns zu widerrufen. Dies hat zur Folge, dass wir die Datenverarbeitung, die auf dieser Einwilligung beruhte, für die Zukunft nicht mehr fortführen dürfen und

gemäß Art. 77 DSGVO sich bei einer Aufsichtsbehörde zu beschweren. In der Regel können Sie sich hierfür an die Aufsichtsbehörde Ihres üblichen Aufenthaltsortes oder Arbeitsplatzes oder unseres Firmensitzes wenden.

Widerspruchsrecht

Sofern Ihre personenbezogenen Daten auf Grundlage von berechtigten Interessen gemäß Art. 6 Abs. 1 S. 1 lit. f DSGVO verarbeitet werden, haben Sie das Recht, gemäß Art. 21 DSGVO Widerspruch gegen die Verarbeitung Ihrer personenbezogenen Daten einzulegen, soweit dafür Gründe vorliegen, die sich aus Ihrer besonderen Situation ergeben oder sich der Widerspruch gegen Direktwerbung richtet. Im letzteren Fall haben Sie ein generelles Widerspruchsrecht, das ohne Angabe einer besonderen Situation von uns umgesetzt wird.

Möchten Sie von Ihrem Widerrufs- oder Widerspruchsrecht Gebrauch machen, genügt eine E-Mail mail@hubert-spiess.de

Datensicherheit

Wir bedienen uns geeigneter technischer und organisatorischer Sicherheitsmaßnahmen, um Ihre Daten gegen zufällige oder vorsätzliche Manipulationen, teilweisen oder vollständigen Verlust, Zerstörung oder gegen den unbefugten Zugriff Dritter zu schützen. Unsere Sicherheitsmaßnahmen werden entsprechend der technologischen Entwicklung fortlaufend verbessert.

Aktualität und Änderung dieser Datenschutzerklärung

Diese Datenschutzerklärung ist aktuell gültig und hat den Stand Mai 2018. Durch die Weiterentwicklung unserer Website und Angebote darüber oder aufgrund geänderter gesetzlicher beziehungsweise behördlicher Vorgaben kann es notwendig werden, diese Datenschutzerklärung zu ändern. Die jeweils aktuelle Datenschutzerklärung kann jederzeit auf der Website unter Datenschutzhinweis von Ihnen abgerufen und ausgedruckt werden.

Hinweis: Basistemplate ist von HTML5 UP und lizenziert unter Creative Commons Attribution 3.0 License.