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.

rdng_rrdg_logs
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 com.ibm.rational.rrdg logger

rdng_rrdg_logs_configure
Click to enlarge
Advertisements

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.

 

RRDG versions used by RDNG

“What is the RRDG version in DNG 4.0.6 or 5.0.2 or … ?” This is a very common question we get for RRDG and DNG and this is also the first question one asks when trying to debug a DNG document generation issue or understand what RPE capabilities can be used with that version.

The RM Reporting Wiki has a very nice table at the bottom of the page that documents the mapping between DNG and RRDG versions. Here is the link to it Which versions of the Rational Reporting for Document Generation plug-in are included with which versions of the RM application?

RPE Presence at Interconnect 2015

The RPE team will be present at IBM Interconnect 2015  represented by:

  1. Jared Pulham – product manager
  2. Nithya Rajagopalan – team leader
  3. Karthikeyan Subramanian – development manager
  4. Dragos Cojocari – architect

We look forward to meeting your there and hear how much you love RPE. 🙂 We also welcome complaints, enhancement requests and are very interested in learning your current and planned usage of the RPE/RRDG document generation technology.

Custom templates in DNG’s Quick Print menu

When you register a custom template  DNG the template will appear in the Reports->Generate a Document-style report and in the “Quick Print” menu.

DNG_QuickPrint

This may seem convenient but it is actually a problem since the Quick Print  ( Generate a Report for this View) menu is not functionally equivalent to the Reports one for custom reports.

The difference between using one or the other is in the URL that DNG will configure the report with. The URL ( the data) set by DNG’s Quick Print function is the URL for the current view and not the URL of the module or of the selected artifact(s).  The view data is meant to be used with templates using the View schema of DNG but as that schema is private no custom templates can use it, only OOTB ones do. So as the data will not match the template schema the reports will always be empty.

Until this issue is fixed and custom templates are hidden from the Quick Print you should not use custom templates from the Quick Print option of DNG. All custom templates should be used from the Reports->Generate a Document-Style report menu.

DNG Artifacts – “module version” vs “core version”

Glossaries / “References Term” Link missing gives excellent insight into the notions of “module version” and “core version” of DNG artifacts, differences between these versions relevant to reporting and also the way in which you can get to the “core version” of an artifact from the module’s contextBinding.

Kudos to Sam and Ivan for the great information provided here.