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

Install Design Manager and CLM

  1. Download DM from jazz.net: https://jazz.net/downloads/design-management/
  2. Install DM and CLM using the wizard
  3. Start your local Jazz server using “Start Jazz Server” in Windows start menu.
  4. Follow the Express Setup http://www-01.ibm.com/support/knowledgecenter/SSYMRC_5.0.2/com.ibm.jazz.install.doc/topics/t_running_express_setup.html?lang=en

Create the Rational Rhapsody Example model

With DM up and running you need some data to test with. If you have data you can skip this part. For a fresh installation the Rational Rhapsody Example model that ships with DM is a a quick way to get you started.

  1. Open https://giediprime:9443/jts/admin in your browser.
    dmAdministration
  2. Select “Manage All Project Areas” from the left side menu
  3. Select “Rational Rhapsody Sample” from the top menu to create the example project
    dmRationalRhapsodySample
  4. Navigate to the project dashboard using the Home button on the left side of your screen
    dmAdministrationGotoProject
  5. Explore the available data using the Design->Explore menu
    dmDesignExplorer

Find the DM schema

The next step is to create the RPE template and for that you need the schema of the data . Unlike DNG, QM or RTC the DM schema is not fixed in the sense there is not a single URL that you can use at all times. Instead you need to “discover” the schema for each of your projects.

  1. Open Document Studio and create a new template
  2. From the “Data” menu select the “Schema Discovery -> REST Schema Discovery”
    dmRestSchemaDsicovery
  3. In the Base URL enter https://<server&gt;:<port>/dm/reporting. In my case the URL is https://giediprime:9443/dm/reporting .
    dmRestSchemaDiscovery_Base
  4. Enter your credentials.
  5. Next you need to select the DM configuration to use. Click on the “Select DM Configuration” button. You must have the credentials in place.
    dmRestSchemaDiscovery_Configuration
  6. Replace the placeholder server:port with your server name and port and click load. Select the project you want from the list.
    dmRestSchemaDiscovery_ConfigurationList
  7. NOTE: for DM 6.0 and newer you need to update the label and value properties by removing workspaces/Worskpace as shown below.
    dmSelectConfiguration_60
  8. Click OK to return to the main schema discovery dialog.The Base URL is now modified to include the context information you have selected.
    dmRestSchemaDiscovery_ProjectContext

Schema discovery – selecting the type you need

At this point you are all set to discover the schema for the artifact you need. The RPE Schema Discovery wizard will guide you through the process in a sequence of screens that ask you to choose from metadata and concrete instance data.

The Finish button is enabled when the wizard shows instance data. Typically you will get through multiple screens before getting to the schema you need.

  1. Metadata
    dmRestSchemaDiscovery_Metadata_1
  2. Instance data
    dmRestSchemaDiscovery_Instancedata_1
  3. Continue as much as needed. For UML models the Project type is usually the target
  4. Metadata for the UML profile/domain
    dmRestSchemaDiscovery_Metadata_2
  5. Instance data – the types in the UML profile/domain
    dmRestSchemaDiscovery_Instancedata_2
  6. Click Finish to get the schema added in the template

TIP: if you look in the RPE console window you will notice a message like the one listed below. Copy the URL and remove the &metadata=schema part from it. This is the URL you need to use to configure your report with.

CRRPE2026I The schema was downloaded from https://giediprime:9443/dm/reporting/rhapsody/uml/Project?project=Rhapsody+Sample+Project&workspace=Rhapsody+Sample+Project+1&rmps.context=https%3A%2F%2Fgiediprime%3A9443%2Fdm%2Fstreams%2F11&metadata=schema.

Your first DM document

Everything is now in place to produce your first DM documen. I have chosen to print the project’s name and the top level packages.

  1. test templatedmBasicTemplate
  2. Configure the report with the URL mentioned in step #6 above
  3. The output
    dmBasicTemplate_Output

That’s about it. I hope this will help you start creating documents from Design Manager with RPE.

Advertisements

Author: Dragos Cojocari

Architect for Rational Publishing Engine

Leave a Reply

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

WordPress.com Logo

You are commenting using your WordPress.com 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