You can use Rational® Publishing Engine Document
Studio to create a report template, load the schemas for the data
types to report on, and design the layout for the report by using
the palette tools. A report template has .dta as
a file name extension. 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. You must know which Rational Rhapsody® models
that you want to report on, and be a member of the Design Management
projects that contain the models to report on.
You can add
a schema for a Rational Rhapsody model
to an existing data schema. For example, if you have already created
a template that contains the data sources for comments and links,
you might use that template.
Procedure
- Complete one of the following steps:
- In Rational Publishing Engine Document
Studio, in the RPE Studio perspective, click .
- Open an existing reporting template, for example, you
might use a template the contains collaboration schemas for comments
and linking.
- Import the schema for a type of resource: Click , and complete
the pages in the wizard:
- 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.
- 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.
- 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.
- On the resource page, in the /AdaptorName column,
click rhapsody, and click Next. On the schema page, the schema to discover Jazz™ projects is displayed.
- On the schema page, in the "XML schema" pane, expand the
navigation and select a project from the project list. 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. The list
of available Jazz project areas
is displayed.
- On the resource page, select a project area and click Next. On the schema page, the schema to discover Rhapsody models in a specific Jazz project area is displayed.
- On the schema page, in the "XML schema" pane, expand the
navigation and click rhapsody/ModelList/Model.
In the "Element attributes" pane, select the name check
box and any other attributes that you want to display about a model;
then click Next. On the resource
page, a list of models is displayed.
- On the resource page, after you
select a resource, complete one of the following steps:
- Click .
Results
In
Rational Publishing Engine,
check the Console view for errors. You can now customize the template
to create the report layout by dragging elements from the palette
to the template in the template editor.
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.
For
more information about using the REST Schema Discovery wizard to find
resources in a Design Management application, in the Design Management
reporting tutorial, see the "REST Discovery Wizard" section.
After
you add controls from the palette, including containers, paragraphs,
and text fields, to the report template, you can associate properties
from the data source schemas with the controls in the template.
After
you customize the template, you can generate reports.