OdooWiki OCA HUB

Excel Import/Export/Report

excel_import_export folder_open OCA/server-tools open_in_new
Tools License: AGPL-3

The module provide pre-built functions and wizards for developer to build excel import / export / report with ease.

Without having to code to create excel file, developer do,

  • Create menu, action, wizard, model, view a normal Odoo development.
  • Design excel template using standard Excel application, e.g., colors, fonts, formulas, etc.
  • Instruct how the data will be located in Excel with simple dictionary instruction or from Odoo UI.
  • Odoo will combine instruction with excel template, and result in final excel file.

auto_awesome What this module does

AI-generated from the code · Odoo 18.0

Lets developers and administrators build Excel import, export and report templates from Odoo without writing code. Users can upload an Excel file, map its cells to Odoo fields, and then import or export data through wizards and menus.

This is a technical base module for building Excel-based import, export and reporting features. It does not add ready-made business reports; instead it gives you the tools to create them.

  • You create an Excel template record (xlsx.template) where you upload your own Excel file and describe, cell by cell, which Odoo field goes where. Two tabs, xlsx.template.import and xlsx.template.export, hold those cell-to-field mappings.
  • From a template you can generate an export action, an import action and a report menu, so end users get buttons and menu entries without extra development.
  • The export wizard (export.xlsx.wizard) produces the filled Excel file, optionally converted to CSV, and can zip several files together.
  • The import wizard (import.xlsx.wizard) reads an uploaded Excel file, deletes existing lines when required, creates or updates records, and can run a post-import hook.
  • A generic report wizard (report.xlsx.wizard) lets users pick search criteria and download the result.
  • Excel reports are added as a new report type on ir.actions.report, so a report can be printed directly to Excel.
  • Styling is supported through simple directives for fonts, fills, alignment and number formats, and formulas can be adjusted when rows are extended.

Everything appears under the Excel Import/Export menu in Odoo's settings/custom area, with the XLSX Templates list as the main screen.

Depends on

mail

Required by other modules

account_payment_line_importexcel_import_export_demoexcel_import_export_unidecodel10n_th_account_report

Menus it adds

Excel Import/Exportmenu_xlsx_template
Models and fields (11)
  • xlsx.export · new model
  • xlsx.import · new model
  • xlsx.report · new modeldata (File), name (File Name), state, template_id (Template), choose_template (Allow Choose Template)
  • xlsx.styles · new model
  • xlsx.template · new modelname (Template Name), datas (File Content), fname (File Name), gname (Group Name), to_csv (Convert to CSV?), csv_quote (CSV Quoting), res_model (Resource Model), export_ids, import_ids, description, instruction, result_field, csv_delimiter (CSV Delimiter), csv_extension (CSV File Extension), report_menu_id (Report Menu), redirect_action (Return Action), result_model_id (Report Model), export_action_id, import_action_id, post_import_hook (Post Import Function Hook), report_action_id (Report Action), show_instruction (Show Output), input_instruction (Instruction (Input)), use_report_wizard (Easy Reporting)
  • ir.actions.report · extends an existing modelreport_type
  • export.xlsx.wizard · new modeldata (File), name (File Name), state, res_ids (Resource IDs), res_model (Resource Model), template_id (Template)
  • import.xlsx.wizard · new modeldatas (Sample), fname (Template Name), state, res_id (Resource ID), filename (Import File Name), res_model (Resource Model), import_file (Import File (*.xlsx)), template_id (Template), attachment_ids (Import File(s) (*.xlsx))
  • report.xlsx.wizard · new modeldomain (Search Criterias), res_model
  • xlsx.template.export · new modelsheet, style (Default Style), is_sum (Sum), is_cont (Continue), sequence, is_extend (Extend), row_field, excel_cell (Cell), field_cond (Field Cond.), field_name (Field), style_cond (Style w/Cond.), template_id (XLSX Template), section_type
  • xlsx.template.import · new modelsheet, sequence, no_delete, row_field, excel_cell (Cell), field_cond (Field Cond.), field_name (Field), template_id (XLSX Template), section_type

Text generated by AI (DeepSeek) from reading the Odoo 18.0 code on GitHub; it may contain mistakes, so check the code before deciding. The module is very large and only part of the code was read. View the code on GitHub

Availability by version

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

Confirmation status: 6 confirmed, 3 with no information of 9 versions.

Sources · Odoo 15.0

