patch: create if not exist default data fields layout for lead/deal

This commit is contained in:
Shariq Ansari 2024-12-10 17:40:34 +05:30
parent b4c766f513
commit 0c14decc52
2 changed files with 107 additions and 14 deletions

View File

@ -1,14 +1,14 @@
# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors # Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors
# MIT License. See license.txt # MIT License. See license.txt
from __future__ import unicode_literals
import click import click
import frappe import frappe
from frappe.custom.doctype.custom_field.custom_field import create_custom_fields from frappe.custom.doctype.custom_field.custom_field import create_custom_fields
def before_install(): def before_install():
pass pass
def after_install(force=False): def after_install(force=False):
add_default_lead_statuses() add_default_lead_statuses()
add_default_deal_statuses() add_default_deal_statuses()
@ -20,6 +20,7 @@ def after_install(force=False):
add_default_lead_sources() add_default_lead_sources()
frappe.db.commit() frappe.db.commit()
def add_default_lead_statuses(): def add_default_lead_statuses():
statuses = { statuses = {
"New": { "New": {
@ -58,6 +59,7 @@ def add_default_lead_statuses():
doc.position = statuses[status]["position"] doc.position = statuses[status]["position"]
doc.insert() doc.insert()
def add_default_deal_statuses(): def add_default_deal_statuses():
statuses = { statuses = {
"Qualification": { "Qualification": {
@ -100,6 +102,7 @@ def add_default_deal_statuses():
doc.position = statuses[status]["position"] doc.position = statuses[status]["position"]
doc.insert() doc.insert()
def add_default_communication_statuses(): def add_default_communication_statuses():
statuses = ["Open", "Replied"] statuses = ["Open", "Replied"]
@ -111,46 +114,58 @@ def add_default_communication_statuses():
doc.status = status doc.status = status
doc.insert() doc.insert()
def add_default_fields_layout(force=False): def add_default_fields_layout(force=False):
quick_entry_layouts = { quick_entry_layouts = {
"CRM Lead-Quick Entry": { "CRM Lead-Quick Entry": {
"doctype": "CRM Lead", "doctype": "CRM Lead",
"layout": '[{"label":"Person","fields":["salutation","first_name","last_name","email","mobile_no", "gender"],"hideLabel":true},{"label":"Organization","fields":["organization","website","no_of_employees","territory","annual_revenue","industry"],"hideLabel":true,"hideBorder":false},{"label":"Other","columns":2,"fields":["status","lead_owner"],"hideLabel":true,"hideBorder":false}]' "layout": '[{"label":"Person","fields":["salutation","first_name","last_name","email","mobile_no", "gender"],"hideLabel":true},{"label":"Organization","fields":["organization","website","no_of_employees","territory","annual_revenue","industry"],"hideLabel":true,"hideBorder":false},{"label":"Other","columns":2,"fields":["status","lead_owner"],"hideLabel":true,"hideBorder":false}]',
}, },
"CRM Deal-Quick Entry": { "CRM Deal-Quick Entry": {
"doctype": "CRM Deal", "doctype": "CRM Deal",
"layout": '[{"label": "Select Organization", "fields": ["organization"], "hideLabel": true, "editable": true}, {"label": "Organization Details", "fields": ["organization_name", "website", "no_of_employees", "territory", "annual_revenue", "industry"], "hideLabel": true, "editable": true}, {"label": "Select Contact", "fields": ["contact"], "hideLabel": true, "editable": true}, {"label": "Contact Details", "fields": ["salutation", "first_name", "last_name", "email", "mobile_no", "gender"], "hideLabel": true, "editable": true}, {"label": "Other", "columns": 2, "fields": ["status", "deal_owner"], "hideLabel": true}]' "layout": '[{"label": "Select Organization", "fields": ["organization"], "hideLabel": true, "editable": true}, {"label": "Organization Details", "fields": ["organization_name", "website", "no_of_employees", "territory", "annual_revenue", "industry"], "hideLabel": true, "editable": true}, {"label": "Select Contact", "fields": ["contact"], "hideLabel": true, "editable": true}, {"label": "Contact Details", "fields": ["salutation", "first_name", "last_name", "email", "mobile_no", "gender"], "hideLabel": true, "editable": true}, {"label": "Other", "columns": 2, "fields": ["status", "deal_owner"], "hideLabel": true}]',
}, },
"Contact-Quick Entry": { "Contact-Quick Entry": {
"doctype": "Contact", "doctype": "Contact",
"layout": '[{"label":"Salutation","columns":1,"fields":["salutation"],"hideLabel":true},{"label":"Full Name","columns":2,"hideBorder":true,"fields":["first_name","last_name"],"hideLabel":true},{"label":"Email","columns":1,"hideBorder":true,"fields":["email_id"],"hideLabel":true},{"label":"Mobile No. & Gender","columns":2,"hideBorder":true,"fields":["mobile_no","gender"],"hideLabel":true},{"label":"Organization","columns":1,"hideBorder":true,"fields":["company_name"],"hideLabel":true},{"label":"Designation","columns":1,"hideBorder":true,"fields":["designation"],"hideLabel":true},{"label":"Address","columns":1,"hideBorder":true,"fields":["address"],"hideLabel":true}]' "layout": '[{"label":"Salutation","columns":1,"fields":["salutation"],"hideLabel":true},{"label":"Full Name","columns":2,"hideBorder":true,"fields":["first_name","last_name"],"hideLabel":true},{"label":"Email","columns":1,"hideBorder":true,"fields":["email_id"],"hideLabel":true},{"label":"Mobile No. & Gender","columns":2,"hideBorder":true,"fields":["mobile_no","gender"],"hideLabel":true},{"label":"Organization","columns":1,"hideBorder":true,"fields":["company_name"],"hideLabel":true},{"label":"Designation","columns":1,"hideBorder":true,"fields":["designation"],"hideLabel":true},{"label":"Address","columns":1,"hideBorder":true,"fields":["address"],"hideLabel":true}]',
}, },
"CRM Organization-Quick Entry": { "CRM Organization-Quick Entry": {
"doctype": "CRM Organization", "doctype": "CRM Organization",
"layout": '[{"label":"Organization Name","columns":1,"fields":["organization_name"],"hideLabel":true},{"label":"Website & Revenue","columns":2,"hideBorder":true,"fields":["website","annual_revenue"],"hideLabel":true},{"label":"Territory","columns":1,"hideBorder":true,"fields":["territory"],"hideLabel":true},{"label":"No of Employees & Industry","columns":2,"hideBorder":true,"fields":["no_of_employees","industry"],"hideLabel":true},{"label":"Address","columns":1,"hideBorder":true,"fields":["address"],"hideLabel":true}]' "layout": '[{"label":"Organization Name","columns":1,"fields":["organization_name"],"hideLabel":true},{"label":"Website & Revenue","columns":2,"hideBorder":true,"fields":["website","annual_revenue"],"hideLabel":true},{"label":"Territory","columns":1,"hideBorder":true,"fields":["territory"],"hideLabel":true},{"label":"No of Employees & Industry","columns":2,"hideBorder":true,"fields":["no_of_employees","industry"],"hideLabel":true},{"label":"Address","columns":1,"hideBorder":true,"fields":["address"],"hideLabel":true}]',
}, },
"Address-Quick Entry": { "Address-Quick Entry": {
"doctype": "Address", "doctype": "Address",
"layout": '[{"label":"Address","columns":1,"fields":["address_title","address_type","address_line1","address_line2","city","state","country","pincode"],"hideLabel":true}]' "layout": '[{"label":"Address","columns":1,"fields":["address_title","address_type","address_line1","address_line2","city","state","country","pincode"],"hideLabel":true}]',
}, },
} }
sidebar_fields_layouts = { sidebar_fields_layouts = {
"CRM Lead-Side Panel": { "CRM Lead-Side Panel": {
"doctype": "CRM Lead", "doctype": "CRM Lead",
"layout": '[{"label": "Details", "name": "details", "opened": true, "fields": ["organization", "website", "territory", "industry", "job_title", "source", "lead_owner"]}, {"label": "Person", "name": "person_tab", "opened": true, "fields": ["salutation", "first_name", "last_name", "email", "mobile_no"]}]' "layout": '[{"label": "Details", "name": "details", "opened": true, "fields": ["organization", "website", "territory", "industry", "job_title", "source", "lead_owner"]}, {"label": "Person", "name": "person_tab", "opened": true, "fields": ["salutation", "first_name", "last_name", "email", "mobile_no"]}]',
}, },
"CRM Deal-Side Panel": { "CRM Deal-Side Panel": {
"doctype": "CRM Deal", "doctype": "CRM Deal",
"layout": '[{"label":"Contacts","name":"contacts_section","opened":true,"editable":false,"contacts":[]},{"label":"Organization Details","name":"organization_tab","opened":true,"fields":["organization","website","territory","annual_revenue","close_date","probability","next_step","deal_owner"]}]' "layout": '[{"label":"Contacts","name":"contacts_section","opened":true,"editable":false,"contacts":[]},{"label":"Organization Details","name":"organization_tab","opened":true,"fields":["organization","website","territory","annual_revenue","close_date","probability","next_step","deal_owner"]}]',
}, },
"Contact-Side Panel": { "Contact-Side Panel": {
"doctype": "Contact", "doctype": "Contact",
"layout": '[{"label":"Details","name":"details","opened":true,"fields":["salutation","first_name","last_name","email_id","mobile_no","gender","company_name","designation","address"]}]' "layout": '[{"label":"Details","name":"details","opened":true,"fields":["salutation","first_name","last_name","email_id","mobile_no","gender","company_name","designation","address"]}]',
}, },
"CRM Organization-Side Panel": { "CRM Organization-Side Panel": {
"doctype": "CRM Organization", "doctype": "CRM Organization",
"layout": '[{"label":"Details","name":"details","opened":true,"fields":["organization_name","website","territory","industry","no_of_employees","address"]}]' "layout": '[{"label":"Details","name":"details","opened":true,"fields":["organization_name","website","territory","industry","no_of_employees","address"]}]',
},
}
data_fields_layouts = {
"CRM Lead-Data Fields": {
"doctype": "CRM Lead",
"layout": '[{"no_tabs":true,"sections":[{"label": "Details", "name": "details", "opened": true, "fields": ["organization", "website", "territory", "industry", "job_title", "source", "lead_owner"]}, {"label": "Person", "name": "person_tab", "opened": true, "fields": ["salutation", "first_name", "last_name", "email", "mobile_no"]}]}]',
},
"CRM Deal-Data Fields": {
"doctype": "CRM Deal",
"layout": '[{"no_tabs":true,"sections":[{"label":"Organization Details","name":"organization_tab","opened":true,"fields":["organization","website","territory","annual_revenue","close_date","probability","next_step","deal_owner"]}]}]',
}, },
} }
@ -180,6 +195,20 @@ def add_default_fields_layout(force=False):
doc.layout = sidebar_fields_layouts[layout]["layout"] doc.layout = sidebar_fields_layouts[layout]["layout"]
doc.insert() doc.insert()
for layout in data_fields_layouts:
if frappe.db.exists("CRM Fields Layout", layout):
if force:
frappe.delete_doc("CRM Fields Layout", layout)
else:
continue
doc = frappe.new_doc("CRM Fields Layout")
doc.type = "Data Fields"
doc.dt = data_fields_layouts[layout]["doctype"]
doc.layout = data_fields_layouts[layout]["layout"]
doc.insert()
def add_property_setter(): def add_property_setter():
if not frappe.db.exists("Property Setter", {"name": "Contact-main-search_fields"}): if not frappe.db.exists("Property Setter", {"name": "Contact-main-search_fields"}):
doc = frappe.new_doc("Property Setter") doc = frappe.new_doc("Property Setter")
@ -190,6 +219,7 @@ def add_property_setter():
doc.value = "email_id" doc.value = "email_id"
doc.insert() doc.insert()
def add_email_template_custom_fields(): def add_email_template_custom_fields():
if not frappe.get_meta("Email Template").has_field("enabled"): if not frappe.get_meta("Email Template").has_field("enabled"):
click.secho("* Installing Custom Fields in Email Template") click.secho("* Installing Custom Fields in Email Template")
@ -219,7 +249,59 @@ def add_email_template_custom_fields():
def add_default_industries(): def add_default_industries():
industries = ["Accounting", "Advertising", "Aerospace", "Agriculture", "Airline", "Apparel & Accessories", "Automotive", "Banking", "Biotechnology", "Broadcasting", "Brokerage", "Chemical", "Computer", "Consulting", "Consumer Products", "Cosmetics", "Defense", "Department Stores", "Education", "Electronics", "Energy", "Entertainment & Leisure, Executive Search", "Financial Services", "Food", "Beverage & Tobacco", "Grocery", "Health Care", "Internet Publishing", "Investment Banking", "Legal", "Manufacturing", "Motion Picture & Video", "Music", "Newspaper Publishers", "Online Auctions", "Pension Funds", "Pharmaceuticals", "Private Equity", "Publishing", "Real Estate", "Retail & Wholesale", "Securities & Commodity Exchanges", "Service", "Soap & Detergent", "Software", "Sports", "Technology", "Telecommunications", "Television", "Transportation", "Venture Capital"] industries = [
"Accounting",
"Advertising",
"Aerospace",
"Agriculture",
"Airline",
"Apparel & Accessories",
"Automotive",
"Banking",
"Biotechnology",
"Broadcasting",
"Brokerage",
"Chemical",
"Computer",
"Consulting",
"Consumer Products",
"Cosmetics",
"Defense",
"Department Stores",
"Education",
"Electronics",
"Energy",
"Entertainment & Leisure, Executive Search",
"Financial Services",
"Food",
"Beverage & Tobacco",
"Grocery",
"Health Care",
"Internet Publishing",
"Investment Banking",
"Legal",
"Manufacturing",
"Motion Picture & Video",
"Music",
"Newspaper Publishers",
"Online Auctions",
"Pension Funds",
"Pharmaceuticals",
"Private Equity",
"Publishing",
"Real Estate",
"Retail & Wholesale",
"Securities & Commodity Exchanges",
"Service",
"Soap & Detergent",
"Software",
"Sports",
"Technology",
"Telecommunications",
"Television",
"Transportation",
"Venture Capital",
]
for industry in industries: for industry in industries:
if frappe.db.exists("CRM Industry", industry): if frappe.db.exists("CRM Industry", industry):
@ -231,7 +313,18 @@ def add_default_industries():
def add_default_lead_sources(): def add_default_lead_sources():
lead_sources = ["Existing Customer", "Reference", "Advertisement", "Cold Calling", "Exhibition", "Supplier Reference", "Mass Mailing", "Customer's Vendor", "Campaign", "Walk In"] lead_sources = [
"Existing Customer",
"Reference",
"Advertisement",
"Cold Calling",
"Exhibition",
"Supplier Reference",
"Mass Mailing",
"Customer's Vendor",
"Campaign",
"Walk In",
]
for source in lead_sources: for source in lead_sources:
if frappe.db.exists("CRM Lead Source", source): if frappe.db.exists("CRM Lead Source", source):

View File

@ -6,6 +6,6 @@ crm.patches.v1_0.move_crm_note_data_to_fcrm_note
[post_model_sync] [post_model_sync]
# Patches added in this section will be executed after doctypes are migrated # Patches added in this section will be executed after doctypes are migrated
crm.patches.v1_0.create_email_template_custom_fields crm.patches.v1_0.create_email_template_custom_fields
crm.patches.v1_0.create_default_fields_layout #31/10/2024 crm.patches.v1_0.create_default_fields_layout #10/12/2024
crm.patches.v1_0.create_default_sidebar_fields_layout crm.patches.v1_0.create_default_sidebar_fields_layout
crm.patches.v1_0.update_deal_quick_entry_layout crm.patches.v1_0.update_deal_quick_entry_layout