PenTest.WS Documentation
  • What is PenTest.WS?
    • Tier Comparison
  • Getting Started
    • Dashboard
    • Creating An Engagement
    • Main Window Layout
    • Engagement Console
    • Import Nmap & Masscan XML
    • Port Scan Templates
    • Adding Hosts Manually
    • Adding Ports to Hosts
    • Capturing Credentials
  • Hosts & Services
    • Host Page
    • Port Page
    • Global Service Notes
    • Service Command Library
    • Default Service Checklist
    • Scratchpad Editor
  • People & Events
    • People Hacking
    • Events Timeline
  • Views & Filtering
    • Boards
    • The Matrix
    • Subnetting
  • User Libraries
    • Shells Library
    • General Command Library
    • General Notes Library
    • Bookmark Library
  • Built-In Tools
    • Echo Up
    • CyberChef
    • Venom Builder
  • Search Capabilities
    • CVE DB
    • Exploit-DB
    • Nmap Scripts
    • Metasploit Modules
    • Keyword Search
  • Findings
    • Findings Admin
    • Findings Library
    • Engagement Findings
  • Clients & Reporting
    • Write-Ups
    • Clients Manager
    • Reporting Templates
    • Generating Deliverables
  • Collaboration
    • User Maintenance
    • Shared Engagements
    • Access Control List
  • Automation & Integration
    • API
    • SMTP
  • Authentication
    • Two-Factor Authentication
    • LDAP Authentication
  • Exporting & Importing
    • Export Account Items
    • Import Account Items
    • Export to CSV / JSON
  • Pro Tier
    • Admin Panel
    • Intranet Mode
    • Solo Mode
    • Large Engagement Support
Powered by GitBook
On this page
  • Report Templates Admin
  • Template Syntax
  • Fields List
  • Text Variables
  • Rich Text / HTML
  • IF Statements
  • FOR Loops
  • Sample Report Template
  • Tier Availability
  1. Clients & Reporting

Reporting Templates

PreviousClients ManagerNextGenerating Deliverables

Last updated 11 days ago

URL:

Once that you have collected your set of Findings for the client, you need to build a client deliverable document with these details. The Reporting Module processes user-uploaded DOCX files with embedded {{tags}} to generate fully customized reporting documents with a single click.

Report Templates Admin

Start by downloading the report template and begin customizing your company name, logo and other needed details.

Template Syntax

Fields List

For a full list of fields available in your report templates, visit:

Text Variables

{{= engagement.name}}

Simple text variables are referenced using the {{= variable}} format. You can also insert statements such as {{= client.city + ", " + client.state + " " + client.zip}}

Notice that with simple text variables, the dollar sign $ is not required to reference the variable, but other syntax statements requires the dollar sign $.

Rich Text / HTML

{{HTML $finding.descFull}}

Fields in the PenTest.WS user interface that use the rich text editor require the HTML format {{HTML $variable}} to reference the variable in the reporting template.

The HTML format is also capable of rending images you have inserted into the associated field.

IF Statements

{{IF $finding.evidence != ""}}
    
    Evidence:
    {{HTML $finding.evidence}}
    
{{END-IF}}

Conditional statements are supported through the {{IF $variable = "value"}} syntax. To end the if statement use {{END-IF}}.

FOR Loops

{{FOR finding IN findings}}
    Title: {{= finding.title}}
    Risk:  {{= finding.riskLevel}}
{{END-FOR finding}}

For loops allow you to step through arrays such as Hosts and Findings and follow the classic For Loop programming language structure {{FOR x IN array}} and end with the {{END-FOR x}} statement.

Sample Report Template

Tier Availability

Reporting Templates are available on Hobby Tier and Pro Tier.

Upload your Report Template using the Report Templates Admin screen. From here, the template will be available for use in the Engagement's Reports tab. See for more details.

The template syntax includes For loops, If statements, and Variables and HTML content from your Findings entries including embedded images like screenshots for evidence. Using the you can add tags such as {{= client.name}} and {{= client.shortName}}, its just one less thing you need to fill out in the final report. Once the Reporting Module is finished processing, your browser downloads the new DOCX file where you can further customize the report as needed.

Generating Deliverable
Client Manager
https://gist.github.com/PenTestWS/c5d378e789e06e81a142495ea3823a52
https://pentest.ws/report-templates
57KB
PTWS_Report_Template_2025_May.docx
57KB
PTWS_Report_Template_2025_May.docx
Report Templates Admin\