Merge branch 'ServiceNowDevProgram:main' into main

Thrizvi · web-flow · commit 524e42326bd3 · 2023-10-31T18:39:43.000+05:30
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.DS_Store
diff --git a/Business Rules/duplicateattachments/AvoidduplicateattachmentsonIncident.js b/Business Rules/duplicateattachments/AvoidduplicateattachmentsonIncident.js
@@ -0,0 +1,16 @@
+
+   if(current.table_name=="incident") {
+	
+	var attached = new GlideRecord('sys_attachment');
+	attached.addQuery('table_name','incident');
+	attached.addQuery('table_sys_id', current.table_sys_id);
+	attached.addQuery('file_name',current.file_name);
+	attached.query();
+	if(attached.next())
+		{
+			
+			gs.addInfoMessage('Attachement already Exists with the Same Name do not upload same attachement');
+			current.setAbortAction(true);
+		
+		}
+      }
diff --git a/Business Rules/duplicateattachments/readme.md b/Business Rules/duplicateattachments/readme.md
@@ -0,0 +1,2 @@
+Type: Business Rule When: OnBefore and On Insert Operation  Table:Incident
+This BR runs on Insert Operation , IT compares the filename from Sysattachment table and if same attachment with Same file exists on the Incident this BR runs and Abort the Attaching Attachments
diff --git a/Client Scripts/Open Record in Agne Workspace Tab/openrecawtab.js b/Client Scripts/Open Record in Agne Workspace Tab/openrecawtab.js
@@ -0,0 +1,4 @@
+// Opens a Story attached to a Incident record in the parent field in the readonly mode.
+  function onLoad(g_form) {
+g_aw.openRecord('rm_story', g_form.getValue('parent'), {readOnlyForm: true}); 
+  }
diff --git a/Client Scripts/Open Record in Agne Workspace Tab/readme.md b/Client Scripts/Open Record in Agne Workspace Tab/readme.md
@@ -0,0 +1,3 @@
+This code helps to open a record in readonly mode irrespective of ACLS, UI Policies via client script in a Agent workspace tab.
+
+Here we are opening a story that is stored in the parent field on the incident record in the agent workspace.
diff --git a/Client Scripts/state-edit-for-grpmem/grpmemstateedit.js b/Client Scripts/state-edit-for-grpmem/grpmemstateedit.js
@@ -0,0 +1,11 @@
+//Create a Display Business Rule with the following code and then the following code on "On-Load" client script
+
+//Display Business Rule Code:
+/*****
+g_scratchpad.grpmember = gs.getUser().isMemberOf(current.assignment_group); //This returns true or false . If user is part of the group it returns true, if user is not part of the group it returns false and assign it to scratchpad variable.
+*****/
+
+if(g_scratchpad.grpmember == false)
+{
+g_form.setReadonly("state", true);
+}
diff --git a/Client Scripts/state-edit-for-grpmem/readme.md b/Client Scripts/state-edit-for-grpmem/readme.md
@@ -0,0 +1,2 @@
+This code will make state field editable only for group members, with the help of scratchpad variable that returns true or false from display business rule.
+
diff --git a/GlideQuery/Get User's Roles from User Name/getUserRoles.js b/GlideQuery/Get User's Roles from User Name/getUserRoles.js
@@ -1,11 +1,15 @@
-(function getUserRoles() {
-	// sample user
-	var userName = 'bow.ruggeri';
+function getUserRoles(userName) {
 
-	var roleQuery = new GlideQuery('sys_user_has_role')
-		.where('user.user_name', 'bow.ruggeri')
-		.select(['role$DISPLAY', 'role.active', 'user$DISPLAY', 'user.email'])
-		.toArray(100);
+    var gqRoles = new global.GlideQuery('sys_user_has_role')
+        .where('user.user_name', userName)
+        .select('role$DISPLAY')
+        // use .reduce() instead of .toArray() as it allows us to strip out only whats needed, and doesn't need to know the number of entries.
+        .reduce(function (arr, e) {
+            arr.push(e.role$DISPLAY);
+            return arr;
+        }, []);
 
-	gs.log(JSON.stringify(roleQuery, null, 2));
-})();
+    return gqRoles;
+};
+
+gs.info(getUserRoles('bow.ruggeri'));
diff --git a/GlideQuery/Get User's Roles from User Name/readme.md b/GlideQuery/Get User's Roles from User Name/readme.md
@@ -2,6 +2,4 @@
 
 GlideQuery's can greatly simplify extracting information from queries, especially when dot walking.
 
