Sample assets in RPE Document Builder

Out-of-the-box sample assets have been available in the Rational Publishing Engine (RPE) Desktop installation of RPE Document Studio and RPE Launcher for many versions. These sample assets are now included within RPE Document Builder 2.1.1.

Find details at https://jazz.net/blog/index.php/2017/01/19/sample-assets-in-rational-publishing-engine-document-builder/

 

Understanding type of the model from DM

While building a cross product template from DNG to Design manager, the derived by attribute links to model diagram from Design Manager. How do you know whether it is a use case diagram or sequence diagram or something else?

If you make a GET request to DM model OSLC  / permanent URL (https://server:9443/dm/models/_Eea40KY8EeWtTLergOJe7g~OLDID__6018453__1) with Accept header as application/rdf+xml, you get OSLC representation of the resource. Looking at RDF/Description/type@resource attribute mentions whether the model is a use case or sequence diagram or etc. Continue reading “Understanding type of the model from DM”

Studio Integrated with 2.1 Web application

RPE Studio 2.1 could now access assets from RPE 2.1 Document Builder (Web Services). The templates, snippets and stylesheets from 2.1 web services are available in Studio 2.1. The “Load From Library” in Open Template dialog lists templates and snippets, which could be view, modified and saved back to the web app.

The remote services preference setting is similar to how remote services 1.x were configured. However, the service URL should be pointed to RPE 2.1 web service URL. Find complete documentation here. Continue reading “Studio Integrated with 2.1 Web application”

RPE 2.1 – “Multumesc”

I’m happy to announce RPE 2.1, codename Multumesc, has been made generally available today. With this release we continued on the path we started in RPE 2.0 around simplifying the user experience with RPE. While with 2.0 and 2.0.1 we focused on administrators and end users with 2.1 our focus are template designers:

  1. Interactive Guides – new designers will be walked through the design process
  2. Drag&Drop for quick template design– drop your resource URL from the Browser in document studio and RPE will create a starting template for you
  3. Simplified CLM traceability – with the POX profile you no longer need to manipulate URLs to transform between OSLC and REST API.
  4. Word Import – use Word documents as the starting point of your template. RPE will convert the structure and a subset of the formatting into an RPE template
  5. Java Script Reuse – you can now define code modules inside a template and reuse the functions defined there everywhere else in the template.

This and much more is described in https://www.ibm.com/support/knowledgecenter/SS6RHZ_2.1.0/com.ibm.rational.pe.overview.doc/topics/c_whats_new_21.html and will be further discussed here.

The team even put together videos to show some of the new features https://www.youtube.com/playlist?list=PLZGO0qYNSD4UtXl3xXGsL1hhumg0s8m9i

Kudos to the RPE team and to all of you that helped us define and refine these features.

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”