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

Troubleshooting slow RPE Launcher/Studio start

Update 2015.02.03: another cause for a slow Launcher/Studio start is an invalid RPE WebService URL.  Check your ini files to determine if the -Dcom.ibm.rational.rpews.url is set and verify the URL is correct and accessible.

If RPE Launcher/Studio take more than a few seconds to start it is possible that your license configuration is sub-optimal. A slow license check-in will also impact document generation via the Java API or remote services. In extreme situations this can make RPE appear to hang or take minutes to start.

Symptoms: RPE Launcher/Studio splash screen shows up but there is no progress indicator or progress messages for a few seconds.

How to confirm this is indeed a license issue: start RRPE Launcher in publish wizard mode. In this mode RPE Launcher does not immediately consume a license. The command line to use is:

“%RPE_HOME%\launcher\rpe-launcher.exe” -publish “path to dsx”

If Launcher starts very fast this way than the license setup is indeed an issue.

Cause: the license environment variable, TELELOGIC_LICENSE_FILE, contains a large number of entries. Typically some of those entries will be invalid and some will point to license servers that have RPE licenses.

How to fix: trim the environment variable such that it contains only servers that are valid. If more than one server is present put one with RPE licenses towards the start of the list ( first is best). Once you do that there are a few more steps you need to take:

Continue reading “Troubleshooting slow RPE Launcher/Studio start”

RPE 1.3 iFix 002

RPE 1.3 Interim Fix 2 is available on Fix Central and can be applied using Install manager. You can download the iFix repository or you can install it directly from the online repository. This iFix is cumulative and includes all the fixes made by RPE 1.3 iFix 001

This iFix addresses a number of issues identified after the RPE 1.3 release:

  • Java errors when bidi is true and Hebrew text
  • Standard view is used instead of default view for DOORS if an incorrect view name (non-existent) is provided
  • Results dialog cannot find Word output file if specified with a relative path including ..
  • Document specification version 1.1 (created with RPE 1.1.2) cannot be loaded in 1.3

For the full list of defects fixed and details on the procedure to apply the iFix see the iFix documentation.

Fixing external hyperlinks in Word documents

External hyperlinks generated with RPE 1.2.1 and newer do not work from Word (Ctrl+Click) as the address is prefixed with a “#”. This is a defect in RPE and and until the defet is fixed a solution is to use a post processing macro to identify and correct the hyperlinks.


Public Sub fixLinks()
   Dim lnk As Hyperlink

   ' RPE generated links are empty and the link is stored in the sub-address field
   For Each lnk In ActiveDocument.Hyperlinks
      If Len(lnk.address) = 0 And InStr(lnk.SubAddress, "http") = 1 Then
         lnk.address = lnk.SubAddress
      End If
   Next
End Sub

Managing data connection errors

Updated 2014.07.31

Data connection errors are critical errors in RPE/RRDG and by default any such failure will cause the document generation to abort immediately. There are however scenarios where this default behavior is not desirable:

  1. data containing known broken links
  2. peak load times when requests might sporadically be rejected by the server

Continue reading “Managing data connection errors”

One more technique for debugging DNG document generation

In addition to the methods described in Troubleshooting DNG document generation with RRDG there is one more technique you can use to debug document generation in DNG: replicate the DNG document generation in a standalone RPE installation but the using RPE templates deployed on the DNG server and the DSX files created by DNG.

NOTE if the RRDG engine in DNG and the RRDG version in your standalone RPE are different the results you obtain in the two environments can be very different. Still this method remains valid and useful to understand the inner workings of RRDG in DNG.

When you use the “Generate a Document-Style report” function DNG will use all the selections you make in the wizard in order to build a document specification ( dsx) which it then passes to DNG. The DSX file are stored in <SERVER_INSTALLATION>\server\tomcat\temp\rrc_reports

Continue reading “One more technique for debugging DNG document generation”

Product support content for Rational Publishing Engine

A useful link when troubleshooting RPE is the Product support content for Rational Publishing Engine page which lists all known issues and recent APARs for the product along with workarounds where available.