Add Custom Report Templates

Issue reports in Hive are customizable. You can download and change existing report templates as well as to upload your own report templates.

Note: this option is available for Hive administrators.

Upload new report templates

To add new report template:

  1. Go to Report templates tab;
  2. Click Upload template and add a template from your computer;
  3. A new template appears in the list of templates.

Now you can select your own template for Issue report.

Report template format

To create your own .docx template download default report template template.docx from Report templates tab. Change it as you need and upload it to the Platform.

Note: we recommend changing the name of the template.docx file before uploading it back to the Platform. When loading templates with the same name, the platform will automatically change the file names by adding the date and time to the files, for example [2021-04-06T15: 49: 23.895Z] template.docx.

Variables

An %ISSUES_AREA% variable is used to export issues to the report. When adding this variable to the template, a new section Testing results will be added to the report. This section includes Found vulnerabilities list with the following information:

Note: all issues in the project will be exported to the report. By default, issues in the report are distributed by score: from critical to low.

  • Issue name
  • Issue score
    • Criticality
    • Probability
  • General Description
  • Risk description
  • Technical description
    • Vulnerable host(s)
    • HTTP Requests
    • Images
  • Steps to Reproduce
  • Recommendations

The issue report includes images in the formats that are supported by .docx (png, jpg, bmp, jpeg). Files in other formats that can be attached to the issues will not be exported to the report.

Styles

Important! Do not change the style IDs and style names of the template.docx. Currently, the report generator supports only predefined style names.

You can change styles settings of the headers, lists, paragraphs, tables, images and other. But the style names and IDs must always remain the same.

The following style names and IDs are mandatory:

Style ID Style Name Style type Used for
H1 H1 Paragraph Level 1 headers
H2 H2 Paragraph Level 2 headers
H3 H3 Paragraph Level 3 headers
H4 H4 Paragraph Level 4 headers
H5 H5 Paragraph Level 5 headers
BodyExpRep Body (Exp_Rep) Paragraph All default body paras
BodyExpRepChar Body (Exp_Rep) Char Character Characters inside default body paras
CodeChar Code Char Character Inline codeblocks
Code Code Paragraph Inline codeblocks
Internetlink Internet link Character Internet links
Emphasis Emphasis Character Emphasis (Italic)
Strong Strong Character Strong emphasis (Bold)
vulnrate vulnrate Paragraph Vulnerability rate paragraph
styleRatingLow styleRatingLow Character Characters for low vulnerability rate (green)
styleRatingMedium styleRatingMedium Character Characters for medium vulnerability rate (yellow)
styleRatingHigh styleRatingHigh Character Characters for high vulnerability rate (red)
picturecaption picture_caption Paragraph caption for Picture and table paragraph
hivetable1 hive_table1 Table Style for tables

See also