You can define Rational® Quality Manager as
a data source in Rational Publishing Engine.
Data is extracted using the Rational Quality Manager REST
API. This interface is installed and implemented by the application
and works independently of Rational Publishing Engine.
Tip: Rational Publishing Engine comes
with 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.
Before you begin
- Get familiar with the Rational Quality Manager REST
service and the various URLs needed to extract data from Rational Quality Manager using Rational Publishing Engine.
See Rational Quality Manager REST
API documentation.
- Connect to a data source schema. See Adding a data source schema.
- Schema can be on the local file system. For example, https://server:port/jazz/service/com.ibm.rqm.integration.service.IntegrationService/schema/feed.xsd is
a schema file that uses the feed argument. You can
use this schema to add specific data pieces, such as test case details
or test scripts, from your Rational Quality Manager project
or to access a single resource with a known URL.
- If you are using the REST v2 APIs to generate
the document, you must provide a data source schema URL to the service
provider rather than to the root entry. Example:
- Incorrect: https://server:port/qm/oslc_qm/catalog
- Correct: https://server:port/qm/oslc_qm/catalog/repository/db/schema_repository/
You can use the elements in the data source schema to add queries
in your template. These queries specify which pieces of information
are generated in the report.To ensure that you are receiving a
complete list of returns from a Rational Quality Manager feed
data source, you must set the schema type as Generic XML and add ?abbreviate=false to
the end of the URI. Example: https://rqmserver:9443/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE
Banking (Quality Management)/testcase?abbreviate=false
- After you connect to the data source schema, you can create or
import a template design. With Rational Publishing Engine Document
Studio, you can build a report template design. This design determines
the layout of the report. See Authoring templates with Document Studio.
- Plan the structure of your document and define the content to
extract data. See Designing document templates to
get an overview of the template development process. For large documents
you can create separate templates for each document block.
- 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.
See Template elements in the Palette view for more details.
- Use queries, attributes and variables to
add data to the template.
- You can use the Data Source Configuration element to define some
properties that are not known at run time. See Adding a data source configuration element. For example, a qm data
schema is set dynamically based on the feed data
schema. You always use this schema and dynamically configure it for
specific pieces of data in your template from your Rational Quality Manager project.
- You can use filters, which are more specific 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 Rational Quality Manager repository
during report generation. These filters must be broad enough to retrieve
all of the necessary data referenced by the template or the generated
report does not contain complete data. See Extracting data with a Rational Publishing Engine filter.
- After you create the report template and populate it with Rational Quality Manager data
points, you can generate a report in various formats. When you generate
a report, you must connect to the data source that contains the information
about which you want to run the report. You specify a URI that points
to the Rational Quality Manager repository
that contains the relevant data. To point to the relevant data, see Connecting to a data source.
Note: For
the IBM Rational Quality Manager OSLC
API, by default, if no accept header is specified in the document
specification, Rational Quality Manager returns
the HTML representation of the resources. You must set the accept
header to application/xml to get the XML data.
- If data source schemas are added to a template after
the template is assigned to a document specification, the document
specification becomes out of sync. You can manually
synchronize the document specification or select a preference
option to automatically synchronize the document specification with
the current template. See Setting the document design preferences for information about how to set
the Keep Document Specification synchronized with the current
Template? preference.
- Before you publish your document, see the Specifying output properties topic
for more information about the available output options that you can
choose from and which one is best to use for the elements you are
using in your template.
- You are now ready to publish your document. See Generating a document.