Merge branch 'main' into Prevent-Unnecessary-notifications-from-being-sent-out

Author: koratalas

Background Scripts/Get Installed Plugins details/ReadMe.md

@@ -0,0 +1,3 @@
+Background Script provides the list of installed plugins, version installed and version available for the upgrade in the instance 
+
+Note: We need to set the basic auth credential in order for the script to work on the instance where we are running it. 

Background Scripts/Get Installed Plugins details/getInstalledPluginInfo.js

@@ -0,0 +1,36 @@
+//Get the instance
+var instance_name = gs.getProperty("instance_name");
+
+//build the endpoint
+var endPoint = 'https://'+instance_name+'.service-now.com/api/sn_appclient/appmanager/apps?tab_context=installed';
+
+//initialize the RestMessageV2 API.
+var request = new sn_ws.RESTMessageV2();
+request.setEndpoint(endPoint);
+request.setHttpMethod('POST');
+
+//Eg. UserName="admin", Password="admin" for this code sample.
+var user = 'admin';
+var password = '****'; 
+
+//set the authentication
+request.setBasicAuth(user,password);
+
+//set the request header
+request.setRequestHeader("Accept","application/json");
+
+//invoke the API
+var response = request.execute();
+
+//Parse the response
+var jsonResponse = JSON.parse(response.getBody());
+
+var appsList = jsonResponse.result.apps;
+
+//Print the Header for the response
+gs.info("Application name"+" | "+ "Assigned version"+" | " + "Latest version | "  + "Hasupdate");
+appsList.forEach(function(app){
+    //Print the plugin details
+   var hasUpdate = app.update_available == 1 ? "true" : "false";
+gs.info(app.name+" | "+ app.assigned_version+" | " + app.latest_version+" | " + hasUpdate);
+});

Background Scripts/Reference field value update from CI relationship connection.js

@@ -0,0 +1,29 @@
+var updatedSysIds = [];
+var notUpdatedSysIds = [];
+
+var gr = new GlideRecord('< table_name >');
+gr.addQuery('< query condition >');
+gr.query();
+
+while (gr.next()) {
+
+    var relCi = new GlideRecord('cmdb_rel_ci');
+    relCi.addQuery('child', gr.sys_id);
+    relCi.addQuery('parent.sys_class_name', '< backend name of the table to which the reference field is referred to >');
+    relCi.query();
+
+    if (relCi.next()) {
+        // Update the reference field with the referenced table's sys_id
+        gr.< reference field backend name > = relCi.parent.sys_id;
+        gr.setWorkflow(false); 
+        gr.update();
+        updatedSysIds.push(gr.sys_id.toString()); // Add to updated list
+    } 
+	else {
+        notUpdatedSysIds.push(gr.sys_id.toString()); // Add to not updated list
+    }
+}
+
+// Print the sys_ids of the records updated and not updated
+gs.print("Updated records sys_ids: " + updatedSysIds.join(', '));
+gs.print("Not updated records sys_ids: " + notUpdatedSysIds.join(', '));

Background Scripts/readME.md

@@ -0,0 +1,2 @@
+In this piece of code, we are querying a table for some records and then updating a particular reference field's value of those records to the value of the specific parent class to which it has a cmdb_rel_ci relationship.
+We are also printing the sys_ids pf the records which would be updated and the ones that would be skipped.

Catalog Client Script/Passport Validation/passportvalidity.js

@@ -0,0 +1,38 @@
+function onChange(control, oldValue, newValue, isLoading) {
+    if (isLoading) return;
+  
+    var passportNumber = g_form.getValue('passport_number');
+    var dateOfIssue = g_form.getValue('date_of_issue');
+    var age = parseInt(g_form.getValue('age'), 10);
+    var dateOfExpiry = g_form.getValue('date_of_expiry');
+  
+    // Passport Number Validation
+    var passportPattern = /^[A-Z][1-9][0-9][A-Z0-9]{5}$/;
+    if (passportNumber && !passportPattern.test(passportNumber)) {
+        g_form.showFieldMsg('passport_number', "The entered number is invalid passport number format. It must be 8 characters long, start with an uppercase letter, followed by a number between 1-9, then 0-9, and the rest alphanumeric.", "error");
+        g_form.clearValue('passport_number');
+    } else {
+        g_form.hideFieldMsg('passport_number');
+    }
+  
+    // Date of Expiry Calculation based on date of issue
+    if (dateOfIssue && age) {
+        var issueDate = new GlideDate();
+        issueDate.setValue(dateOfIssue);
+        var expiryDate = new GlideDate();
+        expiryDate.setValue(issueDate);
+      
+        if (age >= 18) {
+            expiryDate.addYears(5); // Adult - add 5 years
+        } else {
+            expiryDate.addYears(10); // Under 18 - add 10 years
+        }
+      
+        g_form.setValue('date_of_expiry', expiryDate.getByFormat('yyyy-MM-dd')); // Set expiry date in correct format
+        g_form.hideFieldMsg('date_of_expiry');
+    } else if (!dateOfIssue) {
+        g_form.showFieldMsg('date_of_issue', "Please enter the Date of Issue first.", "info");
+    } else if (!age) {
+        g_form.showFieldMsg('age', "Please enter your age first.", "info");
+    }
+}

