Search 1.9 billion lines of Odoo code on GitHub
report_qweb_signer
<h1 class="title">Qweb PDF reports signer</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_qweb_signer"><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_qweb_signer"><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 extends the functionality of report module to sign
PDFs using a PKCS#12 certificate.</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="#java-memory-settings" id="id3">Java Memory Settings</a></li>
</ul>
</li>
<li><a class="reference internal" href="#usage" id="id4">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id5">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id6">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id7">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id8">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id9">Contributors</a></li>
<li><a class="reference internal" href="#other-credits" id="id10">Other credits</a><ul>
<li><a class="reference internal" href="#external-utilities" id="id11">External utilities</a></li>
<li><a class="reference internal" href="#icon" id="id12">Icon</a></li>
</ul>
</li>
<li><a class="reference internal" href="#maintainers" id="id13">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="installation"></a>
<h2><a class="toc-backref" href="#id1">Installation</a></h2>
<p>To install this module, you need to install Java JDK Headlees, e.g.:</p>
<blockquote>
apt-get install default-jre-headless</blockquote>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id2">Configuration</a></h2>
<p>In order to start signing PDF documents you need to configure certificate(s)
to use in your company.</p>
<ul class="simple">
<li>Go to <code>Settings > Companies > Companies > Your company</code></li>
<li>Go to <code>Report configuration</code> tab</li>
<li>Click <code>Edit</code></li>
<li>Add a new item in <code>PDF report certificates</code> list</li>
<li>Click <code>Create</code></li>
<li>Set name, certificate file, password file and model</li>
<li>Optionally you can set a domain and filename pattern for saving as attachment</li>
</ul>
<p>For example, if you want to sign only customer invoices in open or paid state:</p>
<ul class="simple">
<li>Model: <code>account.invoice</code></li>
<li>Domain: <code>[('type','=','out_invoice'), ('state', 'in', ('open', 'paid'))]</code></li>
<li>Save as attachment: <code>(object.number or '').replace('/','_') + '.signed.pdf'</code></li>
</ul>
<p><strong>Note</strong>: Linux user that executes Odoo server process must have
read access to certificate file and password file</p>
<a name="java-memory-settings"></a>
<h3><a class="toc-backref" href="#id3">Java Memory Settings</a></h3>
<p>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 <code>$JVM_ARGS</code> environment variable that
contains the required flags. Check out these links too:</p>
<ul class="simple">
<li><a class="reference external" href="https://stackoverflow.com/a/14763095/1468388">StackOverflow answer</a>.</li>
<li><a class="reference external" href="https://docs.oracle.com/cd/E15523_01/web.1111/e13814/jvm_tuning.htm#PERFM161">Java docs</a>.</li>
</ul>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id4">Usage</a></h2>
<p>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.</p>
<p>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.</p>
<p>You can try the signing with the demo report that is included for customers
called "Test PDF certificate".</p>
<p>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'.</p>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id5">Known issues / Roadmap</a></h2>
<ul class="simple">
<li>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.</li>
<li>Add tests.</li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id6">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_qweb_signer%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="#id7">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id8">Authors</a></h3>
<ul class="simple">
<li>Tecnativa</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id9">Contributors</a></h3>
<ul>
<li><p class="first"><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:</p>
<blockquote>
<ul class="simple">
<li>Rafael Blasco</li>
<li>Antonio Espinosa</li>
<li>Pedro M. Baeza</li>
<li>Jairo Llopis</li>
<li>David Vidal</li>
</ul>
</blockquote>
</li>
<li><p class="first">Santi Argüeso <<a class="reference external" href="mailto:santi@comunitea.com">santi@comunitea.com</a>></p>
</li>
<li><p class="first">Omar Castiñeira <<a class="reference external" href="mailto:omar@comunitea.com">omar@comunitea.com</a>></p>
</li>
</ul>
<a name="other-credits"></a>
<h3><a class="toc-backref" href="#id10">Other credits</a></h3>
<a name="external-utilities"></a>
<h4><a class="toc-backref" href="#id11">External utilities</a></h4>
<ul class="simple">
<li>JSignPdf: © Josef Cacek - License <a class="reference external" href="http://www.mozilla.org/MPL">MPL</a> or <a class="reference external" href="http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html">LGPL2</a> - <a class="reference external" href="http://jsignpdf.sourceforge.net/">http://jsignpdf.sourceforge.net/</a></li>
</ul>
<a name="icon"></a>
<h4><a class="toc-backref" href="#id12">Icon</a></h4>
<p><a class="reference external" href="https://thenounproject.com/search/?q=signed+contract&i=65694">Created by Anton Noskov from the Noun Project</a></p>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id13">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_qweb_signer">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>