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”

Rational Publishing Engine (v2.0) for Rhapsody – Training

Andy Lapping has published a fantastic training material for using Rational Publishing Engine with Rational Rhapsody on https://ibm.app.box.com/s/w2wti775zkn25uxzh2io7yixkgraz4wi

This is one the best,  if not the best, education material I’ve seen for RPE and Rhapsody and it adds to Andy’s already long list of contributions to RPE. @Andy – thank you so much for all the help.

rpe_rhapsody

The training gives an introduction to RPE and continues with basic concepts before elaborating on advanced techniques. Everything is beautify explained and the concepts are introduced incrementally in a way that it is easy to follow and understand.

Introduction

  1. Overview of Rational Publishing Engine

Basic Techniques

  1. Creating Basic Templates for Rhapsody
  2. Formatting in RPE
  3. Filtering and Conditions
  4. Bookmarks and Hyperlinks
  5. Debugging Templates
  6. Creating Advanced Templates for Rhapsody
  7. RPE in a Jazz Environment
  8. Troubleshooting

Advanced Techniques

  1. Recursing Through Rhapsody Project Structures
  2. Variables and ‘Looking Down the Tree’
  3. Casting
  4. Reporting on Multiple Rhapsody Projects

Adding Quality Management data to the traceability mix

Continuing the Assemble traceability documents from reusable building blocks I want now to add QM data in the mix. I will be using the same DM model as a starting point and I will follow links to QM Test Cases.

dm_qm_step1
As you read this I  recommend also going through Geoff Rosenthal’s the excellent Rational solution for Collaborative Lifecycle Management Traceability Templates with Rational Publishing Engine tutorial.

The artefacts for this tutorial are available on the Unclassified & Cross Domain Templates section of the RPE Wiki Community at #15  DM to CLM Traceability.

Getting the DM link information is already covered in  Assemble traceability documents from reusable building blocks so I will skip it here. This article starts from the point where you have your DM and DM link data in place in your template.

How QM linking works

But before I go there I want to explain how QM linking works and what are the various schemas you will encounter in the process.

QM, just like all the other CLM products has an OSLC API that is used for linking. A QM Test Case will be referenced from another product using a URL that looks like this:

https://giediprime:9443/qm/oslc_qm/contexts/_cmIwsHceEeW6EPQMMno5Bw/resources/com.ibm.rqm.planning.VersionedTestCase/_sF1Y4XceEeW6EPQMMno5Bw

For the example I am presenting you can get these URLs from the link page of the DM artifact.  And if you access these URLs from a tool like Poster and specify “application/xml” for the “accept” header you can see the data available. One thing you will notice is that even though the data is not in the form you are used to when reporting on QM with RPE which is the QM’s Reportable REST API.

dm_qm_step6

Unlike DNG there is no way to convert from the RQM OSLC v2 URL to the Reportable REST URL but for QM the OSLC representation of the QM artifact contains the link to the RQM Reportable REST URL.

So to get from the OSLC URL to the Reportable REST URL you firsy need to access the OSLC resource, read the Reportable REST URL and then accesses the data there.

How QM linking works – TL;DR version

When you want to access linked QM data you need to:

  1. access the OSLC representation of the artifact
    • you need to use RPE’s Reportate REST v2 schema discovery to find the schema form QM’s OSLC representation. The starting point for the schema discovery process is https://server:port/qm/oslc_qm/catalog
  2. read the URL to the Reportable REST representation of the QM artefact
  3. access the Reportable representation of the artefact
  4. Use the data as needed

Suggested reading:

  1. RQM OSLC v2 REST API – for linking data
  2. RQM Reportable REST API – for document generation

Get linked QM Data from DM

  1. Insert the QM_TC_Snippet.dta in the indicated position
  2. Edit the condition on the QM Container such that you are only processing QM Data. I have used the “link type” property  to only accept “Validated By” links
    dm_qm_step2
  3. Connect the QM snippet to your template by specifying
    1. A data source to have the QM_OSLC_TC inherit from
      dm_qm_step3
    2. The data property that holds the OSLC QM URL
      dm_qm_step4
  4. Make a test run to verify all the pieces fit together. Just like with the RTC example you only need to specify the entry point and credentials for accessing the DM UML project.
    dm_qm_step5

NOTE: You will need to replace the QM schema from my snippet with your particular QM schema so that you can use the custom attributes defined in your particular QM instance.

Conclusion

You now have 2 RPE snippets for accessing RTC and QM linked data that you can reuse in your traceability documents. I recommend evaluating your existing templates to identify other sections in your templates that you use on a regular basis and transform them in reusable snippets.

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”

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.