How to troubleshoot document generation in DNG

When starting with DNG and document generation or when deploying new reports on the server the RRDG log is an invaluable resource for troubleshooting problems on the RRDG server.  As expected the log provides detailed information on errors and additional information including performance data.

Click to enlarge

All the DNG logs can be access at https://server:9443/rm/logs.  The log for document generation is rrdg.log which is located towards the end of the list.

By default the RRDG log is set on WARN level which means only warnings and errors will be logged. This is the recommended setting for most production servers but if you need to troubleshoot document generation you should increase the level and set it to INFO.

Changing the log level is done in the logger configuration page https://server:9443/rm/logs/config by setting the INFO/DEBUG level  to the logger

Click to enlarge

Traceability with DOORS 9 and RQM

Continuing the series of articles on the topic of creating traceability documents I have arrived at an interesting use case:  traceability from DOORS 9 and RQM.


In this article I will describe how to create a document with requirements from DOORS 9 and their associated test cases from RQM.

Continue reading Traceability with DOORS 9 and RQM

Use sophisticated formatting for PDF in DNG

If you are using the document generation UI in DNG’s 5.0.x and older to generate PDF documents the default option is to use RRDG’s  so called “performance driver“.  This driver is legacy and has far fewer capabilities than the alternative “sophisticated formatting” driver.

You can read more on the history of the PDF driver  in RRDG and why we kept the legacy driver but at this time there are no reasons to use it except the fringe scenario where you need to create a 20.000 pages data dump in PDF.

Considering the performance and quality of the output produced by the “sophisticated driver” you should always use that driver. This is enforced in DNG 6.0 by making “sophisticated formatting” the default option for the PDF output.


A 4 step install guide for RPE 2.0.1

This post is a TL;DR version of it for Liberty and Tomcat. The installation procedure for the RPE WebServices 2.0 is described in detail in

RPE 2.0.1 Login Screen
RPE 2.0.1 Login Screen


WAS  Liberty Profile

Apache Tomcat

Ensure the TELELOGIC_LICENSE_FILE environment variable is set and points to a RPE license server.
Copy from %RPE_HOME%\remote-services into the apps folder of your Liberty server Copy rpeng.war and dgass.war from %RPE_HOME%\remote-services into the webapps folder of the Tomcat server
Ensure the JSP and Auth features are enabled for the Liberty server. Add the required users and roles for RPENG. See the example server.xml.  Add users and roles for RPENG. See the example tomcat-users.xml.
Start Liberty and navigate to  http://<server&gt;:9080/rpeng/home Start Tomcat and navigate to http://<server&gt;:8080/rpeng/home

Trouble shooting

  1. Examine rpeng.log and rpedgaas.log in %TEMP% folder
  2. Clear browser cache. This is mandatory when upgrading from 2.0 to 2.0.1
  3. Admin page – list of failed jobs
  4. View page – job details

More traceability – following links from RQM

Continuing the series of articles on producing traceability documents from IBM CLM I will describe today how to follow links from RQM.

If you examine the RQM schema for testcase for example you will notice entries for workitems and requirements.

Click on the image to enlarge it.

With these properties it should be fairly straightforward to build a template that retrieves CM and RM data associated with the QM artefacts.

However if you run your report on a test case feed URL like https://giediprime:9443/qm/service/ Banking (Quality Management)/testcase?abbreviate=false there is no requirement or work item data in the document. And if you examine the XML returned by RQM for this request you will see that information is not present there either.

So what is the problem? The answer is in the Rational Quality Manager Reportable REST API Documentation.  For efficiency reasons RQM does not return the link information by default. If you want to create traceability documents you’ll have to explicitly ask for the link information using the calmlinks argument in the request URL.

Which means that the right URL to use in the RPE docspec will look like this https://giediprime:9443/qm/service/ Banking (Quality Management)/testcase?abbreviate=false&calmlinks=true

Note that the URLs to RTC and DNG are OSLC links and you will need to convert them to Reportable REST API URLs before fetching RM and CCM data.

Examples showing how to follow links from individual testcase or from a test case feed are available in the RPE DevWorks – Cross Domains Templates Wiki.

Embed attachments as OLEs in the RPE Word output

This is a guest post by my colleague Subramanya Pilar from the RPE FVT team.

Hyperlinks are a simple and convenient way to attach additional data to a document. There are however scenarios where embedding the content as OLE objects is more useful:

  • the document is self contained, you can transfer the documents with embedded objects to other computers or mail them without breaking any link.
  • you can edit the embedded objects without changing the content of the source.
  • embedded objects can be edited without having to work in a separate window.

Rational Publishing Engine supports creating such documents. The attachment can be of any format supported by Microsoft Word for embedding .xls, .pdf, .doc, .docx are examples of such documents.

Continue reading Embed attachments as OLEs in the RPE Word output

Rational Publishing Engine (v2.0) for Rhapsody – Training

Andy Lapping has published a fantastic training material for using Rational Publishing Engine with Rational Rhapsody on

This is one the best,  if not the best, education material I’ve seen for RPE and Rhapsody and it adds to Andy’s already long list of contributions to RPE. @Andy – thank you so much for all the help.


The training gives an introduction to RPE and continues with basic concepts before elaborating on advanced techniques. Everything is beautify explained and the concepts are introduced incrementally in a way that it is easy to follow and understand.


  1. Overview of Rational Publishing Engine

Basic Techniques

  1. Creating Basic Templates for Rhapsody
  2. Formatting in RPE
  3. Filtering and Conditions
  4. Bookmarks and Hyperlinks
  5. Debugging Templates
  6. Creating Advanced Templates for Rhapsody
  7. RPE in a Jazz Environment
  8. Troubleshooting

Advanced Techniques

  1. Recursing Through Rhapsody Project Structures
  2. Variables and ‘Looking Down the Tree’
  3. Casting
  4. Reporting on Multiple Rhapsody Projects

Up to date information and comments on RPE, Document Generation and Reporting


Get every new post delivered to your Inbox.

Join 126 other followers