Report designers can use Document Studio
to import data source schemas and build report templates.
The capabilities that are provided by the
Requirements Management (RM) application are licensed as IBM® Rational® DOORS® Next
Generation.
The information about the RM application integration applies to Rational DOORS Next Generation and
to specific versions of IBM Rational Requirements Composer.
Before you begin
Tip: The
Rational Publishing Engine installation
includes a set of sample reports. Before you begin to publish documents,
you can explore this example document generation scenario. See
Creating the REST sample template.
Get
familiar with the RM application REST service and the various URLs
needed in order to extract data from the RM application when you are
using
Rational Publishing Engine.
To locate the information center for your version of the RM application,
see
About the Rational Requirements Composer information
center.
About this task
Data is extracted by using the REST API.
This interface is installed and implemented with the data source application
and works independently of
Rational Publishing Engine.
For more information about the REST API for a data source, see the
documentation for that data source.
Procedure
- Review Designing document templates for
an overview of the template development process. Start
planning the structure of your document and the data that might be
included. For example, decide whether the final document
will be generated from one template or from multiple template files
that each contain reusable pieces of content.
- In the Document Studio application,
create a document template.
- Identify a data source schema from your data
source. To add specific data pieces from your RM application project,
enter the URL in this format:
- https://server:port/rm/publish/artifact
Example:- https://server:port/rm/publish/resources
- Add a data source schema to your document
template. For the RM application, you can complete the following steps:
- In Document Studio, click .
- In Type,
select the type of the schema from the list. For the RM application, select Generic XML.
- In Schema file field, paste in
the URL you identified as the data source schema.
- Append ?metadata=schema to the
end of the URL.
- Example: https://server:port/rm/publish/artifact?metadata=schema
- If the resource is in a secured server, specify
the User name.
- If the resource is in a secured server,
specify the Password.
- Select the Authentication
Type from the list. For the RM application, the authentication type is OAuth.
If you do not select OAuth, each authentication
type is tested until the correct type is found, which might increase
document generation time.
- Add elements to the template. Rational Publishing Engine has
a comprehensive set of template elements that you can use to structure
your document. You can drag elements into the template content editor.
For example, you can add a Container element to hold several paragraphs.
Each paragraph might be controlled by a test condition that associates
it only with specific data. For more information, see Template elements in the Palette view and Adding elements to a template.
- Table elements
- When table data is input from the RM application, widths must
be specified at the column level, as in for each cell, and not at
the table level to be processed by Rational Publishing Engine.
- Use queries, attributes,
and variables to
add data to a template. These items specify which pieces of information
are generated in the report.
- Add formatting and styling to the
elements to control how they display in the output.
- Create filters to narrow the data that
is pulled into the report. You can use
filters, which are detailed versions of the general data source URI,
to point to specific subsets of data so that Rational Publishing Engine does
not attempt to retrieve more information than necessary from the data
source during report generation. These filters must be broad enough
to retrieve all necessary data referenced by the template or the generated
report cannot include complete data. See Rational Requirements Composer data
sources for more information.
- Create sorts to organize the data in
your report.