Merge branch 'ServiceNowDevProgram:main' into myFirstContribution

Author: RaviGaurav007

.github/pull_request_template.md

@@ -1,11 +1,12 @@
 # PR Description: 
-
+replace this with your description
 
 # Pull Request Checklist
 
 ## Overview
+- [x] Put an x inside of the square brackets to check each item.
 - [ ] I have read and understood the [CONTRIBUTING.md](CONTRIBUTING.md) guidelines
-- [ ] My pull request has a descriptive title that accurately reflects the changes
+- [ ] My pull request has a descriptive title that accurately reflects the changes and the description has been filled in above.
 - [ ] I've included only files relevant to the changes described in the PR title and description
 - [ ] I've created a new branch in my forked repository for this contribution
 

.github/workflows/pr-auto-unassign-stale.yml

@@ -0,0 +1,154 @@
+name: Auto-unassign stale PR assignees
+
+on:
+  schedule:
+    - cron: "*/15 * * * *"   # run every 15 minutes
+  workflow_dispatch:
+    inputs:
+      enabled:
+        description: "Enable this automation"
+        type: boolean
+        default: true
+      max_age_minutes:
+        description: "Unassign if assigned longer than X minutes"
+        type: number
+        default: 60
+      dry_run:
+        description: "Preview only; do not change assignees"
+        type: boolean
+        default: false
+
+permissions:
+  pull-requests: write
+  issues: write
+
+env:
+  # Defaults (can be overridden via workflow_dispatch inputs)
+  ENABLED: "true"
+  MAX_ASSIGN_AGE_MINUTES: "60"
+  DRY_RUN: "false"
+
+jobs:
+  sweep:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Resolve inputs into env
+        run: |
+          # Prefer manual run inputs when present
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            echo "ENABLED=${{ inputs.enabled }}" >> $GITHUB_ENV
+            echo "MAX_ASSIGN_AGE_MINUTES=${{ inputs.max_age_minutes }}" >> $GITHUB_ENV
+            echo "DRY_RUN=${{ inputs.dry_run }}" >> $GITHUB_ENV
+          fi
+          echo "Effective config: ENABLED=$ENABLED, MAX_ASSIGN_AGE_MINUTES=$MAX_ASSIGN_AGE_MINUTES, DRY_RUN=$DRY_RUN"
+
+      - name: Exit if disabled
+        if: ${{ env.ENABLED != 'true' && env.ENABLED != 'True' && env.ENABLED != 'TRUE' }}
+        run: echo "Disabled via ENABLED=$ENABLED. Exiting." && exit 0
+
+      - name: Unassign stale assignees
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const owner = context.repo.owner;
+            const repo  = context.repo.repo;
+
+            const MAX_MIN = parseInt(process.env.MAX_ASSIGN_AGE_MINUTES || "60", 10);
+            const DRY_RUN = ["true","True","TRUE","1","yes"].includes(String(process.env.DRY_RUN));
+            const now = new Date();
+
+            core.info(`Scanning open PRs. Threshold = ${MAX_MIN} minutes. DRY_RUN=${DRY_RUN}`);
+
+            // List all open PRs
+            const prs = await github.paginate(github.rest.pulls.list, {
+              owner, repo, state: "open", per_page: 100
+            });
+
+            let totalUnassigned = 0;
+
+            for (const pr of prs) {
+              if (!pr.assignees || pr.assignees.length === 0) continue;
+
+              const number = pr.number;
+              core.info(`PR #${number}: "${pr.title}" — assignees: ${pr.assignees.map(a => a.login).join(", ")}`);
+
+              // Pull reviews (to see if an assignee started a review)
+              const reviews = await github.paginate(github.rest.pulls.listReviews, {
+                owner, repo, pull_number: number, per_page: 100
+              });
+
+              // Issue comments (general comments)
+              const issueComments = await github.paginate(github.rest.issues.listComments, {
+                owner, repo, issue_number: number, per_page: 100
+              });
+
+              // Review comments (file-level)
+              const reviewComments = await github.paginate(github.rest.pulls.listReviewComments, {
+                owner, repo, pull_number: number, per_page: 100
+              });
+
+              // Issue events (to find assignment timestamps)
+              const issueEvents = await github.paginate(github.rest.issues.listEvents, {
+                owner, repo, issue_number: number, per_page: 100
+              });
+
+              for (const a of pr.assignees) {
+                const assignee = a.login;
+
+                // Find the most recent "assigned" event for this assignee
+                const assignedEvents = issueEvents
+                  .filter(e => e.event === "assigned" && e.assignee && e.assignee.login === assignee)
+                  .sort((x, y) => new Date(y.created_at) - new Date(x.created_at));
+
+                if (assignedEvents.length === 0) {
+                  core.info(`  - @${assignee}: no 'assigned' event found; skipping.`);
+                  continue;
+                }
+
+                const assignedAt = new Date(assignedEvents[0].created_at);
+                const ageMin = (now - assignedAt) / 60000;
+
+                // Has the assignee commented (issue or review comments) or reviewed?
+                const hasIssueComment = issueComments.some(c => c.user?.login === assignee);
+                const hasReviewComment = reviewComments.some(c => c.user?.login === assignee);
+                const hasReview = reviews.some(r => r.user?.login === assignee);
+
+                const eligible =
+                  ageMin >= MAX_MIN &&
+                  !hasIssueComment &&
+                  !hasReviewComment &&
+                  !hasReview &&
+                  pr.state === "open";
+
+                core.info(`  - @${assignee}: assigned ${ageMin.toFixed(1)} min ago; commented=${hasIssueComment || hasReviewComment}; reviewed=${hasReview}; open=${pr.state==='open'} => ${eligible ? 'ELIGIBLE' : 'skip'}`);
+
+                if (!eligible) continue;
+
+                if (DRY_RUN) {
+                  core.notice(`Would unassign @${assignee} from PR #${number}`);
+                } else {
+                  try {
+                    await github.rest.issues.removeAssignees({
+                      owner, repo, issue_number: number, assignees: [assignee]
+                    });
+                    totalUnassigned += 1;
+                    // Optional: leave a gentle heads-up comment
+                    await github.rest.issues.createComment({
+                      owner, repo, issue_number: number,
+                      body: `👋 Unassigning @${assignee} due to inactivity (> ${MAX_MIN} min without comments/reviews). This PR remains open for other reviewers.`
+                    });
+                    core.info(`    Unassigned @${assignee} from #${number}`);
+                  } catch (err) {
+                    core.warning(`    Failed to unassign @${assignee} from #${number}: ${err.message}`);
+                  }
+                }
+              }
+            }
+
+            core.summary
+              .addHeading('Auto-unassign report')
+              .addRaw(`Threshold: ${MAX_MIN} minutes\n\n`)
+              .addRaw(`Total unassignments: ${totalUnassigned}\n`)
+              .write();
+
+          result-encoding: string

