Merge branch 'main' into check-user-impersonation-details

Author: SrijanPatwa

.github/pull_request_template.md

@@ -1,3 +1,6 @@
+# PR Description: 
+
+
 # Pull Request Checklist
 
 ## Overview

.github/scripts/validate-structure.js

@@ -49,6 +49,34 @@ function validateFilePath(filePath) {
   const normalized = filePath.replace(/\\/g, '/');
   const segments = normalized.split('/');
 
+  // Check for invalid characters that break local file systems
+  for (let i = 0; i < segments.length; i++) {
+    const segment = segments[i];
+
+    // Check for trailing periods (invalid on Windows)
+    if (segment.endsWith('.')) {
+      return `Invalid folder/file name '${segment}' in path '${normalized}': Names cannot end with a period (.) as this breaks local file system sync on Windows.`;
+    }
+
+    // Check for trailing spaces (invalid on Windows)
+    if (segment.endsWith(' ')) {
+      return `Invalid folder/file name '${segment}' in path '${normalized}': Names cannot end with a space as this breaks local file system sync on Windows.`;
+    }
+
+    // Check for reserved Windows names
+    const reservedNames = ['CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9'];
+    const nameWithoutExt = segment.split('.')[0].toUpperCase();
+    if (reservedNames.includes(nameWithoutExt)) {
+      return `Invalid folder/file name '${segment}' in path '${normalized}': '${nameWithoutExt}' is a reserved name on Windows and will break local file system sync.`;
+    }
+
+    // Check for invalid characters (Windows and general file system restrictions)
+    const invalidChars = /[<>:"|?*\x00-\x1F]/;
+    if (invalidChars.test(segment)) {
+      return `Invalid folder/file name '${segment}' in path '${normalized}': Contains characters that are invalid on Windows file systems (< > : " | ? * or control characters).`;
+    }
+  }
+
   if (!allowedCategories.has(segments[0])) {
     return null;
   }

.github/workflows/validate-structure.yml

@@ -65,6 +65,8 @@ jobs:
           cat "$tmp_error" >&2
 
           if grep -q 'Folder structure violations found' "$tmp_output" "$tmp_error"; then
+            # Save validation output for use in PR comment
+            cat "$tmp_output" "$tmp_error" > "$RUNNER_TEMP/validation_output.txt"
             echo "status=failed" >> "$GITHUB_OUTPUT"
             exit 0
           fi
@@ -87,11 +89,37 @@ jobs:
             const owner = context.repo.owner;
             const repo = context.repo.repo;
 
+            const fs = require('fs');
+            const output = fs.readFileSync(process.env.RUNNER_TEMP + '/validation_output.txt', 'utf8');
+
+            let commentBody = `Thank you for your contribution. However, it doesn't comply with our contributing guidelines.\n\n`;
+
+            // Check if the error is about invalid file/folder names
+            if (output.includes('Names cannot end with a period') ||
+                output.includes('Names cannot end with a space') ||
+                output.includes('is a reserved name on Windows') ||
+                output.includes('Contains characters that are invalid')) {
+              commentBody += `**❌ Invalid File/Folder Names Detected**\n\n`;
+              commentBody += `Your contribution contains file or folder names that will break when syncing to local file systems (especially Windows):\n\n`;
+              commentBody += `\`\`\`\n${output}\n\`\`\`\n\n`;
+              commentBody += `**Common issues:**\n`;
+              commentBody += `- Folder/file names ending with a period (.) - not allowed on Windows\n`;
+              commentBody += `- Folder/file names ending with spaces - not allowed on Windows\n`;
+              commentBody += `- Reserved names like CON, PRN, AUX, NUL, COM1-9, LPT1-9 - not allowed on Windows\n`;
+              commentBody += `- Invalid characters: < > : " | ? * or control characters\n\n`;
+              commentBody += `Please rename these files/folders to be compatible with all operating systems.\n\n`;
+            } else {
+              commentBody += `As a reminder, the general requirements (as outlined in the [CONTRIBUTING.md file](https://github.com/ServiceNowDevProgram/code-snippets/blob/main/CONTRIBUTING.md)) are the following: follow the folder+subfolder guidelines and include a README.md file explaining what the code snippet does.\n\n`;
+              commentBody += `**Validation errors:**\n\`\`\`\n${output}\n\`\`\`\n\n`;
+            }
+
+            commentBody += `Review your contribution against the guidelines and make the necessary adjustments. Closing this for now. Once you make additional changes, feel free to re-open this Pull Request or create a new one.`;
+
             await github.rest.issues.createComment({
               owner,
               repo,
               issue_number: pullNumber,
-              body: `Thank you for your contribution. However, it doesn't comply with our contributing guidelines. As a reminder, the general requirements (as outlined in the [CONTRIBUTING.md file](https://github.com/ServiceNowDevProgram/code-snippets/blob/main/CONTRIBUTING.md)) are the following: follow the folder+subfolder guidelines and include a README.md file explaining what the code snippet does. Review your contribution against the guidelines and make the necessary adjustments. Closing this for now. Once you make additional changes, feel free to re-open this Pull Request or create a new one.`.trim()
+              body: commentBody.trim()
             });
 
             await github.rest.pulls.update({

Client-Side Components/Catalog Client Script/spModal for Sweet Alerts/readme.md

@@ -0,0 +1,27 @@
+In ServiceNow, Open catalog client Scripts [catalog_script_client] and paste the code snippet of [spModalSweetAlerts.js] file.
+
+Setup:
+1. A catalog item having variable name Rewards[rewards] of type 'Select Box'(include none as true) and 2 choices(Yes and No)
+2. A Single line type field named 'Reward Selected' [reward_selected] which will hold the value selected by user from the spModal popup.
+3. The onLoad catalog client script setup as below:
+4. Type: onChange
+5. Variable: rewards (as per step 1)
+6. Script: [[spModalSweetAlerts.js]]
+   
+
+
+Screenshots:
+
+
+<img width="1338" height="268" alt="image" src="https://github.com/user-attachments/assets/f7f22b83-7e0e-47bb-bbed-2a8f38783a4d" />
+
+
+Rewards selected as 'Yes'
+
+<img width="1353" height="327" alt="image" src="https://github.com/user-attachments/assets/1bb55339-36b4-4a9c-8b65-2b254b87cf5b" />
+
+From the spModal popup select anyone of the reward, it should be populated in the Reward Selected field.
+Along with that a message shows the same of the selection.
+
+<img width="1350" height="319" alt="image" src="https://github.com/user-attachments/assets/1b23c766-51f8-4b01-9073-f836f390deb2" />
+

Client-Side Components/Catalog Client Script/spModal for Sweet Alerts/spModalSweetAlerts.js

@@ -0,0 +1,32 @@
+function onChange(control, oldValue, newValue) {
+    if (newValue == 'Yes') {
+        spModal.open({
+            title: "Reward Type",
+            message: "Please select the category of Reward",
+            buttons: [{
+                    label: "Star Performer",
+                    value: "Star Performer"
+                },
+                {
+                    label: "Emerging Player",
+                    value: "Emerging Player"
+                },
+                {
+                    label: "High Five Award",
+                    value: "High Five Award"
+                },
+                {
+                    label: "Rising Star",
+                    value: "Rising Star"
+                }
+            ]
+        }).then(function(choice) {
+            if (choice && choice.value) {
+				g_form.addInfoMessage('Selected Reward: '+ choice.label);
+                g_form.setValue('reward_selected', choice.value);
+            }
+        });
+    } else {
+        g_form.clearValue('reward_selected');
+    }
+}

Client-Side Components/Client Scripts/Detect oldValue newValue and Operation in Glide List Type Fields/detectOldValuenewValueOperation.js

@@ -0,0 +1,43 @@
+function onChange(control, oldValue, newValue, isLoading, isTemplate) {
+    if (isLoading) {
+        return;
+    }
+
+    var prevValue;
+    if (g_scratchpad.prevValue == undefined)
+        prevValue = oldValue;
+    else {
+        prevValue = g_scratchpad.prevValue;
+    }
+    g_scratchpad.prevValue = newValue;
+
+
+    var oldGlideValue = prevValue.split(',');
+    var newGlideValue = newValue.split(',');
+
+    var operation;
+
+    if (oldGlideValue.length > newGlideValue.length || newValue == '') {
+        operation = 'remove';
+    } else if (oldGlideValue.length < newGlideValue.length || oldGlideValue.length == newGlideValue.length) {
+        operation = 'add';
+    } else {
+        operation = '';
+    }
+
+    var ajaxGetNames = new GlideAjax('watchListCandidatesUtil');
+    ajaxGetNames.addParam('sysparm_name', 'getWatchListUsers');
+    ajaxGetNames.addParam('sysparm_old_values', oldGlideValue);
+    ajaxGetNames.addParam('sysparm_new_values', newGlideValue);
+    ajaxGetNames.getXMLAnswer(function(response) {
+
+        var result = JSON.parse(response);
+
+        g_form.clearMessages();
+        g_form.addSuccessMessage('Operation Performed : ' + operation);
+        g_form.addSuccessMessage('OldValue : ' + result.oldU);
+        g_form.addSuccessMessage('NewValue : ' + result.newU);
+
+    });
+
+}

Client-Side Components/Client Scripts/Detect oldValue newValue and Operation in Glide List Type Fields/readme.md

@@ -0,0 +1,39 @@
+In Client Scripts, oldValue will display the value of last value/record which is stored in that field. 
+For new records, it is generally empty and for existing records it displays the value which is stored after load.
+If we will try to change the value in that field, it will still show oldValue the same value which was there during the load of form.
+
+So, In order to identify the oldValue on change(as it does in business rule(previous)), This script comes handy and also it will
+detect the action performed.
+
+
+This onChange Client script comes handy when dealing with Glide List type fields where we have to detect whether the value was added or removed and returns the display name of users who were added/removed along with name of operation performed.
+
+Setup details:
+
+onChange client Script on [incident] table
+Field Name: [watch_list]
+Script: Check [detectOldValuenewValueOperation.js] file
+Script Include Name: watchListCandidatesUtil (client callable/GlideAjax Enabled - true), Check [watchListCandidatesUtil.js] file for script
+
+
+
+Output:
+
+Currently there is no one in the watchlist field:
+
+<img width="873" height="298" alt="image" src="https://github.com/user-attachments/assets/a46ca53a-f031-4bf9-9f85-2056c408b66b" />
+
+
+Adding [Bryan Rovell], It shows the operation was addition, oldValue as 'No record found' as there was no value earlier.New Value shows the name of the user (Bryan Rovell)
+<img width="870" height="443" alt="image" src="https://github.com/user-attachments/assets/484284b6-846e-424c-b9c8-a53278f48c72" />
+
+
+Adding 2 users one by one:
+
+<img width="987" height="484" alt="image" src="https://github.com/user-attachments/assets/35dfe96a-c932-4f95-9c8e-bdb48b1c7b5f" />
+
+
+Removing 2 at once:
+
+<img width="879" height="496" alt="image" src="https://github.com/user-attachments/assets/c83d4e01-f150-44cb-9078-9841072ec949" />
+

Client-Side Components/Client Scripts/Detect oldValue newValue and Operation in Glide List Type Fields/watchListCandidatesUtil.js

@@ -0,0 +1,37 @@
+var watchListCandidatesUtil = Class.create();
+watchListCandidatesUtil.prototype = Object.extendsObject(AbstractAjaxProcessor, {
+
+
+    getWatchListUsers: function() {
+
+        var oldUsers = this.getParameter('sysparm_old_values');
+        var newUsers = this.getParameter('sysparm_new_values');
+
+        var result = {
+            oldU: this._getUserNames(oldUsers),
+            newU: this._getUserNames(newUsers)
+        };
+
+        return JSON.stringify(result);
+    },
+
+    
+    _getUserNames: function(userList) {
+        var names = [];
+
+        var grUserTab = new GlideRecord('sys_user');
+        grUserTab.addQuery('sys_id', 'IN', userList);
+        grUserTab.query();
+        if (grUserTab.hasNext()) {
+            while (grUserTab.next()) {
+                names.push(grUserTab.getDisplayValue('name'));
+            }
+            return names.toString();
+        } else {
+            return 'No record found';
+        }
+    },
+
+
+    type: 'watchListCandidatesUtil'
+});

Client-Side Components/Client Scripts/Dynamically Switch Form View Based on Field Value/README.md

@@ -0,0 +1,20 @@
+## Dynamically Switch Form View Based on Field Value
+
+This client script demonstrates how to **automatically switch form views** based on the value of a field.
+
+**Use case:**  
+For example, if the **Category** field is set to *Hardware*, the form view switches to **ess**.  
+You can extend this by updating the mapping object to support additional fields and values (e.g., *Software → itil*, *Network → support*).
+
+**Benefit:**  
+Improves user experience by guiding users to the **most relevant form view**, ensuring the right fields are shown for the right scenario.
+
+**Test:**  
+- Change the **Category** field to *Hardware* → Form view should switch to **ess**.  
+- Update mapping to add new conditions (e.g., *Software → itil*) and verify the view switches accordingly.
+
+**How to Use:**  
+1. **Modify the table name** in the `switchView` function to match your target table:
+   ```javascript
+   switchView("section", "<your_table_name>", targetView);
+2. **Modify the view mapping**

Client-Side Components/Client Scripts/Dynamically Switch Form View Based on Field Value/dynamic-form-view-onchange.js

@@ -0,0 +1,33 @@
+/**
+ * dynamic-form-view-onchange.js
+ *
+ * Dynamically switches the form view automatically depending on the value of a specific field.
+ * Example: If Category = Hardware → switch to ess view.
+ * Extendable by modifying the mapping object for different fields/values.
+ *
+ */
+
+function onChange(control, oldValue, newValue, isLoading) {
+  if (isLoading || !newValue) {
+    return;
+  }
+
+  // Field value → view name mapping
+  var viewMapping = {
+    "hardware": "ess",
+    "software": "itil",
+    "network": "support"
+  };
+
+  var fieldValue = newValue.toLowerCase();
+  var targetView = viewMapping[fieldValue];
+
+  if (targetView) {
+    try {
+      // Here for example the table name is incident
+      switchView("section", "incident", targetView);
+    } catch (e) {
+      console.error("View switch failed: ", e);
+    }
+  }
+}