Define IBM® Rational® ClearQuest® as a data source in Rational Publishing Engine
Note: Make sure that you have installed and deployed
Rational Publishing Engine Data Services with the
Rational ClearQuest adapter. See
Deploying Data Services.
- Get familiar with the Rational ClearQuest REST service and the various URLs needed in order to
extract data from Rational ClearQuest using Rational Publishing Engine. See Rational ClearQuest infocenter.
- Connect to a data source schema. See Adding 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 start URL that can be used to discover schema is https://server:port/DataServices/ClearQuest. See Creating REST data source schema.
- Use 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” at the end of the URI. A typical URI is structured
like this: https://server:port-number/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 Creating REST data source schema.
Note: With this approach, Rational Publishing Engine does not need Rational Data Services. It can directly
discover schema from Rational ClearQuestby 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. Please note, set HTTP headers OSLC-Core-Version to 2.0 and accept to application/rdf+xml. From
the returned result, it is easy to find ServiceProvider URL rdf:about.
You can use the elements in the data source schema to add queries
in your template. These queries specify what pieces of information
are ultimately generated in the report.
- Once you have connected 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. Designing documents.
- Plan the structure of your document and define the content to
extract data. See Template development process to get an overview of the template development process. For
very 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 necessary data referenced by the template
or the generated report will be incomplete. See Extracting data using native filters.
- Once you have finished creating the report template and populating
it with Rational ClearQuest data points, you can generate a report in a variety of
formats. When you generate a report, you must connect to the data
source that contains the information on which you want to run the
report. To point to the relevant data, see Assigning values in document specification file.
- Before you publish your document, see this topic Set the output format to understand the available output
options that you can choose from.