Designing templates with Rational Quality Manager as a data source

Report designers can use Document Studio to import data source schemas and build report templates.

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.

About this task

Data is extracted by using the REST API. This interface is installed and implemented with the data source application and works independently of Rational Publishing Engine. For more information about the REST API for a data source, see the documentation for that data source.


  1. Review Designing document templates for an overview of the template development process.
    Start planning the structure of your document and the data that might be included.
    For example, decide whether the final document will be generated from one template or from multiple template files that each contain reusable pieces of content.
  2. In the Document Studio application, create a document template.
  3. Identify a data source schema from your data source.
    • To add specific data pieces from a collection, such as test case details or test scripts, from your Rational Quality Manager project or to access a single resource with a known URL, construct a URL that uses the feed argument. You always use this schema and dynamically configure it for specific pieces of data in your template from your Rational Quality Manager project.
      • Example: https://server:port/qm/service/
    • To add specific data pieces from an individual resource, such as test case details or test scripts, from your Rational Quality Manager project or to access a single resource with a known URL, construct a URL that uses the qm argument:
      • Example: https://server:port/qm/service/
    • 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/
  4. Add a data source schema to your document template.
    For Rational Quality Manager, you can complete the following steps:
    1. In Document Studio, click Data > Add Data Source Schema.
    2. In the Predefined field, select one of the RQM schemas.
    3. In Type, select the type of the schema from the list.
      For Rational Quality Manager, select Generic XML.
    4. Edit the Schema field if needed or click Browse to select the path for the schema file.
      (POX profile only) For CLM 6.0.2 and later, copy the link for the artifact from your browser and then paste the URL in the Schema field .
    5. Append the following text to the end of the URL:
      • ?abbreviate=false
      • (POX profile only - CLM 6.0.2 and later) &metadata=schema
      • Example: https://server:port/qm/service/ Banking (Quality Management)/testcase?abbreviate=false
    6. If the resource is in a secured server, specify the User name.
    7. If the resource is in a secured server, specify the Password.
    8. Select the Authentication Type from the list.
      For Rational Quality Manager, you can use authentication types of Form, Basic or OAuth.
      Note: When Collaborative Lifecycle Management (CLM) applications are enabled with SSO (single sign-on) authentication by using Jazz Security Architecture, you must set the authentication method to Basic when configuring the data source for the CLM applications in Launcher or in Document Builder.
    9. (POX profile only - for CLM 6.0.2 and later) In the Extra headers field, select the POX profile header. For more information about the POX profile, see Creating traceability documents from CLM applications using the POX profile.
    10. Click Next and then Finish.
  5. Add elements to the template.
    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. For example, you can add a Container element to hold several paragraphs. Each paragraph might be controlled by a test condition that associates it only with specific data. For more information, see Template elements in the Palette view and Adding elements to a template.
  6. Use queries, attributes, and variables to add data to a template. These items specify which pieces of information are generated in the report.
  7. Add formatting and styling to the elements to control how they display in the output.
  8. Create filters to narrow the data that is pulled into the report.
    You can use filters, which are detailed 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 data source during report generation. These filters must be broad enough to retrieve all necessary data referenced by the template or the generated report cannot include complete data.
  9. Create sorts to organize the data in your report.