You can define IBM® Rational® ClearQuest® as
a data source in IBM Rational Publishing Engine.
Before you begin
- Get familiar with the Rational ClearQuest
REST service and the various URLs needed to extract data from Rational ClearQuest using Rational Publishing Engine.
See About the Rational ClearQuest information
center.
- Connect to a data source schema. See Adding a data source schema.
- Schema can be on the local file system. Rational Publishing Engine uses Rational Data Services to discover
schema and query data. The URL that can be used to discover schema
is https://server:port/DataServices/ClearQuest.
See Adding a REST data source schema with the schema discovery wizard.
- Schema can be any URI that is accessible from the computer. You
can construct a URL that points to the data source schema. Open your
data source schema and, from the XML file, take the URI for a particular
resource. Add ?metadata=schema to the end of
the URI. Example: https://server:port/service/cq/records/defects?metadata=schema.
- For latest versions of Rational ClearQuest,
you can also use the REST v2 Schema Discovery to create a data source
schema. See Adding a REST data source schema with the schema discovery wizard.
Note: With
the REST v2 Schema Discovery, Rational Publishing Engine does
not need Rational Data
Services. Rational Publishing Engine can
discover schema from Rational ClearQuest by
REST v2 resource discovery started from a ServiceProvider URL.
Users can obtain the ServiceProvider URL by visiting Rational ClearQuest REST v2 ServiceCatalog URL,
like https://server:port/context/oslc.
Set HTTP headers OSLC-Core-Version to 2.0 and accept
to application/rdf+xml. From the returned result,
you can find the ServiceProvider URL rdf:about.
- 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/cqweb/oslc
- Correct: https://server:port/cqweb/oslc/repo/repository/db/schema_repository/
- 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. 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.
- 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 ClearQuest 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 include the complete set of data. See Extracting data using native filters.
- After you create the report template and populate it with Rational ClearQuest data
points, you can generate a report in various formats. When you generate
a report, you must be connected to the data source. To point to the
relevant data, see Connecting to a data source.
- 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.