.. image:: https://odoo-community.org/readme-banner-image
:target: https://odoo-community.org/get-involved?utm_source=readme
:alt: Odoo Community Association
=======================
Qweb PDF reports signer
=======================
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:8e3e54c5fb4cf809950609cadd0a782a02940ee7a40be85ffbc935d24ec465fa
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
:target: https://github.com/OCA/reporting-engine/tree/17.0/report_qweb_signer
:alt: OCA/reporting-engine
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/reporting-engine-17-0/reporting-engine-17-0-report_qweb_signer
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=17.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This module extends the functionality of report module to sign PDFs
using a PKCS#12 certificate.
**Table of contents**
.. contents::
:local:
Installation
============
To install this module, you need to install Java JDK Headlees, e.g.:
apt-get install default-jre-headless
Configuration
=============
In order to start signing PDF documents you need to configure
certificate(s) to use in your company.
- Go to ``Settings > Companies > Companies > Your company``
- Go to ``Report configuration`` tab
- Click ``Edit``
- Add a new item in ``PDF report certificates`` list
- Click ``Create``
- Set name, certificate file, password file and model
- Optionally you can set a domain and filename pattern for saving as
attachment
For example, if you want to sign only customer invoices in posted state:
- Model: ``account.move``
- Domain:
``[('move_type','=','out_invoice'), ('state', '=', 'posted')]``
- Save as attachment:
``(object.name or '').replace('/','_') + '.signed.pdf'``
**Note**: Linux user that executes Odoo server process must have read
access to certificate file and password file
Java Memory Settings
--------------------
If you are signing large amounts of reports at the same time, or if you
have a lower worker memory size than the JVM defaults, you may need to
tune the JVM heap memory limits. Do so by adding a ``$JVM_ARGS``
environment variable that contains the required flags. Check out these
links too:
- `StackOverflow
answer <https://stackoverflow.com/a/14763095/1468388>`__.
- `Java
docs <https://docs.oracle.com/cd/E15523_01/web.1111/e13814/jvm_tuning.htm#PERFM161>`__.
Usage
=====
User just prints PDF documents (only Qweb PDF reports supported) as
usual, but signed PDF is automatically downloaded if this document model
is configured as indicated above.
If 'Save as attachment' is configured, signed PDF is saved as attachment
and next time saved one is downloaded without signing again. This is
appropiate when signing date is important, for example, when signing
customer invoices.
You can try the signing with the demo report that is included for
customers called "Test PDF certificate".
You can set extra parameters of JSignPdf library in the system parameter
named 'reportqweb_signer.java_position_parameters', for example '-V' to
visible signature into pdf. You can also set extra parameters for Java
in the system parameter named 'reportqweb_signer.java_parameters'.
Known issues / Roadmap
======================
- When signing multiple documents (if 'Allow only one document' is
disable) then 'Save as attachment' is not applied and signed result is
not saved as attachment.
- Add tests.
- Why not taking the occasion to add the whole configuration at report
level (if to be signed or not, the domain, etc...)? See
https://github.com/OCA/reporting-engine/pull/533#issuecomment-898321161
- This module is incompatible with the ``account_edi_ubl_cii`` module,
because the PDF content is altered after rendering. See:
https://github.com/odoo/odoo/blob/5977da2c93d522ece984d2fa8a31624f4b612eca/addons/account_edi_ubl_cii/models/account_move_send.py#L131C9-L140
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/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 <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qweb_signer%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits
=======
Authors
-------
* Tecnativa
Contributors
------------
- `Tecnativa <https://www.tecnativa.com>`__:
- Rafael Blasco
- Antonio Espinosa
- Pedro M. Baeza
- Jairo Llopis
- David Vidal
- Santi Argüeso <santi@comunitea.com>
- Omar Castiñeira <omar@comunitea.com>
- `Punt Sistemes <https://www.puntsistemes.es>`__:
- Isaac Gallart <igallart@puntsistemes.es>
Other credits
-------------
External utilities
~~~~~~~~~~~~~~~~~~
- JSignPdf: © Josef Cacek - License `MPL <http://www.mozilla.org/MPL>`__
or `LGPL2 <http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html>`__
- http://jsignpdf.sourceforge.net/
Icon
~~~~
`Created by Anton Noskov from the Noun
Project <https://thenounproject.com/search/?q=signed+contract&i=65694>`__
Maintainers
-----------
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
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 <https://github.com/OCA/reporting-engine/tree/17.0/report_qweb_signer>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/reporting-engine",
"name": "odoo-addon-report-qweb-signer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Tecnativa, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": null,
"platform": null,
"description": ".. image:: https://odoo-community.org/readme-banner-image\n :target: https://odoo-community.org/get-involved?utm_source=readme\n :alt: Odoo Community Association\n\n=======================\nQweb PDF reports signer\n=======================\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:8e3e54c5fb4cf809950609cadd0a782a02940ee7a40be85ffbc935d24ec465fa\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github\n :target: https://github.com/OCA/reporting-engine/tree/17.0/report_qweb_signer\n :alt: OCA/reporting-engine\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/reporting-engine-17-0/reporting-engine-17-0-report_qweb_signer\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=17.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis module extends the functionality of report module to sign PDFs\nusing a PKCS#12 certificate.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nInstallation\n============\n\nTo install this module, you need to install Java JDK Headlees, e.g.:\n\n apt-get install default-jre-headless\n\nConfiguration\n=============\n\nIn order to start signing PDF documents you need to configure\ncertificate(s) to use in your company.\n\n- Go to ``Settings > Companies > Companies > Your company``\n- Go to ``Report configuration`` tab\n- Click ``Edit``\n- Add a new item in ``PDF report certificates`` list\n- Click ``Create``\n- Set name, certificate file, password file and model\n- Optionally you can set a domain and filename pattern for saving as\n attachment\n\nFor example, if you want to sign only customer invoices in posted state:\n\n- Model: ``account.move``\n- Domain:\n ``[('move_type','=','out_invoice'), ('state', '=', 'posted')]``\n- Save as attachment:\n ``(object.name or '').replace('/','_') + '.signed.pdf'``\n\n**Note**: Linux user that executes Odoo server process must have read\naccess to certificate file and password file\n\nJava Memory Settings\n--------------------\n\nIf you are signing large amounts of reports at the same time, or if you\nhave a lower worker memory size than the JVM defaults, you may need to\ntune the JVM heap memory limits. Do so by adding a ``$JVM_ARGS``\nenvironment variable that contains the required flags. Check out these\nlinks too:\n\n- `StackOverflow\n answer <https://stackoverflow.com/a/14763095/1468388>`__.\n- `Java\n docs <https://docs.oracle.com/cd/E15523_01/web.1111/e13814/jvm_tuning.htm#PERFM161>`__.\n\nUsage\n=====\n\nUser just prints PDF documents (only Qweb PDF reports supported) as\nusual, but signed PDF is automatically downloaded if this document model\nis configured as indicated above.\n\nIf 'Save as attachment' is configured, signed PDF is saved as attachment\nand next time saved one is downloaded without signing again. This is\nappropiate when signing date is important, for example, when signing\ncustomer invoices.\n\nYou can try the signing with the demo report that is included for\ncustomers called \"Test PDF certificate\".\n\nYou can set extra parameters of JSignPdf library in the system parameter\nnamed 'reportqweb_signer.java_position_parameters', for example '-V' to\nvisible signature into pdf. You can also set extra parameters for Java\nin the system parameter named 'reportqweb_signer.java_parameters'.\n\nKnown issues / Roadmap\n======================\n\n- When signing multiple documents (if 'Allow only one document' is\n disable) then 'Save as attachment' is not applied and signed result is\n not saved as attachment.\n- Add tests.\n- Why not taking the occasion to add the whole configuration at report\n level (if to be signed or not, the domain, etc...)? See\n https://github.com/OCA/reporting-engine/pull/533#issuecomment-898321161\n- This module is incompatible with the ``account_edi_ubl_cii`` module,\n because the PDF content is altered after rendering. See:\n https://github.com/odoo/odoo/blob/5977da2c93d522ece984d2fa8a31624f4b612eca/addons/account_edi_ubl_cii/models/account_move_send.py#L131C9-L140\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qweb_signer%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n-------\n\n* Tecnativa\n\nContributors\n------------\n\n- `Tecnativa <https://www.tecnativa.com>`__:\n\n - Rafael Blasco\n - Antonio Espinosa\n - Pedro M. Baeza\n - Jairo Llopis\n - David Vidal\n\n- Santi Arg\u00fceso <santi@comunitea.com>\n\n- Omar Casti\u00f1eira <omar@comunitea.com>\n\n- `Punt Sistemes <https://www.puntsistemes.es>`__:\n\n - Isaac Gallart <igallart@puntsistemes.es>\n\nOther credits\n-------------\n\nExternal utilities\n~~~~~~~~~~~~~~~~~~\n\n- JSignPdf: \u00a9 Josef Cacek - License `MPL <http://www.mozilla.org/MPL>`__\n or `LGPL2 <http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html>`__\n - http://jsignpdf.sourceforge.net/\n\nIcon\n~~~~\n\n`Created by Anton Noskov from the Noun\nProject <https://thenounproject.com/search/?q=signed+contract&i=65694>`__\n\nMaintainers\n-----------\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/17.0/report_qweb_signer>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "Sign Qweb PDFs usign a PKCS#12 certificate",
"version": "17.0.1.0.2",
"project_urls": {
"Homepage": "https://github.com/OCA/reporting-engine"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b52ffa4ae90b5579537263fd30f4878b0ce2a8dc282a9e5223e4b920c00f01f9",
"md5": "4467d2b7f5836b0ffb8b87942c1eea7e",
"sha256": "d67471896f9479e1ddc63ff472f064077e9b3be3c7ba0d2c9ed95246025b9077"
},
"downloads": -1,
"filename": "odoo_addon_report_qweb_signer-17.0.1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4467d2b7f5836b0ffb8b87942c1eea7e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 18124298,
"upload_time": "2025-07-24T11:44:50",
"upload_time_iso_8601": "2025-07-24T11:44:50.471861Z",
"url": "https://files.pythonhosted.org/packages/b5/2f/fa4ae90b5579537263fd30f4878b0ce2a8dc282a9e5223e4b920c00f01f9/odoo_addon_report_qweb_signer-17.0.1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-24 11:44:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "reporting-engine",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "lxml",
"specs": []
},
{
"name": "mock",
"specs": []
},
{
"name": "openpyxl",
"specs": []
},
{
"name": "py3o.formats",
"specs": []
},
{
"name": "py3o.template",
"specs": []
},
{
"name": "xlrd",
"specs": []
},
{
"name": "xlsxwriter",
"specs": []
}
],
"lcname": "odoo-addon-report-qweb-signer"
}
JSON
