Resources | developer.brewmp.com Resources | developer.brewmp.com

Developer

resources

Report Generator Help

Report Generator is a command-line tool used to generate reports based on test results and input files.

Report Generator supports the following types of reports and produces them using the results created by Test Manager and Interrogator:

  • Class Support: Outlines which classes are supported, unsupported and unverified by a device, and are organized by the Brew MP feature families and subfamilies. Report Generator uses the results from Interrogator to create the Class Support reports.
  • Certification (for Brew Level certification - BL1 or BL2): Summarizes how well a device measures up to the Brew Level 1 (BL1) or Brew Level 2 (BL2) requirements when run against the BL1 and BL2 certification tests.
  • API Validation Results: Provides information on the features that had issues/problems when run against the PVS tests. Report Generator creates BL1/BL2 Certification reports and API Validation Results reports based on the results from Test Manager. The API Validation Results report provides results from both PVS and BVK tests.
  • Workspace Comparison: Compares two or more workspaces.

Prerequisites

The following need to be installed before running Report Generator:

  • Windows 7 (currently only works on this OS)
  • Microsoft Office (2003 or higher)
  • Latest Brew MP SDK and Toolset
  • Brew MP Platform Pro Kit

Note: Before using Report Generator, confirm that Strawberry Perl is installed, not Active State Perl.

Running Report Generator

  1. Open a command prompt in the folder %BREWMP_TOOLSET%\bin.
  2. Execute Report Generator as specified in the following formats and usages:

    reportgen -report=<report>... <report commands>

Parameter Description
-report=<report>

Specifies the type of report generated by Report Generator, where <report> is one of the following:

  • cert (or CertificationReport): Creates BL1 or BL2 Certification reports.
  • class (or ClassSupportReport): Lists supported, unsupported, and unverified classes.
  • api (or APIValidationResults): Summarizes feature issues for PVS and BVK tests.
  • comp (or ComparisonReport): Compares two or more workspaces.

-workspacepath= <workspace filepath> or

-wsp=<workspace filepath>

Specifies the entire filepath of the workspace file (.qwsp) containing the BVK and PVS test kits to be used. For example:

reportgen -report=api -workspacepath=
C:\ProgramData\Qualcomm\Targets\<device name>
\Workspaces\\Workspace.qwsp 

Note: This parameter is required for any test-related operations.

-interrogatorResults= <Interrogator output file> or

-ir=<Interrogator output file>

Specifies a path pointing to an output .csv file from Interrogator.

-allresults

Note: This command applies only to the API Validation Results report.

If specified, all results are reported. Otherwise, redundant PVS test cases and BVK tests are filtered out of the report.

-level=<Brew validation level>

Note: This command applies only to the Certification reports.

Specifies the <Brew validation level>:

  • 1 = BL1
  • 2 = BL2

If not specified, 1 is used.

-output=<output path>

Specifies the name and/or path of the output file generated. If a filename is specified, its extension must match the report type or Office Automation throws an exception (e.g., do not name a Word file with an .xls extension).

If a path is specified with no filename, a default filename is used.

Finding help on Report Generator

  • Enter one of the following at the command prompt:
    • reportgen -h
    • reportgen -help
    • reportgen help

Note: When generating reports, be sure to use the entire filepath for the workspace file (-wsp).

Generating Class Support reports

  1. Open a command prompt in the folder %BREWMP_TOOLSET%\bin.
  2. Run Report Generator as specified in the following format to generate a Class Support report:

    reportgen -report=class -ir=<Interrogator output file> -wsp=<workspace filepath>

Generating Certification reports

  1. Open a command prompt in the folder %BREWMP_TOOLSET%\bin.
  2. Execute Report Generator as specified in the following format to generate a Certification report:

    reportgen -report=cert -wsp=<workspace filepath> -level=<Brew validation level>

Generating API Validation Results reports

  1. Open a command prompt in the folder %BREWMP_TOOLSET%\bin.
  2. Execute Report Generator as specified in the following format to generate an API Validation Results report:

    reportgen -report=api -wsp=<workspace filepath>

Note: See the Validation Primer for instructions on the manual steps required to customize the API Validation Results reports.

Generating Workspace Comparison reports

The Workspace Comparison report requires two workspaces for the comparison.

  1. Open a command prompt in the folder %BREWMP_TOOLSET%\bin.
  2. Execute Report Generator as specified in the following format to generate a Workspace Comparison report:

    reportgen -report=comp -wsp= -wsp=