BIRTReportGenerator Command-Line Options

The following table describes the BIRTReportGenerator options.

BIRTReportGenerator Option Description
-template <template_name>

(Required) Specifies the report template name. The valid values for <template_name> are "CWE Top 25", "CWE/SANS Top 25", "Developer Workbook", "DISA CCI 2", "DISA STIG", "FISMA Compliance", GDPR, MISRA, "OWASP API Top 10", "OWASP ASVS 5.0", "OWASP MASVS 2.0", "OWASP Mobile Top 10", "OWASP Top 10", "PCI DSS Compliance", and "PCI SSF Compliance".

You only need to enclose the report template name in quotes if the <template_name> includes a space. The template name values are case-insensitive.
-source <audited_proj>.fpr (Required) Specifies the audited project on which to base the report.

-format pdf | doc | html

(Required) Specifies the generated report format.

The format values are case-insensitive.

-output <report_file.***>

(Required) Specifies the file to which the report is written.

If you specify a file that already exists, that file is overwritten.

-searchQuery <query>

Specifies a search query to filter issues before generating the report. For example:

-searchQuery audited:false

For a description of the search query syntax, see the OpenText™ Fortify Audit Workbench User Guide.
-ShowSuppressed Include issues that are marked as suppressed.
-ShowRemoved Include issues that are marked as removed.
-ShowHidden Include issues that are marked as hidden.
-filterSet <filterset_name>

Specifies a filter set to use to generate the report (for example, -filterSet "Quick View").
--Version <version>

Specifies the version for the template. The template version values are case-insensitive.

  • Templates that are not listed here have only one version available.

  • If you do not specify a version and multiple versions are available, BIRTReportGenerator uses the most recent version based on the external metadata used when the FPR was created.

  • The BIRTReportGenerator help displays current report versions. OpenText periodically deprecates older report versions, however these versions are still available for FPR files that were created before the report version was deprecated.

The valid values for the template versions are:

  • For the "CWE Top 25" template, the version is "CWE Top 25 <version>" (for example, "CWE Top 25 2024")
  • For the "CWE/SANS Top 25" template, the version is "<version> CWE/SANS Top 25" (for example, "2011 CWE/SANS Top 25")
  • For the "DISA STIG" template, the version is "DISA STIG <version>" (for example, "DISA STIG 6.3")
  • For the "FISMA Compliance" template, the version is "NIST 800-53 Rev <version>" (for example, "NIST 800-53 Rev 5")

  • For the MISRA template, the available versions are "MISRA C 2023" or "MISRA C++ 2008"

  • For the "OWASP Mobile Top 10" template, the version is "OWASP Mobile Top 10 <version>" (for example, "OWASP Mobile Top 10 2024")
  • For the "OWASP Top 10" template, the version is "OWASP Top 10 <version>" (for example, "OWASP Top 10 2021")

  • For the "PCI DSS Compliance" template, the version is "PCI <version>" (for example, "PCI 4.0.1")

  • For the "PCI SSF Compliance" template, the version is "PCI SSF <version>" (for example, "PCI SSF 1.2")
--IncludeDescOfKeyTerminology Include the Description of Key Terminology section in the report.
--IncludeAboutFortify Include the About Fortify Solutions section in the report.
--SecurityIssueDetails Provide detailed descriptions of reported issues. This option is not available for the Developer Workbook template.
--UseFortifyPriorityOrder Use Fortify Priority Order instead of folder names to categorize issues. This option is not available for the Developer Workbook and PCI Compliance templates.

-h | -help

 Displays detailed information about the options.

-debug

 Displays debug information that can be helpful to troubleshoot issues with BIRTReportGenerator.