Merge branch 'main' into Flow-Actions/script-for-concatenating

Author: tewariap

Background Scripts/Stale Tasks Auto-Close/Stale Tasks Auto-Close.js

@@ -0,0 +1,18 @@
+var staleDays = 7;
+var closeDays = 14;
+var reminderGR = new GlideRecord('task');
+reminderGR.addActiveQuery();
+reminderGR.addEncodedQuery('sys_updated_onRELATIVELE@dayofweek@ago@' + staleDays);
+reminderGR.query();
+while (reminderGR.next()) {
+    gs.eventQueue('task.reminder', reminderGR, reminderGR.assigned_to, staleDays + ' days without update.');
+    }
+
+var closeGR = new GlideRecord('task');
+closeGR.addActiveQuery();
+closeGR.addEncodedQuery('sys_updated_onRELATIVELE@dayofweek@ago@' + closeDays);
+closeGR.query();
+while (closeGR.next()) {
+    closeGR.state = 3; // Closed
+    closeGR.update();
+    }

Background Scripts/Stale Tasks Auto-Close/readme.md

@@ -0,0 +1 @@
+The script identifies tasks that haven’t been updated for a set period, sends reminder notifications to assigned users, and, if still inactive after additional time, automatically closes them. This helps keep task lists current and reduces manual follow-ups.

Background Scripts/encryptAndDecryptNonPasswordFields/encryptAndDecryptNonPasswordFields.js

@@ -0,0 +1,21 @@
+//To Encrypt password field
+var grIncident = new GlideRecord('incident');
+if (grIncident.get('dc1c4143476202101b589d2f316d4390')) {
+ grIncident.setDisplayValue('u_pass', 'demo@123');
+ grIncident.update();
+}
+//NOTE: You can't use the setValue() API for the Password2 field
+
+//To print cipher text
+var grIncident = new GlideRecord('incident');
+if (grIncident.get('dc1c4143476202101b589d2f316d4390')) {
+ gs.info('Encrypted cipher test of password ' + grIncident.getValue('u_pass'));
+}
+
+//To decrypt password field
+var grIncident = new GlideRecord('incident');
+if (grIncident.get('dc1c4143476202101b589d2f316d4390')) {
+ var result = grIncident.u_pass.getDecryptedValue();
+ gs.info("Decrypted password- " +result);
+}
+//NOTE: The getDecryptedValue() API isn't scoped. It's available globally.

Background Scripts/encryptAndDecryptNonPasswordFields/readme.md

@@ -0,0 +1,10 @@
+Dear ServiceNow Community,
+
+
+The GlideEncrypter API uses 3DES encryption standard with NIST 800-131 A Rev2 has recommended against using to encrypt data after 2023. ServiceNow offers alternative cryptographic solutions to the GlideEncrypter API. 
+
+Glide Element API to encrypt/decrypt password2 values through GlideRecord.
+
+Below are the sample scripts I ran in my PDI: For Password fields. 
+
+Note: 'u_pass' is Password (2 Way Encrypted) field.

Business Rules/Automatic Group Membership Updates via API/README.md

@@ -0,0 +1,18 @@
+# Overview
+This code snippet helps ServiceNow developers manage group memberships automatically by integrating with an external API. It retrieves group membership data from a specified API endpoint and updates user-group relationships in ServiceNow accordingly. 
+
+This is useful for organizations where user groups are managed dynamically in external systems, and developer want a seamless and up-to-date integration with ServiceNow.
+
+# How It Works
+The script:
+- Fetches API Data: It connects to an external API (specified by the `apiEndpoint` variable) to retrieve the current group membership details.
+- Parses API Response: The response is parsed to extract user information (based on email) and group identifiers.
+- Updates Group Memberships:
+    - For each member in the response, the script queries the `sys_user` table to locate the user in ServiceNow based on their email address.
+    - Once a user is found, the script creates a new record in the `sys_user_grmember` table, associating the user with the appropriate group.
+
+# Implementation
+- Define the `apiEndpoint` URL, replacing `https://your-group-api.com/members` with the actual endpoint from which group membership data will be fetched.
+- Ensure that any necessary authentication for the API is configured, such as API keys or tokens.
+- This script uses email as a unique identifier for users. Adjust `userGR.addQuery('email', member.email)`; if another identifier is needed.
+- Deploy the script as a Business Rule in ServiceNow, setting the appropriate table and conditions under which it should execute. For example, it could run on a schedule or be triggered by a specific update.

