# XML Reports

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.

Table of contents

- Installation
- Usage
  - If you are a developer
- Bug Tracker
- Credits
  - Authors
  - Contributors
  - Other credits
  - Maintainers

# Installation

To install this module, you need to:

- Install lxml in Odoo’s `$PYTHONPATH`.
- Install the repository reporting-engine.

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.

# Usage

This module is intended as a base engine for other modules to use it, so no direct result if you are a user.

## If you are a developer

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` 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.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.

For further information, please visit:

- https://www.odoo.com/forum/help-1
- https://github.com/OCA/reporting-engine

# Bug Tracker

Bugs are tracked on GitHub Issues. 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 feedback.

Do not contact contributors directly about support or help with technical issues.

# Credits

## Authors

- Tecnativa
- Avoin.Systems

## Contributors

- Enric Tobella <etobella@creublanca.es>
- Tecnativa:
    - Jairo Llopis
- Avoin.Systems:
    - Tatiana Deribina
- Iván Antón <ozono@ozonomultimedia.com>

## Other credits

- Icon taken from http://commons.wikimedia.org/wiki/File:Text-xml.svg

## Maintainers

This module is maintained by the OCA.

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 project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.