Skip to content

Quick Start

Creating a report in Omni Designer is quick and visual. Follow these steps to generate your first document from scratch.

Before you begin, make sure:

  • The omni_designer modules are installed in your Odoo instance.
  • You have the Omni Report Manager access rights (group omni_report.group_omni_report_manager).

First, you need to create a report template in Odoo, or open an existing one.

  1. Navigate to Settings > Technical > Reporting > Reports.
  2. Click New or select an existing report.
  3. If creating a new report, fill in the Report Name, Report Type (PDF), and target Model (e.g., sale.order).
Odoo report action form with Report Name, Type, and Model fields
Odoo report action form with Report Name, Type, and Model fields

Once you have a report template configured:

  1. Look for the Open Designer button in the report form header or the Design button in the Kanban view.
  2. Clicking this button will launch the Omni Designer interface within your browser.
The 'Open Designer' button on the report form
The 'Open Designer' button on the report form
The 'Design' button on the report Kanban card
The 'Design' button on the report Kanban card

The designer workspace opens with four main areas:

Empty designer workspace overview
Empty designer workspace overview
  • Toolbar (top) Save, Undo/Redo, Delete, Preview
  • Sidebar (left) Components, Data fields, Outline tree
  • Canvas (center) Your report page with rulers and margins
  • Property Panel (right) Styling and configuration for selected elements
  1. Add Elements: Open the Components tab on the left sidebar and drag a Text, Table, or any other element onto the canvas.
  2. Bind Data: Switch to the Data tab to browse available fields for the current model. Drag and drop fields directly onto the canvas the designer will automatically create properly bound elements.
  3. Format Layout: Click any element to select it, then use the right Properties panel to adjust font size, color, borders, and margins.
Video placeholder
Full design flow: drag components, bind data, and style elements

Click an empty area of the canvas (deselect all elements) to access Page Settings in the Property Panel:

  • Paper size A4, Letter, Legal, and more
  • Orientation Portrait or Landscape
  • Margins Top, Bottom, Left, Right
  • Header & Footer Enable page headers and footers with configurable heights
Page Settings panel with paper size and margin configuration
Page Settings panel with paper size and margin configuration

Omni Designer generates PDF previews instantly in your browser without communicating back to the Odoo server.

  1. Click the Preview button (eye icon) in the top toolbar to see exactly how your report will look when printed with real data.
  2. Select which records to use for the preview from the record picker dialog.
  3. If you are satisfied with the result, click the Save button (disk icon) or press Ctrl + S (Cmd + S on macOS).
  4. Check the “Unsaved” indicator dot on the right side of the toolbar to ensure your changes are safely stored.
Video placeholder
Previewing a report with real Odoo data and saving

Congratulations! You have successfully created and styled a custom Odoo report. Proceed to the Interface Guide to learn more about the tools at your disposal.