Managing Templates
Through the Report Templates screen, you can manage templates by:
Creating a Template
To create a customized template, click on
, available in the top right corner of the screen.
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 the instructions in the following sections.
Defining General Details
Template Base
The template base is optional and works as an accelerator when creating a new template.
The drop-down list shows the list of all the templates filtered by the selected type. Once you select a template as a base, all the parameters will be automatically populated according to the selected template. You can edit the General Details and Filters, and then Save your new template.
Template Name
This mandatory field allows you to define the name of the new template being created. Once you save the template, it will be available in the templates list with the defined name.
File Format
This mandatory field allows you to select the output format (such as JSON or PDF) of the reports generated from this template.
For more details about the supported formats, see the Formats page.
Scan Type
This field is mandatory when creating a Scan template. It has the following available values:
Scan Information - Results by Vulnerability Type
Scan Information - Results by Result State
For further details about these templates, see Scan Template page.
Defining Filters
In the Filters section, you can define the filters that will be applied every time a report is requested using this template. When generating the report, the results are filtered according to these filters.
For further details about which filters are available for each template type, see the Filters page.
Teams and projects
This field allows you to filter the teams and projects that will be included in the reports generated by this template.
You can select teams and projects by ticking the correspondent check boxes in the drop-down list. You can select one or multiple teams, and for each team, you can select one or multiple projects.
By typing key words in the Search text area you can filter teams and projects.
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.
By hovering over the total number of selected teams and projects (for example, in the above screenshot: +23) you can see all the teams and projects defined as filters.
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/or projects
Expand the drop-down list.
Type the key words you would like to apply to filter the list of teams and projects.
When you are creating a Team(s) template, if you select only one team, a Single Team template will be created. 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 the one, and only one, project by ticking the corresponding radio button.
 |
Once the project is selected it is visible in the filter bar.
 |
By typing key words in the Search text area you can filter the projects list.
Project custom fields
This parameter allows you to filter only projects having specific custom field based on a key:value pair.
Project custom fields is an optional filter and it is 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 select one or multiple key:values pairs.
By typing key words in the Search text area you can filter the custom fields list.
 |
Timeframe
This filter allows you to define the timeframe period that you would like 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, Last 3 days.
The maximum value allowed in 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 two 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, with the exception of Not Exploitable.
 |
The selected values are visible in the Result State filter area. By hovering over +1 you can see all the other values included in the filter.
 |
To include results having all the possible states, check All.
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 filter, by ticking the correspondent check box.
 |
The selected values are visible in the Status filter area.
To include results having all the possible status, check All.
Data Point
This filter allows you to define if the KPIs are built based on the last or the first scan:
last: means that the last scan is considered.
first: means that the first scan is considered.
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 have an impact on any KPI calculation, since all results are taken into consideration when calculating the data points.
Defining Metadata
The metadata is optional and allows you to include additional 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 displayed 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, in addition to the Team information.
Scan Custom Fields: If enabled, the Scan level custom fields details are displayed in the Data Information card.
Result Comments: If you added comments to some scan results and you want them displayed in the report, you can enable the Scan Comments toggle. By having it set On, the comments are displayed in the Scan Results section for the corresponding result.
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, in addition to the Team information.
Project Branch Information: If you want to have branch details available 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:Original Project Name: If the project you are analyzing is a branch from another project, you will see in this field the name of the original project.
Branched on Scan Id: If the project you are analyzing is a branch from another project, you will see in this field the Scan Id from where the branch was created.
Related Projects: If the project under analysis is the source of branches, you can see in this field a list of all the projects that are branches of it.
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 to have branch details available 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 project, you will see in this field the name of the original project.
Branched on Scan Id: If the project you are analyzing is a branch from another project, you will see in this field the Scan Id from where the branch was created.
Related Projects: If the project under analysis is the source of branches, you can see in this field a list of all the projects that are branches of it.
Multiple Teams Template
When creating a multiple teams 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 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 at the Data Information card, available for each project under the Projects main section.
Project Branch Information: If you want to have branch details available 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 project, you will see in this field the name of the original project.
Branched on Scan Id: If the project you are analyzing is a branch from another project, you will see in this field the Scan Id from where the branch was created.
Related Projects: If the project under analysis is the source of branches, you can see in this field a list of all the projects that are branches of it.
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.