Reports Overview
Reports are the main deliverable in Vulnsy — professional pentest reports generated from your engagement data, containing tabs, narrative sections, findings, and export configuration.
A report is the primary deliverable you produce in Vulnsy. It is a structured pentest report linked to a project, built from your engagement data, and exported as a professional DOCX document for your client.
What Is a Report?
Each report belongs to a project and contains everything needed to produce a client-ready document:
| Component | Purpose |
|---|---|
| Tabs | Top-level sections representing different testing areas (e.g., "Web Application", "Infrastructure") |
| Narrative sections | Free-form content blocks within each tab — Scope, Methodology, Executive Summary, and custom sections |
| Findings | Vulnerabilities assigned to specific tabs, imported from your library or created inline |
| Export configuration | Template selection, tag prefixes, and sort order for generating DOCX output |
Report Fields
Every report has the following top-level fields:
| Field | Description |
|---|---|
| Title | The name of the report (e.g., "Q1 2025 External Penetration Test") |
| Version | A version identifier for tracking revisions |
| Status | Current state — Draft, Review, or Final |
| Executive Summary | High-level overview of the engagement and results |
| Methodology | Description of the testing approach used |
| Scope | What was tested and any boundaries or exclusions |
Report fields like executive summary, methodology, and scope are also available as template tags during DOCX export, so they flow directly into your generated documents.
How Reports Fit into Vulnsy
Reports sit within the project hierarchy:
- A Client has one or more Projects
- Each Project has one or more Reports
- Each Report contains one or more Tabs
- Each Tab contains Narrative sections and Findings
This structure lets you produce multiple reports per engagement — for example, a draft report and a retest report — all under the same project.
Report Workflow
- Create a report inside a project
- Add tabs for each testing area you need to cover
- Write narrative sections — scope, methodology, executive summary, and any custom sections
- Add findings to each tab from your library or create them inline
- Configure export settings — choose a template, set sort order, and assign tag prefixes
- Export to DOCX — generate the final document
Next Steps
- Report Tabs — understand how tabs organize your report into testing areas
- Narrative Sections — write and manage the content blocks within each tab
- Report Findings — add and manage findings in your report
- Exporting Reports — configure templates and generate DOCX output