Generating documents with Rational Quality Manager as a data source

After you finish creating the report template and populating it with data points, you can generate a report in various formats.

Procedure

  1. In either the Document Studio or the Launcher application, open the document generation wizard by clicking Document Specification > Generate > Configure and generate document.
  2. In the Templates section, the templates already listed in the document specification display. To add a template:
    1. Select the location of the templates to add:
      • From the central library: To select templates stored in the Central Management component
      • From local or remote file: To select a local or remote templates, you can either enter a URL to a template or click Browse to select a template.
    2. Select one or more template to add.
      • If you selected From the central library and selected templates from the Central Management component, click Add selected to add the templates to the document specification.
      • If you selected From local or remote file and entered a URL to an individual template, click Add URL to add the template to the document specification.
      • If you selected From local or remote file and browsed to add templates, when you click Open, the templates are added to the document specification.
    3. Optional: Repeat to add additional templates from other locations.
    4. Optional: Reorder the templates in the document specification by selecting a template and clicking Up or Down.
    5. Click Next.
  3. In the Data sources section, configure each data source.
    Note:
    • If a default value exists for a data source or a default URI value has already been entered, the data source displays as configured and the default value is used in the output unless another value is selected.
    • If you move past the Data sources section and then click Back to make additional changes to a data source, the section always opens to the first data source in the list.
    1. Select a data source from one of the following locations:
      • Manual configuration: To select a local or remote data source because no other configuration information exists for this data source in the configuration layer or Central Management component
      • Using data source values from the Central Library: To select a data source stored in the Central Management component
      • Load from Configuration Layer: To select a value from the configuration metadata that was entered for the data source in the template
    2. Depending on the selection you made in the previous step, you can either select a value for the data source by entering a URL, clicking Browse to select one, or select a value from the configuration layer. Whether the value is a URL or is a value contains a URL, the typical data source URL for Rational® Quality Manager can be determined by:
      1. Identify the data source schema URL, which was used to add the schema to the template.
      2. From the data source schema URL, remove the ?metadata=schema suffix. Example:
        • Data source schema URL: https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/feed.xsd?abbreviate=false
        • Data source URL: https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/feed.xsd.

      You are not required to use the same URL as the data source schema. You can point to a different Rational Quality Manager repository to access the data contained within it, because Rational Quality Manager repositories all use the same REST API.

    3. If the resource is in a secured server, specify the User name.
    4. If the resource is in a secured server, specify the Password.
    5. Select the Authentication Type from the list. For Rational Quality Manager, the authentication type is OAuth. If you do not select OAuth, each authentication type is tested until the correct type is found, which might increase document generation time.
    6. For the Accept header, enter application/xml.
      Note: For the IBM® Rational Quality Manager OSLC API, by default, if no accept header is specified in the document specification, Rational Quality Manager returns the HTML representation of the resources. You must set the accept header to application/xml to get the XML data.
    7. Optional: If you want to apply the credentials you entered to each data source, select the Apply these user name and password values to every configured and unconfigured data source option.
    8. Click Next
  4. In the Variables section, configure each variable.
    Note:
    • If a default value exists for a variable, the variable displays as configured and the default value is used in the output unless another value is selected.
    • If you move past the Variables section and then click Back to make additional changes to a variable, the section always opens to the first variable in the list.
    1. From the drop-down menu, select one of the following options:
      • Manual configuration: To enter any value for the variable because no other configuration information exists for this variable in the configuration layer or Central Management component
      • From Configuration Layer: To select a value from the configuration metadata you entered for the variable in your template
      • Using variable values from the central library: To select a variable stored in the Central Management component
    2. Enter or select a value for the configuration.
    3. Click Next.
  5. In the Output section, select the output types to generate:
    • Microsoft Word
    • PDF
    • HTML
    • XSL-FO
    • Legacy PDF
    1. Optional: For the Save location, click Browse to select a path to save the file for each output type. If the save location for the output is not specified, the file is generated in the temporary location.
    2. Optional: For the Style sheet, click Browse to select a style sheet to use for each output type while generating the output.
    3. Optional: Microsoft Word output only: For the Macro, enter the name of the macro that is contained within the style sheet.
    4. Optional: To enter additional metadata or configure other document properties that are not included in the wizard, click Edit metadata properties.
    5. Click Next.
  6. Verify that the template and output information in the summary window is correct.
  7. Select which action to take when you click Finish:
    • Run the document generation: Generates the output types you specified.
    • Run the document generation and close RPE: Generates the output types you specified and closes the Rational Publishing Engine application after you exit the Results window.
    • Close this wizard and open the RPE client: Opens the document specification with the details you entered in the Launcher application.

Feedback