OSLC API and POX Profile simplifies CLM traceability

Further to OSLC + POXProfile post, RPE 2.1 with CLM 6.0.2 simplifies the data source configuration; especially while configuring dynamic data source for traceability reports.

Use OSLC / Permanent link for configuring the data source URL without having to modify the URL manually or through JavaScript. This simplifies the data source configuration to a great extent as the Permanent / OSLC links are available to the user from the product UI.

Watch video, created by Dragos, on requirement (DNG) to use case design (DM) traceability document generation using Permanent / OSLC links from DNG and DM without having to go through building Rest URL. Continue reading “OSLC API and POX Profile simplifies CLM traceability”

Advertisements

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

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.

 

How to follow links from DM to DNG

In this article I describe how to generate a document with RPE that contains DM resources and their linked DNG requirements. While the example uses DNG as a target the technique is applicable to other CLM sources or even DOORS 9 with slight changes.

Credit: thanks to Kevin Cornell for his excellent DM Reporting Tutorial .

How it works

Unlike other Rational data sources links are not stored in the representation of a DM resource. This means that if you request the Reportable REST representation of a Package there will be no links inside it. The links are stored separately and access via the the “collaboration/links” Reportable REST URI.

So in order to build a document that contains DM resources and linked requirements you have to perform these 3 steps:

  1. retrieve the DM resource.
  2. retrieve the links for the DM resource
  3. access the linked artifacts

The anatomy of the template reflects these 3 steps:

DM_Links

I will skip step 1 and describe step 2 and 3

#2 Retrieve the links for a DM resource

The links for a DM resource are retrieved from the the collaboration/Link service. The dmResourceID and the dmContextID properties are available in the resource you’ve got at step 1.

https://server:port/dm/reporting/collaboration/Link?referencingId=<dmResourceID>&rmps.context=<dmContextID>

#3 Access the linked artifacts

Now that you have the link href all you need to do is access the information. Assuming all the links are for DNG text artifacts all you need is to convert the OSLC URL stored in DM to a Reportable REST form using a script like this and then access the DNG data through a Dynamic Data Source.

href.replace("resources/","publish/text?resourceURI=")

Reusing the template

The template is available on the Modelling Templates Page of the RPE DevWorks Wiki and is provided also as a reusable snippet. See the attachments section for:

  • DM Links for Package Diagrams Example
  • DM Links Snippet

Once imported in your template you connect your code to the snippet by adding code to set the baseURL, dmResourceID and dmContextID in the “add code here” Java Script block.

The paper size of the Word stylesheet is modified by DOORS Next Generation

DNG modifies the Word templates used, specifically the paper size. DNG uses by default the paper size is “Letter” and every time that the publish service is initialized it will update Word templates paper size to “Letter”.

To avoid this behavior you need to remove current value for “publish.PaperSize” property so that the initialize process does not change the paper size set in the Word templates.

dng_paperSize

This can be done in the application Administration (https://serverName:Port/rm/admin):

  1. on the left side click on Advance Properties
  2. search for publish.PaperSize property and remove current value.
  3. save the change
  4. update your Word stylesheets
  5. execute the publish initialize process

Thanks to Ivan from the DNG team for this information.

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?