Skip to main content

Managing Templates

Through the Report Templates screen, you can manage templates by:

Creating a Template

  1. To create a customized template, click on Create_Back_Plus_in_Black_Circle.PNG, available in the top right corner of the screen.

    CreateTemplate.png
  2. Select a template type by clicking the drop-down arrow.

    SelectTemplateType.png
  3. From the expanded drop-down list, select one of the following template types:

    • Scan

    • Project

    • Team/s

    • Application

    • Executive

  4. Click Continue. The Create New Template screen is displayed.

  5. Enter the required information according the instructions in the following sections.

    CreateNewTemplate.png

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

  1. Selecting all teams and projects:

    1. Expand the drop-down list

    2. Tick All

      TeamsandProjects.png
    3. After selection, the teams and projects are visible in the filter area.

      TeamsProjectsFilter.png
    4. 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.

      ListAllTeamsProjectsFilter.png
  2. Selecting all projects from a team

    1. Expand the drop-down list.

    2. Tick the team you want to add as a filter.

      TicktheTeamFilter.png
  3. Selecting some projects for some teams

    1. Expand the drop-down list.

    2. Tick the teams and projects to include as a filter.

      TickTeamProjectFilter.png
  4. Searching teams and/or projects

    1. Expand the drop-down list.

    2. Type the key words you would like to apply to filter the list of teams and projects.

      KeyWordsTeamProjectFilter.png

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.

ProjectRadioButton.png

Once the project is selected it is visible in the filter bar.

ProjectFilterBar.png

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.

CustomFieldsFilter.png

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.

    DateRange.png
  • Pre-defined period, for example Last week, Last 2 months, Last 3 days.

    PreDefinedPeriod.png

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.

SeverityFilter.png

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.

ResultStateFilter.png

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.

ResultStateFilterArea.png

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.

Status_FilterArea.png

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.

Editing a Template

To edit a customized template, click on the Edit Edit.png icon available on each row in the table.

EditTemplate.png

Edit Template

The template is displayed in edit mode. You can change the values, as shown in the following screen:

EditTemplateDef.png

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:

SaveTemplate.png
  • 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 (blue star) button.

Deleting a Template

To delete a customized template, click Delete_Trash_Bin.PNG, available on each row in the table.

DeleteTemplate.png

After clicking the icon, a confirmation message, similar to the one shown below, will be displayed.

DeleteConfirm.png
  • 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 (blue star) button. In this case, the template will not be deleted.

Notice

The default templates cannot be deleted.