=======================
Qweb PDF reports signer
=======================
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:67cb7abf50e6bd50c263bb56013faeac41e907b11074750cfa50c0c815d16fc7
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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/licence-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/16.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-16-0/reporting-engine-16-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=16.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 'report_qweb_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 'report_qweb_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
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:%2016.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/16.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": "=======================\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:67cb7abf50e6bd50c263bb56013faeac41e907b11074750cfa50c0c815d16fc7\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/licence-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/16.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-16-0/reporting-engine-16-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=16.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\nPDFs using 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 certificate(s)\nto 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 attachment\n\nFor example, if you want to sign only customer invoices in posted state:\n\n* Model: ``account.move``\n* Domain: ``[('move_type','=','out_invoice'), ('state', '=', 'posted')]``\n* Save as attachment: ``(object.name or '').replace('/','_') + '.signed.pdf'``\n\n**Note**: Linux user that executes Odoo server process must have\nread access 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 have a\nlower worker memory size than the JVM defaults, you may need to tune the JVM\nheap memory limits. Do so by adding a ``$JVM_ARGS`` environment variable that\ncontains the required flags. Check out these links too:\n\n- `StackOverflow answer <https://stackoverflow.com/a/14763095/1468388>`_.\n- `Java 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 usual,\nbut signed PDF is automatically downloaded if this document model is configured\nas indicated above.\n\nIf 'Save as attachment' is configured, signed PDF is saved as attachment and\nnext time saved one is downloaded without signing again. This is appropiate\nwhen signing date is important, for example, when signing customer invoices.\n\nYou can try the signing with the demo report that is included for customers\ncalled \"Test PDF certificate\".\n\nYou can set extra parameters of JSignPdf library in the system parameter\nnamed 'report_qweb_signer.java_position_parameters', for example '-V' to\nvisible signature into pdf. You can also set extra parameters for Java in the\nsystem parameter named 'report_qweb_signer.java_parameters'.\n\nKnown issues / Roadmap\n======================\n\n* When signing multiple documents (if 'Allow only one document' is disable)\n then 'Save as attachment' is not applied and signed result is not\n saved as attachment.\n* Add tests.\n* Why not taking the occasion to add the whole configuration at report level\n (if to be signed or not, the domain, etc...)?\n See https://github.com/OCA/reporting-engine/pull/533#issuecomment-898321161\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:%2016.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* Santi Arg\u00fceso <santi@comunitea.com>\n* Omar Casti\u00f1eira <omar@comunitea.com>\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>`__ or `LGPL2 <http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html>`__ - http://jsignpdf.sourceforge.net/\n\nIcon\n++++\n\n`Created by Anton Noskov from the Noun Project <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/16.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\n\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "Sign Qweb PDFs usign a PKCS#12 certificate",
"version": "16.0.1.0.1.3",
"project_urls": {
"Homepage": "https://github.com/OCA/reporting-engine"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "76528707c98bac2357506f296fc49bc7c12e1c3b89cc8b2b5fef6c3b1bb76ca5",
"md5": "f680dc8f316208df7be94913d0312e8f",
"sha256": "fa6d412cfbd52b444e346155693255e0a3b7170e8670b91d7099975887ea1643"
},
"downloads": -1,
"filename": "odoo_addon_report_qweb_signer-16.0.1.0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f680dc8f316208df7be94913d0312e8f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 18123392,
"upload_time": "2024-04-30T05:48:43",
"upload_time_iso_8601": "2024-04-30T05:48:43.464423Z",
"url": "https://files.pythonhosted.org/packages/76/52/8707c98bac2357506f296fc49bc7c12e1c3b89cc8b2b5fef6c3b1bb76ca5/odoo_addon_report_qweb_signer-16.0.1.0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 05:48:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "reporting-engine",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "odoo-addon-report-qweb-signer"
}
JSON
