Assemble traceability documents from reusable building blocks

When building a template you can take advantage of the reuse capabilities that RPE Template and Document Studio provide.  You can use this for any documents and traceability documents are a great candidates since they usually involve the same steps over and over again:

  1. Read the data from Product A and print the details you need
  2. In the data of Product A find the links to data in Product B
  3. Read the data from Product B and render it

The above is the outline of any 2 source traceability report and steps 2 and 3 are almost identical for all reports so they can be packaged as blocks to be reused as needed.

To show this I have created a document with DM and RTC data. The artifacts I use in my example are available on the Unclassified & Cross Domain Templates section of the RPE Wiki Community at #15  DM to CLM Traceability.

Continue reading “Assemble traceability documents from reusable building blocks”

Advertisements

Getting started with document generation from Design Manager

Updated 2015.10.22: select configuration changes for DM 6.0. See bullet #7 in the “Find the DM schema” section.

I’m writing this article to document my own experience learning how to setup and perform document generation from Design Manager.

This is a TL;DR article and once you get past it I recommend Kevin Cornell’s  excellent DM Reporting Tutorial to get a better grasp of the concepts involved. I also recommend going through Integrating Design Management with Rational Publishing Engine.

dm_document

Software used:

  1. CLM 5.0.2 – no fixpacks
  2. Rhapsody Design Manager 5.0.2 – no fixpacks
  3. RPE 2.0 – latest fixpack
  4. Windows 7 64 bit

Continue reading “Getting started with document generation from Design Manager”

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.

Using IBM Rational Publishing Engine to generate compliance documents

Using IBM Rational Publishing Engine to generate compliance documents: Report generation for Rational Quality Manager, introducing REST service URLs, importing schemas, and basic template authoring is the latest IBM DevWorks article Dr. Einar Karlsen has published on document generation with Rational Publishing Engine. Enjoy the read.