Generating traceability reports with Engineering Publishing

You can use IBM® Engineering Lifecycle Optimization - Publishing to generate reports of traceability between architecture elements and other artifacts such as DOORS Next requirements, using the model information that is stored on the Rhapsody® Model Manager server. Rhapsody Model Manager provides a traceability schema that you can use to build a template, and you can then include your template in a document specification that will be used to generate reports.

Procedure

  1. Open Engineering Publishing Document Studio.
  2. Create a new template.
  3. Import the Rhapsody Model Manager traceability schema:
    1. From the main menu, select Data > Add Data Source. The Add Data Source Schema Wizard is displayed.
    2. Set Type to Generic XML.
    3. For Schema, use the path https://<server name>:<port number>/ccm/reporting/rhapsody/ArchitectureElementStatistics.xsd
    4. For Authentication Type, select Oauth.
    5. Enter your user name and password.
    6. Click Finish.
    The schema is loaded.
  4. Use elements from the schema to design your template, and then save the template.
    Note: If you are including details from remote artifacts in your template, follow the steps for using the POX profile header, as described in Creating traceability documents from ELM applications using the POX profile.
  5. Click the Engineering Publishing Launcher tab.
  6. In the Document Specification pane, select Metadata.
  7. In the Properties section below the Document Specification pane, set the value of Ignore Data Source Configuration Errors to true. This will prevent failure of document generation due to invalid links.
    Ignore data source configuration errors
  8. In the Document Specification pane, right-click the data source below your template to open the pop-up menu.
  9. Select Configure Data Source.... The Configure XML Data Source window is displayed.
    Configure REST Data Source window in Engineering Publishing
  10. For the URL field, enter <serverUri>/ccm/reporting/rhapsody/ArchitectureElementStatistics, and add the following parameters:
    • the ID of the relevant project: projectId=<the ID for the project>. To get the ID of the project, go to the Administration page for the relevant project area, and from the address bar copy the value of the itemId parameter, for example, itemId=_T2Y4oe4lEeizDNiRY9kKBg
    • a parameter for the scope, using one of the following options:
      • for a Rhapsody Model Manager project area: projectName=<name of project area>
      • for a Rhapsody Model Manager component: componentName=<name of component>
      • for specific architecture element (for example, package) and its aggregates: resourceScope=<resourceUri>. To find the URI:
        • Navigate to the page for the relevant architecture element.
        • In the breadcrumb trail, click the Copy link icon.
          Copy link icon in breadcrumb trail
        • When the Copy Link window is displayed, clear the Add configuration context to link option, and then copy the updated URL.
          Copy Link window
    • the filterTypes parameter to specify the types of elements for which traceability should be calculated, for example, filterTypes=Package,Project
      type of archtecture element
    • the filterLinkTypes parameter to specify the types of links that should be analyzed. Can take one or more of the following values:
      • derives, refine, satisfy, trace (for requirements)
      • validatedby (for test cases)
      • elaborates (for work items)
      • External (for URIs)

      For example, filterLinkTypes=satisfy,derives

    So a complete URL would look something like this: https://<server name>:<port number>/ccm/reporting/rhapsody/ArchitectureElementStatistics?projectId=<ID of project area>&componentName=RhapsodySampleComponent&filterTypes=Package,Project&filterLinkTypes=satisfy,trace
    Note: If you are generating a report for a project area that is not part of a global configuration, and you want to use a specific stream rather than the default context, you can include the parameter oslc_config.context in the URL. The value of the parameter should be the URI of the local stream to use.
  11. For Authentication Type, select Oauth.
  12. Enter your user name and password.
  13. Accept Header - leave default setting.
  14. If you are generating the report for a project area that is part of a global configuration, enter the URI of the global configuration in the Configuration Context field. To find the URI, navigate to the global configuration and select the Copy Link tool.
    Find URI of global configuration
  15. Click OK to save the information.
  16. Save the document specification.
  17. You can now use the defined document specification to generate reports with Engineering Publishing.

Feedback