Business Rules/Automatic Group Membership Updates via API/autoGroupMembershipUpdate.js

@@ -0,0 +1,25 @@
+// Script to update group memberships based on API data
+(function executeRule(current, previous /*null when async*/) {
+    var apiEndpoint = 'https://your-group-api.com/members';
+    var request = new sn_ws.RESTMessageV2();
+    request.setEndpoint(apiEndpoint);
+    request.setHttpMethod('GET');
+
+    var response = request.execute();
+    var responseData = JSON.parse(response.getBody());
+    
+    // Update group memberships
+    responseData.members.forEach(function(member) {
+        var userGR = new GlideRecord('sys_user');
+        userGR.addQuery('email', member.email);
+        userGR.query();
+        
+        if (userGR.next()) {
+            var groupMembership = new GlideRecord('sys_user_grmember');
+            groupMembership.initialize();
+            groupMembership.group = member.group_id;
+            groupMembership.user = userGR.sys_id;
+            groupMembership.insert();
+        }
+    });
+})(current, previous);

Business Rules/Backup Critical Table Data/README.md

@@ -0,0 +1,12 @@
+# Overview
+This ServiceNow script automates backing up critical record data (such as task or incident records) to an external storage solution. Designed to run as a Business Rule, it helps maintain redundancy for sensitive information by copying specific record details to a backup API whenever a record is created or modified.
+
+# How It Works
+- Data Extraction: Collects key record fields (such as `sys_id`, `number`, `short_description`) from `current`.
+- API Call: Sends a `POST` request with record data to an external backup endpoint.
+- Logging: Outputs API response for monitoring.
+
+# Implementation
+1. Update the `setEndpoint` URL to match your backup API endpoint.
+2. Modify the `recordData` with table data structure as needed.
+3. Ensure the Business Rule is triggered on the appropriate conditions (e.g., on record insert/update) in the target table.

Business Rules/Backup Critical Table Data/backupCriticalTableData.js

@@ -0,0 +1,18 @@
+// Script to back up critical table data to external storage
+(function executeRule(current, previous /*null when async*/) {
+    var recordData = {
+        sys_id: current.sys_id.toString(),
+        number: current.number.toString(),
+        short_description: current.short_description.toString()
+    };
+    
+    // Call external API to store data
+    var request = new sn_ws.RESTMessageV2();
+    request.setEndpoint('https://your-backup-api.com/backup');
+    request.setHttpMethod('POST');
+    request.setRequestBody(JSON.stringify(recordData));
+    
+    var response = request.execute();
+    gs.info("Backup response: " + response.getBody());
+})(current, previous);
+

Business Rules/Fetching reference field value from higher-level parents/Fetching reference field value from higher-level parents.js

@@ -0,0 +1,12 @@
+// In this before insert or update Business Rule, we are fetching a reference field value from higher-level parents in hierarchy when there is a field containing the parent record in the children and our use-case reference field is present in all the tables in hierarchy
+// I would be referring to "reference field name we want to populate" as "r1"
+// I would be referring to "reference field containing parent record" as "parent"
+
+
+(function executeRule(current, previous /*null when async*/ ) {
+    if (current.r1 == "" && !JSUtil.nil(current.parent.r1)) // Populate 'use-case reference field' from parent's value for the reference field'
+        current.r1 = current.parent.r1;
+    else if (current.< reference field name we want to populate > == "" && !JSUtil.nil(current.parent.parent.r1)) // Populate 'use-case reference field' from 'parent of parent' 
+        current.r1 = current.parent.parent.r1;
+
+})(current, previous);

Business Rules/Fetching reference field value from higher-level parents/readme.md