-This query retrieves a user's roles, and returns an array of objects with the the role's display
-value, the role's active status, the user's display value, and the user's email.  Adding more
-fields is trivial with this format, and the query stream is very easy to follow.
+This code has been updated to simplify the function to return an array of roles for the given user.  Shows the use of GlideQuery and .reduce() in place of .toArray().
diff --git a/GlideRecord/comments on gr.update/code.js b/GlideRecord/comments on gr.update/code.js
@@ -0,0 +1,4 @@
+var now_GR = new GlideRecord('incident');
+now_GR.get('99ebb4156fa831005be8883e6b3ee4b9');
+now_GR.setValue('short_description', 'Update the short description');
+now_GR.update("updated from BR" ); // This comment gets added to the activity log of incident for audit purposes.
diff --git a/GlideRecord/comments on gr.update/readme.md b/GlideRecord/comments on gr.update/readme.md
@@ -0,0 +1,3 @@
+Comments on gr.update via an optional parameter of why or from where it is being update.
+
+Reference of documentation link: https://developer.servicenow.com/dev.do#!/reference/api/utah/server/no-namespace/c_GlideRecordScopedAPI#r_ScopedGlideRecordUpdate_String?navFilter=update
diff --git a/Scheduled Jobs/Unpublish Public Reports/Readme.md b/Scheduled Jobs/Unpublish Public Reports/Readme.md
@@ -0,0 +1 @@
+Scheduled Job to query the report table for any reports that are Published or roles are set to Public and remove the public role from report.
diff --git a/Scheduled Jobs/Unpublish Public Reports/UnpublishReports.js b/Scheduled Jobs/Unpublish Public Reports/UnpublishReports.js
@@ -0,0 +1,12 @@
+var pubReport = new GlideRecord('sys_report');
+pubReport.addQuery('is_published=true^ORroles=public');
+pubReport.query();
+while(pubReport.next()) {
+    //Obtain current roles report is shared with
+	var removePublic = pubReport.roles;
+    //Remove public role from string
+	removePublic = removePublic.replace(/public/g, '');
+    //Set report roles to new string value. Wihtout public role, report will auto unpublish
+	pubReport.roles.setValue(removePublic);
+	pubReport.update();
+}
diff --git a/Script Includes/CacheHelper/CacheHelper.js b/Script Includes/CacheHelper/CacheHelper.js
@@ -0,0 +1,78 @@
+var CacheHelper = Class.create();
+CacheHelper.prototype = {
+
+    logIt : false,
+
+    initialize: function(log) {
+        this.logIt = log;
+    },
+
+    /**
+     * Adds data to the cache
+     * 
+     * @param {string} cacheName : cache name
+     * @param {string} key : unique cache key 
+     * @param {any} data : any data to be cached
+     */
+    addToCache: function(cacheName, key, data) {
+        this._validateCacheName(cacheName);
+        this._validateCacheKey(key);
+
+        GlideCacheManager.put(cacheName, key, data);
+    },
+
+    /**
+     * Removes data from cache
+     * 
+     * @param {string} cacheName : cache name
+     * @param {string} key : unique cache key 
+     * @returns cached data
+     */
+    getFromCache: function(cacheName, key) {
+        this._validateCacheName(cacheName);
+        this._validateCacheKey(key);
+
+        var data = GlideCacheManager.get(cacheName, key);
+        return data;
+    },
+
+    removeFromCache: function(cacheName) {
+        this._validateCacheName(cacheName);
+        
+        GlideCacheManager.flush(cacheName);
+    },
+
+    /**
+     * Either gets the data from cache or calls the callback functions, get the data and then adds it to the cache
+     * @param {string} cacheName : cache name
+     * @param {string} key : unique cache key 
+     * @param {function} dataCallBack : call back function that returns the data to be cached
+     * @returns data from the cache or based on call back function
+     */
+    getOrAddToCache: function(cacheName, key, dataCallBack) {
+        this._validateCacheName(cacheName);
+        this._validateCacheKey(key);
+
+        var data = GlideCacheManager.get(cacheName, key);
+
+        if (gs.nil(data)) {
+            data = dataCallBack();
+            GlideCacheManager.put(cacheName, key, data);
+            if(this.logIt) gs.debug("Data from source.");
+            return data;
+        }
+
+        if(this.logIt) gs.debug("Data from cache.");
+        return data;
+    },
+
+    _validateCacheName :function(cacheName){
+        if(!cacheName) throw new Error("cacheName is required");
+    },
+
+    _validateCacheKey :function(cacheKey){
+        if(!cacheKey) throw new Error("cacheKey is required");
+    },
+
+    type: 'CacheHelper'
+};
diff --git a/Script Includes/CacheHelper/readme.md b/Script Includes/CacheHelper/readme.md
@@ -0,0 +1,25 @@
+# BenchmarkRunner
+Just a wrapper around GlideCacheManager with methods to enable validation of Cache key and data and ability to use the GlideCacheManager easily.
+
+## Example server-side call (background script)
+```javascript
+var cacheName = "rahman_test";
+var cacheKey = "1";
+
+var helper = new CacheHelper(false);
+
+// Either get the data from cache or add it
+var data = helper.getOrAddToCache(cacheName, cacheKey, function(){
+    gs.log("This will be called if the data is not in the cache. The second time will not be called.");
+
+    // This will be called if the data is not in cache!!!
+    var data = {
+        name: "rahman",
+    }
+
+    return data;
+})
+
+gs.log(JSON.stringify(data));
+
+//helper.removeFromCache(cacheName)
diff --git a/Script Includes/Single Sign-On (SSO) Direct Login URL Generator/UserHelper.js b/Script Includes/Single Sign-On (SSO) Direct Login URL Generator/UserHelper.js
@@ -0,0 +1,52 @@
+var UserHelper = Class.create();
+UserHelper.prototype = {
+    SECRET_KEY: '<YOUR_SECRET_KEY>', //secret key defined by you for encoding
+    MAC_ALG: 'HmacSHA256',
+    GLIDE_SSO_ID: '<SSO_PROVIDER_SYS_ID>', //system id of digest token sso provider
+
+    initialize: function(userGR) {
+        this.userGR = userGR;
+    },
+
+    getUserById: function(sys_id) {
+        return this.getUser('sys_id', sys_id);
+    },
+
+    getUserByEmail: function(email) {
+        return this.getUser('email', email);
+    },
+
+    getUserByName: function(user_name) {
+        return this.getUser('user_name', user_name);
+    },
+
+    getUser: function(key, value) {
+        if (key && value) {
+            this.userGR = new GlideRecord('sys_user');
+            this.userGR.get(key, value);
+        }
+        return this.userGR;
+    },
+
+    //generate the direct login url using user_name or user glide record
+    login: function(user_name) {
+
+        if (user_name) {
+            this.getUserByName(user_name);
+        }
+
+        if (!this.userGR) {
+            return null;
+        }
+
+        //generating token
+        var token = SncAuthentication.encode(this.userGR.getValue('user_name'), this.SECRET_KEY, this.MAC_ALG);
+
+        //formating url
+        var url = gs.getProperty('glide.servlet.uri') + '?glide_sso_id=' + this.GLIDE_SSO_ID + '&SM_USER=' + this.userGR.getValue('user_name') + '&DE_USER=' + token;
+
+        return url;
+    },
+
+    type: 'UserHelper'
+};
diff --git a/Script Includes/Single Sign-On (SSO) Direct Login URL Generator/readme.md b/Script Includes/Single Sign-On (SSO) Direct Login URL Generator/readme.md
@@ -0,0 +1,52 @@
+# Script Include for Single Sign-On (SSO) Direct Login URL Generator using UserHelper
+
+1. [Introduction](#introduction)
+2. [Installation](#installation)
+3. [Example & Usage](#usage)
+4. [Security](#security)
+
+## Introduction<a name="introduction"></a>
+
+The UserHelper script include provides functions for generating direct login URLs for users in ServiceNow. This functionality is similar to the impersonate user feature in ServiceNow, but it allows you to directly log in the user without requiring them to enter any credentials.
+
+## Installation<a name="installation"></a>
+
+This script include required Digest Token Authentication Integration below:
+
+#### Prerequisites
+
+* Multi-Provider SSO plugin is activated [documentation](https://docs.servicenow.com/bundle/vancouver-platform-security/page/integrate/single-sign-on/task/t_ActivateMultipleProviderSSO.html)
+* Multi-Provider SSO properties are configured [documentation](https://docs.servicenow.com/bundle/vancouver-platform-security/page/integrate/single-sign-on/task/t_ConfigureMultiProviderSSOProps.html)
+
+#### Steps
+
+1. Go to **Multi-Provider SSO** > **Identity Providers**.
+2. Select the **Digested Token** record.
+3. Add a **Secret Passphrase**. This will be the `<YOUR_SECRET_KEY>` in the script include.
+4. Note the **sys_id** of the **Digested Token** record. This will be the `<SSO_PROVIDER_SYS_ID>` for the script include.
+
+## Usage<a name="usage"></a>
+
+To generate a direct login URL for a user, you can use the `login()` function provided by the UserHelper script include. This function takes the user's name or GlideRecord as input and returns a URL that the user can use to log in directly.
+
+The following example shows how to use the UserHelper script include to generate a direct login URL for a user:
+```javascript
+// Generate a direct login URL for the user "admin".
+var userHelper = new UserHelper();
+
+// Generate a direct login URL for the user "admin".
+var loginUrl = userHelper.login('admin');
+```
+```javascript
+// Generate a direct login URL for the user with the sys_id "1234567890", email.
+var userHelper = new UserHelper();
+userHelper.getUserById('1234567890'); //userHelper.getUserByEmail('<EMAIL>');
+
+// Generate a direct login URL for the user "admin".
+var loginUrl = userHelper.login();
+
+//loginUrl: https://<instance>.service-now.com/?glide_sso_id=<SSO_PROVIDER_SYS_ID>&SM_USER=admin&DE_USER=htrULTFZTOLl9PHEvNBejz65ghxp6dJgDazXXv9v/wY=
+```
+
+## Security<a name="security"></a>
+It is crucial to emphasize that the UserHelper script include provides direct access to users without requiring any credentials. Therefore, it is important to set proper security policies to secure this script include. Make sure to follow best practices for securing access to this functionality.
diff --git a/UI Actions/Cancel Incident/readme.md b/UI Actions/Cancel Incident/readme.md
@@ -0,0 +1 @@
+This is a ui action run on incident table which is client callable, run on condition current.state == '1' which means when state is new.It cancel the incident through the form.
diff --git a/UI Actions/Cancel Incident/script.js b/UI Actions/Cancel Incident/script.js
@@ -0,0 +1,17 @@
+function cancelIncident(){
+	var gm = new GlideModal("glide_ask_standard", false, 600); // glide modal to get the confirmation
+	gm.setPreference("title", "Are you sure you wanna cancel incident!!!");
+	gm.setPreference("onPromptComplete", function() {
+		gsftSubmit(null,g_form.getFormElement(),'cancel_incident');}); //calling same ui action
+	gm.render();
+	
+}
+
+if(typeof window == 'undefined'){
+	serverCancel();
+}
+
+function serverCancel(){
+	current.state = '8'; //setting the state to canceled
+	current.update();
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Type: Business Rule When: OnBefore and On Insert Operation Table:Incident`
	`2`	`+This BR runs on Insert Operation , IT compares the filename from Sysattachment table and if same attachment with Same file exists on the Incident this BR runs and Abort the Attaching Attachments`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+This code helps to open a record in readonly mode irrespective of ACLS, UI Policies via client script in a Agent workspace tab.`
	`2`	`+`
	`3`	`+Here we are opening a story that is stored in the parent field on the incident record in the agent workspace.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+This code will make state field editable only for group members, with the help of scratchpad variable that returns true or false from display business rule.`
	`2`	`+`