Report Templates
Report Templates
Section titled “Report Templates”Report templates define the structure and styling of generated penetration test reports. Customize templates to match your organization’s branding and requirements.
Overview
Section titled “Overview”Template management includes:
- Default template configuration
- Custom template creation
- Template variables
- Branding customization
Template Manager
Section titled “Template Manager”Accessing Templates
Section titled “Accessing Templates”- Navigate to Settings → Report Templates
- Or from a project: Reports → Manage Templates
Template List
Section titled “Template List”View all available templates:
- Template name
- Description
- Last modified
- Usage count
Default Template
Section titled “Default Template”About the Default
Section titled “About the Default”NEURO includes a professional default template with:
- Cover page
- Table of contents
- Executive summary
- Methodology
- Findings by severity
- Remediation roadmap
- Appendices
Using the Default
Section titled “Using the Default”The default template is pre-selected for new reports. To change:
- Go to Report Templates
- Click Set as Default on desired template
Custom Templates
Section titled “Custom Templates”Creating Custom Templates
Section titled “Creating Custom Templates”- Click + New Template
- Choose starting point:
- Blank template
- Copy from default
- Upload existing DOCX
- Configure template settings
- Save
Template File Format
Section titled “Template File Format”Templates use Microsoft Word (.docx) format with:
- Jinja2-style variables:
{{ variable_name }} - Control structures for loops
- Conditional sections
Template Variables
Section titled “Template Variables”Project Variables
Section titled “Project Variables”| Variable | Description |
|---|---|
{{ project.name }} | Project name |
{{ project.client.name }} | Client name |
{{ project.start_date }} | Start date |
{{ project.end_date }} | End date |
{{ project.description }} | Project description |
Finding Variables
Section titled “Finding Variables”| Variable | Description |
|---|---|
{{ finding.title }} | Finding title |
{{ finding.severity }} | Severity level |
{{ finding.cvss_score }} | CVSS score |
{{ finding.description }} | Description text |
{{ finding.impact }} | Impact statement |
{{ finding.remediation }} | Remediation steps |
Statistics Variables
Section titled “Statistics Variables”| Variable | Description |
|---|---|
{{ stats.total_findings }} | Total count |
{{ stats.critical_count }} | Critical findings |
{{ stats.high_count }} | High findings |
{{ stats.medium_count }} | Medium findings |
{{ stats.low_count }} | Low findings |
Loops and Conditions
Section titled “Loops and Conditions”Looping Through Findings
Section titled “Looping Through Findings”{% for finding in findings %}{{ finding.title }}Severity: {{ finding.severity }}{{ finding.description }}{% endfor %}Conditional Sections
Section titled “Conditional Sections”{% if stats.critical_count > 0 %}CRITICAL FINDINGS REQUIRE IMMEDIATE ATTENTION{% endif %}Grouping by Severity
Section titled “Grouping by Severity”{% for severity in ['Critical', 'High', 'Medium', 'Low'] %} {% set severity_findings = findings|selectattr('severity', 'equalto', severity)|list %} {% if severity_findings %} ## {{ severity }} Severity Findings {% for finding in severity_findings %} {{ finding.title }} {% endfor %} {% endif %}{% endfor %}Template Sections
Section titled “Template Sections”Standard Sections
Section titled “Standard Sections”| Section | Content |
|---|---|
| Cover Page | Title, client, dates |
| Document Control | Version, authors |
| Executive Summary | High-level overview |
| Scope | What was tested |
| Methodology | How testing was performed |
| Findings Summary | Charts and statistics |
| Detailed Findings | Each finding |
| Recommendations | Prioritized actions |
| Appendices | Supporting data |
Customizing Sections
Section titled “Customizing Sections”In template editor:
- Add/remove sections
- Reorder sections
- Customize headers
- Modify layouts
Branding
Section titled “Branding”Adding Your Logo
Section titled “Adding Your Logo”- In template, insert image placeholder
- Use variable:
{{ organization.logo }} - Or embed directly in template
Color Schemes
Section titled “Color Schemes”Customize chart colors:
- Go to Template Settings
- Set severity colors
- Set chart palette
Fonts and Styling
Section titled “Fonts and Styling”Template inherits Word styles:
- Heading styles
- Body text formatting
- Table styles
- Color scheme
Uploading Templates
Section titled “Uploading Templates”Upload Process
Section titled “Upload Process”- Click Upload Template
- Select your DOCX file
- NEURO validates variables
- Preview template
- Save
Validation
Section titled “Validation”During upload, NEURO checks:
- Valid DOCX format
- Variable syntax
- Required sections
- Image compatibility
Troubleshooting Upload
Section titled “Troubleshooting Upload”Common issues:
- Invalid variable: Check syntax
- Missing section: Add required sections
- Format error: Ensure valid DOCX
Testing Templates
Section titled “Testing Templates”Preview Mode
Section titled “Preview Mode”Before using in production:
- Open template
- Click Preview
- Select a project with data
- View generated preview
Test Generation
Section titled “Test Generation”Generate test report:
- Use non-production project
- Generate with template
- Review output
- Iterate on template
Template Versioning
Section titled “Template Versioning”Version History
Section titled “Version History”Templates track versions:
- Each save creates version
- View previous versions
- Restore old versions
Restoring Versions
Section titled “Restoring Versions”- Open template
- Click Version History
- Select version to restore
- Confirm restoration
Sharing Templates
Section titled “Sharing Templates”Export Template
Section titled “Export Template”- Click Export
- Download DOCX file
- Share with team/organization
Import Template
Section titled “Import Template”- Click Import
- Upload shared template
- Review and save
Best Practices
Section titled “Best Practices”Template Design
Section titled “Template Design”- Keep formatting simple
- Use consistent styles
- Test with various data
- Include all required sections
Variable Usage
Section titled “Variable Usage”- Use provided variables
- Test variables before using
- Document custom variables
- Handle empty values
Maintenance
Section titled “Maintenance”- Version control templates
- Document changes
- Test after updates
- Keep backups
Next: Explore User Settings