You can define IBM® Rational® ClearCase® as
a data source in IBM Rational Publishing Engine
Before you begin
- Get familiar with Rational ClearCase and
the various URLs needed to extract data from Rational ClearCase when
you are using Rational Publishing Engine.
To locate the information center for your version of Rational ClearCase,
see About the Rational ClearCase information
center.
- Connect to a data source schema. See Adding a data source schema.
- Schema can be on the local file system. Use the REST schema discovery
to create a data source schema. 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. For example: https://server:port/service/cc/testcase/trace?metadata=schema.
- You can use the elements in the data source schema to add queries
in your template. These queries specify what pieces of information
are generated in the report. See Adding a REST data source schema with the schema discovery wizard.
- After you connect to the data source schema, you can create or
import a template design. With the 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.
- 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 ClearCase repository
during report generation. These filters must be broad enough to retrieve
all of 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 ClearCase data
points, you can generate a report in various formats. When you generate
a report, you must be connected connect 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.