Merge branch 'main' into get-key-value-from-json

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/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);
+    }
+  }
+}

Client-Side Components/Client Scripts/Field Completion Counter/README.md

@@ -0,0 +1,18 @@
+# Field Completion Counter
+
+## Use Case / Requirement
+Display a simple message showing how many fields are completed vs total fields on a form. This helps users track their progress while filling out forms.
+
+## Solution
+A simple onLoad client script that:
+- Counts filled vs empty fields
+- Shows completion status in an info message
+- Updates when fields are modified
+
+## Implementation
+Add this as an **onLoad** client script on any form.
+
+## Notes
+- Excludes system fields and read-only fields
+- Updates in real-time as users fill fields
+- Simple and lightweight solution

Client-Side Components/Client Scripts/Field Completion Counter/script.js

@@ -0,0 +1,54 @@
+function onLoad() {
+    // Display field completion counter
+    showFieldProgress();
+    
+    // Set up listener for field changes
+    setupProgressUpdater();
+    
+    function showFieldProgress() {
+        var allFields = g_form.getFieldNames();
+        var visibleFields = [];
+        var filledFields = 0;
+        
+        // Count visible, editable fields
+        for (var i = 0; i < allFields.length; i++) {
+            var fieldName = allFields[i];
+            
+            // Skip system fields and hidden/readonly fields
+            if (fieldName.indexOf('sys_') === 0 || 
+                !g_form.isVisible(fieldName) || 
+                g_form.isReadOnly(fieldName)) {
+                continue;
+            }
+            visibleFields.push(fieldName);
+            
+            // Check if field has value
+            if (g_form.getValue(fieldName)) {
+                filledFields++;
+            }
+        }
+        var totalFields = visibleFields.length;
+        var percentage = totalFields > 0 ? Math.round((filledFields / totalFields) * 100) : 0;
+        
+        g_form.addInfoMessage('Form Progress: ' + filledFields + '/' + totalFields + ' fields completed (' + percentage + '%)');
+    }
+    
+    function setupProgressUpdater() {
+        // Simple debounced update
+        var updateTimer;
+        
+        function updateProgress() {
+            clearTimeout(updateTimer);
+            updateTimer = setTimeout(function() {
+                g_form.clearMessages();
+                showFieldProgress();
+            }, 500);
+        }
+        
+        // Listen for any field change
+        var allFields = g_form.getFieldNames();
+        for (var i = 0; i < allFields.length; i++) {
+            g_form.addElementChangeListener(allFields[i], updateProgress);
+        }
+    }
+}

Client-Side Components/Client Scripts/Get Logged in User Information/README.md

@@ -0,0 +1,16 @@
+# The Glide User (g_user) is a global object available within the client side. It provides information about the logged-in  user.
+
+Property                   Description
+
+g_user.userID              Sys ID of the currently logged-in user
+g_user.name                User's Full name
+g_user.firstName           User's First name
+g_user.lastName            User's Last name
+
+# It also has some methods available within the client side.
+
+Method                     Description
+
+g_user.hasRole()           Determine whether the logged-in user has a specific role
+g_user.hasRoleExactly()    Do not consider the admin role while evaluating the method
+g_user.hasRoles()          You can pass two or more roles in a single method

Client-Side Components/Client Scripts/Get Logged in User Information/script.js

@@ -0,0 +1,18 @@
+if (g_user.hasRole('admin') || g_user.hasRole('itil')) {
+    // User has at least one of the roles
+    g_form.setDisplay('internal_notes', true);
+}
+
+if (g_user.hasRole('admin') && g_user.hasRole('itil')) {
+    // User must have both roles
+    g_form.setDisplay('advanced_settings', true);
+}
+
+//Using the parameters to set a field value
+g_form.setValue('short_description', g_user.firstName);
+
+g_form.setValue('short_description', g_user.lastName);
+
+g_form.setValue('short_description', g_user.name);
+
+g_form.setValue('short_description', g_user.userID);

Client-Side Components/Client Scripts/Mandatory Field Highlighter/README.md

@@ -0,0 +1,79 @@
+# Mandatory Field Highlighter
+
+## Use Case
+Provides visual feedback for empty mandatory fields on ServiceNow forms by showing error messages when the form loads. Helps users quickly identify which required fields need to be completed.
+
+## Requirements
+- ServiceNow instance
+- Client Script execution rights
+- Forms with mandatory fields
+
+## Implementation
+1. Create a new Client Script with Type "onLoad"
+2. Copy the script code from script.js
+3. **Customize the fieldsToCheck string** with your form's mandatory field names
+4. Apply to desired table/form
+5. Save and test on a form with mandatory fields
+
+## Configuration
+Edit the `fieldsToCheck` variable to include your form's mandatory fields as a comma-separated string:
+
+```javascript
+// Example configurations for different forms:
+
+// For Incident forms:
+var fieldsToCheck = 'short_description,priority,category,caller_id,assignment_group';
+
+// For Request forms:
+var fieldsToCheck = 'short_description,requested_for,category,priority';
+
+// For Change Request forms:
+var fieldsToCheck = 'short_description,category,priority,assignment_group,start_date,end_date';
+
+// For Problem forms:
+var fieldsToCheck = 'short_description,category,priority,assignment_group';
+
+// Custom fields (add as needed):
+var fieldsToCheck = 'short_description,priority,u_business_justification,u_cost_center';
+```
+
+## Features
+- Shows error messages under empty mandatory fields on form load
+- Easy configuration with comma-separated field names
+- Automatically skips fields that don't exist on the form
+- Only processes fields that are actually mandatory and visible
+- Uses proper ServiceNow client scripting APIs
+- No DOM manipulation or unsupported methods
+
+## Common Field Names
+- `short_description` - Short Description
+- `priority` - Priority
+- `category` - Category  
+- `caller_id` - Caller
+- `requested_for` - Requested For
+- `assignment_group` - Assignment Group
+- `assigned_to` - Assigned To
+- `state` - State
+- `urgency` - Urgency
+- `impact` - Impact
+- `start_date` - Start Date
+- `end_date` - End Date
+- `due_date` - Due Date
+- `location` - Location
+- `company` - Company
+- `department` - Department
+
+## Notes
+- Uses g_form.showFieldMsg() method to display error messages
+- Uses g_form.hasField() to safely check field existence (built into the safety checks)
+- Only runs on form load - provides initial validation feedback
+- Easy to customize for different forms by modifying the field list
+- Compatible with all standard ServiceNow forms
+- Lightweight and focused on essential functionality
+
+## Example Usage
+For a typical incident form, simply change the configuration line to:
+```javascript
+var fieldsToCheck = 'short_description,priority,category,caller_id,assignment_group';
+```
+Save the Client Script and test on an incident form to see error messages appear under empty mandatory fields.