Discovering schemas for links and comments

For any element in a Rational® Rhapsody® model, you can add comment and linking information to a report. To report on comments and links, you must add the corresponding schema to a report template that you create by using Rational Publishing Engine Document Studio. This content applies to version 7.6.1 or later.

Before you begin

You must have Rational Publishing Engine Document Studio version 1.1.2 or later open, and you must be in the RPE Studio perspective.

About this task

A report template has .dta as a filename extension.

Comment and linking information for a Rational Rhapsody model is managed by the Design Management Server.

Procedure

  1. If a reporting template does not already exist, in Rational Publishing Engine Document Studio, in the RPE Studio perspective, click File > New > Document Template.
  2. Click Data > Schema Discovery > REST Schema Discovery, and complete the pages in the wizard:
    1. On the Base Configuration page, specify values for the following fields:
      • Name: Specify a name that identifies the type of schema being returned. For example, if you are importing the Rhapsody model schema, you might specify Rhapsody Model Schema in this field. You can also edit this schema name in the Outline view of the editor.
      • Base URL: Specify a URL that includes the Design Management application host name and port, and its reporting service, as in the following example: https://fully_qualified_host_name:9443/dm/reporting
      • Authentication type: From the list, select OAuth.
      • User and Password: Specify the user name and password that grant access to the resources in the Design Management application.
    2. Click Next.

    The Locate Resource Using Data Service page, also known as the schema page, shows the schemas for reporting adaptors that exist at the base URL.

  3. On the schema page, in the "XML schema" pane, expand the navigation and select the Adaptor element. In the "Element attributes" pane, select the AdaptorName check box and any other attributes that you want to display about a resource; then click Next. On the Select Resource URL Discovered By Data Service page, also known as the resource page, a list of available adaptors is displayed. For the base reporting service URL, the resources correspond to the logical domains to group the related meta-models.
  4. On the resource page, in the /AdaptorName column, click collaboration, and click Next. On the schema page, the collaboration type schemas are displayed.
  5. On the schema page, in the "XML schema" pane, expand the navigation and select the Type element. In the "Element attributes" pane, select the name check box and any other attributes that you want to display about a resource; then click Next.
  6. On the resource page, in the /name column, click comment; then click Finish.
  7. Repeat steps 2 to 6 to discover the link data source. In step 6, in the /name column, click Link.

Results

A report template is created. When you open a template in the RPE Studio perspective, a default document specification is created for that template. This document specification can either be modified and saved, or you can open a different document specification file. You can now discover and configure a schema for a Rational Rhapsody model, add it to the template, and then generate a report.

For more information about how to extract Rational Rhapsody Design Management data, complete lesson 11 of the Design Management reporting tutorial. See the related link at the end of this topic.

Hidden content

Nav and search titles

Index entries

This topic does not contain 'alt' text.