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.
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.
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.
RPE 2.0 and RPE 2.0.1 users can receive email notifications when a document generation job completes.
This capability needs to be enabled by the administrator and each user. For both roles the procedure is exceedingly simple.
As a user
You need to enter your email address in the settings page. The user settings are accessed from the menu next to your user name in the top bar of the page.
NOTE: if configured to use JTS for authentication RPE will automatically retrieve your email address associated with your JTS account.
As an administrator
You need to configure RPE to access an email service. This is done by filling the highlighted entries in the image below.
The administrative page is accessed just like the user settings page: from the context menu next to the user name in the top bar. The menu is only available to users that have the administrative role.
Once the mail settings are properly configured an email will be sent to the owner of the document each time a document generation completes (successfully or not). For successful jobs you can access the generated documents immediately using the links from the email.
The administrative settings page also contain two properties that allow the administrator to change the content of the email generated by RPE. Please make sure that code is valid HTML and test it in a browser before changing it in the RPE settings.
With RPE 2.0.1 you can specify .docx as the extension for the output documents regardless of the stylesheet you are using. With 2.0 and older the generation process would fail if the stylesheet contained macros since .docx is a macro free Word document format.
To avoid this RPE 2.0.1 will remove all macros before saving the .docx file. This also means that any macro specified to be executed for the output will be ignored if the output extension is .docx. If you need macros in your output document you need to use one of the macro enabled document formats .doc or .docm.
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.
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:
retrieve the DM resource.
retrieve the links for the DM resource
access the linked artifacts
The anatomy of the template reflects these 3 steps:
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.
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.