Catalog Client Script/Passport Validation/readme.md

@@ -0,0 +1,21 @@
+This OnChange Catalog Client Script is for validating passport number, date of issue, and date of expiry. 
+
+It follows the specified rules(As per indian passport):- 
+- The passport number should be 8 characters long, with the first character as an uppercase letter, the second and third characters as numbers (1-9 for the first digit, 0-9 for the second digit).
+- The date of expiry should be calculated based on the date of issue:
+- 1. If the user is an adult (18 years or older), the expiry date should be exactly 5 years from the date of issue.
+  2. If the user is under 18, the expiry date should be exactly 10 years from the date of issue.
+        
+Passport Number Validation:
+The passportPattern uses a regular expression:
+^[A-Z] – The first character must be an uppercase letter.
+[1-9][0-9] – The second and third characters are numbers; the first is between 1-9, and the second between 0-9.
+[A-Z0-9]{5}$ – The last five characters are alphanumeric.
+If the passport number does not match this pattern, the script displays an error message and clears the field.
+
+Date of Expiry Calculation:
+- After the date of issue and age are provided, the script calculates the expiry date by adding 5 years for adults (18 or older) or 10 years for minors (under 18).
+- The calculated expiry date is automatically set in the date_of_expiry field in the yyyy-MM-dd format.
+- Prompts are displayed if necessary fields like date_of_issue or age are missing before attempting the expiry date calculation.
+
+This Client Script will ensure that the entered passport information and expiry date meet the requirements, providing a seamless and guided experience for the user.

Client Scripts/Adding Placeholder on Resolution Notes/README.md

@@ -0,0 +1,15 @@
+# Adding Placeholder Text in Resolution Notes
+
+To maintain consistency and ensure specific information is captured in resolution notes, process owners may require fulfillers to follow a predefined format when resolving tickets.
+
+By adding **placeholder** text in the resolution notes, fulfillers are reminded of the required information(e.g., Root cause, Steps taken, Resolution provided), reducing the risk of missing important details. The placeholder disappears as soon as the fulfiller begins entering their notes, ensuring it doesn't interfere with their input.
+
+## How It Works
+
+### When?
+- The placeholder text is automatically added when the state of the ticket changes to Resolved (6).
+
+### What Happens?
+- A placeholder text appears in the resolution notes field to guide the fulfiller.
+- As soon as the fulfiller starts typing, the placeholder disappears.
+- This ensures consistency and alignment with the process requirements.

Client Scripts/Adding Placeholder on Resolution Notes/script.js

@@ -0,0 +1,10 @@
+function onChange(control, oldValue, newValue, isLoading, isTemplate) {
+    if (isLoading || newValue === '') {
+        return;
+    }
+    var res = g_form.getElement('close_notes');
+    if (newValue == 6)
+        res.placeholder = "1. Root Cause" + "\n" + "2. Steps taken" + "\n" + "3. Resolution provided"; //Placeholder text as required
+    else
+        res.placeholder = "";
+}

Client Scripts/Redact Sensitive Information/README.md

@@ -0,0 +1,18 @@
+# Redact Sensitive Information
+
+When users create an incident or HR case via the self-service portal, they may occasionally enter sensitive information (e.g., personal identifiers, account numbers). 
+To prevent misuse of such data, **fulfillers** can redact sensitive information from the short description or description fields.
+
+This ensures that confidential information is safeguarded and not accessible for unauthorized use or distribution.
+
+## Prerequisites
+
+1. Custom Field:
+    Add a custom field to the form to hold the redacted text.
+    Example: u_redact (Redact).
+   
+2. OnSubmit Client Script:
+    Create an onsubmit client script to redact sensitive information.
+    This script will update the **short description** and **description** field with custom value as required.
+
+**Note**: Data that has been redacted cannot be recovered.

Client Scripts/Redact Sensitive Information/script.js

