Document Generation.

I introduce the IBM Engineering Lifecycle Optimization – Publishing (Rational Publishing Engine) solution in this article. You will learn which documentation can be generated from which data sources.

Term Reporting

The term reporting has several meanings. In the article I will only deal with document generation from a specification to output formats such as Word or PDF.

Reporting as Document generation

Document generation
  • Automatic generation of documentation
  • from different data sources
  • in various formats (Word, PDF, CSV, HTML, XML-FO)
  • with flexible formatting

Reporting for Document Generation (RDG)

This is the reusable reporting component for the individual Jazz products to enable document-like reporting. RDG is included in various IBM ELM products and provides a subset of the functionality of IBM Engineering Lifecycle Optimization – Publishing (PUB). IBM Engineering Lifecycle Optimization – Publishing (PUB) is required for customization of templates. This allows you to cover your own variables, a special document structure and the integration of various data sources.

Reporting with Dashboards

Dashboard

There is another use case in the reporting topic. Through Jazz Reporting Service (integrated into the IBM Engineering Management solution) the following is covered:

  • Visualization of key figures
  • Online status reports
  • Trend analyses / trend charts

Data sources

Different data sources can be connected by the reporting solutions. The data can come from the following areas:

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

IBM Engineering Lifecycle Optimization – Publishing (Rational Publishing Engine)

The Document Generation Solution (abbreviated as PUB), consists of the following components:

Launcher

Eclipse-based client application for creating document specifications and generating output documents from these specifications. The launcher is available as a wizard. Output formats, data sources, templates and variables can be defined.

Document Studio

Eclipse-based client application for designing document templates using various views and wizards. The Document Studio provides powerful support for scripting languages (JavaScript) with an editor.

Document Builder

Provides a web interface for creating reports from templates and for generating, scheduling and viewing documents. The Document Builder hides the complexity of template creation for regular users. It is a centralized Web interface for a team and/or the entire organization. Jobs for document creation can be scheduled (daily, weekly)

Tool integration

Document generation can be started directly in the menu by integration within tools (e.g. DOORS). Available are native API extensions and an Eclipse plug-in.

Available output formats

Architecture Desktop

In addition to document generation via the launcher and tool integration, the architecture of the desktop is based on the creation of a document template. Document templates can be designed and edited using Document Studio.

Architecture Desktop

Architecture Web

With the Web architecture via the Document Builder, the focus is on simple operation for generating, planning and displaying documents.

Architecture Web
next

Demo of document generation with DOORS Next

In the following pictures I show a document generation of a specification which is located in IBM DOORS Next.

Specification module in a DOORS Next project

The template is created within the Document Studio. Master pages can be created to define a header, footer and properties such as page orientation and border styling. Data source schemas define queries and attributes to define the data structure. The use of variables and JavaScript is especially helpful for specific configuration. This allows dynamic values to be configured at runtime.

Document Studio: Making the template

The launcher is used to set the parameters of the output. The desired output formats, the output path and corresponding macros or stylesheets are defined.

Launcher: Defining the output

OSLC configuration selection in the launcher: In the selection menu of the data source the specification in the DOORS Next project or the desired data stream can be selected.

Launcher: OSLC configuration selection

The OSLC resource detection helps to determine the desired data stream.

Auswahl des Basis-Datenstroms

The URI for the data source in DOORS Next Generation is determined by the dialog selection and added in the URI field. No manual determination of the data source is necessary with the PUB 7.0 version.

Selection of the data source URI

After clicking on the generation, the process is completed after a short time. The output formats are linked in the dialog box.

Completion of document generation

The following picture shows the output of the specification as a Word document, PDF and Excel format.

Output as Word document, PDF and Excel

If required, IBM Engineering Lifecycle Optimization – Publishing can also output the specification as HTML or XSL-FO.

Output as HTML and XSL-FO
next

Demonstration – Document comparison in Desktop client

With the 7.0 version of IBM Engineering Lifecycle Optimization – Publishing, you can now specify a different configuration as the base document under the same data source. The PUB application generates the target document and the base document and then compares them to generate a comparison document.

The corresponding specifications can be selected via the context menu of the data source.

Configuration of the OSLC base configuration selection

After entering the OSLC resource detection, the corresponding data stream can be selected via the OSLC Delegated UI.

Selection of the target data stream

The OSLC configuration context is copied via the dialog and inserted into the corresponding field in the launcher.

Copying the link

The document generation can be started in the launcher. After successful completion, the links to the base, target and comparison document are displayed in the dialog box.

Generation and output of three documents

In the comparison document, the differences between the two specification versions are shown in color.

Output of the compare document
next

Imprint/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.