Before you can generate a report, you must use the Rational® Publishing Engine Launcher
application to create a configuration file, also known as a document
specification file, that specifies the data sources and templates
to use to generate a report, and the output formats of the report.
A document specification file has .dsx as a file
name extension.
Before you begin
In Rational Publishing Engine Document
Studio, you must create a report template and import at least one
data source schema. A report template has .dta as
a file name extension.
Procedure
- In Rational Publishing Engine Document
Studio, open RPE Launcher perspective: Near the
main toolbar, click RPE Launcher.
- If a document specification is not already open, click , browse to a .dsx file, and click Open.
- In the Document Specification view, in the Output hierarchy,
delete the output formats that you do not want to generate: Right-click
a Target:format_name item and click Delete
Output. Although only one format is required,
typically both HTML and Microsoft Word
are generated.
- Configure the remaining output formats: Right-click the
format name and in the Configure HTML Output window,
specify values for the fields. For more information about setting
values for the specific output formats, see the link to the related
"Specifying output formats" task topic at the end of this topic. The values that you specify are displayed in the Properties
view.
Tip: You can also edit the values directly in the
Properties view.
- Configure the path to the report template (.dta)
file: In the Document Specification view, in
the Templates hierarchy, expand Templates,
and verify the path to the report template file. To change the path
name, right-click the template name and select an option from the
pop-up menu.
- For each template, configure associated data sources: In
the Templates hierarchy, expand Data sources;
then right-click a Data source: element and
click Configure Data Source.
- In the Configure Data Source window,
complete the following fields:
- URL: Specify the URL to the REST
resource on which you are reporting. If you do not have the URL, click Discover to
start the REST Discovery wizard so that you can locate the resource. *****All Design Management data sources must have a user name
and password specified. Data sources that are dynamically configured
by the template using a Data Source Configuration control do not require
an URL to be specified. The URL for non-dynamic data sources should
specify one or more Design Management resources based on the Design
Management reporting service URL. This URL can also be specified using
the REST discovery wizard in the Rational Publishing Engine Launcher
application
- Required: User and Password:
You must specify login credentials for each Design Management data
source, even those data sources that are dynamically configured at
report generation time.
If this document specification
is shared with other users, you might want to leave the credentials
fields empty. If you do not specify credentials and then run a report
by using the document specification, you are prompted for credentials.
- Click the Documentation Specification perspective,
then click , and specify a destination for the document specification.
Example
For an example of how to create and configure a document
specification file, complete Lesson 1 of the Design Management reporting
tutorial. See the related link at the end of this topic.
What to do next
After you create a document specification file, you can generate
Design Management reports.