@@ -0,0 +1,17 @@
+function onSubmit() {
+    var redact = g_form.getValue("u_redact"); //custom field on the form to redact information
+    if (redact == true) {
+        var answer = confirm(getMessage('Do you want to redact sensitive information')); //Confirm the user who wants to redact information 
+        if (answer) {
+            g_form.setValue('short_description', 'Short Description is redacted as it contained sensitive information'); //Custom short_description post redacting
+            g_form.setValue('description', 'Description is redacted as it contained sensitive information'); //Custom description post redacting
+            g_form.setValue('work_notes', 'The Description and Short Description has been redacted.'); //Adding work notes to track who redacted the short_description and description
+            g_form.setReadOnly('short_description', true);
+            g_form.setReadOnly('description', true);
+            g_form.setReadOnly('u_redact', true)
+        } else {
+            g_form.setValue('u_redact', false);
+            return false;
+        }
+    }
+}

Fix scripts/Remove leading and trailing spaces/README.md

@@ -0,0 +1,7 @@
+## Fix script to remove leading and trailing spaces from a field in bulk
+
+- we often encounter in a situation that a field has leading or trailing spaces and we want to remove it
+- This fix script helps to remove leading and trailing spaces from a field in bulk number.
+- Just for an example I have taken incident table and short description as a field.
+- feel free to modify and use it as per your requirement.
+  

Fix scripts/Remove leading and trailing spaces/RemoveLeadingTrailingSpaces.js

@@ -0,0 +1,43 @@
+var page = 1;
+var count = 0;
+var infoMsg = 'Fix Script to remove leading or trailing spaces from short_description. \n';
+var sd = '';  //sd inshort for shortdescription 
+
+
+var regExSpacecheck = /^\s+|\s+$/g;  //regular expression to check if a sentence has leading and trailing spaces.
+
+var grInc = new GlideRecord('incident');
+grInc.addEncodedQuery('short_descriptionISNOTEMPTY');
+grInc.query();
+while (grInc.next()) {
+
+    if (regExSpacecheck.test(grInc.short_description)) {
+
+        infoMsg += 'incident record found with leading or trailing space for short_description: ' + grInc.sys_id + '\n';
+        infoMsg += 'Sd ' + grInc.short_description + 'Contains leading or trailing spaces \n';
+        sd = grInc.short_description;
+        sd = sd.trim();    //trimmed value of short description
+        infoMsg += 'sd is ' + sd + '\n';
+
+        if (regExSpacecheck.test(sd)) {
+            infoMsg += 'sd: ' + sd + ' still has a trailing space\n';
+        } else {
+            infoMsg += 'sd: ' + sd + ' no longer contains trailing space \n';
+        }
+        //Replace the value for u_location_svid with the trimmed version
+        grInc.setValue('short_description', sd);
+        grInc.setWorkflow(false);
+        grInc.update();
+
+        count++;
+
+        if (count == 50) {
+            gs.info(infoMsg);
+            page++;
+            count = 0;
+            infoMsg = 'Fix Script to remove leading or trailing spaces from short_description  (' + page + ')\n';
+        }
+
+    }
+
+}

GlideAggregate/Improve incident handling/readme.md

@@ -0,0 +1,21 @@
+Suppose you want to gather data about incident resolution in your system. 
+Specifically, you need to find the total number of incidents, the average time to resolution (in hours), and the number of incidents per assignment group. 
+This information can help analyze the efficiency of different groups and improve incident handling.
+
+Below are the added Aggregations:
+
+inc.addAggregate('COUNT') gets the total count of resolved incidents.
+inc.addAggregate('AVG', 'calendar_duration') calculates the average calendar duration for incident resolution (measured in hours).
+inc.addAggregate('COUNT', 'assignment_group') counts incidents per assignment group, and ga.groupBy('assignment_group') groups the result by assignment group to produce totals per group.
+
+Result:
+- It fetches total counts, average resolution time, and group-specific counts.
+- Logs the total number of resolved incidents and the average resolution time.
+- For each assignment group, it logs the group’s sys_id and the corresponding incident count.
+
+Benefits of Using GlideAggregate:
+- Reduces the number of queries and records you need to process, as it performs calculations at the database level.
+- Works well with large datasets, making it suitable for summary reports and dashboards.
+- Allows grouping and multiple aggregations (e.g., AVG, COUNT, MIN, MAX) on various fields in a single query.
+  
+This GlideAggregate example provides a consolidated view of incident resolution statistics, which can aid in optimizing group efficiency and improving response times.

GlideAggregate/Improve incident handling/script.js

