feat: CRM Settings (#27788)
* feat: crm settings
* feat: CRM Settings
* feat: lead and opprtunity section
* feat: added CRM Settings in ERPNext Settings workspace
* fix: review chnages
* added patch
* fix: linter issues
* fix: linter issues
* fix: linter issues
* fix: removed crm settings from selling module
* fix: raw query to frappe.qb
* fix: removed hardcoded value
* fix: linter issue
* fix: simplify CRM Settings migration patch
Co-authored-by: Anupam Kumar <anupam@Anupams-MacBook-Air.local>
Co-authored-by: Rucha Mahabal <ruchamahabal2@gmail.com>
diff --git a/erpnext/crm/doctype/crm_settings/__init__.py b/erpnext/crm/doctype/crm_settings/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/erpnext/crm/doctype/crm_settings/__init__.py
diff --git a/erpnext/crm/doctype/crm_settings/crm_settings.js b/erpnext/crm/doctype/crm_settings/crm_settings.js
new file mode 100644
index 0000000..c6569d8
--- /dev/null
+++ b/erpnext/crm/doctype/crm_settings/crm_settings.js
@@ -0,0 +1,8 @@
+// Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and contributors
+// For license information, please see license.txt
+
+frappe.ui.form.on('CRM Settings', {
+ // refresh: function(frm) {
+
+ // }
+});
diff --git a/erpnext/crm/doctype/crm_settings/crm_settings.json b/erpnext/crm/doctype/crm_settings/crm_settings.json
new file mode 100644
index 0000000..95b19fa
--- /dev/null
+++ b/erpnext/crm/doctype/crm_settings/crm_settings.json
@@ -0,0 +1,114 @@
+{
+ "actions": [],
+ "creation": "2021-09-09 17:03:22.754446",
+ "description": "Settings for Selling Module",
+ "doctype": "DocType",
+ "document_type": "Other",
+ "engine": "InnoDB",
+ "field_order": [
+ "section_break_5",
+ "campaign_naming_by",
+ "allow_lead_duplication_based_on_emails",
+ "column_break_4",
+ "create_event_on_next_contact_date",
+ "auto_creation_of_contact",
+ "opportunity_section",
+ "close_opportunity_after_days",
+ "column_break_9",
+ "create_event_on_next_contact_date_opportunity",
+ "quotation_section",
+ "default_valid_till"
+ ],
+ "fields": [
+ {
+ "fieldname": "campaign_naming_by",
+ "fieldtype": "Select",
+ "in_list_view": 1,
+ "label": "Campaign Naming By",
+ "options": "Campaign Name\nNaming Series"
+ },
+ {
+ "fieldname": "column_break_9",
+ "fieldtype": "Column Break"
+ },
+ {
+ "fieldname": "default_valid_till",
+ "fieldtype": "Data",
+ "label": "Default Quotation Validity Days"
+ },
+ {
+ "fieldname": "section_break_5",
+ "fieldtype": "Section Break",
+ "label": "Lead"
+ },
+ {
+ "default": "0",
+ "fieldname": "allow_lead_duplication_based_on_emails",
+ "fieldtype": "Check",
+ "label": "Allow Lead Duplication based on Emails"
+ },
+ {
+ "default": "1",
+ "fieldname": "auto_creation_of_contact",
+ "fieldtype": "Check",
+ "label": "Auto Creation of Contact"
+ },
+ {
+ "default": "1",
+ "fieldname": "create_event_on_next_contact_date",
+ "fieldtype": "Check",
+ "label": "Create Event on Next Contact Date"
+ },
+ {
+ "fieldname": "opportunity_section",
+ "fieldtype": "Section Break",
+ "label": "Opportunity"
+ },
+ {
+ "default": "15",
+ "description": "Auto close Opportunity Replied after the no. of days mentioned above",
+ "fieldname": "close_opportunity_after_days",
+ "fieldtype": "Int",
+ "label": "Close Replied Opportunity After Days"
+ },
+ {
+ "default": "1",
+ "fieldname": "create_event_on_next_contact_date_opportunity",
+ "fieldtype": "Check",
+ "label": "Create Event on Next Contact Date"
+ },
+ {
+ "fieldname": "column_break_4",
+ "fieldtype": "Column Break"
+ },
+ {
+ "fieldname": "quotation_section",
+ "fieldtype": "Section Break",
+ "label": "Quotation"
+ }
+ ],
+ "icon": "fa fa-cog",
+ "index_web_pages_for_search": 1,
+ "issingle": 1,
+ "links": [],
+ "migration_hash": "3ae78b12dd1c64d551736c6e82092f90",
+ "modified": "2021-11-03 09:00:36.883496",
+ "modified_by": "Administrator",
+ "module": "CRM",
+ "name": "CRM Settings",
+ "owner": "Administrator",
+ "permissions": [
+ {
+ "create": 1,
+ "email": 1,
+ "print": 1,
+ "read": 1,
+ "role": "System Manager",
+ "share": 1,
+ "write": 1
+ }
+ ],
+ "sort_field": "modified",
+ "sort_order": "DESC",
+ "track_changes": 1
+}
\ No newline at end of file
diff --git a/erpnext/crm/doctype/crm_settings/crm_settings.py b/erpnext/crm/doctype/crm_settings/crm_settings.py
new file mode 100644
index 0000000..bde5254
--- /dev/null
+++ b/erpnext/crm/doctype/crm_settings/crm_settings.py
@@ -0,0 +1,9 @@
+# Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and contributors
+# For license information, please see license.txt
+
+# import frappe
+from frappe.model.document import Document
+
+
+class CRMSettings(Document):
+ pass
diff --git a/erpnext/crm/doctype/crm_settings/test_crm_settings.py b/erpnext/crm/doctype/crm_settings/test_crm_settings.py
new file mode 100644
index 0000000..3372c5d
--- /dev/null
+++ b/erpnext/crm/doctype/crm_settings/test_crm_settings.py
@@ -0,0 +1,9 @@
+# Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors
+# See license.txt
+
+# import frappe
+import unittest
+
+
+class TestCRMSettings(unittest.TestCase):
+ pass
diff --git a/erpnext/crm/doctype/lead/lead.py b/erpnext/crm/doctype/lead/lead.py
index c590523..9adbe8b 100644
--- a/erpnext/crm/doctype/lead/lead.py
+++ b/erpnext/crm/doctype/lead/lead.py
@@ -11,6 +11,7 @@
cint,
comma_and,
cstr,
+ get_link_to_form,
getdate,
has_gravatar,
nowdate,
@@ -91,13 +92,14 @@
self.contact_doc.save()
def add_calendar_event(self, opts=None, force=False):
- super(Lead, self).add_calendar_event({
- "owner": self.lead_owner,
- "starts_on": self.contact_date,
- "ends_on": self.ends_on or "",
- "subject": ('Contact ' + cstr(self.lead_name)),
- "description": ('Contact ' + cstr(self.lead_name)) + (self.contact_by and ('. By : ' + cstr(self.contact_by)) or '')
- }, force)
+ if frappe.db.get_single_value('CRM Settings', 'create_event_on_next_contact_date'):
+ super(Lead, self).add_calendar_event({
+ "owner": self.lead_owner,
+ "starts_on": self.contact_date,
+ "ends_on": self.ends_on or "",
+ "subject": ('Contact ' + cstr(self.lead_name)),
+ "description": ('Contact ' + cstr(self.lead_name)) + (self.contact_by and ('. By : ' + cstr(self.contact_by)) or '')
+ }, force)
def update_prospects(self):
prospects = frappe.get_all('Prospect Lead', filters={'lead': self.name}, fields=['parent'])
@@ -108,12 +110,13 @@
def check_email_id_is_unique(self):
if self.email_id:
# validate email is unique
- duplicate_leads = frappe.get_all("Lead", filters={"email_id": self.email_id, "name": ["!=", self.name]})
- duplicate_leads = [lead.name for lead in duplicate_leads]
+ if not frappe.db.get_single_value('CRM Settings', 'allow_lead_duplication_based_on_emails'):
+ duplicate_leads = frappe.get_all("Lead", filters={"email_id": self.email_id, "name": ["!=", self.name]})
+ duplicate_leads = [frappe.bold(get_link_to_form('Lead', lead.name)) for lead in duplicate_leads]
- if duplicate_leads:
- frappe.throw(_("Email Address must be unique, already exists for {0}")
- .format(comma_and(duplicate_leads)), frappe.DuplicateEntryError)
+ if duplicate_leads:
+ frappe.throw(_("Email Address must be unique, already exists for {0}")
+ .format(comma_and(duplicate_leads)), frappe.DuplicateEntryError)
def on_trash(self):
frappe.db.sql("""update `tabIssue` set lead='' where lead=%s""", self.name)
@@ -172,41 +175,42 @@
self.title = self.company_name or self.lead_name
def create_contact(self):
- if not self.lead_name:
- self.set_full_name()
- self.set_lead_name()
+ if frappe.db.get_single_value('CRM Settings', 'auto_creation_of_contact'):
+ if not self.lead_name:
+ self.set_full_name()
+ self.set_lead_name()
- contact = frappe.new_doc("Contact")
- contact.update({
- "first_name": self.first_name or self.lead_name,
- "last_name": self.last_name,
- "salutation": self.salutation,
- "gender": self.gender,
- "designation": self.designation,
- "company_name": self.company_name,
- })
-
- if self.email_id:
- contact.append("email_ids", {
- "email_id": self.email_id,
- "is_primary": 1
+ contact = frappe.new_doc("Contact")
+ contact.update({
+ "first_name": self.first_name or self.lead_name,
+ "last_name": self.last_name,
+ "salutation": self.salutation,
+ "gender": self.gender,
+ "designation": self.designation,
+ "company_name": self.company_name,
})
- if self.phone:
- contact.append("phone_nos", {
- "phone": self.phone,
- "is_primary_phone": 1
- })
+ if self.email_id:
+ contact.append("email_ids", {
+ "email_id": self.email_id,
+ "is_primary": 1
+ })
- if self.mobile_no:
- contact.append("phone_nos", {
- "phone": self.mobile_no,
- "is_primary_mobile_no":1
- })
+ if self.phone:
+ contact.append("phone_nos", {
+ "phone": self.phone,
+ "is_primary_phone": 1
+ })
- contact.insert(ignore_permissions=True)
+ if self.mobile_no:
+ contact.append("phone_nos", {
+ "phone": self.mobile_no,
+ "is_primary_mobile_no":1
+ })
- return contact
+ contact.insert(ignore_permissions=True)
+
+ return contact
@frappe.whitelist()
def make_customer(source_name, target_doc=None):
diff --git a/erpnext/crm/doctype/opportunity/opportunity.py b/erpnext/crm/doctype/opportunity/opportunity.py
index 0bef80a..fcbd4de 100644
--- a/erpnext/crm/doctype/opportunity/opportunity.py
+++ b/erpnext/crm/doctype/opportunity/opportunity.py
@@ -8,6 +8,7 @@
from frappe import _
from frappe.email.inbox import link_communication_to_document
from frappe.model.mapper import get_mapped_doc
+from frappe.query_builder import DocType
from frappe.utils import cint, cstr, flt, get_fullname
from erpnext.setup.utils import get_exchange_rate
@@ -28,7 +29,6 @@
})
self.make_new_lead_if_required()
-
self.validate_item_details()
self.validate_uom_is_integer("uom", "qty")
self.validate_cust_name()
@@ -70,21 +70,21 @@
"""Set lead against new opportunity"""
if (not self.get("party_name")) and self.contact_email:
# check if customer is already created agains the self.contact_email
- customer = frappe.db.sql("""select
- distinct `tabDynamic Link`.link_name as customer
- from
- `tabContact`,
- `tabDynamic Link`
- where `tabContact`.email_id='{0}'
- and
- `tabContact`.name=`tabDynamic Link`.parent
- and
- ifnull(`tabDynamic Link`.link_name, '')<>''
- and
- `tabDynamic Link`.link_doctype='Customer'
- """.format(self.contact_email), as_dict=True)
- if customer and customer[0].customer:
- self.party_name = customer[0].customer
+ dynamic_link, contact = DocType("Dynamic Link"), DocType("Contact")
+ customer = frappe.qb.from_(
+ dynamic_link
+ ).join(
+ contact
+ ).on(
+ (contact.name == dynamic_link.parent)
+ & (dynamic_link.link_doctype == "Customer")
+ & (contact.email_id == self.contact_email)
+ ).select(
+ dynamic_link.link_name
+ ).distinct().run(as_dict=True)
+
+ if customer and customer[0].link_name:
+ self.party_name = customer[0].link_name
self.opportunity_from = "Customer"
return
@@ -191,30 +191,31 @@
self.add_calendar_event()
def add_calendar_event(self, opts=None, force=False):
- if not opts:
- opts = frappe._dict()
+ if frappe.db.get_single_value('CRM Settings', 'create_event_on_next_contact_date_opportunity'):
+ if not opts:
+ opts = frappe._dict()
- opts.description = ""
- opts.contact_date = self.contact_date
+ opts.description = ""
+ opts.contact_date = self.contact_date
- if self.party_name and self.opportunity_from == 'Customer':
- if self.contact_person:
- opts.description = 'Contact '+cstr(self.contact_person)
- else:
- opts.description = 'Contact customer '+cstr(self.party_name)
- elif self.party_name and self.opportunity_from == 'Lead':
- if self.contact_display:
- opts.description = 'Contact '+cstr(self.contact_display)
- else:
- opts.description = 'Contact lead '+cstr(self.party_name)
+ if self.party_name and self.opportunity_from == 'Customer':
+ if self.contact_person:
+ opts.description = 'Contact '+cstr(self.contact_person)
+ else:
+ opts.description = 'Contact customer '+cstr(self.party_name)
+ elif self.party_name and self.opportunity_from == 'Lead':
+ if self.contact_display:
+ opts.description = 'Contact '+cstr(self.contact_display)
+ else:
+ opts.description = 'Contact lead '+cstr(self.party_name)
- opts.subject = opts.description
- opts.description += '. By : ' + cstr(self.contact_by)
+ opts.subject = opts.description
+ opts.description += '. By : ' + cstr(self.contact_by)
- if self.to_discuss:
- opts.description += ' To Discuss : ' + cstr(self.to_discuss)
+ if self.to_discuss:
+ opts.description += ' To Discuss : ' + cstr(self.to_discuss)
- super(Opportunity, self).add_calendar_event(opts, force)
+ super(Opportunity, self).add_calendar_event(opts, force)
def validate_item_details(self):
if not self.get('items'):
@@ -363,7 +364,7 @@
def auto_close_opportunity():
""" auto close the `Replied` Opportunities after 7 days """
- auto_close_after_days = frappe.db.get_single_value("Selling Settings", "close_opportunity_after_days") or 15
+ auto_close_after_days = frappe.db.get_single_value("CRM Settings", "close_opportunity_after_days") or 15
opportunities = frappe.db.sql(""" select name from tabOpportunity where status='Replied' and
modified<DATE_SUB(CURDATE(), INTERVAL %s DAY) """, (auto_close_after_days), as_dict=True)
diff --git a/erpnext/patches.txt b/erpnext/patches.txt
index 7a2cc7a..ee9060b 100644
--- a/erpnext/patches.txt
+++ b/erpnext/patches.txt
@@ -313,3 +313,4 @@
erpnext.patches.v13_0.create_pan_field_for_india #2
erpnext.patches.v14_0.delete_hub_doctypes
erpnext.patches.v13_0.create_ksa_vat_custom_fields
+erpnext.patches.v14_0.migrate_crm_settings
diff --git a/erpnext/patches/v14_0/migrate_crm_settings.py b/erpnext/patches/v14_0/migrate_crm_settings.py
new file mode 100644
index 0000000..30d3ea0
--- /dev/null
+++ b/erpnext/patches/v14_0/migrate_crm_settings.py
@@ -0,0 +1,16 @@
+import frappe
+
+
+def execute():
+ settings = frappe.db.get_value('Selling Settings', 'Selling Settings', [
+ 'campaign_naming_by',
+ 'close_opportunity_after_days',
+ 'default_valid_till'
+ ], as_dict=True)
+
+ frappe.reload_doc('crm', 'doctype', 'crm_settings')
+ frappe.db.set_value('CRM Settings', 'CRM Settings', {
+ 'campaign_naming_by': settings.campaign_naming_by,
+ 'close_opportunity_after_days': settings.close_opportunity_after_days,
+ 'default_valid_till': settings.default_valid_till
+ })
diff --git a/erpnext/selling/doctype/selling_settings/selling_settings.json b/erpnext/selling/doctype/selling_settings/selling_settings.json
index c27f1ea..27bc541 100644
--- a/erpnext/selling/doctype/selling_settings/selling_settings.json
+++ b/erpnext/selling/doctype/selling_settings/selling_settings.json
@@ -11,11 +11,6 @@
"customer_group",
"column_break_4",
"territory",
- "crm_settings_section",
- "campaign_naming_by",
- "default_valid_till",
- "column_break_9",
- "close_opportunity_after_days",
"item_price_settings_section",
"selling_price_list",
"maintain_same_rate_action",
@@ -44,13 +39,6 @@
"options": "Customer Name\nNaming Series\nAuto Name"
},
{
- "fieldname": "campaign_naming_by",
- "fieldtype": "Select",
- "in_list_view": 1,
- "label": "Campaign Naming By",
- "options": "Campaign Name\nNaming Series\nAuto Name"
- },
- {
"fieldname": "customer_group",
"fieldtype": "Link",
"in_list_view": 1,
@@ -72,18 +60,6 @@
"options": "Price List"
},
{
- "default": "15",
- "description": "Auto close Opportunity after the no. of days mentioned above",
- "fieldname": "close_opportunity_after_days",
- "fieldtype": "Int",
- "label": "Close Opportunity After Days"
- },
- {
- "fieldname": "default_valid_till",
- "fieldtype": "Data",
- "label": "Default Quotation Validity Days"
- },
- {
"fieldname": "column_break_5",
"fieldtype": "Column Break"
},
@@ -170,15 +146,6 @@
"fieldtype": "Column Break"
},
{
- "fieldname": "crm_settings_section",
- "fieldtype": "Section Break",
- "label": "CRM Settings"
- },
- {
- "fieldname": "column_break_9",
- "fieldtype": "Column Break"
- },
- {
"fieldname": "item_price_settings_section",
"fieldtype": "Section Break",
"label": "Item Price Settings"
@@ -204,7 +171,7 @@
"index_web_pages_for_search": 1,
"issingle": 1,
"links": [],
- "modified": "2021-09-08 19:38:10.175989",
+ "modified": "2021-09-13 12:32:17.004404",
"modified_by": "Administrator",
"module": "Selling",
"name": "Selling Settings",
diff --git a/erpnext/setup/workspace/erpnext_settings/erpnext_settings.json b/erpnext/setup/workspace/erpnext_settings/erpnext_settings.json
index 1412acf..e47837f 100644
--- a/erpnext/setup/workspace/erpnext_settings/erpnext_settings.json
+++ b/erpnext/setup/workspace/erpnext_settings/erpnext_settings.json
@@ -10,7 +10,7 @@
"idx": 0,
"label": "ERPNext Settings",
"links": [],
- "modified": "2021-10-26 21:32:55.323591",
+ "modified": "2021-11-05 21:32:55.323591",
"modified_by": "Administrator",
"module": "Setup",
"name": "ERPNext Settings",
@@ -123,6 +123,13 @@
"label": "Products Settings",
"link_to": "Products Settings",
"type": "DocType"
+ },
+ {
+ "doc_view": "",
+ "icon": "crm",
+ "label": "CRM Settings",
+ "link_to": "CRM Settings",
+ "type": "DocType"
}
],
"title": "ERPNext Settings"
diff --git a/erpnext/startup/boot.py b/erpnext/startup/boot.py
index ed8c878..0da45a5 100644
--- a/erpnext/startup/boot.py
+++ b/erpnext/startup/boot.py
@@ -22,7 +22,7 @@
'customer_group')
bootinfo.sysdefaults.allow_stale = cint(frappe.db.get_single_value('Accounts Settings',
'allow_stale'))
- bootinfo.sysdefaults.quotation_valid_till = cint(frappe.db.get_single_value('Selling Settings',
+ bootinfo.sysdefaults.quotation_valid_till = cint(frappe.db.get_single_value('CRM Settings',
'default_valid_till'))
# if no company, show a dialog box to create a new company