Define IBM® Rational® Change as a data source
in 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
Explore the sample REST template.
- Get familiar with the Rational Change
REST service and the various URLs needed in order to extract data
from Rational Change using Rational Publishing Engine.
See the Rational Change
infocenter.
- Connect to a data source schema. See Adding data source schema.
- Schema can be on the local file system. For example, https://server
host:port/ibm/report/com.ibm.change.project.artifacts.xsd is
a schema file that uses artifacts argument. You
can use this schema to add specific data pieces from your Rational Change project.
- Or, 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 https://server
host:port/ibm/report/com.ibm.change.project.artifacts.xsd.
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. See 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.
- Rational Publishing Engine has
a comprehensive set of template elements that you can use to structure
your document. You need to simply drag and drop template elements
into the editor area. See Structuring the template for
more details.
- 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 Change 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've finished creating the report template and populating
it with Rational Change
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. You do this by
specifying a URI that points to the Rational System Architect repository
that contains 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.