@@ -0,0 +1,38 @@
+// Create a GlideAggregate instance for the Incident table
+var inc = new GlideAggregate('incident');
+
+// Filter for resolved incidents only
+inc.addQuery('state', 6); 
+
+// Add aggregations
+inc.addAggregate('COUNT');                    // Total number of incidents
+inc.addAggregate('AVG', 'calendar_duration'); // Average resolution time in hours
+inc.addAggregate('COUNT', 'assignment_group'); // Count of incidents per assignment group
+inc.groupBy('assignment_group'); // Group by assignment group to get the count per group
+inc.query();
+
+var totalIncidents = 0;
+var averageResolution = 0;
+var results = [];
+
+while (inc.next()) {
+    totalIncidents = inc.getAggregate('COUNT');
+    averageResolution = inc.getAggregate('AVG', 'calendar_duration');
+
+    // Get assignment group and incident count per group
+    var groupSysId = inc.assignment_group.toString();
+    var groupIncidentCount = inc.getAggregate('COUNT', 'assignment_group');
+
+    results.push({
+        groupSysId: groupSysId,
+        groupIncidentCount: groupIncidentCount
+    });
+}
+
+// Display results in logs
+gs.info("Total Resolved Incidents are: " + totalIncidents);
+gs.info("Average Resolution Time (hours) is: " + averageResolution);
+
+results.forEach(function(result) {
+    gs.info("Assignment Group: " + result.groupSysId + " | Incident Count: " + result.groupIncidentCount);
+});

Regular Expressions/Remove all HTML Tags/Remove all html tags.js

@@ -0,0 +1,2 @@
+var html  = '<div id="someid"><span>Hello World</span></div>'; // insert your html content
+var outputString = html.replace(/<\/?[^>]+(>|$)/g, ""); // output will a string without the HTML tags

Regular Expressions/Remove all HTML Tags/readme.md

@@ -0,0 +1 @@
+Will accept a html and remove all the html tags and give a string from it.

UI Actions/Open Record producer from Form Button In Configurable workspace/OpenItem.js

@@ -0,0 +1,25 @@
+/* 
+UI Action
+   Client - true
+   action name - open_item
+   show update - true ( As per your requirement)
+   onClick - openItem();
+   Workspace Form button - true
+   Format for Configurable Workspace - true 
+*/
+
+//Workspace client script: 
+function onClick() {
+    var result = g_form.submit('open_item');
+    if (!result) {
+        return;
+    }
+    result.then(function() {
+        var params = {};
+        params.sysparm_parent_sys_id = g_form.getUniqueValue();
+        params.sysparm_shortDescription = g_form.getValue('short_description');
+        //add params as required, These params can be parsed and used in the record producer.
+        g_service_catalog.openCatalogItem('sc_cat_item', 'recordproducer_sysid_here', params); 
+        //Use the record producer sys_id in second parameter.
+    });
+}

UI Actions/Open Record producer from Form Button In Configurable workspace/ParseUrl.js

@@ -0,0 +1,31 @@
+/*
+Catalog Client script on the record producer/catalog item you want to open from ui action
+   Name - ParseURL
+   Type - Onload
+   Applies on catalog item view - true
+*/
+
+function onLoad() {
+
+  
+	g_form.setValue('task',parseURL('sysparm_parent_sys_id'));
+	g_form.setValue('description',parseURL('sysparm_description));
+	
+	function parseURL(paramName) {
+		
+		var url = decodeURIComponent(top.location.href); //Get the URL and decode it
+		var workspaceParams = url.split('extra-params/')[1]; //Split off the url on Extra params
+		var allParams = workspaceParams.split('/'); //The params are split on slashes '/'
+		
+		//Search for the parameter requested
+		for (var i=0; i< allParams.length; i++) {
+			if(allParams[i] == paramName) {
+				return allParams[i+1];
+			}
+		}
+	}
+}
+/*
+pass the parameter name which was used in the ui action to parse the value here.
+Example - parseURL('sysparm_description) as I am passing description value in the params from ui action.
+*/

UI Actions/Open Record producer from Form Button In Configurable workspace/readme.md

@@ -0,0 +1,18 @@
+When we want to open a catalog item with details from current record and map it to the opened catalog form then we can use this code.
+
+This UI Action and catalog client script Redirects you to the record producer or catalog item( based on the sys id provided) and auto-populates the fields from the parent record to the catalog item/record producer variables.
+
+1. UI Action
+   Client - true
+   action name - open_item
+   show update - true ( As per your requirement)
+   onClick - openItem();
+   Workspace Form button - true
+   Format for Configurable Workspace - true 
+
+2. Catalog Client script.
+   Type - Onload
+   Applies on catalog item view - true
+   Name - ParseURL
+
+Note : Above UI Action works in Configurable workspace and opens the catalog item/record producer in workspace itself.