Create QWEB Custom Report using Abstract Model in Odoo

Qweb Reporting Engine | To day you will learn how to create custom reports in Odoo using QWEB reporting engine. In this post we will learn how to create simple custom reports and its template using QWEB.

What is QWEB

Qweb is a reporting engine or template engine used by Odoo. By using this (QWEB) we can create reports in odoo. It uses XML to create design of reports as per your need. We can also say that QWEB is XML based reporting engine for OpenERP/Odoo.

Read More: How to Add Page Number in QWEB Report

Models.py

	class example_report(models.AbstractModel):
	_name = 'report.module_name.report_my_custom_report'
	@api.multi
	def render_html(self,data=None):
	report_obj = self.env['report']
	report = report_obj._get_report_from_name('module_name.report_my_custom_report')
	# your report data structure goes in data_array
	data_array = []
	docargs = {
	'hold_data_array':data_array,
	}
	# here we will pass the report data into our report template
	return report_obj.render('module_name.report_my_custom_report', docargs)

view raw create_qweb_custom_report.py hosted with ❤ by GitHub

Description

Here we describe important lines, In line no 1 we declare a class named  "example_report" and here we use "AbstractModel", for creating our reports.

Read More: Add Custom Header and Footer in QWEB Reports

In line no 2 we declare the name of our report (Note: Here the important things is the name of the report should be same as the name of "template_id" which is created in xml file of the report.) and  In line no 14 we render our "Data" to xml files.

Read More: Generate QR Code for QWEB Report and Redirect to URL in Odoo

XML

	<?xml version="1.0" encoding="UTF-8"?>
	<openerp>
	<data>
	<report id="your_report_id"
	model="your.model.name"
	string="Report Name Goes Here"
	name="module_name.report_my_custom_report"
	file="module_name.your_report_id"
	report_type="qweb-html" />
	<template id="report_my_custom_report">
	<t t-call="report.layout">
	<div class="page">
	<div class="text-center">
	<h4>
	<b>Hello This is Custom Report (Odoo QWEB)</b>
	</h4>
	<t t-foreach="hold_data_array" t-as="data">
	<t t-esc="data[0]" />
	<t t-esc="data[1]" />
	......
	......
	......
	</t>
	</div>
	</div>
	</t>
	</template>
	</data>
	</openerp>

view raw create_qweb_custom_report.xml hosted with ❤ by GitHub

Description

Here the name of template id (report_my_custom_report) is same as the name of report (Line no 2 in Model.py file).

Read More: How to Link Custom Paper Format in QWEB Reports

The screen shot of above report is given below: