Managing Templates
Through the Report Templates screen, you can manage templates by:
Creating a Template
Create templates to view screenshots of your scans with filters and fields you wish to include in your report. Follow these steps to create a template:
To create a customized template, click
.
Select a template type by clicking the drop-down arrow.
From the expanded drop-down list, select one of the following template types:
Scan
Project
Team/s
Application
Executive
Click Continue. The Create New Template screen is displayed.
Enter the required information according to the instructions in the following sections.
In the Filters section, using this template, you can define the filters applied every time a report is requested. When generating the report, the results are filtered according to these filters.
See the Filters page for further details about which filters are available for each template type.
Teams and Projects
This field allows you to filter the teams and projects included in the reports generated by this template.
Select teams and projects by ticking the correspondent checkboxes in the drop-down list. You can select multiple teams and choose one or various projects for each team.
You can filter teams and projects by typing keywords in the Search text area.
Examples
Selecting all teams and projects:
Expand the drop-down list.
Tick All
After selection, the teams and projects are visible in the filter area.
You can see all the teams and projects defined as filters by hovering over the total number of selected teams and projects (for example, in the above screenshot: +23).
Selecting all projects from a team
Expand the drop-down list.
Tick the team you want to add as a filter.
Selecting some projects for some teams
Expand the drop-down list.
Tick the teams and projects to include as a filter.
Searching teams and projects
Expand the drop-down list.
Type the keywords you would like to apply to filter the list of teams and projects.
When creating a Team(s) template, a Single Team template will be made if you select only one team. Otherwise, it will be a Multi-Team template.
Project
This parameter allows you to filter the project to include in the reports generated by this template.
You can select one and only one project by ticking the corresponding radio button.
Once the project is selected, it is visible in the filter bar.
Filter the projects list by typing keywords in the Search text area.
Project Custom Fields
This parameter allows you to filter only projects with specific custom fields based on a key-value pair.
Project custom fields are optional and are editable only after defining Teams and Projects or Projects filters. The list of available custom fields is filtered according to the selected projects.
You can select the project custom fields by ticking the correspondent check box. You can choose one or multiple key-value pairs.
You can filter the custom fields list by typing keywords in the Search text area,
Timeframe
This filter lets you define the timeframe period you want to analyze in the reports.
You can set the timeframe as a:
Date range, composed of start and end dates.
Pre-defined period, for example, last week, last 2 months, and last 3 days. The maximum value allowed is 1 year.
Severity
This filter allows you to define the severities of the results you would like to include in the reports generated by the template. For example, if you want to analyze only High and Medium results, you would define only these values in the Severity filter by ticking the correspondent check boxes. To include all the severities, check All. Selected values are visible in the Severity filter area.
Result State
The Result State filter allows you to define the states of the results you would like to include in the reports generated by this template. For example, if you want to exclude Not Exploitable results from the reports, you would check all the values except for Not Exploitable. To include results in all the possible states, check All.
The selected values are visible in the Result State filter area. By hovering over +1, you can see all the other values in the filter.
Status
The Result State filter allows you to define the status of the results you would like to include in the reports generated by this template. For example, if you want to analyze only the results appearing for the first time, you must define New as a filter by ticking the correspondent check box. The selected values are visible in the Status filter area. To include results with all the possible statuses, check All.
Data Point
This filter allows you to determine if the KPIs are built based on the first or last scan:
First, the KPI is based on the first scan.
Last: KPI is based on the previous scan.
Query
The query filter allows you to restrict the results used in the KPIs calculation based on a specific set of vulnerabilities. It is applicable for the Scan template only.
Results Limit
This filter allows you to restrict the number of results displayed and printed in the scan report.
When applied, it does not impact any KPI calculation since all results are considered when calculating the data points.
The metadata is optional and allows you to include details for specific KPIs in the reports.
By default, the metadata options are disabled. To enable these, set the toggle from Off 
to On 
.
When enabled, the additional details are available and displayed in the report. If disabled, details are not shown in the report.
Scan Template
When creating a scan template, the following information is available as metadata:
Team Name Full Path: When enabled, the Team Name Full Path is displayed in the generated reports in the Data Information card and the Team information.
Scan Custom Fields: If enabled, the Scan level custom field details are displayed in the Data Information card.
Result Comments: If you added comments to some scan results and want them displayed in the report, you can enable the Scan Comments toggle. Having it set On, the comments on the corresponding result are shown in the Scan Results section.
Categories: When enabled, a section displaying the results per category is available in the report. If not selected, categories are not displayed.
You can select the categories to include by ticking the correspondent checkboxes in the drop-down list. You can choose multiple teams and select one or various projects for each team.
You can filter specific categories by typing keywords in the Search text area.
Exclude zero results: When enabled, the categories having zero results are excluded from the report. This option must be unchecked to display the categories with zero results in the scan report.
Project Template
When creating a project template, the following details are available as metadata:
Team Name Full Path: When enabled, the Team Name Full Path is displayed in the generated reports in the Data Information card and the Team information.
Project Branch Information: If you want branch details in the report, you can set the option Project Branch Information to On
. When enabled, the following information is available on the Data Information card:Original Project Name: If the project you are analyzing is a branch from another, you will see the actual project's name in this field.
Branched on Scan ID: If the project you are analyzing is a branch from another project, you will see the Scan ID from where the branch was created in this field.
Related Projects: If the project under analysis is the source of branches, you can see a list of all its branches in this field.
Single Team Template
When creating a single team template, the following metadata is available to be enabled:
Team Name Full Path: When enabled, the Team Name Full Path is displayed in the generated reports in the Teams Data card under the General Information main section.
Project Branch Information: If you want branch details in the report, you can set the option Project Branch Information to On
. When enabled, the following information is available in the Data Information card, available for each project under the Projects main section:Original Project Name: If the project you are analyzing is a branch from another, you will see the actual project's name in this field.
Branched on Scan ID: If the project you are analyzing is a branch from another project, you will see the Scan ID from where the branch was created in this field.
Related Projects: If the project under analysis is the source of branches, you can see a list of all its branches in this field.
Multiple Teams Template
When creating a multiple teams template, the following metadata can be enabled:
Team Name Full Path: When enabled, the Team Name Full Path is displayed in the generated reports for each team under the Teams main section, in addition to the team name information.
Application Template
When creating an application template, the following details are available as metadata:
Team Name Full Path: When enabled, the Team Name Full Path is displayed in the generated reports on the Data Information card, and it is available for each project under the Projects main section.
Project Branch Information: If you want branch details in the report, you can set the option Project Branch Information to On
. When enabled, the following information is available in the Data Information card, available for each project under the Projects main section:Original Project Name: If the project you are analyzing is a branch from another, you will see the actual project's name in this field.
Branched on Scan ID: If the project you are analyzing is a branch from another project, you will see the Scan ID from where the branch was created in this field.
Related Projects: If the project under analysis is the source of branches, you can see a list of all its branches in this field.
Include your company's logo, header, and footer in your reports by toggling the respective feature switch. The feature switch is disabled by default and must be enabled from the Report Customization page.
Logo: Include or exclude your company logo.
Header: Include or exclude a header.
Footer: Include or exclude a footer.
See here for more information on customizing your report's logo, header, and footer.
Editing a Template
To edit a customized template, click on the Edit 
icon available on each row in the table.
 |
Edit Template
The template is displayed in edit mode. You can change the values, as shown in the following screen:
 |
Editing template definitions
After editing the fields, click:
Save to save the changes.
Cancel to cancel the changes and keep the previous values.
Notice
The default templates cannot be edited.
Save changes
When clicking Save to save the changes in the template, you are given the following options:
 |
Update current template: to save the changes in the template and keep same versioning.
Create new version of template: to save the changes made in the template and to increment the versioning.
When saving the changes, you are able to:
Save and generate: to save the changes to the template and to generate a new report according to the new definitions.
Save: to save the changes to the template and without generating a report.
To exit the modal window without saving the changes, click on the 
button.
Deleting a Template
To delete a customized template, click 
, available on each row in the table.
 |
After clicking the icon, a confirmation message, similar to the one shown below, will be displayed.
 |
Click Yes, delete to confirm the removal. Once the template is deleted, it will be removed from the templates list and it will no longer be available.
To Cancel the template removal, click Cancel.
To exit the modal window, click on the button. In this case, the template will not be deleted.
Notice
The default templates cannot be deleted.