<h1 class="title">Py3o Report Engine</h1> <p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/13.0/report_py3o"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/reporting-engine-13-0/reporting-engine-13-0-report_py3o"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/143/13.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p>The py3o reporting engine is a reporting engine for Odoo based on <a class="reference external" href="http://www.libreoffice.org/">Libreoffice</a>:</p> <ul class="simple"> <li>the report is created with Libreoffice (ODT or ODS),</li> <li>the report is stored on the server in OpenDocument format (.odt or .ods file)</li> <li>the report is sent to the user in OpenDocument format or in any output format supported by Libreoffice (PDF, HTML, DOC, DOCX, Docbook, XLS, etc.)</li> </ul> <p>The key advantages of a Libreoffice based reporting engine are:</p> <ul class="simple"> <li>no need to be a developer to create or modify a report: the report is created and modified with Libreoffice. So this reporting engine has a full WYSIWYG report development tool!</li> <li>For a PDF report in A4/Letter format, it's easier to develop it with a tool such as Libreoffice that is designed to create A4/Letter documents than to develop it in HTML/CSS, also some print peculiarities (backgrounds, margin boxes) are not very well supported by the HTML/CSS based solutions.</li> <li>If you want your users to be able to modify the document after its generation by Odoo, just configure the document with ODT output (or DOC or DOCX) and the user will be able to modify the document with Libreoffice (or Word) after its generation by Odoo.</li> <li>Easy development of spreadsheet reports in ODS format (XLS output possible).</li> </ul> <p>This module <em>report_py3o</em> is the base module for the Py3o reporting engine. If used alone, it will spawn a libreoffice process for each ODT to PDF (or ODT to DOCX, ..) document conversion. This is slow and can become a problem if you have a lot of reports to convert from ODT to another format. In this case, you should consider the additionnal module <em>report_py3o_fusion_server</em> which is designed to work with a libreoffice daemon. With <em>report_py3o_fusion_server</em>, the technical environnement is more complex to setup because you have to install additionnal software components and run 2 daemons, but you have much better performances and you can configure the libreoffice PDF export options in Odoo (allows to generate PDF forms, PDF/A documents, password-protected PDFs, watermarked PDFs, etc.).</p> <p>This reporting engine is an alternative to <a class="reference external" href="https://github.com/aeroo-community/aeroo_reports">Aeroo</a>: these two reporting engines have similar features but their implementation is entirely different. You cannot use aeroo templates as drop in replacement though, you'll have to change a few details.</p> <p><strong>Table of contents</strong></p> <div class="contents local topic" id="contents"> <ul class="simple"> <li><a class="reference internal" href="#installation" id="id1">Installation</a></li> <li><a class="reference internal" href="#configuration" id="id2">Configuration</a><ul> <li><a class="reference internal" href="#configuration-parameters" id="id3">Configuration parameters</a></li> </ul> </li> <li><a class="reference internal" href="#usage" id="id4">Usage</a><ul> <li><a class="reference internal" href="#available-functions-and-objects" id="id5">Available functions and objects</a></li> <li><a class="reference internal" href="#sample-report-templates" id="id6">Sample report templates</a></li> </ul> </li> <li><a class="reference internal" href="#known-issues-roadmap" id="id7">Known issues / Roadmap</a></li> <li><a class="reference internal" href="#bug-tracker" id="id8">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id9">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id10">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id11">Contributors</a></li> <li><a class="reference internal" href="#maintainers" id="id12">Maintainers</a></li> </ul> </li> </ul> </div> <a name="installation"></a> <h2><a class="toc-backref" href="#id1">Installation</a></h2> <p>Install the required python libs:</p> <pre class="code"> <code class="code">pip install py3o.template pip install py3o.formats</code> </pre> <p>To allow the conversion of ODT or ODS reports to other formats (PDF, DOC, DOCX, etc.), install libreoffice:</p> <pre class="code"> <code class="code">apt-get --no-install-recommends install libreoffice</code> </pre> <a name="configuration"></a> <h2><a class="toc-backref" href="#id2">Configuration</a></h2> <p>For example, to replace the native invoice report by a custom py3o report, add the following XML file in your custom module:</p> <pre class="code"> <code class="code">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt; &lt;odoo&gt; &lt;record id=&quot;account.account_invoices&quot; model=&quot;ir.actions.report&quot;&gt; &lt;field name=&quot;report_type&quot;&gt;py3o&lt;/field&gt; &lt;field name=&quot;py3o_filetype&quot;&gt;odt&lt;/field&gt; &lt;field name=&quot;module&quot;&gt;my_custom_module_base&lt;/field&gt; &lt;field name=&quot;py3o_template_fallback&quot;&gt;report/account_invoice.odt&lt;/field&gt; &lt;/record&gt; &lt;/odoo&gt;</code> </pre> <p>where <em>my_custom_module_base</em> is the name of the custom Odoo module. In this example, the invoice ODT file is located in <em>my_custom_module_base/report/account_invoice.odt</em>.</p> <p>It's also possible to reference a template located in a trusted path of your Odoo server. In this case you must let the <em>module</em> entry empty and specify the path to the template as <em>py3o_template_fallback</em>.</p> <pre class="code"> <code class="code">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt; &lt;odoo&gt; &lt;record id=&quot;account.account_invoices&quot; model=&quot;ir.actions.report&quot;&gt; &lt;field name=&quot;report_type&quot;&gt;py3o&lt;/field&gt; &lt;field name=&quot;py3o_filetype&quot;&gt;odt&lt;/field&gt; &lt;field name=&quot;py3o_template_fallback&quot;&gt;/odoo/templates/py3o/report/account_invoice.odt&lt;/field&gt; &lt;/record&gt; &lt;/odoo&gt;</code> </pre> <p>Moreover, you must also modify the Odoo server configuration file to declare the allowed root directory for your py3o templates. Only templates located into this directory can be loaded by py3o report.</p> <pre class="code"> <code class="code">[options] ... [report_py3o] root_tmpl_path=/odoo/templates/py3o</code> </pre> <p>If you want an invoice in PDF format instead of ODT format, the XML file should look like:</p> <pre class="code"> <code class="code">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt; &lt;odoo&gt; &lt;record id=&quot;account.account_invoices&quot; model=&quot;ir.actions.report&quot;&gt; &lt;field name=&quot;report_type&quot;&gt;py3o&lt;/field&gt; &lt;field name=&quot;py3o_filetype&quot;&gt;pdf&lt;/field&gt; &lt;field name=&quot;module&quot;&gt;my_custom_module_base&lt;/field&gt; &lt;field name=&quot;py3o_template_fallback&quot;&gt;report/account_invoice.odt&lt;/field&gt; &lt;/record&gt; &lt;/odoo&gt;</code> </pre> <p>If you want to add a new py3o PDF report (and not replace a native report), the XML file should look like this:</p> <pre class="code"> <code class="code">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt; &lt;odoo&gt; &lt;record id=&quot;partner_summary_report&quot; model=&quot;ir.actions.report&quot;&gt; &lt;field name=&quot;name&quot;&gt;Partner Summary&lt;/field&gt; &lt;field name=&quot;model&quot;&gt;res.partner&lt;/field&gt; &lt;field name=&quot;report_name&quot;&gt;res.partner.summary&lt;/field&gt; &lt;field name=&quot;report_type&quot;&gt;py3o&lt;/field&gt; &lt;field name=&quot;py3o_filetype&quot;&gt;pdf&lt;/field&gt; &lt;field name=&quot;module&quot;&gt;my_custom_module_base&lt;/field&gt; &lt;field name=&quot;py3o_template_fallback&quot;&gt;report/partner_summary.odt&lt;/field&gt; &lt;!-- Add entry in &quot;Print&quot; drop-down list --&gt; &lt;field name=&quot;binding_type&quot;&gt;report&lt;/field&gt; &lt;field name=&quot;binding_model_id&quot; ref=&quot;base.model_res_partner&quot;/&gt; &lt;/record&gt; &lt;/odoo&gt;</code> </pre> <a name="configuration-parameters"></a> <h3><a class="toc-backref" href="#id3">Configuration parameters</a></h3> <dl class="docutils"> <dt>py3o.conversion_command</dt> <dd>The command to be used to run the conversion, <code>libreoffice</code> by default. If you change this, whatever you set here must accept the parameters <code>--headless --convert-to $ext $file</code> and put the resulting file into <code>$file</code>'s directory with extension <code>$ext</code>. The command will be started in <code>$file</code>'s directory.</dd> </dl> <a name="usage"></a> <h2><a class="toc-backref" href="#id4">Usage</a></h2> <p>The templating language is <a class="reference external" href="http://py3otemplate.readthedocs.io/en/latest/templating.html">extensively documented</a>, the records are exposed in libreoffice as <code>objects</code>, on which you can also call functions.</p> <a name="available-functions-and-objects"></a> <h3><a class="toc-backref" href="#id5">Available functions and objects</a></h3> <dl class="docutils"> <dt>user</dt> <dd>Browse record of current user</dd> <dt>lang</dt> <dd>The user's company's language as string (ISO code)</dd> <dt>b64decode</dt> <dd><code>base64.b64decode</code></dd> <dt>format_multiline_value(string)</dt> <dd>Generate the ODF equivalent of <code>&lt;br/&gt;</code> and <code>&amp;nbsp;</code> for multiline fields (ODF is XML internally, so those would be skipped otherwise)</dd> <dt>html_sanitize(string)</dt> <dd>Sanitize HTML string</dd> <dt>time</dt> <dd>Python's <code>time</code> module</dd> <dt>display_address(partner)</dt> <dd>Return a formatted string of the partner's address</dd> <dt>o_format_lang(value, lang_code=False, digits=None, grouping=True, monetary=False, dp=False, currency_obj=False, no_break_space=True)</dt> <dd>Return a formatted numeric or monetary value according to the context language and timezone</dd> <dt>o_format_date(value, lang_code=False, date_format=False)</dt> <dd>Return a formatted date or time value according to the context language and timezone</dd> </dl> <a name="sample-report-templates"></a> <h3><a class="toc-backref" href="#id6">Sample report templates</a></h3> <p>Sample py3o report templates for the main Odoo native reports (invoice, sale order, purchase order, picking, etc.) are available on the Github project <a class="reference external" href="https://github.com/akretion/odoo-py3o-report-templates">odoo-py3o-report-templates</a>.</p> <a name="known-issues-roadmap"></a> <h2><a class="toc-backref" href="#id7">Known issues / Roadmap</a></h2> <ul class="simple"> <li>generate barcode ?</li> <li>add more detailed example in demo file to showcase features</li> <li>add migration guide aeroo -&gt; py3o</li> </ul> <a name="bug-tracker"></a> <h2><a class="toc-backref" href="#id8">Bug Tracker</a></h2> <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/reporting-engine/issues">GitHub Issues</a>. 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 <a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_py3o%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <p>Do not contact contributors directly about support or help with technical issues.</p> <a name="credits"></a> <h2><a class="toc-backref" href="#id9">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id10">Authors</a></h3> <ul class="simple"> <li>XCG Consulting</li> <li>ACSONE SA/NV</li> </ul> <a name="contributors"></a> <h3><a class="toc-backref" href="#id11">Contributors</a></h3> <ul class="simple"> <li>Florent Aide (<a class="reference external" href="http://odoo.consulting/">XCG Consulting</a>)</li> <li>Laurent Mignon &lt;<a class="reference external" href="mailto:laurent.mignon&#64;acsone.eu">laurent.mignon&#64;acsone.eu</a>&gt;,</li> <li>Alexis de Lattre &lt;<a class="reference external" href="mailto:alexis.delattre&#64;akretion.com">alexis.delattre&#64;akretion.com</a>&gt;,</li> <li>Guewen Baconnier &lt;<a class="reference external" href="mailto:guewen.baconnier&#64;camptocamp.com">guewen.baconnier&#64;camptocamp.com</a>&gt;</li> <li>Omar Castiñeira &lt;<a class="reference external" href="mailto:omar&#64;comunitea.com">omar&#64;comunitea.com</a>&gt;</li> <li>Holger Brunn &lt;<a class="reference external" href="mailto:hbrunn&#64;therp.nl">hbrunn&#64;therp.nl</a>&gt;</li> </ul> <a name="maintainers"></a> <h3><a class="toc-backref" href="#id12">Maintainers</a></h3> <p>This module is maintained by the OCA.</p> <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> <p>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.</p> <p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/13.0/report_py3o">OCA/reporting-engine</a> project on GitHub.</p> <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>