Skip to main content

Base module to create csv report

Project description

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runbot

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

Table of contents

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 smashing 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

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

File details

Details for the file odoo13_addon_report_csv-13.0.1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo13_addon_report_csv-13.0.1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b3e77d7d9e5e5a951c3b5e1197ecbbb4e0d6ed9ad8a85f48d8c61ff0e55836f8
MD5 585ad1807c9bc8137037222b3d19c563
BLAKE2b-256 77f1ac3151af9ae547d0096c0134689ea66067ddc6aea4728026e31dd2d62ef8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page