Confirmed on 2026-11-03 in branch 15.0 of OCA/server-tools.

terminal Installation and usage

OCA documentation · Odoo 18.0

Installation

Source · Odoo 18.0

To install this module, you need to install following python library, xlrd, xlwt, openpyxl.

Then, simply install excel_import_export.

For demo, install excel_import_export_demo

Configuration

Source · Odoo 18.0

If you have existing templates from the version 16.0.1.2.0 or earlier, you need to click 'REMOVE EXPORT ACTION' and then click 'ADD EXPORT ACTION' in these templates for export actions to work as expected.

Usage

Source · Odoo 18.0

Concepts

This module contain pre-defined function and wizards to make exporting, importing and reporting easy.

At the heart of this module, there are 2 main methods

  • self.env['xlsx.export'].export_xlsx(...)
  • self.env['xlsx.import'].import_xlsx(...)

For reporting, also call export_xlsx(...) but through following method

  • self.env['xslx.report'].report_xlsx(...)

After install this module, go to Settings \> Technical \> Excel Import/Export \> XLSX Templates, this is where the key component located.

As this module provide tools, it is best to explain as use cases. For example use cases, please install excel_import_export_demo

Use Cases

Use Case 1: Export/Import Excel on existing document

This add export/import action menus in existing document (example - excel_import_export_demo/import_export_sale_order)

  • Create export action menu on document, \ with res_model="export.xlsx.wizard" and src_model="\", and context['template_domain'] to locate the right template -- actions.xml
  • Create import action menu on document, \ with res_model="import.xlsx.wizard" and src_model="\", and context['template_domain'] to locate the right template -- action.xml
  • Create/Design Excel Template File (.xlsx), in the template, name the underlining tab used for export/import -- \.xlsx
  • Create instruction dictionary for export/import in xlsx.template model -- templates.xml

Use Case 2: Import Excel Files

With menu wizard to create new documents (example - excel_import_export_demo/import_sale_orders)

  • Create report menu with search wizard, res_model="import.xlsx.wizard" and context['template_domain'] to locate the right template -- menu_action.xml
  • Create Excel Template File (.xlsx), in the template, name the underlining tab used for import -- \.xlsx
  • Create instruction dictionary for import in xlsx.template model -- templates.xml

Use Case 3: Create Excel Report

This create report menu with criteria wizard. (example - excel_import_export_demo/report_sale_order)

  • Create report's menu, action, and add context['template_domain'] to locate the right template for this report -- \.xml
  • Create report's wizard for search criteria. The view inherits excel_import_export.xlsx_report_view and mode="primary". In this view, you only need to add criteria fields, the rest will reuse from interited view -- \
  • Create report model as models.Transient, then define search criteria fields, and get reporing data into results field -- \.py
  • Create/Design Excel Template File (.xlsx), in the template, name the underlining tab used for report results -- \.xlsx
  • Create instruction dictionary for report in xlsx.template model -- templates.xml

Note:

Another option for reporting is to use report action (report_type='excel'), I.e.,

<record id="action_report_saleorder_excel" model="ir.actions.report">
        <field name="name">Quotation / Order (.xlsx)</field>
        <field name="model">ir.model</field>
        <field name="report_name">'sale.order'</field>
        <field name="report_file">'sale.order'</field>
        <field name="binding_model_id" ref="sale.model_sale_order"/>
        <field name="binding_type">report</field>
        <field name="report_type">excel</field>
</record>

By using report action, Odoo will find template using combination of model and name, then do the export for the underlining record. Please see example in excel_import_export_demo/report_action, which shows,

  • Print excel from an active sale.order
  • Run partner list report based on search criteria.

Easy Reporting Option

Technically, this option is the same as "Create Excel Report" use case. But instead of having to write XML / Python code like normally do, this option allow user to create a report based on a model or view, all by configuration only.

  • Go to Settings \> Technical\> Excel Import/Export \> XLSX Templates, and create a new template for a report.
  • On the new template, select "Easy Reporting" option, then select followings
  • Report Model, this can be data model or data view we want to get the results from.
  • Click upload your file and add the excel template (.xlsx)
  • Click Save, system will create sample export line, user can add more fields according to results model.
  • Click Add Report Menu, the report menu will be created, user can change its location. Now the report is ready to use.

>

Note: Using easy reporting mode, system will used a common criteria wizard.

>

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.