From df06e49e0c821e2ea2989588cafbbeeb0a21ec83 Mon Sep 17 00:00:00 2001 From: Afshan <33727827+AfshanKhan@users.noreply.github.com> Date: Mon, 26 Apr 2021 22:48:13 +0530 Subject: [PATCH] feat: enable custom field search on POS (#25421) * feat: multi lingual item search in POS * fix: limit the options for selection and broken down funtion for geting condition --- .../doctype/pos_search_fields/__init__.py | 0 .../pos_search_fields/pos_search_fields.json | 37 +++++++++++++++++ .../pos_search_fields/pos_search_fields.py | 10 +++++ .../doctype/pos_settings/pos_settings.js | 40 +++++++++++++++++++ .../doctype/pos_settings/pos_settings.json | 11 ++++- .../page/point_of_sale/point_of_sale.py | 26 +++++++++--- 6 files changed, 117 insertions(+), 7 deletions(-) create mode 100644 erpnext/accounts/doctype/pos_search_fields/__init__.py create mode 100644 erpnext/accounts/doctype/pos_search_fields/pos_search_fields.json create mode 100644 erpnext/accounts/doctype/pos_search_fields/pos_search_fields.py diff --git a/erpnext/accounts/doctype/pos_search_fields/__init__.py b/erpnext/accounts/doctype/pos_search_fields/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/erpnext/accounts/doctype/pos_search_fields/pos_search_fields.json b/erpnext/accounts/doctype/pos_search_fields/pos_search_fields.json new file mode 100644 index 0000000000..a627f5b5be --- /dev/null +++ b/erpnext/accounts/doctype/pos_search_fields/pos_search_fields.json @@ -0,0 +1,37 @@ +{ + "actions": [], + "creation": "2021-04-19 14:56:06.652327", + "doctype": "DocType", + "editable_grid": 1, + "engine": "InnoDB", + "field_order": [ + "field", + "fieldname" + ], + "fields": [ + { + "fieldname": "fieldname", + "fieldtype": "Data", + "hidden": 1, + "label": "Fieldname" + }, + { + "fieldname": "field", + "fieldtype": "Select", + "in_list_view": 1, + "label": "Field" + } + ], + "index_web_pages_for_search": 1, + "istable": 1, + "links": [], + "modified": "2021-04-21 11:12:54.632093", + "modified_by": "Administrator", + "module": "Accounts", + "name": "POS Search Fields", + "owner": "Administrator", + "permissions": [], + "sort_field": "modified", + "sort_order": "DESC", + "track_changes": 1 +} \ No newline at end of file diff --git a/erpnext/accounts/doctype/pos_search_fields/pos_search_fields.py b/erpnext/accounts/doctype/pos_search_fields/pos_search_fields.py new file mode 100644 index 0000000000..720ea77745 --- /dev/null +++ b/erpnext/accounts/doctype/pos_search_fields/pos_search_fields.py @@ -0,0 +1,10 @@ +# -*- coding: utf-8 -*- +# Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and contributors +# For license information, please see license.txt + +from __future__ import unicode_literals +# import frappe +from frappe.model.document import Document + +class POSSearchFields(Document): + pass diff --git a/erpnext/accounts/doctype/pos_settings/pos_settings.js b/erpnext/accounts/doctype/pos_settings/pos_settings.js index 3625393a80..9003af56a5 100644 --- a/erpnext/accounts/doctype/pos_settings/pos_settings.js +++ b/erpnext/accounts/doctype/pos_settings/pos_settings.js @@ -1,9 +1,17 @@ // Copyright (c) 2017, Frappe Technologies Pvt. Ltd. and contributors // For license information, please see license.txt +let search_fields_datatypes = ['Data', 'Link', 'Dynamic Link', 'Long Text', 'Select', 'Small Text', 'Text', 'Text Editor']; +let do_not_include_fields = ["naming_series", "item_code", "item_name", "stock_uom", "hub_sync_id", "asset_naming_series", + "default_material_request_type", "valuation_method", "warranty_period", "weight_uom", "batch_number_series", + "serial_no_series", "purchase_uom", "customs_tariff_number", "sales_uom", "deferred_revenue_account", + "deferred_expense_account", "quality_inspection_template", "route", "slideshow", "website_image_alt", "thumbnail", + "web_long_description", "hub_sync_id"] + frappe.ui.form.on('POS Settings', { onload: function(frm) { frm.trigger("get_invoice_fields"); + frm.trigger("add_search_options"); }, get_invoice_fields: function(frm) { @@ -21,6 +29,38 @@ frappe.ui.form.on('POS Settings', { ); }); + }, + + add_search_options: function(frm) { + frappe.model.with_doctype("Item", () => { + var fields = $.map(frappe.get_doc("DocType", "Item").fields, function(d) { + if (search_fields_datatypes.includes(d.fieldtype) && !(do_not_include_fields.includes(d.fieldname))) { + return [d.label]; + } else { + return null; + } + }); + + fields.unshift(''); + frm.fields_dict.pos_search_fields.grid.update_docfield_property('field', 'options', fields); + }); + + } +}); + +frappe.ui.form.on("POS Search Fields", { + field: function(frm, doctype, name) { + var doc = frappe.get_doc(doctype, name); + var df = $.map(frappe.get_doc("DocType", "Item").fields, function(d) { + if (doc.field == d.label && search_fields_datatypes.includes(d.fieldtype)) { + return d; + } else { + return null; + } + })[0]; + + doc.fieldname = df.fieldname; + frm.refresh_field("fields"); } }); diff --git a/erpnext/accounts/doctype/pos_settings/pos_settings.json b/erpnext/accounts/doctype/pos_settings/pos_settings.json index 35395889a6..962eb94a29 100644 --- a/erpnext/accounts/doctype/pos_settings/pos_settings.json +++ b/erpnext/accounts/doctype/pos_settings/pos_settings.json @@ -5,7 +5,8 @@ "editable_grid": 1, "engine": "InnoDB", "field_order": [ - "invoice_fields" + "invoice_fields", + "pos_search_fields" ], "fields": [ { @@ -13,11 +14,17 @@ "fieldtype": "Table", "label": "POS Field", "options": "POS Field" + }, + { + "fieldname": "pos_search_fields", + "fieldtype": "Table", + "label": "POS Search Fields", + "options": "POS Search Fields" } ], "issingle": 1, "links": [], - "modified": "2020-06-01 15:46:41.478928", + "modified": "2021-04-19 14:56:24.465218", "modified_by": "Administrator", "module": "Accounts", "name": "POS Settings", diff --git a/erpnext/selling/page/point_of_sale/point_of_sale.py b/erpnext/selling/page/point_of_sale/point_of_sale.py index 062cba19e6..750a1a6071 100644 --- a/erpnext/selling/page/point_of_sale/point_of_sale.py +++ b/erpnext/selling/page/point_of_sale/point_of_sale.py @@ -23,7 +23,7 @@ def get_items(start, page_length, price_list, item_group, pos_profile, search_va if search_value: data = search_serial_or_batch_or_barcode_number(search_value) - + item_code = data.get("item_code") if data.get("item_code") else search_value serial_no = data.get("serial_no") if data.get("serial_no") else "" batch_no = data.get("batch_no") if data.get("batch_no") else "" @@ -31,7 +31,7 @@ def get_items(start, page_length, price_list, item_group, pos_profile, search_va if data: item_info = frappe.db.get_value( - "Item", data.get("item_code"), + "Item", data.get("item_code"), ["name as item_code", "item_name", "description", "stock_uom", "image as item_image", "is_stock_item"] , as_dict=1) item_info.setdefault('serial_no', serial_no) @@ -139,8 +139,24 @@ def get_conditions(item_code, serial_no, batch_no, barcode): if serial_no or batch_no or barcode: return "item.name = {0}".format(frappe.db.escape(item_code)) - return """(item.name like {item_code} - or item.item_name like {item_code})""".format(item_code = frappe.db.escape('%' + item_code + '%')) + return make_condition(item_code) + +def make_condition(item_code): + condition = "(" + condition += """item.name like {item_code} + or item.item_name like {item_code}""".format(item_code = frappe.db.escape('%' + item_code + '%')) + condition += add_search_fields_condition(item_code) + condition += ")" + + return condition + +def add_search_fields_condition(item_code): + condition = '' + search_fields = frappe.get_all('POS Search Fields', fields = ['fieldname']) + if search_fields: + for field in search_fields: + condition += " or item.{0} like {1}".format(field['fieldname'], frappe.db.escape('%' + item_code + '%')) + return condition def get_item_group_condition(pos_profile): cond = "and 1=1" @@ -257,4 +273,4 @@ def set_customer_info(fieldname, customer, value=""): elif fieldname == 'mobile_no': contact_doc.set('phone_nos', [{ 'phone': value, 'is_primary_mobile_no': 1}]) frappe.db.set_value('Customer', customer, 'mobile_no', value) - contact_doc.save() \ No newline at end of file + contact_doc.save()