OdooWiki OCA HUB

Report xlsx helpers

report_xlsx_helper folder_open OCA/reporting-engine open_in_new
Reporting License: AGPL-3

This module provides a set of tools to facilitate the creation of excel reports with format xlsx.

auto_awesome What this module does

AI-generated from the code · Odoo 19.0

This module gives developers a ready-made toolkit for building Excel (.xlsx) reports in Odoo, with pre-defined cell formats, automatic sheet-name cleaning and a helper to serve xlsx files over the web.

This is a technical helper module: it does not add menus or buttons for end users, but it makes Excel reports possible and consistent across Odoo.

  • It extends the abstract report model report.report_xlsx.abstract with a standard way to generate a workbook: each report declares its worksheets and the module creates them, writes the title, the header line and the data lines.
  • It provides a large set of ready-to-use cell formats (alignment left/centre/right, bold, amounts, percentages, integers, dates, grey/yellow/blue headers, bordered table cells, and conditional formats that show negative numbers in red), so all xlsx reports share the same look.
  • It automatically sanitises worksheet names: invalid characters ( / \ * [ ] : ? ) are removed and names are cut to 31 characters; if sanitising is disabled, a clear error is raised instead.
  • It adds a standard footer showing the report date/time and page number, and helpers to set column widths, freeze panes and merge title cells.
  • It extends ir.actions.report so that an xlsx report can be rendered even when no report record exists, using the report name from the context, and it extends the web report controller so xlsx files are returned with the correct file name and content type.
  • A sample report on partners (report.report_xlsx_helper.test_partner_xlsx) shows the pattern: columns for name, number of contacts and creation date.

Text generated by AI (DeepSeek) from reading the Odoo 19.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub

Availability by version

Reviewed: 2026-11-03
Confirmed (verified in repository and branch) Estimated (unverified) No information

Confirmation status: 8 confirmed, 1 with no information of 9 versions.

Sources · Odoo 12.0

Confirmed on 2026-11-03 in branch 12.0 of OCA/reporting-engine.

terminal Installation and usage

OCA documentation · Odoo 19.0

Installation

Source · Odoo 19.0

This module requires report_xlsx version 13.0.1.0.0 or higher.

Usage

Source · Odoo 19.0

In order to create an Excel report you can define a report of type 'xlsx' in a static or dynamic way:

  • Static syntax: cf. account_move_line_report_xls for an example.
  • Dynamic syntax: cf. report_xlsx_helper_demo for an example

The AbstractReportXlsx class contains a number of attributes and methods to facilitate the creation excel reports in Odoo.

  • Cell types string, number, boolean, datetime.
  • Cell formats The predefined cell formats result in a consistent look and feel of the Odoo Excel reports.
  • Cell formulas Cell formulas can be easily added with the help of the _rowcol_to_cell() method.
  • Excel templates It is possible to define Excel templates which can be adapted by 'inherited' modules. Download the account_move_line_report_xls module from as example.
  • Excel with multiple sheets Download the account_asset_management_xls module from as example.

No verified information in OCA: Configuration.

info

Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.