Generating and saving reports

You can generate reports from the Software Analysis Results view and save them in PDF or HTML format.

Before you begin

If you want to save a generated report in HTML format, you must configure the browser that is linked with the development workbench. The method for saving an HTML report to the file system depends on whether the browser is configured as internal or external. To configure the browser, from the main menu, select Window > Preferences > General > Web Browser. The default setting is internal. For more information about setting up a browser for use with the workbench, see Web browser preferences.

About this task

The histories and results that are generated by a code review are retained while the workbench remains open:
  • The histories are displayed in reverse chronological order in the history pane of the Software Analyzer Results view, which is on the left side of the view.
  • The results of the currently selected history are displayed in the analysis domain tabs, which are on the right side of the view.
  • The icons and highlighting that mark source code problems are displayed in the source code files by the COBOL, PL/I, and System z® LPEX editors.
These items are lost when the workbench closes. You can preserve a history and its component results, by saving the report to the workstation's file system in HTML or PDF format.

Software analysis configurations, including built-in rules, custom rules, and user-written rules are persistent across opens and closes of the workbench.

Note: If you want to export result information into other data formats, see Exporting results from an analysis history.

Generating a report

About this task

A general analysis report is an HTML or PDF document that shows all the results of an analysis history in an orderly text format. The types of general analysis report are COBOL Code Review and PL/I Code Review.

Procedure

  1. In the history pane, on the left side of the Software Analyzer Results view, select an analysis history. The results from the history are displayed in the analysis domain tabs, which are on the right side of the view.
  2. In the analysis domain tab, on the toolbar, click Generate a report for the current selection Generate a report for the current selection. The Software Analyzer Reporting window opens.
  3. Select COBOL Code Review or PL/I Code Review.
  4. Select a report type, either HTML report or PDF report.
  5. Click OK. The report is generated. PDF reports are displayed in Adobe Reader. HTML reports are displayed in the browser that is configured for the workbench.
    Restriction: When you close a report, you cannot reopen that instance of it. However, if the analysis history is not lost or deleted, you can quickly regenerate another instance of the report.

Saving a PDF report to the file system

Procedure

To save a PDF file to the file system in Adobe Reader, click File > Save As.

Saving an HTML report to the file system

Procedure

  1. To save a report that is open in an external browser, use the method that is provided by the browser, such as clicking File > Save.
    Note: Even though you configure the browser as external, the HTML report might still be displayed in the internal browser. Success depends on the brand and version of the browser and on the runtime environment. If this problem occurs, use the internal browser method.
  2. To save a report that is open in an internal browser:
    1. Right-click the text area of the browser and click Select all.
    2. Right-click again and click Copy.
    3. Paste the contents into an editor or word-processing program and save the text to the file system.

Feedback