Merge branch 'ServiceNowDevProgram:main' into Use_case_-Base64-Encode-Before-Save-And-Decode-on-Display

Author: DhruvBhatheja

.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/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.

Client-Side Components/Client Scripts/Mandatory Field Highlighter/script.js

@@ -0,0 +1,26 @@
+function onLoad() {
+
+    // USER CONFIGURATION: Add field names you want to check (comma-separated)
+    var fieldsToCheck = 'short_description,priority,category,caller_id';
+    
+    // Convert to array and process
+    var fieldArray = fieldsToCheck.split(',');
+    
+    // Check each field
+    for (var i = 0; i < fieldArray.length; i++) {
+        var fieldName = fieldArray[i];
+        
+        // Skip if field is not mandatory or not visible
+        if (!g_form.isMandatory(fieldName) || !g_form.isVisible(fieldName)) {
+            continue;
+        }
+        
+        // Get current field value
+        var value = g_form.getValue(fieldName);
+        
+        // Show error message if field is empty
+        if (!value || value === '') {
+            g_form.showFieldMsg(fieldName, 'This field is required', 'error');
+        }
+    }
+}

Client-Side Components/Client Scripts/field-character-counter/README.md

@@ -0,0 +1,56 @@
+# Field Character Counter
+
+## Use Case
+Provides real-time character count feedback for text fields in ServiceNow forms. Shows remaining characters with visual indicators to help users stay within field limits.
+
+## Requirements
+- ServiceNow instance
+- Client Script execution rights
+- Text fields with character limits
+
+## Implementation
+1. Create a new Client Script with Type "onChange"
+2. Copy the script code from `script.js`
+3. Configure the field name and character limit in the script
+4. Apply to desired table/form
+5. Save and test
+
+## Configuration
+Edit these variables in the script:
+
+```javascript
+var fieldName = 'short_description';  // Your field name
+var maxLength = 160;                  // Your character limit
+```
+
+## Features
+- Real-time character counting as user types
+- Visual indicators: info (blue), warning (yellow), error (red)
+- Shows "X characters remaining" or "Exceeds limit by X characters"
+- Automatically clears previous messages
+
+## Common Examples
+```javascript
+// Short Description (160 chars)
+var fieldName = 'short_description';
+var maxLength = 160;
+
+// Description (4000 chars)
+var fieldName = 'description';
+var maxLength = 4000;
+
+// Work Notes (4000 chars)
+var fieldName = 'work_notes';
+var maxLength = 4000;
+```
+
+## Message Thresholds
+- **50+ remaining**: Info message (blue)
+- **1-20 remaining**: Warning message (yellow)
+- **Over limit**: Error message (red)
+
+## Notes
+- Uses standard ServiceNow APIs: `g_form.showFieldMsg()` and `g_form.hideFieldMsg()`
+- Create separate Client Scripts for multiple fields
+- Works with all text fields and text areas
+- Character count includes all characters (spaces, punctuation, etc.)

Client-Side Components/Client Scripts/field-character-counter/script.js

@@ -0,0 +1,22 @@
+function onChange(control, oldValue, newValue, isLoading) {
+    if (isLoading) return;
+    
+    // USER CONFIGURATION: Set field name and character limit
+    var fieldName = 'Description';  // Change to your field name
+    var maxLength = 80;                  // Change to your character limit
+    
+    var currentLength = newValue ? newValue.length : 0;
+    var remaining = maxLength - currentLength;
+    
+    // Clear any existing messages
+    g_form.hideFieldMsg(fieldName);
+    
+    // Show appropriate message based on remaining characters
+    if (remaining < 0) {
+        g_form.showFieldMsg(fieldName, 'Exceeds limit by ' + Math.abs(remaining) + ' characters', 'error');
+    } else if (remaining <= 20) {
+        g_form.showFieldMsg(fieldName, remaining + ' characters remaining', 'warning');
+    } else if (remaining <= 50) {
+        g_form.showFieldMsg(fieldName, remaining + ' characters remaining', 'info');
+    }
+}

Server-Side Components/Background Scripts/Copy Field Values and Insert in Target Record/README.md

@@ -0,0 +1,23 @@
+
+Script Usage :
+
+This function takes the parameters such as source table, source record sys_id, target table, fields that needs to be copied to target table.
+
+As a validation check, the fields from source table should be similar to target else abort inserting the record.
+
+
+Same Code to invoke the function: 
+copyFieldsValidated(
+    'dmn_demand',
+    '8c10306edbc00810f777526adc961976',
+    'pm_project',
+    ['name', 'short_description']   //will throw error since name field not common in both tables
+);
+
+
+copyFieldsValidated(
+    'dmn_demand',
+    '8c10306edbc00810f777526adc961976',
+    'pm_project',
+    ['short_description']   //Insert the record since short_description is common in both tables
+);

Server-Side Components/Background Scripts/Copy Field Values and Insert in Target Record/script.js

@@ -0,0 +1,46 @@
+/**
+ * Copies specified fields from a source record to a newly created target record,
+ * validating all fields before performing the insert operation.
+ *
+ * @param {string} sourceTable - The name of the source table.
+ * @param {string} sourceId - The sys_id of the source record.
+ * @param {string} targetTable - The name of the target table.
+ * @param {string[]} fields - An array of field names to copy.
+ * @returns {string|null} The sys_id of the newly created target record, or null on failure.
+ */
+function copyFieldsValidated(sourceTable, sourceId, targetTable, fields) {
+    var src = new GlideRecord(sourceTable);
+    if (!src.get(sourceId)) {
+        gs.error("Source record not found in " + sourceTable + " with sys_id: " + sourceId);
+        return null;
+    }
+
+    var tgt = new GlideRecord(targetTable);
+    tgt.initialize();
+    var allFieldsAreValid = true;
+    // First, validate all fields before doing any work
+    fields.forEach(function(f) {
+        if (!src.isValidField(f) || !tgt.isValidField(f)) {
+            gs.warn("Field [" + f + "] is not valid in both " + sourceTable + " and " + targetTable + ". Aborting insert.");
+            allFieldsAreValid = false;
+        }
+    });
+
+    // Proceed with copying and inserting only if all fields are valid
+    if (allFieldsAreValid) {
+        fields.forEach(function(f) {
+            tgt.setValue(f, src.getValue(f));
+        });
+        var newId = tgt.insert();
+        if (newId) {
+            gs.info("Record copied from " + sourceTable + " → " + targetTable + ". New sys_id: " + newId);
+            return newId;
+        } else {
+            gs.error("Failed to insert new record into " + targetTable);
+            return null;
+        }
+    } else {
+        gs.error("Aborting record insert due to invalid fields.");
+        return null;
+    }
+}