Script Report python file return's advanced Use

mtajammul · February 5, 2018, 6:30am

Hi there,
We are normally using custom report python file to return columns and data.
But we want to send more data along with report to be used in html file.
I searched deep and saw below lines in query_report.py file

github.com

frappe/frappe/blob/e3de8c10ef9b9dbba1d215e49c62b6c4af9beaa4/frappe/desk/query_report.py#L112


      
          				chart = res[3]
          			if len(res) > 4:
          				data_to_be_printed = res[4]
          
          
	if report.apply_user_permissions and result:
          		result = get_filtered_data(report.ref_doctype, columns, result, user)
          
          
	if cint(report.add_total_row) and result:
          		result = add_total_row(result, columns)
          
          
	return {
          		"result": result,
          		"columns": columns,
          		"message": message,
          		"chart": chart,
          		"data_to_be_printed": data_to_be_printed
          	}
          
          

          
@frappe.whitelist()
          def export_query():

these lines are showing that we can return three other variables to be used.
But when i access message, chart or data_to_be_printed variables in html I found none of them are available there.
I am returning data from python file like this.
return columns, data, ["test"], [], ["data 1", "data 2"]
How to access these variables (message, chart or data_to_be_printed) in html file?
Please help.

magic-overflow · February 5, 2018, 7:01am

It returns those values but it’s not available to use.

github.com

frappe/frappe/blob/03720775d0f121be50189e52c6e8a813232ec759/frappe/public/js/frappe/views/reports/query_report.js#L501


      
          
          
		this.setup_header_row();
          		this.grid.init();
          		this.setup_sort();
          
          
		// further setup of grid like click subscription for tree
          		if (this.get_query_report_opts().tree) {
          			this.setup_tree();
          		}
          
          
		this.set_message(res.message);
          		this.setup_chart(res);
          		this.set_print_data(res.data_to_be_printed);
          
          
		this.toggle_expand_collapse_buttons(this.is_tree_report);
          	},
          
          
	make_columns: function(columns) {
          		var me = this;
          		var formatter = this.get_formatter();

mtajammul · February 5, 2018, 7:12am

Just checked here

github.com

frappe/frappe/blob/03720775d0f121be50189e52c6e8a813232ec759/frappe/public/js/frappe/views/reports/query_report.js#L193


      
          	print_report: function() {
          		if(!frappe.model.can_print(this.report_doc.ref_doctype)) {
          			frappe.msgprint(__("You are not allowed to print this report"));
          			return false;
          		}
          		if(this.html_format) {
          			var content = frappe.render(this.html_format, {
          				data: frappe.slickgrid_tools.get_filtered_items(this.dataView),
          				filters: this.get_values(),
          				report: this,
          				data_to_be_printed: this.data_to_be_printed
          			});
          
          
			frappe.render_grid({
          				content: content,
          				title: __(this.report_name),
          				print_settings: this.print_settings,
          				columns: this.columns
          			});
          		} else {
          			frappe.render_grid({

And I found that data_to_be_printed is available in html
Tested and successful
That’s very nice, really needed this.
I hope this discussion or post will help others
I Love ERPNext

magic-overflow · February 5, 2018, 7:16am

BTW what’s your use case to use data_to_be_printed?

report template?

mtajammul · February 5, 2018, 7:16am

So to help others:
You can return from python file like below

return columns, data, [ ], [ ], [ "Data 1", "Data 2" ]

and the last parameter will be available in html under the variable of data_to_be_printed enjoy

mtajammul · February 5, 2018, 7:18am

Yes I want to print other information too in report html template. Before I was able to use only filters, columns and rows.
Now I can send other information through data_to_be_printed and use it while printing.