# Creating Reports

The harness does not automatically create reports of test results after a test run. You must create test reports either from the command line in batch mode (see Writing Reports in the Command-Line Interface User's Guide) or from the harness GUI.

Reports might contain configuration values as well as test results. To ensure that any configuration values printed in reports are those that were used to run the tests, observe the following precautions after running tests for which you intend to generate one or more reports:

- Do not change any values in the current configuration.
- Do not load a different configuration into the work directory.

To minimize the chance of creating reports with configuration values that are inconsistent with the test results, either create reports after running the tests or use different work directories for different configurations.

## Create a Test Report

To create a test report from the harness GUI, you must complete these steps:

1. Choose Report > Create Report from the Test Manager menu bar.

> The harness opens the Create a New Report dialog box.

2. Type the name of a report directory in the Report Directory field or click the Browse button to specify where to put the new reports.

   You can either specify a new directory or an existing directory. If you ran reports earlier, it displays the directory from the previous run. If you use an existing report directory, the harness can save the previous reports as backups when it writes the new reports. Use the settings in the Other Options tab to backup old reports and specify the number of backup reports to keep in the report directory.

   If you only generate a text report without HTML reports in an existing directory containing HTML reports, you must use an external text editor or web browser to view the `summary.txt` file. To use the Report Browser when viewing text reports, generate the text only report either in a new report directory or in an existing report directory that only contains plain text reports.

   The Report Results for field specifies the filter used to select the test results that are reported. You can choose Last Test Run, Current Configuration, All Tests, Custom, or Certification. If the Custom filter was previously renamed, the dialog box displays the current name of the custom filter. You can create or modify a custom filter for generating test reports for a specific set of test criteria.

   See Using View Filters for a description of the filters.

   See Custom View Filter for a description of how to create a custom view filter.

3. Use the Backup Options settings to enable the backup option and to set the frquency of backups.

   When the Backup Option is enabled, the harness saves the previous reports by appending a tilde and a sequential numeric to the `.html` extension (such as `failed.html~1~`). The harness maintains the specified number of copies by deleting the oldest copy when the limit of backups is reached for a specific report. Changing this or any other setting in the report dialog box does not alter any previously saved backup reports. Existing backups are not deleted if backups are turned off and file names are not changed as old backups are deleted.

   The harness backs up the entire set of reports. If the first set of reports included XML and HTML formats, and the next set of reports are generated in XML format only, the harness creates backups of the previous HTML and XML reports (appending the appropriate tilde and sequence number to the backup file name). The harness generates the new top-level `index.html` file and updates its hyperlinks to maintain a self-consistent backup report set.

4. Use the tabbed panes to set printing formats and options. See Report Formats, HTML Options, and HTML Files for a description of the formats and options that you can set.
5. Click the Create Report(s) button.

The harness writes the reports and displays a dialog box that gives you the option of either viewing the new reports in the report browser or returning to the Test Manager window.

The options set in this dialog are persistent. After the options are set, they are used each time a report is generated. These settings also apply to reports printed from the command-line interface.

## Report Formats

In the left column, choose the report formats to be generated by the harness.

## HTML Options

If you selected HTML Report in the Report Formats list, use the HTML Options tab to select the sections of the main HTML report file that are generated.

The following options are available for generating HTML reports:

- Configuration - Selecting this option enables all of the following subordinate options:
  - Question Log - Generates a report that is the equivalent of the Configuration Question Log.
  - Test Environment - Generates a report that is the equivalent of the Show Environment dialog box.
  - Standard Values - Generates a report that contains the values from the Quick Set Mode.
- Results Summary - Generates a report of the pass, Fail, Error, Not Run, and Total values.

> The HTML report provides hyperlinks to content in the other HTML files. If it is not selected, the hyperlinks are not generated.

- Keyword Summary - Generates a report that provides a count of the number of occurrences of keywords that appeared in the selected tests.

## HTML Files

If the HTML report format is selected, in the HTML Files tab, choose the main report location and choose the report files that you want generated.

Copyright © 2002, 2009, Oracle and/or its affiliates. All rights reserved.