> For the complete documentation index, see [llms.txt](https://support.attackforge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.attackforge.com/app/getting-started/reporting.md).

# Reporting

## Overview <a href="#overview" id="overview"></a>

AttackForge generates reports on demand, straight from the project's live data. There's no copying findings into a Word template and no last-minute reformatting. Choose a template and download a report that reflects the project as it is right now.

Project data flows through your ReportGen templates into custom reports. The JSON export and evidence ZIP are downloaded straight from the project, without a template.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FCI1GgggeghLIC9wuRQ9Y%2Freporting-at-a-glance.svg?alt=media&amp;token=12493c50-2dd9-43f7-81f9-b0510b11917a" alt=""><figcaption></figcaption></figure>

## Why reporting in AttackForge matters <a href="#why-reporting-in-attackforge-matters" id="why-reporting-in-attackforge-matters"></a>

* **Always current.** Reports are built from the project's data when you download them, so they include the latest findings, statuses and retest results.
* **No manual assembly.** Findings, evidence, the executive summary and test coverage flow into the template automatically.
* **Consistent quality.** Every report uses the same approved templates, so it's on brand and in house style whoever produces it.
* **The right report for each audience.** A project can have as many templates as you need: technical, executive, retest, compliance and more.
* **Self-service for clients.** Clients and stakeholders can download the latest report themselves, without waiting for someone to send it.

## What you can download <a href="#what-you-can-download" id="what-you-can-download"></a>

| Output             | What it contains                                            | Use it for                                                                                        |
| ------------------ | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| **Custom reports** | A DOCX report built from a template by the ReportGen engine | Deliverables for clients, executives, developers and auditors                                     |
| **JSON export**    | All the project's report data, as JSON                      | Building reports offline, feeding other tools, or keeping a backup                                |
| **Evidence ZIP**   | All evidence uploaded to the project's vulnerabilities      | Full-resolution screenshots, and evidence that can't go in a document, such as scripts and videos |

You can download all three directly from the project.

## Who benefits <a href="#who-benefits" id="who-benefits"></a>

| Who                                | How                                                         |
| ---------------------------------- | ----------------------------------------------------------- |
| **Testers and consultants**        | Spend time testing, not formatting documents                |
| **Delivery and practice managers** | Every report follows approved templates and house style     |
| **Clients and stakeholders**       | Download the latest report whenever they need it            |
| **Developers and asset owners**    | Get a report of just the findings that are relevant to them |

## Who can do what <a href="#who-can-do-what" id="who-can-do-what"></a>

| Task                                            | Who                                                                                                                                                        |
| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Download reports                                | Anyone on the project team, but only using the templates they've been given access to, and only once the project's settings make reports available to them |
| Edit the executive summary and reporting fields | Users with **Edit** access to the project                                                                                                                  |
| Create and manage report templates              | Administrators and Project Coordinators                                                                                                                    |

## Download a custom report <a href="#download-a-custom-report" id="download-a-custom-report"></a>

Custom reports are DOCX files that the **ReportGen** engine builds from your report templates. Every project can have an unlimited number of report templates, so you can keep a template for each audience and type of engagement.

Common report types include:

* Pentest reports
* Retesting reports
* Executive reports
* Testing summary reports
* Application and infrastructure reports
* Mobile testing reports
* Red team and purple team reports
* Configuration audit reports
* Compliance reports

#### **To download a report:**

1. Open the project and go to the **Reporting** tab.
2. Choose the template you need.
3. Download the report. It's built from the project's data at that moment.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FyAJ9HEGR7R4Xc4QVRK5j%2FScreenshot%202026-11-01%20at%2010.03.01%E2%80%AFam.png?alt=media&amp;token=dd94901f-c555-4feb-87f7-3f171ed8027b" alt=""><figcaption></figcaption></figure>

## Control who can use each template <a href="#control-who-can-use-each-template" id="control-who-can-use-each-template"></a>

Templates are controlled in two places:

* **Report Templates module.** Decide which templates each role, group or user can use. People only see the templates they've been given.
* **Project settings > Access control.** Decide when the Reporting section and custom reports become available on the project, and who can create reports.

For example, you might hold back the client's report until QA is complete, and give developers only the remediation template.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FVGt0T8mc8ENnKff03MOj%2FScreenshot%202026-11-01%20at%2010.05.08%E2%80%AFam.png?alt=media&amp;token=3b611343-bfa4-4b5c-937f-d316d6c5a050" alt=""><figcaption></figcaption></figure>

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FIpeBIGKLPYqws8gMllop%2FScreenshot%202026-11-01%20at%2010.05.40%E2%80%AFam.png?alt=media&amp;token=c76ad955-5489-4840-a472-edd4fd7bad16" alt=""><figcaption></figcaption></figure>

## Create a report for selected vulnerabilities <a href="#create-a-report-for-selected-vulnerabilities" id="create-a-report-for-selected-vulnerabilities"></a>

Sometimes a team only needs part of the picture. A web team may want just the web application findings, or an asset owner just the findings on their systems.

1. Go to the project's **Vulnerabilities** tab.
2. Select the vulnerabilities you want to include.
3. Choose **Actions > Custom Report**.
4. Pick a template and download the report.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FsFErjTgEprH7TxnShMzW%2FScreenshot%202026-11-01%20at%2010.07.26%E2%80%AFam.png?alt=media&amp;token=49317538-8f13-4743-a175-86b22358986c" alt=""><figcaption></figcaption></figure>

## Write the executive summary <a href="#write-the-executive-summary" id="write-the-executive-summary"></a>

The executive summary is the part of the report most senior readers will actually read. Write it in plain language for a non-technical audience, focusing on business risk and what to do next.

To edit it, open the project's **Reporting** tab. You need **Edit** access on the project.

A good executive summary can cover:

* the objectives of the engagement
* notable observations and findings
* positive security controls you saw
* assumptions
* limitations

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FsvtTHMpkay79fc4QuKTw%2FScreenshot%202026-11-01%20at%2010.08.29%E2%80%AFam.png?alt=media&amp;token=d204cd89-ac81-4bee-a747-e50e4713e234" alt=""><figcaption></figcaption></figure>

## Draft the executive summary with AI <a href="#draft-the-executive-summary-with-ai" id="draft-the-executive-summary-with-ai"></a>

AI can produce a first draft from the project's findings, which saves time on large engagements. You can:

* ask your AI assistant to draft it through **AI MCP**, using a Skill such as "Generate Pentest Executive Summary"
* run the **Agentic Executive Summary** workflow to draft it automatically

Treat an AI draft as a starting point. A tester or reviewer should check every statement against the findings before the report goes to the client. See [AI MCP and Skills](https://support.attackforge.com/app/modules/ai-mcp-and-skills) and [AI agentic workflows](https://support.attackforge.com/app/ai-agentic-workflows).

## Add custom reporting fields <a href="#add-custom-reporting-fields" id="add-custom-reporting-fields"></a>

Every organisation's reports have their own sections, such as document control, methodology or a summary of recommendations. Custom reporting fields let testers fill these in on the project, so they appear in the report without anyone editing the Word document.

Administrators create the sections and fields under **Administration > Reporting**. For example:

* **Project Summary**, with Executive Summary, Summary of Recommendations and Positive Security Observations
* **Testing Overview**, with Background, Approach and Methodology
* **Document Control**, with Author(s), Reviewer, Approver and Version History

{% hint style="info" %}
**Tip:** Set default values to make reporting easier. For example, a standard methodology statement only needs editing when the approach changes.
{% endhint %}

Once a section is set up, enable it on the projects that need it and set the access levels.

{% hint style="info" %}
**Important:** Only users with **Edit** access on the project can edit reporting fields.
{% endhint %}

To use the fields in your templates, see the [ReportGen guidance on GitHub](https://github.com/AttackForge/ReportGen/issues/25).

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FSoeEjBfgR1otPBbqFx5f%2FScreenshot%202026-11-01%20at%2010.11.16%E2%80%AFam.png?alt=media&amp;token=c7fe45c4-8020-4c2c-993d-4cd4a6dda1ee" alt=""><figcaption></figcaption></figure>

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FjXt0DIyU8KBoW8Vh6DZZ%2FScreenshot%202026-11-01%20at%2010.11.42%E2%80%AFam.png?alt=media&amp;token=0eedb257-aec5-4adc-81c6-2fce9c2af53a" alt=""><figcaption></figcaption></figure>

## Export the project as JSON <a href="#export-the-project-as-json" id="export-the-project-as-json"></a>

The JSON export contains all of the project's report data. Use it to:

* build reports offline or in your own tools
* feed the data into other systems
* keep a backup of the project

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FsbVw9PSFbFyZHfrZHSUJ%2FScreenshot%202026-11-01%20at%2010.13.20%E2%80%AFam.png?alt=media&amp;token=764464c4-894a-4f02-8f0f-d1bfa7994b0d" alt=""><figcaption></figcaption></figure>

## Download all evidence as a ZIP <a href="#download-all-evidence-as-a-zip" id="download-all-evidence-as-a-zip"></a>

The evidence ZIP contains all evidence uploaded to the project's vulnerabilities. It's useful when the report isn't enough, for example:

* full-resolution screenshots that are too detailed to read in a document
* scripts, videos and other evidence that can't go into a DOCX

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2F4qYnK4WTX4QjOcPHfKVK%2FScreenshot%202026-11-01%20at%2010.14.00%E2%80%AFam.png?alt=media&amp;token=6b877edf-aaff-4c9e-ae85-efaa7d07fadc" alt=""><figcaption></figcaption></figure>

## Name downloaded reports automatically <a href="#name-downloaded-reports-automatically" id="name-downloaded-reports-automatically"></a>

Report name tags set the filename of downloaded reports, so every report follows the same naming convention without anyone renaming files. For example, `{project.code} - Pentest Report - {now | dateFormat:["dd-mmm-yyyy"]}` *(example)*.

| Tag                            | Inserts                                                       |
| ------------------------------ | ------------------------------------------------------------- |
| `{project.id}`                 | Project ID                                                    |
| `{project.name}`               | Project name                                                  |
| `{project.code}`               | Project code                                                  |
| `{project.organization_code}`  | Project organisation code                                     |
| `{project.status}`             | Project status                                                |
| `{project.start_date}`         | Project start date                                            |
| `{project.end_date}`           | Project end date                                              |
| `{project.custom_field.<key>}` | A project custom field. Replace `<key>` with the field's key. |
| `{now}`                        | When the report was generated, in ISO 8601 format             |

To format a date, add a `dateFormat` filter:

* `{project.start_date | dateFormat:["fullDate"]}`
* `{project.end_date | dateFormat:["paddedShortDate"]}`
* `{now | dateFormat:["dd-mmm-yyyy"]}`

Add the output each format produces, for example "01-Nov-2026" for `dd-mmm-yyyy`.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FHODbJJXTyCeQ5vNcLwus%2FScreenshot%202026-11-01%20at%2010.15.21%E2%80%AFam.png?alt=media&amp;token=0d745933-caca-466e-870b-1546156187de" alt=""><figcaption></figcaption></figure>

## What else ends up in a report <a href="#what-else-ends-up-in-a-report" id="what-else-ends-up-in-a-report"></a>

Reports use the project's data, so the quality of the report depends on the work done earlier:

* **Vulnerabilities.** Only findings visible to the reader appear in their report. Pending findings stay out until they pass QA. See [Reviewing and QA vulnerabilities](https://support.attackforge.com/app/getting-started/reviewing-and-qa-vulnerabilities).
* **Test cases.** Test case status and notes can show coverage. See [Test cases](https://support.attackforge.com/app/getting-started/test-cases).
* **Attack chains.** Show how findings combine into a real attack path. See [Attack chains](https://support.attackforge.com/app/getting-started/attack-chains).
* **Custom fields and pages.** Can be included if your templates use them.

## Tips <a href="#tips" id="tips"></a>

* **Finish QA before you download the client's report.** The report reflects the project at the moment you download it.
* **Set default values** on reporting fields, so testers only change what's specific to the engagement.
* **Keep one template per audience** rather than one template that tries to do everything.
* **Use report name tags** so every report has a consistent, searchable filename.
* **Download the evidence ZIP** when a client needs evidence at full resolution, or evidence that can't go in a document.
* **Download the JSON export** at the end of an engagement if you need an offline record.

## FAQ <a href="#faq" id="faq"></a>

**Who can download reports?** Anyone on the project team, but only with the templates they've been given, and only once project settings make reports available to them.

**Why can't I see a template?** You haven't been given access to it in the Report Templates module. Ask your administrator.

**Why can't I edit the executive summary or reporting fields?** You need **Edit** access on the project.

**Does a report update when findings change?** Not a report you've already downloaded. Download it again to get the latest data.

**Can I build my own report templates?** Yes. Templates use ReportGen. See the ReportGen documentation

**Can AI write the executive summary?** It can draft one, using AI MCP or the Agentic Executive Summary. A person should always review it before it's sent.

## Related pages <a href="#related-pages" id="related-pages"></a>

* [Reviewing and QA vulnerabilities](https://support.attackforge.com/app/getting-started/reviewing-and-qa-vulnerabilities)
* [Attack chains](https://support.attackforge.com/app/getting-started/attack-chains)
* [Test cases](https://support.attackforge.com/app/getting-started/test-cases)
* [Creating and managing projects](https://support.attackforge.com/app/getting-started/creating-and-managing-projects)
* [AI MCP and Skills](https://support.attackforge.com/app/modules/ai-mcp-and-skills)
* [AI agentic workflows](https://support.attackforge.com/app/ai-agentic-workflows)
* [ReportGen on GitHub](https://github.com/AttackForge/ReportGen)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://support.attackforge.com/app/getting-started/reporting.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
