Report designers can use Document Studio
to import data source schemas and build report templates.
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 a collection from Rational® DOORS® Web
Access or to access a single resource with a known URL, right-click
an object URL from an open module and click Copy URL.
You always use this schema and dynamically configure it for specific
pieces of data in your template from Rational DOORS Web
Access.
- Example: https://server:port/dwa/rm/urn:rational::object_number
- Add a data source schema to your document
template. For Rational DOORS Web
Access, you can complete the following steps:
- In Document Studio, click .
- In Schema type,
select the type of the schema from the list. For Rational DOORS Web
Access, select Generic XML.
- In Schema file field, paste in
the URL you identified as the data source schema.
- In the Data Source
ID field, type a name for the data source in the template. Click Next.
- 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 Rational DOORS Web
Access, the authentication type is OAuth-OSLC.
If you do not select OAuth-OSLC, 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.
- 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.
- Create sorts to organize the data in
your report.