Merge branch 'main' into add-incident-count-snippet

Author: rishanmenezes

Client-Side Components/Catalog Client Script/Clear all fields/README.md

@@ -1,13 +1,18 @@
 # Clear all fields on a catalog item form
 
-This works on both the native platform and service portal / mobile. Typically used with an OnChange catalog client script when you would like to reset all the fields after a certain variable is changed.
+This function clears all editable fields on a form, except those explicitly excluded.  
+It works on both the native platform (Classic UI) and Service Portal / Mobile.  
+Typically used with an OnChange catalog client script when you want to clear all fields after a certain variable changes.
 
-This function does support an exclusion list if there are fields you would like to exclude from being reset, typically you would want to add the field that triggered to the change to the exlusion
+The function returns an array of the field names that were cleared, which can be used for logging or further processing.
 
-### Example
+### Exclusion Support
 
-```js
-clearFields(['field1', 'field2']);
-```
+You can pass an array of field names to exclude from being cleared.  
+This is useful when you want to preserve the value of the field that triggered the change or other important fields.
 
-All fields on the form **except** field1 and field2 will be cleared.
+### Example
+```
+clearFields(['short_description', 'priority']);
+```
+// Clears all fields except 'short_description' and 'priority'

Client-Side Components/Catalog Client Script/Clear all fields/script.js

@@ -1,26 +1,47 @@
-/**SNDOC
-    @name clearFields
-    @description Clear/reset all fields on a form
-    @param  {Array} [dontClearFieldsArray] - Fields to not clear
-    @example
-    clearFields(['field1', 'field2']);
-*/
+/**
+ * Clears or resets all editable fields on a form, except those explicitly excluded.
+ * Compatible with Classic UI and Service Portal/Mobile.
+ * Intended for use in onChange client scripts.
+ *
+ * @function clearFields
+ * @param {Array} dontClearFieldsArray - Array of field names to exclude from clearing.
+ * @returns {Array} - Array of field names that were cleared.
+ *
+ * @example
+ * // Clears all fields except 'short_description' and 'priority'
+ * clearFields(['short_description', 'priority']);
+ */
+function clearFields(dontClearFieldsArray) {
+    // Ensure the exclusion list is defined and is an array
+    dontClearFieldsArray = Array.isArray(dontClearFieldsArray) ? dontClearFieldsArray : [];
 
-function clearFields(dontClearFieldsArray){
+    // Helper function to check if a field should be cleared
+    function shouldClear(fieldName) {
+        return dontClearFieldsArray.indexOf(fieldName) === -1;
+    }
 
-	try{ // Classic UI
-		var pFields = g_form.nameMap;
-		pFields.forEach(function(field){
-			if(dontClearFieldsArray.indexOf(field.prettyName) == -1){
-				g_form.clearValue(field.prettyName);
-			}
-		});
-	}catch(e){ // Service Portal or Mobile
-		var fields = g_form.getEditableFields();
-		fields.forEach(function(field){
-			if(dontClearFieldsArray.indexOf(fields) == -1){
-				g_form.clearValue(field);
-			}
-		});
-	}
-}
+    var clearedFields = [];
+
+    try {
+        // Classic UI: use g_form.nameMap to get all fields
+        var allFields = g_form.nameMap;
+        allFields.forEach(function(field) {
+            var fieldName = field.prettyName;
+            if (shouldClear(fieldName)) {
+                g_form.clearValue(fieldName);
+                clearedFields.push(fieldName);
+            }
+        });
+    } catch (e) {
+        // Service Portal or Mobile: use getEditableFields()
+        var editableFields = g_form.getEditableFields();
+        editableFields.forEach(function(fieldName) {
+            if (shouldClear(fieldName)) {
+                g_form.clearValue(fieldName);
+                clearedFields.push(fieldName);
+            }
+        });
+    }
+
+    return clearedFields;
+}

Client-Side Components/Client Scripts/Check all mandatory fields using mandatoryCheck()/README.md

@@ -1,11 +1,17 @@
-**Client Script**
+# Mandatory Field Check on Form Change
 
-Client script which is showing how to use g_form.mandatoryCheck() function, which allows to easily detect if any of mandatory field is not filled on record.
+This client script demonstrates how to use `g_form.mandatoryCheck()` to validate whether all mandatory fields on a form are filled.
 
-**Example configuration**
+It is typically used in an **onChange** catalog client script to trigger validation when a specific field changes.
 
-![Coniguration](ScreenShot_1.PNG)
+If mandatory fields are missing, the script:
+- Displays an info message listing the missing fields. Note: the red message is the existing functionality that will give you an error message.
+- Visually highlights each missing field using a flashing effect to guide the user.
 
-**Example execution**
+This approach improves user experience by clearly indicating which fields require attention.
 
-![Execution](ScreenShot_2.PNG)
+**Example configuration**
+<img width="1122" height="638" alt="image" src="https://github.com/user-attachments/assets/31f86ae7-27fe-4921-8d8b-391eaa55304d" />
+
+**Example execution**
+<img width="1029" height="495" alt="image" src="https://github.com/user-attachments/assets/b8384507-4292-41f4-9155-9be10195493e" />

Client-Side Components/Client Scripts/Check all mandatory fields using mandatoryCheck()/script.js

@@ -1,19 +1,17 @@
 function onChange(control, oldValue, newValue, isLoading, isTemplate) {
-    if (isLoading || newValue === '') {
-        return;
-    }
-
-    //Client script, which shows how to use mandatoryCheck() function
-    //mandatoryCheck() allows validating if all mandatory fields are filled
-    //If all mandatory fields are filled it return true, otherwise it returns false
+   if (isLoading || newValue === '') {
+      return;
+   }
 
-    //Check if all mandatory fields are filled on record
+    // Check if all mandatory fields are filled
     if (!g_form.mandatoryCheck()) {
-
-        //Example action when not all mandatory fields are filled - display message and remove state field
+        //if not get all missing fields
         var missing = g_form.getMissingFields();
-        g_form.addInfoMessage("State field removed, because not all mandatory fields are filled: " + missing);
-        g_form.setDisplay('state', false);
+        //Info message displaying the fields that are missing
+        g_form.addInfoMessage("Please complete the following mandatory fields: " + missing.join(", "));
+        //go through missing fields and flash them
+        missing.forEach(function (fieldName) {
+            g_form.flash(fieldName, "#FFFACD",0); // Flash to draw attention
+        });
     }
-
 }