How oca/reporting-engine works
Main Components
a. Core Reporting Services:
• Base Report Engine Layer
• Report Format Handlers (PDF, CSV, XLSX, XML, etc.)
• Template Engine (QWeb, Py3o)
• SQL Query Engine
b. Specialized Report Modules:
• Business Intelligence Views
• Async Report Processing
• Security Features (Encryption, Signing)
• Export Services
c. Integration Components:
• Database Layer
• Odoo Core Integration
• External Services (LibreOffice, wkhtmltopdf)
┌─ Presentation Layer ─────────────────────┐
• Web Interface │
• Report Preview │
• Export Options │
• Business Logic Layer ───────────────────┤
• ┌─ Report Generation Services ─┐ │
• QWeb Engine │ │
• XLSX Generator │ │
• CSV Processor │ │
• XML Builder │ │
• ┘ │
• ┌─ Enhancement Services ──────┐ │
• PDF Watermarking │ │
• Digital Signing │ │
• Encryption │ │
• ┘ │
• Data Access Layer ────────────────────┤
• SQL Request Abstract │
• BI View Editor │
• SQL Export │
• ┘
Connection Types
• Double lines: Data flow
Important Elements to Highlight
a. Module Relationships:
• How base_comment_template connects to other report modules
• Bi_sql_editor and bi_view_editor interaction
• Report_async's connection to various report types
b. Security Flow:
• Encryption/signing process flow
• Access control points
• Data validation checkpoints
c. External Dependencies:
• LibreOffice connection for report_py3o
• Database connectivity for SQL operations
• File system interaction for export operations
Implementation Details
Create subsections for:
• Template Management
• Report Generation Pipeline
• Export Processors
• Security Handlers
Notes
Annotations for:
• Critical paths
• Performance considerations
• Security checkpoints
• Scalability points