odoo-addon-report-csv 15.0.2.0.0.4

Base module to create csv report

This module provides a basic report class to generate csv report.

Table of contents

• Configuration

• Usage

• Bug Tracker

• Credits

  • Authors

  • Contributors

  • Maintainers

Configuration

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

• Encoding: set an encoding system (such as cp932)

• 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.

Usage

An example of CSV report for partners on a module called module_name:

A python class

from odoo import models

class PartnerCSV(models.AbstractModel):
    _name = 'report.report_csv.partner_csv'
    _inherit = 'report.report_csv.abstract'

    def generate_csv_report(self, writer, data, partners):
        writer.writeheader()
        for obj in partners:
            writer.writerow({
                'name': obj.name,
                'email': obj.email,
            })

    def csv_report_options(self):
        res = super().csv_report_options()
        res['fieldnames'].append('name')
        res['fieldnames'].append('email')
        res['delimiter'] = ';'
        res['quoting'] = csv.QUOTE_ALL
        return res

A report XML record

<report
    id="partner_csv"
    model="res.partner"
    string="Print to CSV"
    report_type="csv"
    name="module_name.report_name"
    file="res_partner"
    attachment_use="False"
/>

Update encoding with an appropriate value (e.g. cp932) as necessary.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

• Creu Blanca

Contributors

• Enric Tobella <[e-mail]>

• Jaime Arroyo <[e-mail]>

• Rattapong Chokmasermkul <[e-mail]>

• Quartile:

  • Aung Ko Ko Lin

Maintainers

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/reporting-engine project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.