Print Format Settings

dave-greeko · January 19, 2022, 11:01pm

Hi All,
I have created a custom print format(HTML+CSS+Jinja) and all works well but I would like to add some variables to retrieve before rendering the document the likes of “Compact Item Print” when printing a sales invoice. I would appreciate it if I can get some guidance on how to go about achieving this.

Please see below,
print_format_custom

Best Regards,
Dave

dave-greeko · January 23, 2022, 7:06pm

Any suggestions?
Many thanks!

ChillarAnand · January 24, 2022, 2:29am

If you are using custom format builder, you can use Jinja rendering to add custom variables.

For example, to add customer in the print you can add the following line

{{ doc.customer }}

Similarly you can use other variables as needed.

peterg · January 24, 2022, 3:36am

Oh, wow, this is super-cool. I’d never noticed that before. Apparently Frappe polls each doctype for additional print settings to show, using the method get_print_setting.

github.com

frappe/frappe/blob/541db956a6e46f82a7136d9c7d981e9e766a30fb/frappe/printing/page/print/print.py

import frappe

@frappe.whitelist()
def get_print_settings_to_show(doctype, docname):
	doc = frappe.get_doc(doctype, docname)
	print_settings = frappe.get_single('Print Settings')

	if hasattr(doc, 'get_print_settings'):
		fields = doc.get_print_settings() or []
	else:
		return []

	print_settings_fields = []
	for fieldname in fields:
		df = print_settings.meta.get_field(fieldname)
		df.default = print_settings.get(fieldname)
		print_settings_fields.append(df)

	return print_settings_fields

The only implementation I could find was in the accounts controller:

github.com

frappe/erpnext/blob/14e0d00a6176dc89437d39245d208436f15cb156/erpnext/controllers/accounts_controller.py#L68


      
          
          
class AccountMissingError(frappe.ValidationError): pass
          
          
force_item_fields = ("item_group", "brand", "stock_uom", "is_fixed_asset", "item_tax_rate",
          	"pricing_rules", "weight_per_unit", "weight_uom", "total_weight")
          
          
class AccountsController(TransactionBase):
          	def __init__(self, *args, **kwargs):
          		super(AccountsController, self).__init__(*args, **kwargs)
          
          
	def get_print_settings(self):
          		print_setting_fields = []
          		items_field = self.meta.get_field('items')
          
          
		if items_field and items_field.fieldtype == 'Table':
          			print_setting_fields += ['compact_item_print', 'print_uom_after_quantity']
          
          
		taxes_field = self.meta.get_field('taxes')
          		if taxes_field and taxes_field.fieldtype == 'Table':
          			print_setting_fields += ['print_taxes_with_zero_amount']

Using that for an example, it should be pretty straightforward to add other settings to other documents. It will, however, require a custom app. I don’t think it’s possible to do this client-side.

dave-greeko · January 25, 2022, 5:06am

Many thanks @peterg