📄 01 Getting Started

Getting Started

Understand the Report Designer architecture, module set and first production-ready workflow.

1. Concepts and requirements

What the plugin does

The plugin stores each layout as structured JSON on an Odoo report template. The browser Designer edits that layout, while the server resolves record data and turns the design into a printable PDF. Positions and dimensions are stored in millimetres, which makes the same design suitable for A4 documents, custom forms and small labels.

A report consists of:

  • A target model, such as Sales Order, Invoice, Contact or Stock Picking.
  • A paper size with physical width, height, margins and grid settings.
  • Regions: Body, optional Header, optional Footer and optional Watermark.
  • Elements placed at exact X/Y coordinates.
  • Dynamic data coming from the current Odoo record, related records, the active company or computed expressions.
  • A report action that can expose the design in the Print menu of its target model.

Modules and optional extensions

ModulePurpose
Metaglow Report HubCore report templates, paper sizes, cliparts, Designer, preview and PDF report actions.
Reports – Layouts & LabelsAdds reusable layouts and label-printing workflows.
MG Report Hub Render BackendAdds the alternative Pango/WeasyPrint renderer and CMYK-oriented workflows.
Print Server IntegrationRoutes output to PDF, a configured print server, or both.

Before you start

  • Confirm that the Reports application is installed and visible.
  • Create or verify the required paper size under Configuration.
  • Make sure you know the Odoo model the report will print from.
  • Use a representative sample record. It makes field, image, barcode and computed previews much easier to validate.
  • For production rollout, test with records containing short, long, empty and multi-line values.