audrius/reporting-engine
1
0
Fork 1
mirror of https://github.com/OCA/reporting-engine.git synced 2025-02-16 16:30:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

[MIG][13.0] report_xml: Migration to 13.0

Browse Source
This commit is contained in:
Tatiana Deribina
2019-12-23 15:49:33 +02:00
committed by Enric Tobella
parent e2869482c9
commit 9df5049644
21 changed files with 428 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
report_xml/readme/CONTRIBUTORS.rst
View File

@@ -1,4 +1,5 @@
* Enric Tobella <etobella@creublanca.es>
* `Tecnativa <https://www.tecnativa.com>`_:
Jairo Llopis
* Jairo Llopis
* `Avoin.Systems <https://avoin.systems/>`_:
* Tatiana Deribina

22
report_xml/readme/USAGE.rst
View File

@@ -3,25 +3,30 @@ This module is intended as a base engine for other modules to use it, so no dire
If you are a developer
~~~~~~~~~~~~~~~~~~~~~~
To learn from an example, just check the `sample module`_.
To learn from an example, just check the `demo report`_ on GitHub for
the model ``res.company`` or check it in interface from companies views.
To develop with this module, you need to:
* Create a module.
* Make it depend on this one.
* Follow `instructions to create reports`_ having in mind that the
``report_type`` field in your ``ir.actions.report.xml`` record must be
``report_type`` field in your ``ir.actions.report`` record must be
``qweb-xml``.
In case you want to create a `custom report`_, the instructions remain the same
as for HTML reports, and the method that you must override is also called
``_get_report_values``, even when this time you are creating a XML report.
You can make your custom report inherit ``report_xml.xsd_checked_report``, name
it like your XML ``<template>`` id prepended by ``report.``, add a ``xsd()``
method that returns a XSD in a string, and have XSD automatic checking for
You can make your custom report inherit ``report.report_xml.abstract``, name
it in such way ``report.<module.report_name>``. Also you can add a XSD file for
report validation into ``xsd_schema`` field of your report (check
`report definition`_) and have XSD automatic checking for
free.
You can customize rendering process and validation way via changing logic of
``generate_report`` and ``validate_report`` methods in your report class.
You can visit ``http://<server-address>/report/xml/<module.report_name>/<ids>``
to see your XML report online as a web page.
@@ -30,6 +35,7 @@ For further information, please visit:
* https://www.odoo.com/forum/help-1
* https://github.com/OCA/reporting-engine
.. _custom report: https://www.odoo.com/documentation/12.0/reference/reports.html#custom-reports
.. _instructions to create reports: https://www.odoo.com/documentation/12.0/reference/reports.html
.. _sample module: https://github.com/OCA/reporting-engine/tree/12.0/report_xml_sample
.. _custom report: https://www.odoo.com/documentation/13.0/reference/reports.html#custom-reports
.. _instructions to create reports: https://www.odoo.com/documentation/13.0/reference/reports.html
.. _demo report: https://github.com/OCA/reporting-engine/blob/13.0/report_xml/demo/demo_report.xml
.. _report definition: https://github.com/OCA/reporting-engine/blob/13.0/report_xml/demo/report.xml