@@ -0,0 +1,12 @@
+This is a "**before insert/update**" Business Rule
+We are fetching a reference field value from higher-level parents in hierarchy 
+when there is a field containing the parent record in the children and 
+our use-case reference field is present in all the tables in hierarchy
+
+In the code, we are referring to "reference field name we want to populate" as "_r1_"
+In the code, we are referring to "reference field containing parent record" as "_parent_"
+
+The "**JSUtil.nil**" is being used to check for empty/null value for the field.
+
+
+Through the code we are checking the empty value of the use-case reference field and dot walking to parents and fetching the value from them if it exists

Client Scripts/Validate Short Description/Readme.md

@@ -0,0 +1 @@
+Effectively validates the short description field ensuring data quality and preventing invalid input.

Client Scripts/Validate Short Description/validateSpecialChar.js

@@ -0,0 +1,12 @@
+// Client Script to Validate Special Charecters
+function onSubmit() {
+    var shortDescription = g_form.getValue('short_description');
+  var specialCharsRegex = /[^a-zA-Z0-9\s]/g;
+var specialChars = description.match(specialCharsRegex);
+  if (specialChars) {
+        alert('Description contains invalid characters: ' + specialChars.join(', '));
+        return false;
+    } else {
+        return true;
+    }
+    

UX Client Scripts/debug-event/debug-event.js

@@ -0,0 +1,10 @@
+/**
+* @param {params} params
+* @param {api} params.api
+* @param {any} params.event
+* @param {any} params.imports
+* @param {ApiHelpers} params.helpers
+*/
+function handler({ api, event, helpers, imports }) {
+  console.log(`DEBUG Event ${event.elementId} ${event.name}`, event);
+}

UX Client Scripts/debug-event/readme.md

@@ -0,0 +1,22 @@
+# DEBUG Event UX Client Script
+
+This repository provides a simple UX Client Script for logging events to the console. Named `DEBUG Event`, this client script is designed to assist in debugging by outputting key event details to the console, helping developers track event triggers and properties in real-time.
+
+## Features
+
+- **Console Logging**: Logs event details, including `elementId` and `name`, to the console for easy tracking.
+- **Simplified Debugging**: Useful for monitoring and debugging UX interactions without complex setup.
+
+## Script Overview
+
+```javascript
+/**
+ * @param {params} params
+ * @param {api} params.api
+ * @param {any} params.event
+ * @param {any} params.imports
+ * @param {ApiHelpers} params.helpers
+ */
+function handler({ api, event, helpers, imports }) {
+  console.log(`DEBUG Event ${event.elementId} ${event.name}`, event);
+}

UX Client Scripts/debug-state/debug-state.js

@@ -0,0 +1,10 @@
+/**
+* @param {params} params
+* @param {api} params.api
+* @param {any} params.event
+* @param {any} params.imports
+* @param {ApiHelpers} params.helpers
+*/
+function handler({ api, event, helpers, imports }) {
+  console.log(`DEBUG State:`, { ...api.state });
+}

UX Client Scripts/debug-state/readme.md

@@ -0,0 +1,23 @@
+# Debug State UX Client Script
+
+This repository contains a UX Client Script called `Debug State`, designed to log the current client state to the console. This script is useful for developers who want to inspect the state object in real time, making debugging more efficient by allowing quick access to current state values.
+
+## Features
+
+- **Console Logging of State**: Logs the entire `state` object to the console, enabling developers to track and inspect state changes.
+- **Efficient Debugging**: Simplifies the debugging process by providing direct access to the client's state.
+
+## Script Overview
+
+```javascript
+/**
+ * @param {params} params
+ * @param {api} params.api
+ * @param {any} params.event
+ * @param {any} params.imports
+ * @param {ApiHelpers} params.helpers
+ */
+function handler({ api, event, helpers, imports }) {
+  console.log(`DEBUG State:`, { ...api.state });
+}
+```

UX Data Broker Transform/create-update-user-preference/create-update-user-preference.js

@@ -0,0 +1,43 @@
+/**
+ * This data broker creates or updates a user preference of the given name with the given value
+ * @param {{name: string, value?: string}} inputs inputs from the properties field above
+ */
+function transform({ name, value }) {
+  const lib = "Data Broker";
+  const func = "Create/Update User Preference";
+  try {
+    if (!name) throw new Error("Missing required param 'name'");
+
+
+    gs.getUser().savePreference(name, value);
+  } catch (e) {
+    gs.error(`${lib} ${func} - ${e}`);
+    throw new Error(e);
+  }
+}
+
+/**
+ * Make sure to select that this data broker mutates data
+ * Input this in the properties field:
+ * 
+ [
+    {
+        "name": "name",
+        "label": "Name",
+        "description": "The name of the user preference to create or update",
+        "readOnly": false,
+        "fieldType": "string",
+        "mandatory": true,
+        "defaultValue": ""
+    },
+    {
+        "name": "value",
+        "label": "Value",
+        "description": "The value to store in the user preference",
+        "readOnly": false,
+        "fieldType": "string",
+        "mandatory": false,
+        "defaultValue": ""
+    }
+  ]
+ */

UX Data Broker Transform/create-update-user-preference/readme.md

@@ -0,0 +1,29 @@
+# Create/Update User Preference Data Broker
+
+This repository provides a data broker for creating or updating user preferences in ServiceNow. The broker allows you to specify a preference name and value, storing or updating it in the user’s preferences.
+
+## Features
+
+- **Create or Update User Preferences**: Provides a simple interface for adding or modifying preferences by name and value.
+- **Error Handling**: Logs errors if the preference name is missing or if an unexpected issue arises.
+
+## Template Overview
+
+```javascript
+/**
+ * This data broker creates or updates a user preference of the given name with the given value
+ * @param {{name: string, value?: string}} inputs inputs from the properties field above
+ */
+function transform({ name, value }) {
+  const lib = "Data Broker";
+  const func = "Create Update User Preference";
+  try {
+    if (!name) throw new Error("Missing required param 'name'");
+
+    gs.getUser().savePreference(name, value);
+  } catch (e) {
+    gs.error(`${lib} ${func} - ${e}`);
+    throw new Error(e);
+  }
+}
+```

UX Data Broker Transform/starter-template/readme.md

@@ -0,0 +1,72 @@
+# Transform Data Broker Template
+
+This repository provides a starter template for creating Transform Data Brokers in ServiceNow’s UX framework. This template includes error handling, input validation, and JSDoc annotations for a streamlined setup.
+
+## Features
+
+- **JSDoc Type Annotations** for clarity and type-checking.
+- **Destructured Inputs** for simplified parameter handling.
+- **Error Logging & Propagation**: Logs errors while allowing the data resource to fail if needed.
+- **Properties Example**: Provides an example of what the properties should look like
+
+## Template Overview
+
+```javascript
+/**
+ * @param {{param1: string, param2: number, param3?: boolean}} inputs 
+ * Inputs from the properties field above; param1 and param2 are mandatory.
+ * @returns {string} The value returned after transformation.
+ */
+function transform({ param1, param2, param3 }) {
+  const lib = "Data Broker";
+  const func = "<insert data broker name here>";
+  let res;
+
+  try {
+    if (!param1) throw new Error("Missing required param 'param1'");
+    if (!param2) throw new Error("Missing required param 'param2'");
+
+    // Add transformation logic here
+
+    return res;
+  } catch (e) {
+    gs.error(`${lib} ${func} - ${e}`);
+    throw new Error(e);
+  }
+}
+
+/**
+ * TIPS
+ * Make sure to flag mutates data if your data resource changes any data
+ * Properties structure (these are the inputs for your data resource):
+ [
+    {
+        "name": "param1",
+        "label": "Param 1",
+        "description": "An example of the first param as a string, mandatory",
+        "readOnly": false,
+        "fieldType": "string",
+        "mandatory": true,
+        "defaultValue": ""
+    },
+    {
+        "name": "param2",
+        "label": "Param 2",
+        "description": "An example of the second param as a number, mandatory",
+        "readOnly": false,
+        "fieldType": "number",
+        "mandatory": true,
+        "defaultValue": ""
+    },
+    {
+        "name": "param3",
+        "label": "Param 3",
+        "description": "An example of the third param as a boolean, optional",
+        "readOnly": false,
+        "fieldType": "boolean",
+        "mandatory": false,
+        "defaultValue": ""
+    }
+  ]
+ */
+```