<img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg"> <a name="qweb-xml-reports"></a> <h2>Qweb XML Reports</h2> <p>This module was written to extend the functionality of the reporting engine to support XML reports and allow modules to generate them by code or by QWeb templates.</p> <a name="installation"></a> <h2>Installation</h2> <p>To install this module, you need to:</p> <ul class="simple"> <li>Install <a class="reference external" href="http://lxml.de/">lxml</a> in Odoo's <code>$PYTHONPATH</code>.</li> <li>Install the repository <a class="reference external" href="https://github.com/OCA/reporting-engine">reporting-engine</a>.</li> </ul> <p>But this module does nothing for the end user by itself, so if you have it installed it's probably because there is another module that depends on it.</p> <a name="configuration"></a> <h2>Configuration</h2> <p>No manual configuration is needed.</p> <a name="usage"></a> <h2>Usage</h2> <a name="if-you-are-a-user"></a> <h3>If you are a user</h3> <p>You will be able to download XML reports from the <em>Print</em> menu found on form and list views.</p> <a name="if-you-are-a-developer"></a> <h3>If you are a developer</h3> <p>To learn from an example, just check the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/8.0/report_xml_sample">sample module</a>.</p> <p>To develop with this module, you need to:</p> <ul class="simple"> <li>Create a module.</li> <li>Make it depend on this one.</li> <li>Follow <a class="reference external" href="https://www.odoo.com/documentation/8.0/reference/reports.html">instructions to create reports</a> having in mind that the <code>report_type</code> field in your <code>ir.actions.report.xml</code> record must be <code>qweb-xml</code>.</li> </ul> <p>In case you want to create a <a class="reference external" href="https://www.odoo.com/documentation/8.0/reference/reports.html#custom-reports">custom report</a>, the instructions remain the same as for HTML reports, and the method that you must override is also called <code>render_html</code>, even when this time you are creating a XML report.</p> <p>You can make your custom report inherit <code>report_xml.xsd_checked_report</code>, name it like your XML <code>&lt;template&gt;</code> id prepended by <code>report.</code>, add a <code>xsd()</code> method that returns a XSD in a string, and have XSD automatic checking for free.</p> <p>You can visit <code>http://&lt;server-address&gt;/report/xml/&lt;module.report_name&gt;/&lt;ids&gt;</code> to see your XML report online as a web page.</p> <p>For further information, please visit:</p> <ul class="simple"> <li><a class="reference external" href="https://www.odoo.com/forum/help-1">https://www.odoo.com/forum/help-1</a></li> <li><a class="reference external" href="https://github.com/OCA/reporting-engine">https://github.com/OCA/reporting-engine</a></li> </ul> <a name="known-issues-roadmap"></a> <h2>Known issues / Roadmap</h2> <p>None</p> <a name="credits"></a> <h2>Credits</h2> <ul class="simple"> <li>Icon taken from <a class="reference external" href="http://commons.wikimedia.org/wiki/File:Text-xml.svg">http://commons.wikimedia.org/wiki/File:Text-xml.svg</a>.</li> </ul> <a name="contributors"></a> <h3>Contributors</h3> <ul class="simple"> <li>Jairo Llopis &lt;<a class="reference external" href="mailto:j.llopis&#64;grupoesoc.es">j.llopis&#64;grupoesoc.es</a>&gt;</li> </ul> <a name="maintainer"></a> <h3>Maintainer</h3> <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>This module is maintained by the OCA.</p> <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>To contribute to this module, please visit <a class="reference external" href="http://odoo-community.org">http://odoo-community.org</a>.</p>