Developing a custom report for IBM Rational DOORS Next Generation is not something You do every day when You are working with the tool. But in every project most probably you will have to create a Software Requirements Specification document and it good to have it labeled with company logo and in the template which is used in the organization. Developing new report in Rational Publishing Engine can be a challenge for less experienced users without strong development background, but it doesn’t mean that for every change developer is required. During the session, the speaker will present fundamentals of report development in IBM Rational Publishing Engine for DOORS Next Generation and will implement examples that will give the audience overview how to customize report templates and styling without involving development team.

1. 1
Bartosz Chrabski
Director of Technology – SmarterProcess
bartosz.chrabski@smarterprocess.pl
IBM Rational Publishing Engine
and DNG in 30 minutes - How to
change report template without
development experience.

2. 2
4 ways of reporting in IBM Rational DOORS NG
Demo & Discussion & Additional Resources
Introduction to IBM Rational Publishing Engine and
creating report templates
What can non-developer person do with RPE ?
1
2 3
4
5
Session overview
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
1
2
3
4
5 Q&A

3. 3
DNG – 4 ways of reporting
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
IBM Rational
DOORS NG
Widgets and
custom widgets
IBM Report
Builder
Data Export +
Excel
IBM Rational
Publishing Engine
Usage: Statistics, charts,
project & artifact data, user
data, traceability
Usage: Documentation with
artifact data, traceability (Word,
HTML, XML, Excel, PDF)
Usage: Artifact data, traceability
Usage: Statistics, charts,
artifact data, traceability, project
trends.

4. 4
Why IBM Rational Publishing Engine
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
Automates generation of high quality documents
from IBM Rational products and third-party
products:
• Examples of usage:
• Compliance
• Engineering documents
• Audits
• Regulatory compliance documents
• Diffs comparing different stages of project
Key Features:
• Coherent
• Same concepts used for all data sources
• Same concepts used for all output formats
• Separates data from formatting
• Self contained
• Platform, data source and output format
independent
• Does not require Microsoft Word or any other
3rd party tools installed for output.
• Non-intrusive
• No changes made to the data sources
• Extensible
• Can be extended with new data sources and
output formats
• Xsl-fo allows generating additional output
formats not directly supported

5. 5
How does IBM Rational Publishing Engine work?
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
When You implement DOORS Next
Generation, Rational Publishing Engine
is a must, but we all often forget about it.DNG Modules

6. 6
How RPE works with DNG ?
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
• Tool integration for commanding document generation
from within tools (e.g. DOORS, Rhapsody, DNG)
• Launcher for managing document
production in a agnostic fashion
• Document Studio for creating
and editing templates
• Web based Document Builder to make it easy for end
users to start and manage document generation

7. 7
DNG as a data source for Rational Publishing Engine
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
• Add new DNG Data Source
schema
• Define DNG repository (name,
artifact schema and data type).
• Authenticate using DNG username
and password
• Validate if data source was
imported.
Data Source
Schema is defined
by reporting API Data Source can
use RQM, RTC,
DNG, DM or 3rd
part tools data
schemas
1
2
4
3

8. 8
Using Publishing Engine palette to build a report
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
• Select palette elements you want to add to the
report
• Drag and drop elements to add the to the report
• Create structure you will use to present data from
data source
Outline view can be helpful
in complex reports
1
2
3
4
• Use outline view to change and manage the
structure of elements in the report

9. 9
Elements available on the RPE pallet
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
Basic elements (text
objects, containers,
images, links, tables)
Lists (numbered lists or
bulleted lists)
Data elements
(Iterations switching
between data sources,
including files)
Other (Table of
Contents, First page
formatting, page
numeration, captions
for tables and images
and more)
1
2
3
4

10. 10
Associate data schema with the report structure
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
For Microsoft word reports you
can use styles defined in MS
Word documents
1
2
• Drag and drop data source elements to associate
them with a report structure
• Click on each object in report structure to set
formatting and styles

11. 11
Associating data schema and data with report element
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
DNG Data source
schema imported to
Rational Publishing
Engine Data Source
associated with
report elements
Data in IBM Rational
DOORS Next
Generation1
2
3

12. 12
Filtering and processing data
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
RPE conditions can be
more complex than
previous example
Simple filtering (only
requirements with
comments)
Filtering defined as
container condition
RPE condition defined
as JavaScript
condition statement
DNG Data source
schema imported
to Rational
Publishing Engine
1
2
3
4

