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.
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 data types that you want to report
on, and be a member of the Design Management projects that contain
the resources to report on.
Procedure
- In Rational Publishing Engine Document
Studio, in the RPE Studio perspective, click .
- 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
schema for a UML package, you might specify Package 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 schema for displaying the resources
that exist at the base URL. If the base URL corresponds to the base
reporting service URL as provided in step 2.a, the schema for
selecting a reporting domain adaptor, such as bpmn, deploy, and uml,
is displayed.
- In the "XML schema" pane, select an
element from the XML schema navigation. In the "Element attributes"
pane, select the href check box and any other
attributes that you want to display about a resource, such as its
name; then click Next. The Select
Resource URL Discovered By Data Service page, also known as the resource
page, is displayed. This page displays the resources and their attributes
that correspond to the type schema that was shown in the previous
schema page. For the base reporting service URL, the resources correspond
to the logical domains to group the related meta-models.
- 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 use the items in the palette in a report, see the related links
at the end of this topic. Also, see the link to the Design Management
reporting tutorial at the end of this topic. In the tutorial, see
Lesson 1.
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.