Skip to main content

Py3o Report Engine - Fusion server support

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

This module was written to let a py3o fusion server handle format conversion instead of local libreoffice. If you install this module above the report_py3o 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:

  • much better performances: Libreoffice runs permanently in the background, no need to spawn a new Libreoffice instance upon every document conversion.

  • ability to configure PDF export options in Odoo. This brings many new possibilities such as the ability to generate:

    • PDF forms

    • PDF/A documents (required by some electronic invoicing standards such as Factur-X)

    • watermarked PDF documents

    • password-protected PDF documents

Table of contents

Installation

Install several additional components and Python libs:

  • Py3o Fusion server,

  • Py3o render server,

  • a Java Runtime Environment (JRE), which can be OpenJDK,

  • Libreoffice started in the background in headless mode,

  • the Java driver for Libreoffice (Juno).

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.

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.

Installation of Libreoffice, JRE and required Java libs on Debian/Ubuntu:

sudo apt-get install default-jre ure libgoogle-gson-java libreoffice-java-common libreoffice-writer

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:

sudo apt-get install fonts-symbola

Installation of py3o.fusion:

pip3 install py3o.fusion
pip3 install service-identity

Installation of py3o.renderserver:

pip3 install py3o.renderserver

At the end, with the dependencies, you should have the following py3o python libs:

% 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

Start the Py3o Fusion server:

start-py3o-fusion --debug -s localhost -i localhost

Start the Py3o render server:

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

On the output of the Py3o render server, the first line looks like:

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

After -Djava.class.path, there is a list of Java libs with .jar 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 –ure= argument on the command line of Py3o render server.

To check that the Py3o Fusion server is running fine, visit the URL http://<IP_address>:8765/form. On this web page, under the section Target format, make sure that you have a line This server currently supports these formats: ods, odt, docx, doc, html, docbook, pdf, xls..

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:

sudo apt-get install msttcorefonts

Configuration

To configure the PDF export options:

  1. Go to the menu Settings > Technical > Reporting > Py3o > Py3o PDF Export Options and create a PDF export options profile.

  2. Set the PDF export options profile on the Py3o Server (menu Settings > Technical > Reporting > Py3o > Py3o Servers) or on a particular Py3o report with PDF output format (menu Settings > Technical > Actions > Reports).

Known issues / Roadmap

  • Add support for PDF signatures (possible, but no easy because the signature certificate is a very particular PDF export option)

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

  • XCG Consulting

  • ACSONE SA/NV

  • Akretion

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.

Metadata

Release files for odoo-addon-report-py3o-fusion-server 18.0.1.0.0.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo-addon-report-py3o-fusion-server 18.0.1.0.0.8
File Interpreter ABI Platform
odoo_addon_report_py3o_fusion_server-18.0.1.0.0.8-py3-none-any.whl Python 3 none any Details

Release files / odoo_addon_report_py3o_fusion_server-18.0.1.0.0.8-py3-none-any.whl

Download URL odoo_addon_report_py3o_fusion_server-18.0.1.0.0.8-py3-none-any.whl
Size 285.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a3e2a40dc3683c1ed8a435cb33dd7b039a3e87e3c9ea4b4b7940be0bbf41cf38
BLAKE2b-256 checksum
How to use checksums
03080a2ab23ece4d967215f671eab1fd7b67c27eed0504cb59f1e0f30dd6acd5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page