Creating a comparison document-style report

You can create a document-style report that shows the differences between two document-style reports. For example, you might want to compare two different views from IBM Engineering Requirements Management DOORS® Next (DOORS Next), or two versions of a test case or test plan in IBM Engineering Test Management.

About this task

There are two ways to generate comparison document-style reports:

Procedure

Generating a base document-style report and comparison document-style report at the same time

You can compare two document-style reports that are generated from two configuration contexts of an artifact, for Microsoft Word output only. PUB generates the target document-style report as well as the base document-style report and then compares them to generate a comparison document-style report.

Procedure

  1. In Launcher, open the document specification for the document-style report that you want to generate.
  2. In the Document Specification view under Data Sources, right-click your data source and select OSLC Base Configuration Selection.
  3. Select the OSLC Service catalog, Service provider and Selection dialog that you want to use.
  4. Select Use external browser only if you encounter problems with the embedded browser in the wizard. Click Next.
    • If you did not select the Use external browser check box, choose the configuration by using the embedded browser in the wizard.
      • You must authenticate again when the embedded browser loads the page for the first time.
      • If the full selection of options is not visible, scroll down to find the OK or Select buttons.
    • If you selected the Use external browser check box, choose the configuration in an external browser.
  5. Pick a resource, for example a baseline and click OK and Finish
  6. The resource URL for the selected configuration is updated in the Base configuration context property of the data source in the Properties view.
    Base configuration context
  7. Save the document specification.
  8. Generate the document-style report by clicking the Generate document-style report icon Generate document icon in the toolbar.
    The base document-style report is generated using the same template that is used for target document-style report generation.
  9. The document-style report generation results window shows three document-style reports:
    • target_document_name.doc
    • base_target_document_name.doc
    • compare_target_document_name.doc
    When prompted, open the generated document-style reports.
    Note:
    • If password is set for the Microsoft Word output, you can use the same password to open Target document-style report, Base document-style report and Compare document-style report.
    • If Comparison base document-style report is password protected, use its password as the value for Base document password field.

Generating a comparison document-style report from an existing base document-style report

Before you begin

Generate a base document-style report.

About this task

After you generate a base document-style report, generate a second document-style report (target document-style report) to compare against the base document-style report. When generating the target document-style report, specify the settings for the comparison document-style report in the document specification. Both the target document-style report and the comparison document-style report will be generated. Comparison document-style reports are supported for Microsoft Word output only. Multi-part document-style reports are not supported.

Procedure

  1. In Launcher, open the document specification for the target document-style report that you want to compare to the base document-style report.
    In the Document Specification view, configure the data source for the target document-style report if not already configured under Templates > Data Source
  2. In the Document Specification view under Output, select Output: Word.
  3. In the Properties view set the following properties:
    1. Comparison base document: Enter the path or browse on your file system to the first document-style report that you want to compare.
    2. Track changes author: Specify the author name for comparison tracked changes. The default value is user.
    3. Base document username: Enter the username for the base document-style report if it is an HTTP-secured resource.
    4. Base document password: Enter the password for the base document-style report if required.
    5. Base document cookies: Enter any cookies, such as if you generated the Word document within the Engineering Requirements Management DOORS Next application instead of using Engineering Publishing.
  4. Generate the document by clicking the Generate document-style report icon Generate document icon in the toolbar.
  5. Both the target document-style report and the comparison document-style report are generated. The comparison document-style report is stored in the same directory as the target Word document and is named compare_target_document. When prompted, open the generated document-style reports.

    In the comparison document-style report, the differences between the base document-style report and the target document-style report are shown as tracked changes in Microsoft Word.

    Comparison document-style report showing tracked changes highlighted in red