feat(Code List): default common code

Allow linking to a Common Code that shall be used as the default. Add helper methods to retrieve the default code.

Author: barredterra

erpnext/edi/doctype/code_list/code_list.js

@@ -37,5 +37,13 @@ frappe.ui.form.on("Code List", {
 				}
 			);
 		};
+
+		frm.set_query("default_common_code", function (doc) {
+			return {
+				filters: {
+					code_list: doc.name,
+				},
+			};
+		});
 	},
 });

erpnext/edi/doctype/code_list/code_list.json

@@ -10,6 +10,7 @@
   "title",
   "canonical_uri",
   "url",
+  "default_common_code",
   "column_break_nkls",
   "version",
   "publisher",
@@ -66,6 +67,13 @@
    "fieldtype": "Data",
    "label": "URL",
    "options": "URL"
+  },
+  {
+   "description": "This value shall be used when no matching Common Code for a record is found.",
+   "fieldname": "default_common_code",
+   "fieldtype": "Link",
+   "label": "Default Common Code",
+   "options": "Common Code"
   }
  ],
  "index_web_pages_for_search": 1,
@@ -75,7 +83,7 @@
    "link_fieldname": "code_list"
   }
  ],
- "modified": "2024-10-01 12:32:27.990888",
+ "modified": "2024-11-06 18:56:23.177120",
  "modified_by": "Administrator",
  "module": "EDI",
  "name": "Code List",

erpnext/edi/doctype/code_list/code_list.py

@@ -20,6 +20,7 @@ class CodeList(Document):
 		from frappe.types import DF
 
 		canonical_uri: DF.Data | None
+		default_common_code: DF.Link | None
 		description: DF.SmallText | None
 		publisher: DF.Data | None
 		publisher_id: DF.Data | None
@@ -33,6 +34,8 @@ def on_trash(self):
 			self.__delete_linked_docs()
 
 	def __delete_linked_docs(self):
+		self.db_set("default_common_code", None)
+
 		linked_docs = frappe.get_all(
 			"Common Code",
 			filters={"code_list": self.name},
@@ -50,6 +53,14 @@ def get_docnames_for(self, doctype: str, code: str) -> tuple[str]:
 		"""Get the mapped docnames for a doctype and code"""
 		return get_docnames_for(self.name, doctype, code)
 
+	def get_default_code(self) -> str | None:
+		"""Get the default common code for this code list"""
+		return (
+			frappe.db.get_value("Common Code", self.default_common_code, "common_code")
+			if self.default_common_code
+			else None
+		)
+
 	def from_genericode(self, root: "Element"):
 		"""Extract Code List details from genericode XML"""
 		self.title = root.find(".//Identification/ShortName").text
@@ -106,3 +117,9 @@ def get_docnames_for(code_list: str, doctype: str, code: str) -> tuple[str]:
 	).run()
 
 	return tuple(d[0] for d in docnames) if docnames else ()
+
+
+def get_default_code(code_list: str) -> str | None:
+	"""Return the default common code for a given code list"""
+	code_id = frappe.db.get_value("Code List", code_list, "default_common_code")
+	return frappe.db.get_value("Common Code", code_id, "common_code") if code_id else None