<h1 class="title">Py3o Report Engine - Fusion server support</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/14.0/report_py3o_fusion_server"><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-14-0/reporting-engine-14-0-report_py3o_fusion_server"><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/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p>This module was written to let a py3o fusion server handle format conversion instead of local libreoffice. If you install this module above the <em>report_py3o</em> module, you will have to deploy additionnal software components and run 3 daemons (libreoffice, py3o.fusion and py3o.renderserver). This additionnal complexiy comes with several advantages:</p> <ul class="simple"> <li>much better performances: Libreoffice runs permanently in the background, no need to spawn a new Libreoffice instance upon every document conversion.</li> <li>ability to configure PDF export options in Odoo. This brings many new possibilities such as the ability to generate:<ul> <li>PDF forms</li> <li>PDF/A documents (required by some electronic invoicing standards such as <a class="reference external" href="http://fnfe-mpe.org/factur-x/factur-x_en/">Factur-X</a>)</li> <li>watermarked PDF documents</li> <li>password-protected PDF documents</li> </ul> </li> </ul> <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></li> <li><a class="reference internal" href="#known-issues-roadmap" id="id3">Known issues / Roadmap</a></li> <li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id5">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id6">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li> <li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li> </ul> </li> </ul> </div> <a name="installation"></a> <h2><a class="toc-backref" href="#id1">Installation</a></h2> <p>Install several additional components and Python libs:</p> <ul class="simple"> <li><a class="reference external" href="https://bitbucket.org/faide/py3o.fusion">Py3o Fusion server</a>,</li> <li><a class="reference external" href="https://bitbucket.org/faide/py3o.renderserver">Py3o render server</a>,</li> <li>a Java Runtime Environment (JRE), which can be OpenJDK,</li> <li>Libreoffice started in the background in headless mode,</li> <li>the Java driver for Libreoffice (Juno).</li> </ul> <p>It is also possible to use the Python driver for Libreoffice (PyUNO), but it is recommended to use the Java driver because it is more stable.</p> <p>The installation procedure below uses the Java driver. It has been successfully tested on Ubuntu 18.04 LTS ; if you use another OS, you may have to change a few details.</p> <p>Installation of Libreoffice, JRE and required Java libs on Debian/Ubuntu:</p> <pre class="code"> <code class="code">sudo apt-get install default-jre ure libgoogle-gson-java libreoffice-java-common libreoffice-writer</code> </pre> <p>You may have to install additionnal fonts. For example, to have the special unicode symbols for phone/fax/email in the PDF reports generated by Py3o, you should install the following package:</p> <pre class="code"> <code class="code">sudo apt-get install fonts-symbola</code> </pre> <p>Installation of py3o.fusion:</p> <pre class="code"> <code class="code">pip3 install py3o.fusion pip3 install service-identity</code> </pre> <p>Installation of py3o.renderserver:</p> <pre class="code"> <code class="code">pip3 install py3o.renderserver</code> </pre> <p>At the end, with the dependencies, you should have the following py3o python libs:</p> <pre class="code"> <code class="code">% pip3 freeze | grep py3o py3o.formats==0.3 py3o.fusion==0.8.9 py3o.renderclient==0.3 py3o.renderers.juno==0.8.1 py3o.renderserver==0.5.2 py3o.template==0.10.0 py3o.types==0.1.1</code> </pre> <p>Start the Py3o Fusion server:</p> <pre class="code"> <code class="code">start-py3o-fusion --debug -s localhost -i localhost</code> </pre> <p>Start the Py3o render server:</p> <pre class="code"> <code class="code">start-py3o-renderserver --java=/usr/lib/jvm/default-java/lib/server/libjvm.so --ure=/usr/share --office=/usr/lib/libreoffice --driver=juno --sofficeport=8997 -i localhost</code> </pre> <p>On the output of the Py3o render server, the first line looks like:</p> <pre class="code"> <code class="code">DEBUG:root:Starting JVM: /usr/lib/jvm/default-java/lib/server/libjvm.so with options: -Djava.class.path=/usr/local/lib/python2.7/dist-packages/py3o/renderers/juno/py3oconverter.jar:/usr/share/java/juh.jar:/usr/share/java/jurt.jar:/usr/share/java/ridl.jar:/usr/share/java/unoloader.jar:/usr/share/java/java_uno.jar:/usr/lib/libreoffice/program/classes/unoil.jar -Xmx150M</code> </pre> <p>After <strong>-Djava.class.path</strong>, there is a list of Java libs with <em>.jar</em> extension ; check that each JAR file is really present on your filesystem. If one of the jar files is present in another directory, create a symlink that points to the real location of the file. If all the jar files are present on another directory, adapt the <em>--ure=</em> argument on the command line of Py3o render server.</p> <p>To check that the Py3o Fusion server is running fine, visit the URL <a class="reference external" href="http:/">http:/</a>/&lt;IP_address&gt;:8765/form. On this web page, under the section <em>Target format</em>, make sure that you have a line <em>This server currently supports these formats: ods, odt, docx, doc, html, docbook, pdf, xls.</em>.</p> <p>If you want to produce valid PDF/A documents with this module, activating the corresponding option in the PDF Export Options may not be enough, you also have to make sure that all the fonts used in the document template are installed on the Odoo server, so that they can be embedded in the PDF/A document. For example, if your document template uses the Arial font, you should install that font on your Odoo server:</p> <pre class="code"> <code class="code">sudo apt-get install msttcorefonts</code> </pre> <a name="configuration"></a> <h2><a class="toc-backref" href="#id2">Configuration</a></h2> <p>To configure the PDF export options:</p> <ol class="arabic simple"> <li>Go to the menu <em>Settings &gt; Technical &gt; Reporting &gt; Py3o &gt; Py3o PDF Export Options</em> and create a PDF export options profile.</li> <li>Set the PDF export options profile on the Py3o Server (menu <em>Settings &gt; Technical &gt; Reporting &gt; Py3o &gt; Py3o Servers</em>) or on a particular Py3o report with PDF output format (menu <em>Settings &gt; Technical &gt; Actions &gt; Reports</em>).</li> </ol> <a name="known-issues-roadmap"></a> <h2><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h2> <ul class="simple"> <li>Add support for PDF signatures (possible, but no easy because the signature certificate is a very particular PDF export option)</li> </ul> <a name="bug-tracker"></a> <h2><a class="toc-backref" href="#id4">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_fusion_server%0Aversion:%2014.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="#id5">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id6">Authors</a></h3> <ul class="simple"> <li>XCG Consulting</li> <li>ACSONE SA/NV</li> <li>Akretion</li> </ul> <a name="contributors"></a> <h3><a class="toc-backref" href="#id7">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="#id8">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/14.0/report_py3o_fusion_server">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>