Odoo Community Association

DOCX reports

Alpha License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runboat

This module allows to provide docx files as report templates to generate docx reports.

Important

This is an alpha version, the data model and design can change at any time without warning. Only for development or testing purpose, do not use in production. More details on development status

Table of contents

Use Cases / Context

This module was developed because for some users it is easier to use the docx format for their templates.

As it uses a slightly different templating language, it is not a drop-in replacement for report_py3o.

It also does not provide any format conversions, though it should be pretty simple to write a glue module that converts the resulting docx files to formats supported by report_py3o.

Installation

To install this module, you need to:

pip install docxtpl

Configuration

To configure this module, you need to:

  1. Go to Settings / Technical / Actions / Report
  2. Create a new report with type DOCX
  3. Fill in the name of a model, ie crm.lead
  4. Upload your DOCX file in the Template field
  5. To help with crafting expressions in the template, switch to the DOCX tab, select a record and fill in some expression. When happy with the result, copy the code into your template document. Don’t forget to read the extensive documentation on the right hand side

Usage

To use this module, you need to:

  1. Print some report created according to the configuration manual

Known issues / Roadmap

  • support images and embedded objects
  • support concatenating docx files for multiple records
  • support embedding html

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

  • Hunki Enterprises BV

Other credits

The development of this module has been financially supported by:

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.

Current maintainer:

hbrunn

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.