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.

There example uses 4 artifacts:

  • DM_RTC_Traceability_Base.dta – the base of the template. This matches #1 in the above list and prints the top level packages from the DM Project
  • DM_Links_Snippet.dta – this is a reusable template for accessing link data stored in DM and it matches #2 in the above list. You can use this snippet whenever you need to access DM link data regardless if you then follow links to another DM model element or a CLM artifact.
  • RTC_WI_Snippet.dta – this is a reusable snippet for accessing RTC Work Items given the OSLC link to a workitem and it matches #3 in the above list. This snippet can be used regardless of where you start your report from ( DM, QM, DNG etc)

With the above snippets available building the template is a matter of assembling the blocks.

Part 1: Get the DM Link information

  1. Start with the base template which prints the packages in the DM model.
  2. Insert the DM_Links_Snippet in the DM_RTC_Traceability_Base template in the “Links” container. Specify “Physical Embedding” as you will need to modify the content of the snippet
  3. Connect the snippet to the main template by editing the indicated elements:
    1. Set the inherited data source for the DM_links data source configuration element so that RPE can authenticate when accessing the Link information
    2. Fill the blanks in the Java Script code to connect the links snippet to the data context in the base template.
  4. Make a test run to verify you get the DM and link data.
  5. In order to get a result like the one below you have to connect the DM project to an RTC project and create a number of “Related To” links for your package.

Part 2: Get the RTC Data

  1. insert the RTC_WI_Snippet.dta in the indicated place in the Links container. Again use “Psychical Embedding”
  2. connect the snippet to the main template by editing the indicated elements
    1. Set the inherited data source for the RTC_WI data source configuration element. This assumes you have the same credentials for DM and RTC.
    2. Fill the blanks in the Java Script code to connect the RTC snippet to the data context.
  3. Run the test again to verify that you get the DM and RTC data. Note that due to how the snippets are design there is no change required in the DSX file.


This is all there is. If you create snippets for QM and RM artifacts you can use them in the exact same manner you have used the CM one.

The starting point of your report does not matter since all these tools use OSLC for linking so you can design the snippets to start with the OSLC URLs regardless of how and where that link is stored and accessed.



Author: Dragos Cojocari

Architect for Rational Publishing Engine

2 thoughts on “Assemble traceability documents from reusable building blocks”

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s