Reporting Engine¶

Generate professional security reports from your scan results and findings.

Overview¶

The Reporting Engine transforms raw security data into professional, actionable reports for various audiences.

Report Types¶

Executive Summary¶

Audience: C-level, management
Focus: High-level overview, business impact
Length: 2-5 pages

Includes: - Overall risk rating - Key findings summary - Business impact - High-level recommendations - Metrics and trends

Technical Report¶

Audience: Security team, IT staff
Focus: Detailed findings, remediation
Length: 10-50+ pages

Includes: - Detailed vulnerability descriptions - Technical evidence - Step-by-step remediation - Tool output - References (CVE, CWE)

Compliance Report¶

Audience: Auditors, compliance team
Focus: Regulatory requirements
Length: Varies

Includes: - Compliance status - Control testing results - Gaps identified - Remediation timeline - Audit evidence

Asset Inventory Report¶

Audience: IT operations, management
Focus: Asset discovery and tracking
Length: 5-20 pages

Includes: - Complete asset list - Asset categorization - Technology stack - Asset relationships - Change tracking

Generating Reports¶

Quick Report Generation¶

Steps: 1. Navigate to Intelligence → Reporting Engine 2. Click Generate Report 3. Select report type 4. Choose engagement/date range 5. Configure options 6. Click Generate 7. Download when ready

📸 Screenshot: Report generation interface

Report Configuration¶

Common Options: - Engagement: Which engagement to report on - Date Range: Time period to cover - Severity Filter: Which vulnerabilities to include - Asset Filter: Which assets to include - Include Screenshots: Add evidence images - Include Raw Data: Append tool output - Format: PDF, HTML, Markdown, DOCX

Custom Report Templates¶

Create Template: 1. Go to Reporting Engine → Templates 2. Click Create Template 3. Design layout 4. Add sections 5. Configure data sources 6. Save template

Template Sections: - Cover page - Table of contents - Executive summary - Methodology - Findings - Recommendations - Appendices

Report Formats¶

PDF¶

Best For: Final delivery, printing
Features: - Professional formatting - Embedded images - Page numbers - Table of contents

HTML¶

Best For: Web viewing, sharing
Features: - Interactive elements - Searchable - Responsive design - Easy sharing

Markdown¶

Best For: Version control, collaboration
Features: - Plain text - Git-friendly - Easy editing - Convert to other formats

DOCX¶

Best For: Editing, customization
Features: - Editable in Word - Custom branding - Easy modifications - Client-specific changes

JSON¶

Best For: API integration, automation
Features: - Machine-readable - API-friendly - Easy parsing - Integration

Report Sections¶

Standard Sections¶

Cover Page: - Report title - Client name - Date - Confidentiality notice

Executive Summary: - Overview - Key findings - Risk rating - Recommendations

Methodology: - Testing approach - Tools used - Scope - Limitations

Findings: - Vulnerability details - Evidence - Impact - Remediation

Recommendations: - Prioritized fixes - Best practices - Strategic improvements

Appendices: - Tool output - Screenshots - References - Glossary

Custom Sections¶

Add Custom Content: - Company background - Compliance requirements - Industry context - Historical trends - Comparison data

Scheduling Reports¶

Automated Report Generation¶

Schedule Options: - Daily - Weekly - Monthly - After each scan - Custom schedule

Configuration: 1. Create report template 2. Click Schedule 3. Set frequency 4. Configure recipients 5. Set delivery method 6. Enable schedule

Delivery Methods: - Email - SFTP - S3 bucket - Webhook - API endpoint

Customization¶

Branding¶

Add Your Brand: - Company logo - Color scheme - Fonts - Header/footer - Cover page design

Configure Branding: 1. Go to Configuration → Branding 2. Upload logo 3. Set colors 4. Choose fonts 5. Save settings

Custom Metrics¶

Add Custom KPIs: - Define metric - Set calculation - Add to reports - Track over time

Example Metrics: - Vulnerability density - Remediation velocity - Coverage percentage - Risk score - Compliance score

Report Distribution¶

Email Delivery¶

Send via Email: 1. Generate report 2. Click Send 3. Enter recipients 4. Add message 5. Send

Email Options: - Multiple recipients - CC/BCC - Custom subject - Custom message - Attachment or link

Share Securely: - Password-protected PDFs - Encrypted email - Secure portal - Time-limited links - Access logging

Export and Download¶

Download Options: - Direct download - Generate link - Archive to S3 - Push to repository

Best Practices¶

Report Writing¶

✅ Know Your Audience: Tailor content
✅ Be Clear: Avoid jargon
✅ Be Accurate: Validate findings
✅ Be Actionable: Provide clear steps
✅ Be Professional: Proper formatting
✅ Be Timely: Deliver promptly

Report Quality¶

✅ Proofread: Check for errors
✅ Validate Data: Ensure accuracy
✅ Include Evidence: Support claims
✅ Provide Context: Explain impact
✅ Offer Solutions: Not just problems

Troubleshooting¶

Report Generation Fails¶

Check: - Data availability - Template validity - Permissions - System resources

Solutions: - Verify data exists - Test template - Check permissions - Retry generation

Missing Data¶

Causes: - Filters too restrictive - No data in range - Incomplete scans

Solutions: - Adjust filters - Expand date range - Complete scans

Formatting Issues¶

Causes: - Template errors - Missing images - Font issues

Solutions: - Fix template - Re-upload images - Use standard fonts

Related: Vulnerabilities | Assets | Dashboard