IBM Support

How to modify HTML Exporter template to include diagrams located under classes in IBM Rational Rhapsody ReporterPLUS

Question & Answer


Question

How do you modify HTML Exporter template to include diagrams located under classes in IBM Rational Rhapsody ReporterPLUS?

Cause

You have found that the HTML Exporter template does not show Object Model Diagrams under any classes in your project.

Your Project:Your Generated ReporterPLUS HTML Exporter Report:

Answer

You need to do two things to get this working:

  1. Enable LoadElementReferences option in ReporterPLUS so that the extra Object Model Diagrams are loaded
  2. Add extra nodes to the existing HTML Exporter template to include the Object Model Diagrams in the report.

Enabling LoadElementReferences

You can do this by adding the following section to your rhapsody.ini:

[ReporterPLUS]
EnableLoadOptions=True
LoadElementReferences=True




Depending on your installation setup and environment, your rhapsody.ini file can be found in one of the following locations:
  • C:/IBM/Rational/Rhapsody
  • C:/Users/<user name>/IBM/Rational/Rhapsody
  • C:/ProgramData/IBM/Rational
You will need to restart Rhapsody and ReporterPLUS to effect changes.

Adding Object Model Diagram Node to template

  • Once you have enabled this option the references should be visible in the ReporterPLUS model browser.


  • You can then add an extra node to the "Print project package documentation" -> "Print class package documentation" node.
    You can copy the "Print structure diagram documentation" node as an example and paste it in to this location.
  • Next you need to modify this copied node. In the Iteration tab, the Association should be set to "references"
    and in the Condition tab, the condition should be set to to metaclass=ObjectModelDiagram.


  • You can also do the same for the "Print nested class documentation" node lower down.
You should now see diagrams in your HTML report for both classes.



Due to the large size of the HTML Exporter template, please contact Rhapsody support for an example template.

[{"Product":{"code":"SSB2MU","label":"IBM Engineering Systems Design Rhapsody"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":"General Information","Platform":[{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"8.0;8.0.1;8.0.2;8.0.3;8.0.4;8.0.5;8.0.6;8.1;8.1.1;8.1.2;8.1.2.1;8.1.3;8.1.4;8.1.5;8.2","Edition":"","Line of Business":{"code":"LOB59","label":"Sustainability Software"}}]

Product Synonym

Rational Rhapsody

Document Information

Modified date:
27 May 2022

UID

swg22002239