OdooWiki OCA HUB

Report Text Format Option

report_text_format_option folder_open OCA/reporting-engine open_in_new
Reporting License: LGPL-3

This is a technical module designed to add encoding fields to the ir.actions.report model and is applied to Text type reports.

auto_awesome What this module does

AI-generated from the code · Odoo 18.0

Adds encoding and line-ending options to text reports in Odoo, so generated text files can be saved in a specific character set (e.g. cp932) and use CRLF or CR line breaks.

This module extends the configuration screen of report actions (ir.actions.report) with three new fields that only appear for text reports.

  • **Encoding**: a free-text field where you can type the character set to use for the generated text file (for example cp932). If left empty, the file keeps its default encoding.
  • **Encoding error handling**: a choice between Ignore and Replace, used when a character cannot be encoded. If nothing is selected, the export fails with an error message instead of silently changing the content.
  • **Line ending**: a choice between CRLF (\r\n) and CR (\r), for reports that must use a different line break than the standard LF.

These options are visible in the report action form, but only when the report type is a text report; the error-handling choice only appears once an encoding has been entered. When a text report is generated, the module applies the chosen line ending first and then encodes the content with the selected encoding and error handling.

A demo text report on contacts (res.partner) is included so the feature can be tested. The module does not add menus of its own; the settings live inside the existing report configuration screens.

Depends on

base
Models and fields (1)
  • ir.actions.report · extends an existing modelline_ending, text_encoding, text_encode_error_handling

Text generated by AI (DeepSeek) from reading the Odoo 18.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: 3 confirmed, 6 with no information of 9 versions.

Sources · Odoo 18.0

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

terminal Installation and usage

OCA documentation · Odoo 18.0

Configuration

Source · Odoo 18.0

In case the exported report should be encoded in another system than UTF-8, following fields of the report record (Settings \> Technical \> Reports) should be populated accordingly.

  • Text Encoding: set an encoding system (such as cp932)
  • Text Encode Error Handling: select 'Ignore' or 'Replace' as necessary.
  • 'Ignore': in case of an encoding error, the problematic character will be removed from the exported file.
  • 'Replace': in case of an encoding error, the problematic character will be replaced with '?' symbol.
  • Leaving the field blank: in case of an encoding error, the report generation fails with an error message.
  • Line Ending: Select the type of line ending, 'CRLF' or 'CR', as necessary.
  • 'CRLF': 'Carriage Return' + 'Line Feed' (Windows)
  • 'CR': 'Carriage Return' (classic Mac OS)
  • Leaving this field blank defaults to using 'LF' (Line Feed), the default behavior of Odoo.

No verified information in OCA: Installation, Usage.

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.