feat: Default energy point rules (#19003)

* feat: Add default energy point rules during install

* fix: Add completed_by field to task doctype

* fix: Rule data

* fix: Add default rules for opportunity

* fix: Add a patch to create default energy point rules

* fix: Default success action message

* fix: Use .items() instead of .iteritems()

* fix: Add "create_default_energy_points" patch entry

* fix: Reload Energy Point Rule to fix patch

* fix: Import frappe

erpnext/setup/default_energy_point_rules.py

@@ -0,0 +1,58 @@
+from __future__ import unicode_literals
+from frappe import _
+
+doctype_rule_map = {
+	'Item': {
+		'points': 5,
+		'for_doc_event': 'New'
+	},
+	'Customer': {
+		'points': 5,
+		'for_doc_event': 'New'
+	},
+	'Supplier': {
+		'points': 5,
+		'for_doc_event': 'New'
+	},
+	'Lead': {
+		'points': 2,
+		'for_doc_event': 'New'
+	},
+	'Opportunity': {
+		'points': 10,
+		'for_doc_event': 'Custom',
+		'condition': 'doc.status=="Converted"',
+		'rule_name': _('On Converting Opportunity'),
+		'user_field': 'converted_by'
+	},
+	'Sales Order': {
+		'points': 10,
+		'for_doc_event': 'Submit',
+		'rule_name': _('On Sales Order Submission'),
+		'user_field': 'modified_by'
+	},
+	'Purchase Order': {
+		'points': 10,
+		'for_doc_event': 'Submit',
+		'rule_name': _('On Purchase Order Submission'),
+		'user_field': 'modified_by'
+	},
+	'Task': {
+		'points': 5,
+		'condition': 'doc.status == "Completed"',
+		'rule_name': _('On Task Completion'),
+		'user_field': 'completed_by'
+	}
+}
+
+def get_default_energy_point_rules():
+	return [{
+		'doctype': 'Energy Point Rule',
+		'reference_doctype': doctype,
+		'for_doc_event': rule.get('for_doc_event') or 'Custom',
+		'condition': rule.get('condition'),
+		'rule_name': rule.get('rule_name') or _('On {0} Creation').format(doctype),
+		'points': rule.get('points'),
+		'user_field': rule.get('user_field') or 'owner'
+	} for doctype, rule in doctype_rule_map.items()]
+

erpnext/setup/default_success_action.py

@@ -2,26 +2,26 @@ from __future__ import unicode_literals
 from frappe import _
 
 doctype_list = [
-    'Purchase Receipt',
-    'Purchase Invoice',
-    'Quotation',
-    'Sales Order',
-    'Delivery Note',
-    'Sales Invoice'
+	'Purchase Receipt',
+	'Purchase Invoice',
+	'Quotation',
+	'Sales Order',
+	'Delivery Note',
+	'Sales Invoice'
 ]
 
 def get_message(doctype):
-    return _("{0} has been submitted successfully".format(_(doctype)))
+	return _("{0} has been submitted successfully").format(_(doctype))
 
 def get_first_success_message(doctype):
-    return _("{0} has been submitted successfully".format(_(doctype)))
+	return get_message(doctype)
 
 def get_default_success_action():
-    return [{
-        'doctype': 'Success Action',
-        'ref_doctype': doctype,
-        'message': get_message(doctype),
-        'first_success_message': get_first_success_message(doctype),
-        'next_actions': 'new\nprint\nemail'
-    } for doctype in doctype_list]
+	return [{
+		'doctype': 'Success Action',
+		'ref_doctype': doctype,
+		'message': get_message(doctype),
+		'first_success_message': get_first_success_message(doctype),
+		'next_actions': 'new\nprint\nemail'
+	} for doctype in doctype_list]
 

erpnext/setup/install.py

@@ -9,6 +9,7 @@ from .default_success_action import get_default_success_action
 from frappe import _
 from frappe.desk.page.setup_wizard.setup_wizard import add_all_roles_to
 from frappe.custom.doctype.custom_field.custom_field import create_custom_field
+from erpnext.setup.default_energy_point_rules import get_default_energy_point_rules
 
 default_mail_footer = """<div style="padding: 7px; text-align: right; color: #888"><small>Sent via
 	<a style="color: #888" href="http://erpnext.org">ERPNext</a></div>"""
@@ -22,6 +23,7 @@ def after_install():
 	add_all_roles_to("Administrator")
 	create_default_cash_flow_mapper_templates()
 	create_default_success_action()
+	create_default_energy_point_rules()
 	add_company_to_session_defaults()
 	frappe.db.commit()
 
@@ -86,6 +88,17 @@ def create_default_success_action():
 			doc = frappe.get_doc(success_action)
 			doc.insert(ignore_permissions=True)
 
+def create_default_energy_point_rules():
+
+	for rule in get_default_energy_point_rules():
+		# check if any rule for ref. doctype exists
+		rule_exists = frappe.db.exists('Energy Point Rule', {
+			'reference_doctype': rule.get('reference_doctype')
+		})
+		if rule_exists: continue
+		doc = frappe.get_doc(rule)
+		doc.insert(ignore_permissions=True)
+
 def add_company_to_session_defaults():
 	settings = frappe.get_single("Session Default Settings")
 	settings.append("session_defaults", {