CONTRIBUTING.md

@@ -31,10 +31,25 @@ If you plan to submit another pull request while your original is still pending,
 - **Descriptive Pull Request Titles**: Your pull request must have explicit and descriptive titles that accurately represent the changes made.
 - **Scope Adherence**: Changes that fall outside the described scope will result in the entire pull request being rejected.
 - **Quality Over Quantity**: Low-effort or spam pull requests will be marked accordingly.
-- **Expanded Snippets**: Code snippets reused from the [ServiceNow Documentation](https://docs.servicenow.com/) or [API References](https://developer.servicenow.com/dev.do#!/reference/) are acceptable only if they are expanded in a meaningful way (e.g., with additional context, documentation, or variations). Remember: *“QUANTITY IS FUN, QUALITY IS KEY.”*
+- **Expanded Snippets**: Code snippets reused from the [ServiceNow Documentation](https://docs.servicenow.com/) or [API References](https://developer.servicenow.com/dev.do#!/reference/) are acceptable only if they are expanded in a meaningful way (e.g., with additional context, documentation, or variations). Remember: *"QUANTITY IS FUN, QUALITY IS KEY."*
 - **Relevance**: Code should be relevant to ServiceNow Developers.
 - **ES2021 Compatibility**: While ES2021 is allowed, we encourage you to disclose if your code is using ES2021 features, as not everyone may be working with ES2021-enabled applications.
 
+## Core Documentation File Changes
+
+**IMPORTANT**: For changes to core documentation files (README.md, CONTRIBUTING.md, LICENSE, etc.), contributors must:
+
+1. **Submit an Issue First**: Before making any changes to core documentation files, create an issue describing:
+   - What you intend to edit
+   - Why the change is needed
+   - Your proposed approach
+
+2. **Get Assignment**: Wait to be assigned to the issue by a maintainer before submitting a PR.
+
+3. **Reference the Issue**: Include the issue number in your PR title and description.
+
+This process helps prevent merge conflicts when multiple contributors want to update the same documentation files and ensures all changes align with the project's direction.
+
 ## Repository Structure
 
 **IMPORTANT**: The repository has been reorganized into major categories. All new contributions MUST follow this structure for PR approval.

Client-Side Components/Catalog Client Script/Auto-populate field from URL/README.md

@@ -0,0 +1,17 @@
+This piece of code is designed for an usecase where you might want to populate a field value that you're passing as a query in the URL which redirects to a catalog item.
+In this case, a custom field 'u_date' is chosen as an example to be shown:
+
+1. You open a catalog item record via a URL that carries a date in the query string.
+Example:
+https://your-instance.service-now.com/your_form.do?sysparm_u_date=2025-10-31
+-(This URL includes a parameter named sysparm_u_date with the value 2025-10-31.)
+
+
+2. The catalog client script reads the page URL and extracts that specific parameter which returns the value "2025-10-31".
+
+3. If the parameter is present, the script populates the form field.
+Calling g_form.setValue('u_date', '2025-10-31') sets the date field on the form to 31 October 2025.
+
+
+Result:
+The date field in the form is prefilled from the URL

Client-Side Components/Catalog Client Script/Auto-populate field from URL/popdatefromurl.js

@@ -0,0 +1,8 @@
+//Logic to fetch the u_date field value passed in the url and setting it in the actual field.
+
+
+var fetchUrl = top.location.href; //get the URL
+
+var setDate = new URLSearchParams(gUrl).get("sysparm_u_date");  //fetch the value of date from the query parameter
+
+g_form.setValue('u_date', setDate);   //set the value to the actual field

Client-Side Components/Catalog Client Script/Clear all fields/README.md

@@ -1,13 +1,18 @@
 # Clear all fields on a catalog item form
 
-This works on both the native platform and service portal / mobile. Typically used with an OnChange catalog client script when you would like to reset all the fields after a certain variable is changed.
+This function clears all editable fields on a form, except those explicitly excluded.  
+It works on both the native platform (Classic UI) and Service Portal / Mobile.  
+Typically used with an OnChange catalog client script when you want to clear all fields after a certain variable changes.
 
-This function does support an exclusion list if there are fields you would like to exclude from being reset, typically you would want to add the field that triggered to the change to the exlusion
+The function returns an array of the field names that were cleared, which can be used for logging or further processing.
 
-### Example
+### Exclusion Support
 
-```js
-clearFields(['field1', 'field2']);
-```
+You can pass an array of field names to exclude from being cleared.  
+This is useful when you want to preserve the value of the field that triggered the change or other important fields.
 
-All fields on the form **except** field1 and field2 will be cleared.
+### Example
+```
+clearFields(['short_description', 'priority']);
+```
+// Clears all fields except 'short_description' and 'priority'

Client-Side Components/Catalog Client Script/Clear all fields/script.js

@@ -1,26 +1,47 @@
-/**SNDOC
-    @name clearFields
-    @description Clear/reset all fields on a form
-    @param  {Array} [dontClearFieldsArray] - Fields to not clear
-    @example
-    clearFields(['field1', 'field2']);
-*/
+/**
+ * Clears or resets all editable fields on a form, except those explicitly excluded.
+ * Compatible with Classic UI and Service Portal/Mobile.
+ * Intended for use in onChange client scripts.
+ *
+ * @function clearFields
+ * @param {Array} dontClearFieldsArray - Array of field names to exclude from clearing.
+ * @returns {Array} - Array of field names that were cleared.
+ *
+ * @example
+ * // Clears all fields except 'short_description' and 'priority'
+ * clearFields(['short_description', 'priority']);
+ */
+function clearFields(dontClearFieldsArray) {
+    // Ensure the exclusion list is defined and is an array
+    dontClearFieldsArray = Array.isArray(dontClearFieldsArray) ? dontClearFieldsArray : [];
 
-function clearFields(dontClearFieldsArray){
+    // Helper function to check if a field should be cleared
+    function shouldClear(fieldName) {
+        return dontClearFieldsArray.indexOf(fieldName) === -1;
+    }
 
-	try{ // Classic UI
-		var pFields = g_form.nameMap;
-		pFields.forEach(function(field){
-			if(dontClearFieldsArray.indexOf(field.prettyName) == -1){
-				g_form.clearValue(field.prettyName);
-			}
-		});
-	}catch(e){ // Service Portal or Mobile
-		var fields = g_form.getEditableFields();
-		fields.forEach(function(field){
-			if(dontClearFieldsArray.indexOf(fields) == -1){
-				g_form.clearValue(field);
-			}
-		});
-	}
-}
+    var clearedFields = [];
+
+    try {
+        // Classic UI: use g_form.nameMap to get all fields
+        var allFields = g_form.nameMap;
+        allFields.forEach(function(field) {
+            var fieldName = field.prettyName;
+            if (shouldClear(fieldName)) {
+                g_form.clearValue(fieldName);
+                clearedFields.push(fieldName);
+            }
+        });
+    } catch (e) {
+        // Service Portal or Mobile: use getEditableFields()
+        var editableFields = g_form.getEditableFields();
+        editableFields.forEach(function(fieldName) {
+            if (shouldClear(fieldName)) {
+                g_form.clearValue(fieldName);
+                clearedFields.push(fieldName);
+            }
+        });
+    }
+
+    return clearedFields;
+}

Client-Side Components/Catalog Client Script/MRVS dependent ref qual 1st row/AccountUtils.js

@@ -0,0 +1,19 @@
+var AccountUtils = Class.create();
+AccountUtils.prototype = Object.extendsObject(AbstractAjaxProcessor, {
+
+    //Populate the department name from the account in the session data for the reference qualifier to use:
+    
+    setSessionData: function() {
+        var acct = this.getParameter('sysparm_account');
+		    var dept = '';
+		    var acctGR = new GlideRecord('customer_account'); //reference table for Account variable
+		    if (acctGR.get(acct)) {
+			      dept = '^dept_name=' + acctGR.dept_name; //department field name on account table
+		    }
+		
+		    var session = gs.getSession().putClientData('selected_dept', dept);
+        return;
+    },
+
+    type: 'AccountUtils'
+});

Client-Side Components/Catalog Client Script/MRVS dependent ref qual 1st row/README.md

@@ -0,0 +1,6 @@
+This Catalog Client Script and Script Include are used with a reference qualifier similar to
+javascript: 'disable=false' + session.getClientData('selected_dept');
+
+The scenario is a MRVS with a reference variable to the customer account table.  When an (active) account is selected in the first row, subsequent rows should only be able to select active accounts in the same department as the first account.
+
+The Catalog Client Script will pass the first selected account (if there is one) to a Script Include each time a MRVS row is added or edited.  The Script Include will pass the department name to the reference qualifier.

Client-Side Components/Catalog Client Script/MRVS dependent ref qual 1st row/onLoad.js

@@ -0,0 +1,17 @@
+function onLoad() {
+    //applies to MRVS, not Catalog Item. This will pass the first selected account (if there is one) to a Script Include each time a MRVS row is added or edited
+    var mrvs = g_service_catalog.parent.getValue('my_mrvs'); //MRVS internal name
+	var acct = '';
+	if (mrvs.length > 2) { //MRVS is not empty
+		var obj = JSON.parse(mrvs);
+       	acct = obj[0].account_mrvs;
+	}
+	var ga = new GlideAjax('AccountUtils');
+    ga.addParam('sysparm_name', 'setSessionData');
+    ga.addParam('sysparm_account', acct);
+    ga.getXMLAnswer(getResponse);
+}
+
+function getResponse(response) { 
+    //do nothing 
+}