Home
Developing
Learn how to develop by using the product.
Creating custom reports
In the Report Editor, you create report templates used to generate custom reports.
Report Editor
With the Report Editor, you can edit custom reports or templates or create a new report. Custom reports include any items that are available to a findings report, such as finding information, code snippets, AppScan® Source trace, and remediation content, as well as a vulnerability matrix. Before you start designing new reports, it is recommended that you become familiar with the report creation process by modifying an existing report template in the Report Editor.

Welcome
Welcome to the documentation for HCL® AppScan® Source.
Introduction to HCL® AppScan® Source
HCL® AppScan® Source delivers maximum value to every user in your organization who plays a role in software security. Whether a security analyst, quality assurance professional, developer, or executive, the AppScan Source products deliver the functionality, flexibility, and power you need - right to your desktop.
What's New in AppScan® Source
Explore these new features that have been added to AppScan® Source - and note any features and capabilities that have been deprecated in this release.
Installing
Learn how to install the product.
Configuring
Learn how to configure the product.
Administering
Learn how to administer the product.
Developing
Learn how to develop by using the product.
- Scanning source code and managing assessments
  This section explains how to scan your source code and manage assessments.
- Triage and analysis
  Grouping similar findings allows security analysts or IT auditors to segment and triage source code problems. This section explains how to triage AppScan® Source assessments and analyze results.
- AppScan® Source trace
  With AppScan® Source trace, you can verify input validation and encoding that meets your software security policies. You can look at the findings that produce input/output traces and mark methods as validation and encoding routines, sources or sinks, callbacks, or taint propagators.
- Findings reports and audit reports
  Security analysts and risk managers can access reports of select findings or a series of audit reports that measure compliance with software security best practices and regulatory requirements. This section explains how to create reports of aggregate finding data.
- Creating custom reports
  In the Report Editor, you create report templates used to generate custom reports.
  - Report Editor
    With the Report Editor, you can edit custom reports or templates or create a new report. Custom reports include any items that are available to a findings report, such as finding information, code snippets, AppScan® Source trace, and remediation content, as well as a vulnerability matrix. Before you start designing new reports, it is recommended that you become familiar with the report creation process by modifying an existing report template in the Report Editor.
    - Report Layout tab
      The Report Layout Tab consists of Palette and Layout sections - and sections that allow you to specify a header or footer that appears on each page.
    - Categories tab
      Using the Categories tab, you can add categories that contain findings based on bundles, properties, or selected findings that you choose. The categories can then be used when adding certain items to the Layout. For example, when you add a Vulnerability Breakdown to the Layout, a table with a breakdown of the number of vulnerabilities in all categories (by severity and classification) is added to the layout. The Categories tab consists of a pane with a tree of categories and a pane in which to edit the attributes of the selected category. Each category contains the findings in the assessment that satisfy certain requirements that you define.
    - Preview tab
      You can preview AppScan® Source for Analysis reports as you edit your templates. From the Preview pane, click Preview to see the report for the open assessment.
  - Generating custom reports
    The procedures in this section's topics describe how to design and generate a report from an existing custom report. Alternatively, you can create a new report. To edit an existing report, open the report and follow the design, modification, and preview procedures.
Extending product function
Learn how to extend the product.
Reference
Review reference information for the product.
Troubleshooting and support
There are a number of self-help information resources and tools to help you troubleshoot problems.

Report Editor

With the Report Editor, you can edit custom reports or templates or create a new report. Custom reports include any items that are available to a findings report, such as finding information, code snippets, AppScan® Source trace, and remediation content, as well as a vulnerability matrix. Before you start designing new reports, it is recommended that you become familiar with the report creation process by modifying an existing report template in the Report Editor.

The Report Editor consists of the Report Layout, Categories, and Preview tabs.

Report Layout: Design the appearance of the report. In the layout, you add, remove, and reorder AppScan® Source report elements.
Categories: Create and edit categories. A category is a group of findings. The category identifies the findings to include in the report, how to group those findings, and the grouping order.
Preview: Look at the report for the current assessment as you edit it.

The three tabs contain common fields:

File: Path of the saved grouping file (read-only). Nothing displays in this field until the file has been saved. Once saved, the grouping file is an XML file that defines the report.
Name: User-defined report name.

Toolbar buttons for saving, opening, creating, copying, and generating custom reports include:

Create a new report: Creates a new custom report
New report from existing: Creates a new custom report from an existing report template
Open a saved report: Open a grouping file to edit
Save: Save the current report to the specified file
Save As: Save the current report to a new file
Generate an instance of this report: Create a copy of the report for the currently open assessment

Tip: To view samples of existing reports, click New report from existing and then choose one of the AppScan® Source report templates. Exploring the Report Layout and Categories tabs in the templates will give you a feel for how reports are designed.