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.
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.

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.
- AppScan® Source for Analysis and defect tracking
  AppScan® Source for Analysis integrates with defect tracking systemsIBM® Rational Team Concert™ to deliver confirmed software vulnerabilities directly to the developer desktop. Defect submission to a defect tracking system contains a textual description of the bug and a file that contains only the findings submitted with the defect.
- 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.

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.

Page Header and Page Footer

The Page Header field allows you to specify text that appears at the top of every report page - while the Page Footer field allows you to specify text that appears at the bottom of every page.

Palette

The Palette displays a list of elements that comprise AppScan® Source standard reports. Some of the elements only display information for categories that have been defined in the Categories tab (see Report Layout Palette - elements that depend on categories).

Table 1. Report Layout Palette - elements that do not depend on categories
Elements that can be chosen to populate the custom report.
Report Element	Description
Text Header	Adds a bold block of text to the report layout.
Image Header	Displays an image scaled to a specified size in pixels.
AppScan® Source Header	Report header containing AppScan® Source branding.
Title and Date	Report title that includes name of the item that was scanned - along with the date of scan and the date the report was generated.
Text Block	Any user-defined text. A heading can also be added for the text block in the Label field.
Vulnerability Matrix	Assessment vulnerability matrix (displays the same graph that appears in the Vulnerability Matrix view).
Metrics	Identifies the total number of packages, classes, methods, and lines of code in all of the packages in the project.
Scan History	Metrics for the current scan and historical metrics for scans of the same target.

Table 2. Report Layout Palette - elements that depend on categories
Elements that can be chosen to populate the custom report.
Report Element	Description
Report Card	Brief breakdown of vulnerability levels of every category defined in the Categories tab. Contains links to the report details and severity indicators summarizing the section.
Vulnerability Breakdown	Table with a breakdown of the number of vulnerabilities in all categories defined in the Categories tab, by severity and classification.
Partial Report Card	Breakdown of vulnerability levels of user-specified categories as specified in the Categories tab.
Categories	Lists all categorized findings data as defined in the Categories tab.
Category	Lists all findings in one or more categories that have been defined in the Categories tab.

Layout

As you add items from the palette, they appear in the Layout. Use the section toolbar to remove, modify, or move items in the layout.