13. 13
Generating a report - configuration
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
• Configure the report before generating
report for the first time
• Configure data source that will be used
for the report. Use artifact and report API
to prepare proper URL.
• Configure output formats that will be
generate as the outcome of report
generation.
Only Microsoft Word,
XLS, PDF, XslFo, HTML
formats are supported
Supported data
sources are module,
view and set of
requirements
Simple filtering (only
requirements with
comments)
1
2
3

14. 14
Looks easy ?
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
Most reports
will have
complex
structure
Use of multiple
data source
schemas
Most of the reports
will require some
JavaScript coding
Knowledge
about
reporting API
is critical for
creating
reports in
RPE
Part of outline (~200
objects)

15. 15
Conclusion
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
• It is a challenge to build good IBM Rational Publishing Engine report from nothing without
knowledge about CLM data schema and lack of basic development skills.
• Editing existing reports can be even more challenging because first you need to understand their
structure and than make a changes.
• If you want to change content of the report, you have to use RPE, if You only want to change layout
you can do it without touching RPE at all.
• Everyone with basic CSS, HTML or Word skills can change report layout

16. 16
Tips & Tricks – Importing Web Resources
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
Copy URL when the module is
open
• Web Resources are using predefined snippets that
are much easier to customize than existing report in
DNG (book and table)
• Works well for basic artifacts and modules.
1
2
Open RPE and select Template
> Import Web Resource
3
Paste URL that was
copied from web
browser
Report structure was
automatically generate
for You
4

17. 17
Tips & Tricks – Importing Web Resources
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
Define styles in Word document.
Headings 1..6, Normal, etc
1
2
3
3
Configure RPE to use created
Microsoft Word file as a style
sheet.
4
Result
• Later report can be deployed to IBM Rational DOORS Next
Generation to generate it directly from UI

18. 18
Tips & Tricks – Changing DNG report template
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
• If You only want to replace existing layout of the DNG reports than open
<JazzTeamServer>serverconfrmreportinginitializationtemplatesword
• Before making changes in the template it is good idea to
backup the original files.
• Make changes to document structure or just paste a
new document template
• Reinitialize reports https://server:port/rm/publish/initialize
Multiple language
versions
1 2
3
Change styles
Add static content,
headers, footers,
logos, etc.
Document cursor is
indicating where the report
content will be located
> 6.0.4 rmadmin and Debug > Publish Services -> Initialize Service

19. 19
RPE without
development
experience

20. 20
Where should I start …. ?
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
Rational Publishing Engine Actual
• https://rpeactual.com/
Incorporating Jazz Reporting Service
Reports into RPE
• https://jazz.net/library/article/1482
Using Rational Publishing Engine to generate compliance documents
• https://www.ibm.com/developerworks/rational/library/rational-publishing-engine-generate-compliance-documents-1/
• https://www.ibm.com/developerworks/rational/library/rational-publishing-engine-generate-compliance-documents-2/
• https://www.ibm.com/developerworks/rational/library/rational-publishing-engine-generate-compliance-documents-3/
• https://www.ibm.com/developerworks/rational/library/rational-publishing-engine-generate-compliance-documents-4/
RPE Knowledge Center - documentation
• https://www.ibm.com/support/knowledgecenter/SS6RHZ_6.0.5

21. 21
Additional resources
P u b l i s h i n g E n g i n e a n d D N G i n 3 0 m i n u t e s - H o w t o c h a n g e r e p o r t t e m p l a t e w i t h o u t d e v e l o p m e n t e x p e r i e n c e
IBM Software – IBM Rational Publishing Engine
• https://www.youtube.com/playlist?list=PL5D39ABB5C9864F85
Generate a requirements document from
DOORS Next Generation
• https://www.youtube.com/watch?v=MXP0JrOiVJQ
Generate traceability reports for CLM using RPE
• https://www.youtube.com/watch?v=NBVSpvcetcY&list=UUqo7twqXP0XOVBJjzpXablQ&index=2
Overview of Rational Publishing Engine
• https://www.youtube.com/watch?v=hIWc_LyPqwo&list=PL5D39ABB5C9864F8
5
Generate a requirements document from
DOORS Next Generation
• https://www.youtube.com/watch?v=MXP0JrOiVJQ&t=2s

22. 22
bartosz.chrabski@smarterprocess.pl
Bartosz Chrabski
Director of Technology

23. 23