Designing templates with Engineering Requirements Management DOORS Next as a data source

Report designers can use Document Studio to import data source schemas and build report templates. The capabilities that are provided by the Requirements Management (RM) application are licensed as IBM Engineering Requirements Management DOORS Next.

Before you begin

Get familiar with the RM application REST service and the various URLs needed in order to extract data from the RM application when you are using IBM Engineering Lifecycle Optimization - Publishing (PUB). To find the documentation for your version of the RM application, see the Engineering Requirements Management DOORS Next product 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 IBM Engineering Lifecycle Optimization - Publishing (PUB). For more information about the REST API for a data source, see the documentation for that data source.

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 your RM application project, enter the URL in this format:
    • https://server:port/rm/publish/artifact
    Example:
    • https://server:port/rm/publish/resources
  4. Add a data source schema to your document template.
    For the RM application, you can complete the following steps:
    1. In Document Studio, click Data > Add Data Source .
    2. In the Predefined field, select DOORS Next Text or DOORS Next Module.
    3. In Type, select the type of the schema from the list.
      For the RM application, select Generic XML.
    4. Edit the Schema field if needed or click Browse to select the path for the schema file.
      Example: https://server:port/rm/publish/artifact?metadata=schema.

      You can get the permanent link by clicking the Show Permalink icon at the end of the breadcrumb for the artifact in the RM application. You can see the URL in the Show Permalink window. Paste the URL into the Schema field and append &metadata=schema to the end of the URL.

    5. (POX profile only - for version 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 document-style reports from ELM applications using the POX profile.
    6. Click Next and then Finish.
    7. Select the Authentication Type from the list.
      For the RM application, 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-style report generation time.
      Note: When IBM Engineering Lifecycle Management (ELM) 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 ELM applications in Launcher or in Publishing Document Builder.
    8. If the resource is on a secured server, specify the User name.
    9. If the resource is on a secured server, specify the Password.
      Note: The user can specify the user password or the application password that is generated by the configured third-party identity provider, such as SAML or OIDC. User must select Basic authentication method while using application password.
  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.
    Table elements
    When table data is input from the RM application, widths must be specified at the column level, for each cell, and not at the table level to be processed by PUB when a document-style report is generated.
  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.