Designing templates with DOORS Web Access as a data source

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

Procedure

  1. Review Designing document templates for an overview of the template development process.
    Start planning the structure of your document-style report and the data that might be included.
    For example, decide whether the final document-style report will be generated from one template or from multiple template files that each contain reusable pieces of content.
  2. In Document Studio, Create a document template.
  3. Identify a data source schema from your data source.
    To add specific data pieces from a collection from IBM Engineering Requirements Management DOORS - Web Access (DWA) or to access a single resource with a known URL, right-click an object URL from an open module and click Copy URL. You always use this schema and dynamically configure it for specific pieces of data in your template from DOORS Web Access.
    • Example: https://server:port/dwa/rm/urn:rational::object_number
  4. Add a data source schema to your document template.
    For DWA, you can complete the following steps:
    1. In Document Studio, click Data > Add Data Source .
    2. In the Predefined field, select the Doors database schema.
    3. In Type, select the type of the schema from the list.
      For DWA, select Generic XML.
    4. Edit the Schema field if needed or click Browse to select the path for the schema file.
    5. If the resource is on a secured server, specify the User name.
    6. If the resource is on a secured server, specify the Password.
    7. Select the Authentication Type from the list.
      For DWA, the authentication type is OAuth-OSLC. If you do not select OAuth-OSLC, each authentication type is tested until the correct type is found, which might increase document-style report generation time.
  5. Add elements to the template.
    The product includes a comprehensive set of template elements that you can use to structure your document-style report. 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 Engineering Publishing ( PUB) does not try 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.