[ { "path": ".github/pull_request_template.md", "content": "# PR Description: \nreplace this with your description\n\n# Pull Request Checklist\n\n## Overview\n- [x] Put an x inside of the square brackets to check each item.\n- [ ] I have read and understood the [CONTRIBUTING.md](CONTRIBUTING.md) guidelines\n- [ ] My pull request has a descriptive title that accurately reflects the changes and the description has been filled in above.\n- [ ] I've included only files relevant to the changes described in the PR title and description\n- [ ] I've created a new branch in my forked repository for this contribution\n\n## Code Quality\n- [ ] My code is relevant to ServiceNow developers\n- [ ] My code snippets expand meaningfully on official ServiceNow documentation (if applicable)\n- [ ] I've disclosed use of ES2021 features (if applicable)\n- [ ] I've tested my code snippets in a ServiceNow environment (where possible)\n\n## Repository Structure Compliance\n- [ ] I've placed my code snippet(s) in one of the required top-level categories:\n - `Core ServiceNow APIs/`\n - `Server-Side Components/`\n - `Client-Side Components/`\n - `Modern Development/`\n - `Integration/`\n - `Specialized Areas/`\n- [ ] I've used appropriate sub-categories within the top-level categories\n- [ ] Each code snippet has its own folder with a descriptive name\n\n## Documentation\n- [ ] I've included a README.md file for each code snippet\n- [ ] The README.md includes:\n - Description of the code snippet functionality\n - Usage instructions or examples\n - Any prerequisites or dependencies\n - (Optional) Screenshots or diagrams if helpful\n\n## Restrictions\n- [ ] My PR does not include XML exports of ServiceNow records\n- [ ] My PR does not contain sensitive information (passwords, API keys, tokens)\n- [ ] My PR does not include changes that fall outside the described scope\n" }, { "path": ".github/scripts/validate-structure.js", "content": "#!/usr/bin/env node\n\nconst { execSync } = require('child_process');\n\nconst allowedCategories = new Set([\n 'Core ServiceNow APIs',\n 'Server-Side Components',\n 'Client-Side Components',\n 'Modern Development',\n 'Integration',\n 'Specialized Areas'\n]);\n\nfunction resolveDiffRange() {\n if (process.argv[2]) {\n return process.argv[2];\n }\n\n const inCI = process.env.GITHUB_ACTIONS === 'true';\n if (!inCI) {\n return 'origin/main...HEAD';\n }\n\n const base = process.env.GITHUB_BASE_REF ? `origin/${process.env.GITHUB_BASE_REF}` : 'origin/main';\n const head = process.env.GITHUB_SHA || 'HEAD';\n return `${base}...${head}`;\n}\n\nfunction getChangedFiles(diffRange) {\n let output;\n try {\n output = execSync(`git diff --name-only --diff-filter=ACMR ${diffRange}`, {\n encoding: 'utf8',\n stdio: ['ignore', 'pipe', 'pipe']\n });\n } catch (error) {\n console.error('Failed to collect changed files. Ensure the base branch is fetched.');\n console.error(error.stderr?.toString() || error.message);\n process.exit(1);\n }\n\n return output\n .split('\\n')\n .map((line) => line.trim())\n .filter(Boolean);\n}\n\nfunction validateFilePath(filePath) {\n const normalized = filePath.replace(/\\\\/g, '/');\n const segments = normalized.split('/');\n\n // Check for invalid characters that break local file systems\n for (let i = 0; i < segments.length; i++) {\n const segment = segments[i];\n\n // Check for trailing periods (invalid on Windows)\n if (segment.endsWith('.')) {\n return `Invalid folder/file name '${segment}' in path '${normalized}': Names cannot end with a period (.) as this breaks local file system sync on Windows.`;\n }\n\n // Check for trailing spaces (invalid on Windows)\n if (segment.endsWith(' ')) {\n return `Invalid folder/file name '${segment}' in path '${normalized}': Names cannot end with a space as this breaks local file system sync on Windows.`;\n }\n\n // Check for reserved Windows names\n const reservedNames = ['CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9'];\n const nameWithoutExt = segment.split('.')[0].toUpperCase();\n if (reservedNames.includes(nameWithoutExt)) {\n return `Invalid folder/file name '${segment}' in path '${normalized}': '${nameWithoutExt}' is a reserved name on Windows and will break local file system sync.`;\n }\n\n // Check for invalid characters (Windows and general file system restrictions)\n const invalidChars = /[<>:\"|?*\\x00-\\x1F]/;\n if (invalidChars.test(segment)) {\n return `Invalid folder/file name '${segment}' in path '${normalized}': Contains characters that are invalid on Windows file systems (< > : \" | ? * or control characters).`;\n }\n }\n\n if (!allowedCategories.has(segments[0])) {\n return null;\n }\n\n // Files must live under: Category/Subcategory/SpecificUseCase/\n if (segments.length < 4) {\n return `Move '${normalized}' under a valid folder hierarchy (Category/Subcategory/Use-Case/your-file). Files directly inside '${segments[0]}' or its subcategories are not allowed.`;\n }\n\n return null;\n}\n\nfunction main() {\n const diffRange = resolveDiffRange();\n const changedFiles = getChangedFiles(diffRange);\n\n if (changedFiles.length === 0) {\n console.log('No relevant file changes detected.');\n return;\n }\n\n const problems = [];\n\n for (const filePath of changedFiles) {\n const issue = validateFilePath(filePath);\n if (issue) {\n problems.push(issue);\n }\n }\n\n if (problems.length > 0) {\n console.error('Folder structure violations found:');\n for (const msg of problems) {\n console.error(` - ${msg}`);\n }\n process.exit(1);\n }\n\n console.log('Folder structure looks good.');\n}\n\nmain();\n" }, { "path": ".github/workflows/hacktrack.yml", "content": "#This file is for ServiceNow Dev Program Hacktoberfest Tracking and can be ignored or deleted.\n\nname: Record Hacktrack Event\non:\n push:\n branches: main\n fork:\n branches: main\n issues:\n types: [opened, closed]\n branches: main\n pull_request_target:\n types: [opened, closed]\n branches: main\njobs:\n deployment:\n if: github.repository == 'ServiceNowDevProgram/code-snippets'\n runs-on: ubuntu-latest\n steps:\n# - name: Log payload\n# env:\n# GITHUB_CONTEXT: ${{ toJson(github) }}\n# run: |\n# echo \"$GITHUB_CONTEXT\"\n - name: Contact DPR\n id: myRequest\n uses: fjogeleit/http-request-action@v1.8.1\n with:\n url: ${{ format('https://{0}.service-now.com/api/x_snc_hacktrack/hacktrack', secrets.HT_INSTANCE_NAME) }}\n method: 'POST'\n contentType: application/json\n data: ${{ toJson(github) }}\n username: ${{ secrets.DPRD_USERNAME }}\n password: ${{ secrets.DPRD_PASSWORD }}\n - name: Show Response\n run: echo ${{ steps.myRequest.outputs.response }}\n" }, { "path": ".github/workflows/pages.yml", "content": "# GitHub Pages deployment workflow\nname: Deploy GitHub Pages\n\non:\n workflow_dispatch:\n\n# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages\npermissions:\n contents: read\n pages: write\n id-token: write\n\n# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.\n# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.\nconcurrency:\n group: pages-${{ github.ref }}\n cancel-in-progress: true\n\njobs:\n # Build and optimize job\n build:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n\n - name: Setup Node.js\n uses: actions/setup-node@v4\n with:\n node-version: '18'\n cache: 'npm'\n\n - name: Install build dependencies\n run: |\n npm init -y\n npm install --save-dev html-minifier-terser clean-css-cli terser html-validate\n\n - name: Validate HTML files\n run: |\n echo \"Validating HTML files...\"\n npx html-validate *.html pages/*.html || echo \"HTML validation completed with warnings\"\n\n - name: Optimize assets\n run: |\n echo \"Optimizing HTML files...\"\n # Create backup directory\n mkdir -p .backup\n \n # Minify HTML files (preserve original structure)\n find . -name \"*.html\" -not -path \"./node_modules/*\" -not -path \"./.backup/*\" | while read file; do\n echo \"Minifying: $file\"\n npx html-minifier-terser \\\n --collapse-whitespace \\\n --remove-comments \\\n --remove-optional-tags \\\n --remove-redundant-attributes \\\n --remove-script-type-attributes \\\n --remove-style-link-type-attributes \\\n --minify-css \\\n --minify-js \\\n \"$file\" -o \"$file.tmp\" && mv \"$file.tmp\" \"$file\"\n done\n \n # Minify CSS files if any exist\n if find . -name \"*.css\" -not -path \"./node_modules/*\" -not -path \"./.backup/*\" | grep -q .; then\n echo \"Optimizing CSS files...\"\n find . -name \"*.css\" -not -path \"./node_modules/*\" -not -path \"./.backup/*\" | while read file; do\n echo \"Minifying: $file\"\n npx cleancss \"$file\" -o \"$file\"\n done\n fi\n \n # Remove build dependencies from final artifact\n rm -rf node_modules package*.json\n\n - name: Setup Pages\n id: pages\n uses: actions/configure-pages@v4\n\n - name: Upload artifact\n uses: actions/upload-pages-artifact@v3\n with:\n path: '.'\n\n # Deployment job\n deploy:\n environment:\n name: github-pages\n url: ${{ steps.deployment.outputs.page_url }}\n runs-on: ubuntu-latest\n needs: build\n steps:\n - name: Deploy to GitHub Pages\n id: deployment\n uses: actions/deploy-pages@v4" }, { "path": ".github/workflows/pr-auto-unassign-stale.yml", "content": "name: Auto-unassign stale PR assignees\n\non:\n schedule:\n - cron: \"*/15 * * * *\" # run every 15 minutes\n workflow_dispatch:\n inputs:\n enabled:\n description: \"Enable this automation\"\n type: boolean\n default: true\n max_age_minutes:\n description: \"Unassign if assigned longer than X minutes\"\n type: number\n default: 60\n dry_run:\n description: \"Preview only; do not change assignees\"\n type: boolean\n default: false\n\npermissions:\n pull-requests: write\n issues: write\n\nenv:\n # Defaults (can be overridden via workflow_dispatch inputs)\n ENABLED: \"true\"\n MAX_ASSIGN_AGE_MINUTES: \"60\"\n DRY_RUN: \"false\"\n\njobs:\n sweep:\n runs-on: ubuntu-latest\n steps:\n - name: Resolve inputs into env\n run: |\n # Prefer manual run inputs when present\n if [ \"${{ github.event_name }}\" = \"workflow_dispatch\" ]; then\n echo \"ENABLED=${{ inputs.enabled }}\" >> $GITHUB_ENV\n echo \"MAX_ASSIGN_AGE_MINUTES=${{ inputs.max_age_minutes }}\" >> $GITHUB_ENV\n echo \"DRY_RUN=${{ inputs.dry_run }}\" >> $GITHUB_ENV\n fi\n echo \"Effective config: ENABLED=$ENABLED, MAX_ASSIGN_AGE_MINUTES=$MAX_ASSIGN_AGE_MINUTES, DRY_RUN=$DRY_RUN\"\n\n - name: Exit if disabled\n if: ${{ env.ENABLED != 'true' && env.ENABLED != 'True' && env.ENABLED != 'TRUE' }}\n run: echo \"Disabled via ENABLED=$ENABLED. Exiting.\" && exit 0\n\n - name: Unassign stale assignees\n uses: actions/github-script@v7\n with:\n script: |\n const owner = context.repo.owner;\n const repo = context.repo.repo;\n\n const MAX_MIN = parseInt(process.env.MAX_ASSIGN_AGE_MINUTES || \"60\", 10);\n const DRY_RUN = [\"true\",\"True\",\"TRUE\",\"1\",\"yes\"].includes(String(process.env.DRY_RUN));\n const now = new Date();\n\n core.info(`Scanning open PRs. Threshold = ${MAX_MIN} minutes. DRY_RUN=${DRY_RUN}`);\n\n // List all open PRs\n const prs = await github.paginate(github.rest.pulls.list, {\n owner, repo, state: \"open\", per_page: 100\n });\n\n let totalUnassigned = 0;\n\n for (const pr of prs) {\n if (!pr.assignees || pr.assignees.length === 0) continue;\n\n const number = pr.number;\n core.info(`PR #${number}: \"${pr.title}\" — assignees: ${pr.assignees.map(a => a.login).join(\", \")}`);\n\n // Pull reviews (to see if an assignee started a review)\n const reviews = await github.paginate(github.rest.pulls.listReviews, {\n owner, repo, pull_number: number, per_page: 100\n });\n\n // Issue comments (general comments)\n const issueComments = await github.paginate(github.rest.issues.listComments, {\n owner, repo, issue_number: number, per_page: 100\n });\n\n // Review comments (file-level)\n const reviewComments = await github.paginate(github.rest.pulls.listReviewComments, {\n owner, repo, pull_number: number, per_page: 100\n });\n\n // Issue events (to find assignment timestamps)\n const issueEvents = await github.paginate(github.rest.issues.listEvents, {\n owner, repo, issue_number: number, per_page: 100\n });\n\n for (const a of pr.assignees) {\n const assignee = a.login;\n\n // Find the most recent \"assigned\" event for this assignee\n const assignedEvents = issueEvents\n .filter(e => e.event === \"assigned\" && e.assignee && e.assignee.login === assignee)\n .sort((x, y) => new Date(y.created_at) - new Date(x.created_at));\n\n if (assignedEvents.length === 0) {\n core.info(` - @${assignee}: no 'assigned' event found; skipping.`);\n continue;\n }\n\n const assignedAt = new Date(assignedEvents[0].created_at);\n const ageMin = (now - assignedAt) / 60000;\n\n // Has the assignee commented (issue or review comments) or reviewed?\n const hasIssueComment = issueComments.some(c => c.user?.login === assignee);\n const hasReviewComment = reviewComments.some(c => c.user?.login === assignee);\n const hasReview = reviews.some(r => r.user?.login === assignee);\n\n const eligible =\n ageMin >= MAX_MIN &&\n !hasIssueComment &&\n !hasReviewComment &&\n !hasReview &&\n pr.state === \"open\";\n\n core.info(` - @${assignee}: assigned ${ageMin.toFixed(1)} min ago; commented=${hasIssueComment || hasReviewComment}; reviewed=${hasReview}; open=${pr.state==='open'} => ${eligible ? 'ELIGIBLE' : 'skip'}`);\n\n if (!eligible) continue;\n\n if (DRY_RUN) {\n core.notice(`Would unassign @${assignee} from PR #${number}`);\n } else {\n try {\n await github.rest.issues.removeAssignees({\n owner, repo, issue_number: number, assignees: [assignee]\n });\n totalUnassigned += 1;\n // Optional: leave a gentle heads-up comment\n await github.rest.issues.createComment({\n owner, repo, issue_number: number,\n body: `👋 Unassigning @${assignee} due to inactivity (> ${MAX_MIN} min without comments/reviews). This PR remains open for other reviewers.`\n });\n core.info(` Unassigned @${assignee} from #${number}`);\n } catch (err) {\n core.warning(` Failed to unassign @${assignee} from #${number}: ${err.message}`);\n }\n }\n }\n }\n\n core.summary\n .addHeading('Auto-unassign report')\n .addRaw(`Threshold: ${MAX_MIN} minutes\\n\\n`)\n .addRaw(`Total unassignments: ${totalUnassigned}\\n`)\n .write();\n\n result-encoding: string\n" }, { "path": ".github/workflows/validate-structure.yml", "content": "name: Validate Folder Structure\n\non:\n pull_request_target:\n branches:\n - main\n\npermissions:\n contents: read\n pull-requests: write\n\nconcurrency:\n group: folder-structure-${{ github.event.pull_request.number || github.run_id }}\n cancel-in-progress: true\n\njobs:\n structure:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout base repository\n uses: actions/checkout@v4\n with:\n fetch-depth: 0\n\n - name: Cache validation script\n run: cp .github/scripts/validate-structure.js \"$RUNNER_TEMP/validate-structure.js\"\n\n - name: Fetch pull request head\n id: fetch_head\n env:\n PR_REMOTE_URL: https://github.com/${{ github.event.pull_request.head.repo.full_name }}.git\n PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}\n run: |\n git remote remove pr >/dev/null 2>&1 || true\n git remote add pr \"$PR_REMOTE_URL\"\n if git fetch pr \"$PR_HEAD_REF\":pr-head --no-tags; then\n git checkout pr-head\n git fetch origin \"${{ github.event.pull_request.base.ref }}\"\n echo \"fetched=true\" >> \"$GITHUB_OUTPUT\"\n else\n echo \"::warning::Unable to fetch fork repository. Skipping structure validation.\"\n echo \"fetched=false\" >> \"$GITHUB_OUTPUT\"\n fi\n\n - name: Use Node.js 18\n uses: actions/setup-node@v4\n with:\n node-version: 18\n\n - name: Validate folder layout\n if: ${{ steps.fetch_head.outputs.fetched == 'true' }}\n id: validate\n run: |\n set -euo pipefail\n\n tmp_output=$(mktemp)\n tmp_error=$(mktemp)\n\n set +e\n node \"$RUNNER_TEMP/validate-structure.js\" origin/${{ github.event.pull_request.base.ref }}...HEAD >\"$tmp_output\" 2>\"$tmp_error\"\n status=$?\n set -e\n\n cat \"$tmp_output\"\n cat \"$tmp_error\" >&2\n\n if grep -q 'Folder structure violations found' \"$tmp_output\" \"$tmp_error\"; then\n # Save validation output for use in PR comment\n cat \"$tmp_output\" \"$tmp_error\" > \"$RUNNER_TEMP/validation_output.txt\"\n echo \"status=failed\" >> \"$GITHUB_OUTPUT\"\n exit 0\n fi\n\n if [ $status -ne 0 ]; then\n echo \"::warning::Structure validation skipped because the diff could not be evaluated (exit code $status).\"\n echo \"status=skipped\" >> \"$GITHUB_OUTPUT\"\n exit 0\n fi\n\n echo \"status=passed\" >> \"$GITHUB_OUTPUT\"\n\n - name: Close pull request on failure\n if: ${{ steps.validate.outputs.status == 'failed' }}\n uses: actions/github-script@v6\n with:\n github-token: ${{ github.token }}\n script: |\n const pullNumber = context.payload.pull_request.number;\n const owner = context.repo.owner;\n const repo = context.repo.repo;\n\n const fs = require('fs');\n const output = fs.readFileSync(process.env.RUNNER_TEMP + '/validation_output.txt', 'utf8');\n\n let commentBody = `Thank you for your contribution. However, it doesn't comply with our contributing guidelines.\\n\\n`;\n\n // Check if the error is about invalid file/folder names\n if (output.includes('Names cannot end with a period') ||\n output.includes('Names cannot end with a space') ||\n output.includes('is a reserved name on Windows') ||\n output.includes('Contains characters that are invalid')) {\n commentBody += `**❌ Invalid File/Folder Names Detected**\\n\\n`;\n commentBody += `Your contribution contains file or folder names that will break when syncing to local file systems (especially Windows):\\n\\n`;\n commentBody += `\\`\\`\\`\\n${output}\\n\\`\\`\\`\\n\\n`;\n commentBody += `**Common issues:**\\n`;\n commentBody += `- Folder/file names ending with a period (.) - not allowed on Windows\\n`;\n commentBody += `- Folder/file names ending with spaces - not allowed on Windows\\n`;\n commentBody += `- Reserved names like CON, PRN, AUX, NUL, COM1-9, LPT1-9 - not allowed on Windows\\n`;\n commentBody += `- Invalid characters: < > : \" | ? * or control characters\\n\\n`;\n commentBody += `Please rename these files/folders to be compatible with all operating systems.\\n\\n`;\n } else {\n 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`;\n commentBody += `**Validation errors:**\\n\\`\\`\\`\\n${output}\\n\\`\\`\\`\\n\\n`;\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.`;\n\n await github.rest.issues.createComment({\n owner,\n repo,\n issue_number: pullNumber,\n body: commentBody.trim()\n });\n\n await github.rest.pulls.update({\n owner,\n repo,\n pull_number: pullNumber,\n state: 'closed'\n });\n\n - name: Mark job as failed if validation failed\n if: ${{ steps.validate.outputs.status == 'failed' }}\n run: exit 1\n" }, { "path": ".gitignore", "content": ".DS_Store\r\n\r\n# Claude Code settings\r\n.claude/\r\nsettings.local.json\r\n" }, { "path": "AGENTS.md", "content": "# AGENTS.md\n\nThis file provides guidance to AI Coding Agents when working with code in this repository.\n\n## Repository Overview\n\nThis is the **ServiceNow Developer Program's Code Snippets Repository** - a community-driven collection of ServiceNow development code examples and utilities. The repository contains 900+ code snippets organized into 50+ categories covering all aspects of ServiceNow platform development.\n\n## Repository Structure and Organization\n\n### Directory Structure\nAll code snippets follow a standardized four-level structure:\n```\nTop-Level Category/\n├── Sub-Category/\n│ ├── Specific-Use-Case/\n│ │ ├── README.md # Description and usage instructions\n│ │ ├── script.js # Main code implementation\n│ │ └── variant.js # Optional code variations\n```\n\n### Top-Level Categories (REQUIRED Structure)\nThe repository is organized into **6 major categories**. All contributions MUST use these categories:\n\n- **Core ServiceNow APIs/**: Essential ServiceNow JavaScript APIs\n - `GlideRecord/`, `GlideAjax/`, `GlideSystem/`, `GlideDate/`, `GlideDateTime/`, `GlideElement/`, `GlideFilter/`, `GlideAggregate/`, `GlideHTTPRequest/`, `GlideModal/`, `GlideQuery/`, `GlideTableDescriptor/`\n\n- **Server-Side Components/**: Server-executed code\n - `Background Scripts/`, `Business Rules/`, `Script Includes/`, `Script Actions/`, `Scheduled Jobs/`, `Transform Map Scripts/`, `Server Side/`, `Inbound Actions/`, `Processors/`\n\n- **Client-Side Components/**: Browser-executed code\n - `Client Scripts/`, `Catalog Client Script/`, `UI Actions/`, `UI Scripts/`, `UI Pages/`, `UI Macros/`, `UX Client Scripts/`, `UX Client Script Include/`, `UX Data Broker Transform/`\n\n- **Modern Development/**: Modern ServiceNow frameworks\n - `Service Portal/`, `Service Portal Widgets/`, `NOW Experience/`, `GraphQL/`, `ECMASCript 2021/`\n\n- **Integration/**: External systems and data exchange\n - `Integration/` (original), `RESTMessageV2/`, `Import Set API/`, `Scripted REST Api/`, `Mail Scripts/`, `MIDServer/`, `Attachments/`\n\n- **Specialized Areas/**: Domain-specific functionality\n - `CMDB/`, `ITOM/`, `Performance Analytics/`, `ATF Steps/`, `Agile Development/`, `Advanced Conditions/`, `Browser Bookmarklets/`, `Browser Utilities/`, `Dynamic Filters/`, `Fix scripts/`, `Flow Actions/`, `Formula Builder/`, `Notifications/`, `On-Call Calendar/`, `Record Producer/`, `Regular Expressions/`, `Styles/`\n\n## Development Guidelines\n\n### Code Quality Standards\n- Each snippet must include comprehensive README.md documentation\n- Code should be relevant to ServiceNow developers\n- ES2021 features are allowed but should be clearly documented\n- Examples should expand meaningfully on official ServiceNow documentation\n- Quality over quantity - low-effort submissions are rejected\n\n### Contribution Requirements\n- **Mandatory Category Structure**: All contributions MUST use the 6 top-level categories. PRs with incorrect structure will be rejected.\n- **Descriptive Structure**: Changes must match pull request scope exactly\n- **No XML Exports**: Avoid ServiceNow record exports in favor of JavaScript code\n- **Documentation**: Every code snippet requires accompanying README.md\n- **Proper Categorization**: Place snippets in appropriate existing sub-categories within the required top-level structure\n\n### File Organization\n- Use descriptive folder names that clearly indicate functionality\n- Group related code variations in the same folder\n- Include screenshots or examples when helpful for understanding\n- Maintain consistent naming conventions across similar snippets\n\n## Common ServiceNow Development Patterns\n\n### GlideRecord Usage\n- Most snippets demonstrate proper GlideRecord query patterns\n- Security considerations with ACL enforcement examples\n- Performance optimization through proper query construction\n- Reference field handling and relationship traversal\n\n### Integration Patterns\n- REST API consumption and production examples\n- Authentication handling for external systems\n- Data transformation and mapping utilities\n- Error handling and logging best practices\n\n### Business Logic Implementation\n- Business Rules for event-driven processing\n- Background Scripts for administrative tasks\n- Client Scripts for form behavior and validation\n- UI Actions for custom user interactions\n\n## Testing and Validation\n\n### Code Verification\n- Test all code snippets in development environments before submission\n- Validate against multiple ServiceNow versions when possible\n- Consider security implications and access controls\n- Document any prerequisites or dependencies\n\n### Community Review Process\n- All contributions undergo peer review by Developer Advocates\n- Changes outside described scope result in rejection\n- Multiple submissions require separate branches in forked repositories\n\n## Security Considerations\n\n- Never include sensitive information (passwords, API keys, tokens)\n- Consider security implications of all code examples\n- Demonstrate proper access control patterns where applicable\n- Include warnings for potentially dangerous operations\n\n## Repository Maintenance\n\n### Branch Management\n- Main branch contains all approved code snippets\n- Use descriptive branch names for contributions\n- Create separate branches for different feature additions\n\n### File Management\n- No build processes or compilation required\n- Direct GitHub editing supported\n- Git-enabled IDEs like VS Code recommended for larger contributions\n- Standard .gitignore excludes only .DS_Store files\n\nThis repository serves as a comprehensive reference for ServiceNow developers at all skill levels, emphasizing practical, tested solutions for real-world development scenarios.\n" }, { "path": "CONTRIBUTING.md", "content": "# How to Contribute\r\n\r\nWe welcome contributions to the **ServiceNow Developer Program's Code Snippets Repository**! Follow these steps to get involved:\r\n\r\n## Steps to Contribute\r\n\r\n1. **Fork the Repository**: Click the \"Fork\" button on the top right of this page to create your own copy of the repository.\r\n\r\n2. **Create a New Branch**: \r\n - Name your branch according to the functionality you are adding (e.g., `feature/new-snippet` or `bugfix/fix-issue`).\r\n - Switch to your new branch from the main branch dropdown.\r\n\r\n3. **Add or Edit Code Snippets**:\r\n - Navigate to the appropriate folders and files to add, edit, or reorganize code snippets.\r\n - Commit your changes to your forked repository.\r\n\r\n4. **Submit a Pull Request**:\r\n - Go to the original repository and click on the \"Pull Requests\" tab.\r\n - Click \"New Pull Request\" and select your branch.\r\n - Ensure your pull request has a descriptive title and comment that outlines what changes you made.\r\n - Only include files relevant to the changes described in the pull request title and description.\r\n - Avoid submitting XML exports of ServiceNow records.\r\n\r\nThat's it! A Developer Advocate or a designated approver from the ServiceNow Dev Program will review your pull request. If approved, it will be merged into the main repository for everyone's benefit!\r\n\r\n### Note on Multiple Submissions\r\nIf you plan to submit another pull request while your original is still pending, make sure to create a new branch in your forked repository first.\r\n\r\n## General Requirements\r\n\r\n- **Descriptive Pull Request Titles**: Your pull request must have explicit and descriptive titles that accurately represent the changes made.\r\n- **Scope Adherence**: Changes that fall outside the described scope will result in the entire pull request being rejected.\r\n- **Quality Over Quantity**: Low-effort or spam pull requests will be marked accordingly.\r\n- **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.\"*\r\n- **Relevance**: Code should be relevant to ServiceNow Developers.\r\n- **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.\r\n\r\n## Core Documentation File Changes\r\n\r\n**IMPORTANT**: For changes to core documentation files (README.md, CONTRIBUTING.md, LICENSE, etc.), contributors must:\r\n\r\n1. **Submit an Issue First**: Before making any changes to core documentation files, create an issue describing:\r\n - What you intend to edit\r\n - Why the change is needed\r\n - Your proposed approach\r\n\r\n2. **Get Assignment**: Wait to be assigned to the issue by a maintainer before submitting a PR.\r\n\r\n3. **Reference the Issue**: Include the issue number in your PR title and description.\r\n\r\nThis 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.\r\n\r\n## Repository Structure\r\n\r\n**IMPORTANT**: The repository has been reorganized into major categories. All new contributions MUST follow this structure for PR approval.\r\n\r\nPlease follow this directory structure when organizing your code snippets:\r\n\r\n- **Top-Level Categories**: These are fixed categories that represent major areas of ServiceNow development:\r\n - `Core ServiceNow APIs/` - GlideRecord, GlideAjax, GlideSystem, GlideDate, etc.\r\n - `Server-Side Components/` - Background Scripts, Business Rules, Script Includes, etc.\r\n - `Client-Side Components/` - Client Scripts, Catalog Client Scripts, UI Actions, etc.\r\n - `Modern Development/` - Service Portal, NOW Experience, GraphQL, ECMAScript 2021\r\n - `Integration/` - RESTMessageV2, Import Sets, Mail Scripts, MIDServer, etc.\r\n - `Specialized Areas/` - CMDB, ITOM, Performance Analytics, ATF Steps, etc.\r\n\r\n- **Sub-Categories**: Each top-level category contains sub-folders for specific ServiceNow technologies or use cases.\r\n- **Snippet Folders**: Each sub-category contains folders for **each code snippet**.\r\n- **Snippet Folder Contents**: Within each snippet folder, include:\r\n - A `README.md` file that describes the code snippet.\r\n - Individual files for each variant of the code snippet.\r\n\r\n### New Structure Example\r\n\r\n```\r\nCore ServiceNow APIs/\r\n ├── GlideRecord/\r\n │ ├── Query Performance Optimization/\r\n │ │ ├── README.md # Description of the optimization snippet\r\n │ │ ├── basic_query.js # Basic query example\r\n │ │ └── optimized_query.js # Performance-optimized version\r\n │ └── Reference Field Handling/\r\n │ ├── README.md # Description of reference handling\r\n │ └── reference_query.js # Reference field query example\r\n └── GlideAjax/\r\n ├── Async Data Loading/\r\n │ ├── README.md # Description of async loading\r\n │ ├── client_script.js # Client-side implementation\r\n │ └── script_include.js # Server-side Script Include\r\nServer-Side Components/\r\n ├── Business Rules/\r\n │ ├── Auto Assignment Logic/\r\n │ │ ├── README.md # Description of auto assignment\r\n │ │ └── assignment_rule.js # Business rule implementation\r\n```\r\n\r\n### Category Placement Guidelines\r\n\r\n- **Core ServiceNow APIs**: All Glide* APIs and core ServiceNow JavaScript APIs\r\n- **Server-Side Components**: Code that runs on the server (Business Rules, Background Scripts, etc.)\r\n- **Client-Side Components**: Code that runs in the browser (Client Scripts, UI Actions, etc.)\r\n- **Modern Development**: Modern ServiceNow development approaches and frameworks\r\n- **Integration**: External system integrations, data import/export, and communication\r\n- **Specialized Areas**: Domain-specific functionality (CMDB, ITOM, Testing, etc.)\r\n\r\n## Final Checklist\r\n\r\nBefore submitting your pull request, ensure that:\r\n- All code snippet files are in the appropriate folders.\r\n- Each folder is correctly placed within its category.\r\n- Your code snippet is accompanied by a `readme.md` file that describes it.\r\n\r\nThank you for contributing! Your efforts help create a richer resource for the ServiceNow development community.\r\n" }, { "path": "Client-Side Components/Catalog Client Script/Add Label For Attachment/README.md", "content": "Code Snippet to add a label to the attachment for a Catalog Item on the Portal." }, { "path": "Client-Side Components/Catalog Client Script/Add Label For Attachment/add_label_for_attachment.js", "content": "function onLoad() {\n var attachmentElement = top.document.querySelectorAll('[ng-if=\"c.showAttachments()\"]');\n \n\tif (attachmentElement[0]) {\n\t\tvar label = top.document.createElement('label');\n\t\tlabel.innerHTML = 'LABEL COMES HERE';\n\t\tattachmentElement[0].prepend(label);\n\t}\n}" }, { "path": "Client-Side Components/Catalog Client Script/Add Rows in MRVS/README.md", "content": "With this simple script you can through a client script add rows in the MRVS if you like. Ex. you want to prefill a few rows that you get from a GlideAjax call depending on what the user choosed in another variable\n" }, { "path": "Client-Side Components/Catalog Client Script/Add Rows in MRVS/addrows.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n\tif (isLoading)\n\t\treturn;\n\n\tvar obj = (g_form.getValue('multi_test').length != 0) ? JSON.parse(g_form.getValue('multi_test')): [];//Get the MRVS\n\n //Push in what you want\n\tobj.push({var_one: 'test1',\n\t\t\t var_two: 'test2'});\n\tg_form.setValue('multi_test', JSON.stringify(obj));//And set the value again\n\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Auto Save Draft Feature/README.md", "content": "# Auto Save Draft Feature for Catalog Items\r\n\r\nThis snippet provides automatic draft saving functionality for ServiceNow Catalog Items, helping prevent data loss by automatically saving form data at regular intervals.\r\n\r\n## Overview\r\n\r\nThe feature includes two implementations:\r\n1. Basic Implementation (`basic_implementation.js`)\r\n2. Advanced Implementation (`advanced_implementation.js`)\r\n\r\n## Basic Implementation\r\n\r\n### Features\r\n- Auto-saves form data every minute\r\n- Stores single draft in sessionStorage\r\n- Provides draft restoration on form load\r\n- Basic error handling and user feedback\r\n\r\n### Usage\r\n```javascript\r\n// Apply in Catalog Client Script\r\n// Select \"onLoad\" for \"Client script runs\"\r\n// Copy content from basic_implementation.js\r\n```\r\n\r\n## Advanced Implementation\r\n\r\n### Enhanced Features\r\n- Multiple draft support (keeps last 3 drafts)\r\n- Advanced draft management\r\n- Draft selection dialog\r\n- Detailed metadata tracking\r\n- Improved error handling\r\n- User-friendly notifications\r\n\r\n### Usage\r\n```javascript\r\n// Apply in Catalog Client Script\r\n// Select \"onLoad\" for \"Client script runs\"\r\n// Copy content from advanced_implementation.js\r\n```\r\n\r\n## Technical Details\r\n\r\n### Dependencies\r\n- ServiceNow Platform UI Framework\r\n- GlideForm API\r\n- GlideModal (advanced implementation only)\r\n\r\n### Browser Support\r\n- Modern browsers with sessionStorage support\r\n- ES5+ compatible\r\n\r\n### Security Considerations\r\n- Uses browser's sessionStorage (cleared on session end)\r\n- No sensitive data transmission\r\n- Instance-specific storage\r\n\r\n## Implementation Guide\r\n\r\n1. Create a new Catalog Client Script:\r\n - Table: Catalog Client Script [catalog_script_client]\r\n - Type: onLoad\r\n - Active: true\r\n\r\n2. Choose implementation:\r\n - For basic needs: Copy `basic_implementation.js`\r\n - For advanced features: Copy `advanced_implementation.js`\r\n\r\n3. Apply to desired Catalog Items:\r\n - Select applicable Catalog Items\r\n - Test in dev environment first\r\n\r\n## Best Practices\r\n\r\n1. Testing:\r\n - Test with various form states\r\n - Verify draft restoration\r\n - Check browser storage limits\r\n\r\n2. Performance:\r\n - Default 60-second interval is recommended\r\n - Adjust based on form complexity\r\n - Monitor browser memory usage\r\n\r\n3. User Experience:\r\n - Clear feedback messages\r\n - Confirmation dialogs\r\n - Error notifications\r\n\r\n## Limitations\r\n\r\n- Browser session dependent\r\n- Storage size limits\r\n- Form field compatibility varies\r\n\r\n## Troubleshooting\r\n\r\nCommon issues and solutions:\r\n1. Draft not saving\r\n - Check browser console for errors\r\n - Verify sessionStorage availability\r\n - Check form modification detection\r\n\r\n2. Restoration fails\r\n - Validate stored data format\r\n - Check browser storage permissions\r\n - Verify form field compatibility\r\n\r\n## Version Information\r\n\r\n- Compatible with ServiceNow: Rome and later\r\n- Browser Requirements: Modern browsers with ES5+ support\r\n- Last Updated: October 2025" }, { "path": "Client-Side Components/Catalog Client Script/Auto Save Draft Feature/advanced_implementation.js", "content": "/**\r\n * Advanced Auto-save Draft Implementation with Enhanced Features\r\n * This version adds multi-draft support and advanced error handling\r\n */\r\n\r\nfunction onLoad() {\r\n var autosaveInterval = 60000; // 1 minute\r\n var maxDrafts = 3; // Maximum number of drafts to keep\r\n \r\n // Initialize draft manager\r\n initializeDraftManager();\r\n \r\n // Try to restore previous draft\r\n restoreLastDraft();\r\n \r\n // Set up auto-save interval\r\n setInterval(function() {\r\n if (g_form.isModified()) {\r\n saveAdvancedDraft();\r\n }\r\n }, autosaveInterval);\r\n}\r\n\r\nfunction initializeDraftManager() {\r\n window.draftManager = {\r\n maxDrafts: 3,\r\n draftPrefix: 'catalogDraft_' + g_form.getUniqueValue() + '_',\r\n \r\n getAllDrafts: function() {\r\n var drafts = [];\r\n for (var i = 0; i < sessionStorage.length; i++) {\r\n var key = sessionStorage.key(i);\r\n if (key.startsWith(this.draftPrefix)) {\r\n drafts.push({\r\n key: key,\r\n data: JSON.parse(sessionStorage.getItem(key))\r\n });\r\n }\r\n }\r\n return drafts.sort((a, b) => b.data.timestamp - a.data.timestamp);\r\n },\r\n \r\n cleanup: function() {\r\n var drafts = this.getAllDrafts();\r\n if (drafts.length > this.maxDrafts) {\r\n drafts.slice(this.maxDrafts).forEach(function(draft) {\r\n sessionStorage.removeItem(draft.key);\r\n });\r\n }\r\n }\r\n };\r\n}\r\n\r\nfunction saveAdvancedDraft() {\r\n try {\r\n var draftData = {};\r\n g_form.serialize(draftData);\r\n \r\n // Add metadata\r\n var draftKey = window.draftManager.draftPrefix + new Date().getTime();\r\n var draftInfo = {\r\n timestamp: new Date().getTime(),\r\n data: draftData,\r\n user: g_user.userName,\r\n catalog_item: g_form.getTableName(),\r\n fields_modified: g_form.getModifiedFields()\r\n };\r\n \r\n sessionStorage.setItem(draftKey, JSON.stringify(draftInfo));\r\n window.draftManager.cleanup();\r\n \r\n // Show success message with draft count\r\n var remainingDrafts = window.draftManager.getAllDrafts().length;\r\n g_form.addInfoMessage('Draft saved. You have ' + remainingDrafts + ' saved draft(s).');\r\n \r\n } catch (e) {\r\n console.error('Error saving draft: ' + e);\r\n g_form.addErrorMessage('Failed to save draft: ' + e.message);\r\n }\r\n}\r\n\r\nfunction restoreLastDraft() {\r\n try {\r\n var drafts = window.draftManager.getAllDrafts();\r\n \r\n if (drafts.length > 0) {\r\n // If multiple drafts exist, show selection dialog\r\n if (drafts.length > 1) {\r\n showDraftSelectionDialog(drafts);\r\n } else {\r\n promptToRestoreDraft(drafts[0].data);\r\n }\r\n }\r\n } catch (e) {\r\n console.error('Error restoring draft: ' + e);\r\n g_form.addErrorMessage('Failed to restore draft: ' + e.message);\r\n }\r\n}\r\n\r\nfunction showDraftSelectionDialog(drafts) {\r\n var dialog = new GlideModal('select_draft_dialog');\r\n dialog.setTitle('Available Drafts');\r\n \r\n var html = '
';\r\n drafts.forEach(function(draft, index) {\r\n var date = new Date(draft.data.timestamp).toLocaleString();\r\n html += '
';\r\n html += 'Draft ' + (index + 1) + ' - ' + date;\r\n html += '
Modified fields: ' + draft.data.fields_modified.join(', ');\r\n html += '
';\r\n });\r\n html += '
';\r\n \r\n dialog.renderWithContent(html);\r\n}\r\n\r\nfunction promptToRestoreDraft(draftInfo) {\r\n var timestamp = new Date(draftInfo.timestamp);\r\n if (confirm('A draft from ' + timestamp.toLocaleString() + ' was found. Would you like to restore it?')) {\r\n Object.keys(draftInfo.data).forEach(function(field) {\r\n g_form.setValue(field, draftInfo.data[field]);\r\n });\r\n g_form.addInfoMessage('Draft restored from ' + timestamp.toLocaleString());\r\n }\r\n}" }, { "path": "Client-Side Components/Catalog Client Script/Auto Save Draft Feature/basic_implementation.js", "content": "/**\r\n * Basic Auto-save Draft Implementation\r\n * This version provides core functionality for auto-saving catalog item form data\r\n */\r\n\r\nfunction onLoad() {\r\n var autosaveInterval = 60000; // 1 minute\r\n \r\n // Try to restore previous draft\r\n restoreLastDraft();\r\n \r\n // Set up auto-save interval\r\n setInterval(function() {\r\n if (g_form.isModified()) {\r\n saveDraft();\r\n }\r\n }, autosaveInterval);\r\n}\r\n\r\nfunction saveDraft() {\r\n try {\r\n var draftData = {};\r\n g_form.serialize(draftData);\r\n \r\n var draftKey = 'catalogDraft_' + g_form.getUniqueValue();\r\n sessionStorage.setItem(draftKey, JSON.stringify({\r\n timestamp: new Date().getTime(),\r\n data: draftData\r\n }));\r\n \r\n g_form.addInfoMessage('Draft saved automatically');\r\n } catch (e) {\r\n console.error('Error saving draft: ' + e);\r\n }\r\n}\r\n\r\nfunction restoreLastDraft() {\r\n try {\r\n var draftKey = 'catalogDraft_' + g_form.getUniqueValue();\r\n var savedDraft = sessionStorage.getItem(draftKey);\r\n \r\n if (savedDraft) {\r\n var draftData = JSON.parse(savedDraft);\r\n var timestamp = new Date(draftData.timestamp);\r\n \r\n if (confirm('A draft from ' + timestamp.toLocaleString() + ' was found. Would you like to restore it?')) {\r\n Object.keys(draftData.data).forEach(function(field) {\r\n g_form.setValue(field, draftData.data[field]);\r\n });\r\n g_form.addInfoMessage('Draft restored from ' + timestamp.toLocaleString());\r\n } else {\r\n sessionStorage.removeItem(draftKey);\r\n }\r\n }\r\n } catch (e) {\r\n console.error('Error restoring draft: ' + e);\r\n }\r\n}" }, { "path": "Client-Side Components/Catalog Client Script/Auto Save Draft Feature/script.js", "content": "/**\r\n * Auto-save draft feature for Catalog Client Script\r\n * \r\n * This script automatically saves form data as a draft in the browser's sessionStorage\r\n * every minute if changes are detected. It also provides functionality to restore\r\n * the last saved draft when the form is loaded.\r\n */\r\n\r\n// Executes when the form loads\r\nfunction onLoad() {\r\n var autosaveInterval = 60000; // 1 minute\r\n \r\n // Try to restore previous draft\r\n restoreLastDraft();\r\n \r\n // Set up auto-save interval\r\n setInterval(function() {\r\n if (g_form.isModified()) {\r\n saveDraft();\r\n }\r\n }, autosaveInterval);\r\n}\r\n\r\n// Saves the current form state as a draft\r\nfunction saveDraft() {\r\n try {\r\n var draftData = {};\r\n g_form.serialize(draftData);\r\n \r\n var draftKey = 'catalogDraft_' + g_form.getUniqueValue();\r\n sessionStorage.setItem(draftKey, JSON.stringify({\r\n timestamp: new Date().getTime(),\r\n data: draftData\r\n }));\r\n \r\n g_form.addInfoMessage('Draft saved automatically');\r\n } catch (e) {\r\n console.error('Error saving draft: ' + e);\r\n }\r\n}\r\n\r\n// Restores the last saved draft if available\r\nfunction restoreLastDraft() {\r\n try {\r\n var draftKey = 'catalogDraft_' + g_form.getUniqueValue();\r\n var savedDraft = sessionStorage.getItem(draftKey);\r\n \r\n if (savedDraft) {\r\n var draftData = JSON.parse(savedDraft);\r\n var timestamp = new Date(draftData.timestamp);\r\n \r\n // Ask user if they want to restore the draft\r\n if (confirm('A draft from ' + timestamp.toLocaleString() + ' was found. Would you like to restore it?')) {\r\n Object.keys(draftData.data).forEach(function(field) {\r\n g_form.setValue(field, draftData.data[field]);\r\n });\r\n g_form.addInfoMessage('Draft restored from ' + timestamp.toLocaleString());\r\n } else {\r\n // Clear the draft if user chooses not to restore\r\n sessionStorage.removeItem(draftKey);\r\n }\r\n }\r\n } catch (e) {\r\n console.error('Error restoring draft: ' + e);\r\n }\r\n}" }, { "path": "Client-Side Components/Catalog Client Script/Auto-populate field from URL/README.md", "content": "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.\nIn this case, a custom field 'u_date' is chosen as an example to be shown:\n\n1. You open a catalog item record via a URL that carries a date in the query string.\nExample:\nhttps://your-instance.service-now.com/your_form.do?sysparm_u_date=2025-10-31\n-(This URL includes a parameter named sysparm_u_date with the value 2025-10-31.)\n\n\n2. The catalog client script reads the page URL and extracts that specific parameter which returns the value \"2025-10-31\".\n\n3. If the parameter is present, the script populates the form field.\nCalling g_form.setValue('u_date', '2025-10-31') sets the date field on the form to 31 October 2025.\n\n\nResult:\nThe date field in the form is prefilled from the URL\n" }, { "path": "Client-Side Components/Catalog Client Script/Auto-populate field from URL/popdatefromurl.js", "content": "//Logic to fetch the u_date field value passed in the url and setting it in the actual field.\n\n\nvar fetchUrl = top.location.href; //get the URL\n\nvar setDate = new URLSearchParams(gUrl).get(\"sysparm_u_date\"); //fetch the value of date from the query parameter\n\ng_form.setValue('u_date', setDate); //set the value to the actual field\n" }, { "path": "Client-Side Components/Catalog Client Script/Autofilling the request details from previous request/Auto fill script include.JS", "content": "var GetRecentRequestValues = Class.create();\nGetRecentRequestValues.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n getValues: function() {\n var userID = this.getParameter('sysparm_user');\n var itemID = this.getParameter('sysparm_item');\n var result = { found: false, values: {} };\n\n var gr = new GlideRecord('sc_req_item');\n gr.addQuery('requested_for', userID);\n gr.addQuery('cat_item', itemID);\n gr.orderByDesc('sys_created_on');\n gr.setLimit(1);\n gr.query();\n\n if (gr.next()) {\n result.found = true;\n\n \n var vars = gr.variables;\n result.values = {\n 'requested_for': vars.requested_for + '',\n 'location': vars.location + '',\n 'department': vars.department + ''\n };\n }\n\n return JSON.stringify(result);\n }\n});\n\n" }, { "path": "Client-Side Components/Catalog Client Script/Autofilling the request details from previous request/Client script Autofill.js", "content": "function onLoad() {\n var user = g_user.userID;\n var itemID = g_form.getUniqueValue();\n\n var ga = new GlideAjax('GetRecentRequestValues');\n ga.addParam('sysparm_name', 'getValues');\n ga.addParam('sysparm_user', user);\n ga.addParam('sysparm_item', itemID);\n ga.getXMLAnswer(function(response) {\n var data = JSON.parse(response);\n if (data && data.found) {\n var confirmFill = confirm(\"We found a similar request. Do you want to autofill fields?\");\n if (confirmFill) {\n for (var field in data.values) {\n if (g_form.getControl(field)) {\n g_form.setValue(field, data.values[field]);\n console.log(\"Set \" + field + \" to \" + data.values[field]);\n } else {\n console.log(\"Field not found: \" + field);\n }\n }\n }\n } else {\n console.log(\"No previous request found.\");\n }\n });\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Autofilling the request details from previous request/Readme.md", "content": "Recent Request Autofill for ServiceNow Catalog.it automatically offers to fill in fields based on the user's most recent similar request.\n Features\n- Detects previous requests for the same catalog item\n- Prompts user to reuse values from their last submission\n- Autofills fields like location, department, and justification\n\n\"image\"\n\n\n\n" }, { "path": "Client-Side Components/Catalog Client Script/Autopopulate Department/README.md", "content": "# Autopopulate Department Catalog Client Script\n\nUse this onChange catalog client script to populate a **department** variable in a catalog item based on a modifiable **requested_for**. Both variables must be reference type pointing to their respective tables.\n\n## Use case\n\nThe GlideUser API (g_user) does not provide a way to retrieve a user's department in a client-side script. Here is a small snippet using `g_form.getReference()` to retrieve the user from the **requested_for** variable and populate the **department** variable in a catalog item while allowing the submitter to still change the department if the data is incorrect.\n\nAttach this client script to a variable set for easy reuse. It can be augmented with a number of other fields from the user record such as email, phone number, manager, etc. Just be mindful of field types and whether the desired field will return a sys_id or display text.\n" }, { "path": "Client-Side Components/Catalog Client Script/Autopopulate Department/autopopulateDepartment.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n g_form.getReference(\"requested_for\", function (gr) {\n g_form.setValue(\"department\", gr.department);\n g_form.setValue(\"email\", gr.email);\n g_form.setValue(\"phone\", gr.phone);\n });\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Autopopulate user information fields/ClientCallableScriptInclude.js", "content": "/*\n* The following is a client callable script include. This can be used with the onChange Client script to be able to gather the data on the server side\n*/\n\nvar ReferenceQualifierAjaxHelper = Class.create();\nReferenceQualifierAjaxHelper.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n getUserInformation : function() {\n var userID = this.getParameter('sysparm_user');\n var userRec = new GlideRecord('sys_user');\n\n if(userRec.get(userID)) {\n var results = {\n \"email\" : userRec.getValue('email'),\n \"department\" : userRec.getValue('department'),\n \"title\" : userRec.getValue('title'),\n \"phone\" : userRec.getValue('phone')\n };\n\n return JSON.stringify(results)\n }\n\n },\n \n type: 'ReferenceQualifierAjaxHelper'\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/Autopopulate user information fields/README.md", "content": "## Overview\nThis onchange catalog client script and script inlcude work together autopopulate the user fields that might show up on a catalog item. In the \nglobal scope you will have to create the client callable script include to be able to use the Ajax call that is in the on change client script.\nIn this example we use the OOB Requested For field that already auto populates the user that is logged in then we go to the server to get that \nusers information. The fields that are brough back are the ones that are in the code but you can modify to bring back more or less fields if needed.\n\n" }, { "path": "Client-Side Components/Catalog Client Script/Autopopulate user information fields/onChangeClientScript.js", "content": "/*\n* In order for this to work make sure to have an onChange catalog client script on a variable that is type Requested For. This variable\n* already autopopulates the logged in user with its OOB functionality. In the updateUserFields function you can add any other user fields\n* that you might need. \n*/\n\nfunction onChange(control, oldValue, newValue, isLoading) {\n //This variable will store the sys_id of the user that populates in your requested for variable\n var userID = newValue;\n\n var ga = new GlideAjax(ReferenceQualifierAjaxHelper);\n ga.addParam('sysparm_name', 'getUserInformation');\n ga.addParam('sysparm_user', userID);\n ga.getXMLAnswer(updateUserFields);\n\n function updateUserFields(response) {\n var returnedData = JSON.parse(response);\n g_form.setValue(\"email\", returnedData.email);\n g_form.setValue(\"department\", returnedData.department);\n g_form.setValue(\"title\", returnedData.title);\n g_form.setValue(\"phone\", returnedData.phone);\n }\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Block Submit/README.md", "content": "Code Snippet to block submission of catalog item based on answer to other yes/no variable.\n\n#update\nTo fix a task from issue #745\nReplace JavaScript alert() method to GlideModal() API.\n\n" }, { "path": "Client-Side Components/Catalog Client Script/Block Submit/block_submit.js", "content": "//Block the user from submitting the form based on variable answer\nfunction onSubmit() {\n var someVariable = g_form.getValue(\"someVariable\");\n if(someVariable == 'No'){\n\tvar gm = new GlideModal('glide_warn',false);\n gm.setTitle(\"Submit Blocked! You can only use this form for someReason. Review someInstructions\");\n gm.render();\n \treturn false; // this stops user from submitting the form\n }\n return true; // allow form submit\n}\n\n" }, { "path": "Client-Side Components/Catalog Client Script/Calculate age on based on date of birth/Calculate age based on dob.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || newValue == '') {\n return;\n }\n \n function calculateAge(dateOfBirth) {\n if (!dateOfBirth || isNaN(Date.parse(dateOfBirth))) {\n alert('Invalid date of birth provided.');\n return;\n }\n var dob = new Date(dateOfBirth);\n var currentDate = new Date();\n var age = calculateAgeDifference(dob, currentDate);\n var ageString = '';\n \n if (age.years > 0) {\n ageString += age.years + ' years';\n if (age.months > 0 || age.days > 0) {\n ageString += ', ';\n }\n }\n \n if (age.months > 0) {\n ageString += age.months + ' months';\n if (age.days > 0) {\n ageString += ', ';\n }\n }\n \n if (age.days > 0) {\n ageString += age.days + ' days';\n }\n return ageString;\n }\n \n function calculateAgeDifference(startDate, endDate) {\n var years = endDate.getFullYear() - startDate.getFullYear();\n var months = endDate.getMonth() - startDate.getMonth();\n var days = endDate.getDate() - startDate.getDate();\n \n if (days < 0) {\n months--;\n days += new Date(endDate.getFullYear(), endDate.getMonth(), 0).getDate();\n }\n \n if (months < 0) {\n years--;\n months += 12;\n }\n \n return { years: years, months: months, days: days };\n }\n \n var dateOfBirth = newValue;\n var age = calculateAge(dateOfBirth);\n g_form.setValue('age', age);\n }" }, { "path": "Client-Side Components/Catalog Client Script/Calculate age on based on date of birth/README.md", "content": "# Age Calculator - On Change Client Script\n\nThis script is designed to calculate a person's age based on their date of birth.\n\n## Functions\n\n- `calculateAge(dateOfBirth)`: Calculates the age in years, months, and days based on the provided date of birth.\n- `calculateAgeDifference(startDate, endDate)`: Computes the difference in years, months, and days between two dates.\n\n## Sample Input and Output\n\n![age_calculator](image.png)" }, { "path": "Client-Side Components/Catalog Client Script/Catalog Approval/Readme.md", "content": "This project adds a dynamic preview feature to Service Catalog items, allowing users to see the full approval chain before submitting a request. It improves transparency, reduces confusion, and helps users understand who will be involved in the approval process based on their selections.\n" }, { "path": "Client-Side Components/Catalog Client Script/Catalog Approval/client script.js", "content": "function onLoad() {\n var ga = new GlideAjax('ApprovalChainHelper');\n ga.addParam('sysparm_name', 'getApprovers');\n ga.addParam('sysparm_item_id', g_form.getUniqueValue());\n ga.getXMLAnswer(function(response) {\n var approvers = JSON.parse(response);\n var message = 'This request will be approved by: ' + approvers.join(', ');\n g_form.showFieldMsg('requested_for', message, 'info');\n });\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Catalog Approval/script include.js", "content": "var ApprovalChainHelper = Class.create();\nApprovalChainHelper.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n getApprovers: function() {\n var itemId = this.getParameter('sysparm_item_id');\n var userId = gs.getUserID();\n\n var approvers = [];\n\n // Example logic: fetch approval rules based on item and user\n var ruleGR = new GlideRecord('sysapproval_approver');\n ruleGR.addQuery('document_id', 80f8920bc3e4b2105219daec050131e3);\n ruleGR.query();\n\n while (ruleGR.next()) {\n approvers.push(ruleGR.approver.name.toString());\n }\n\n return JSON.stringify(approvers);\n }\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/Clear all fields/README.md", "content": "# Clear all fields on a catalog item form\n\nThis function clears all editable fields on a form, except those explicitly excluded. \nIt works on both the native platform (Classic UI) and Service Portal / Mobile. \nTypically used with an OnChange catalog client script when you want to clear all fields after a certain variable changes.\n\nThe function returns an array of the field names that were cleared, which can be used for logging or further processing.\n\n### Exclusion Support\n\nYou can pass an array of field names to exclude from being cleared. \nThis is useful when you want to preserve the value of the field that triggered the change or other important fields.\n\n### Example\n```\nclearFields(['short_description', 'priority']);\n```\n// Clears all fields except 'short_description' and 'priority'\n" }, { "path": "Client-Side Components/Catalog Client Script/Clear all fields/script.js", "content": "/**\n * Clears or resets all editable fields on a form, except those explicitly excluded.\n * Compatible with Classic UI and Service Portal/Mobile.\n * Intended for use in onChange client scripts.\n *\n * @function clearFields\n * @param {Array} dontClearFieldsArray - Array of field names to exclude from clearing.\n * @returns {Array} - Array of field names that were cleared.\n *\n * @example\n * // Clears all fields except 'short_description' and 'priority'\n * clearFields(['short_description', 'priority']);\n */\nfunction clearFields(dontClearFieldsArray) {\n // Ensure the exclusion list is defined and is an array\n dontClearFieldsArray = Array.isArray(dontClearFieldsArray) ? dontClearFieldsArray : [];\n\n // Helper function to check if a field should be cleared\n function shouldClear(fieldName) {\n return dontClearFieldsArray.indexOf(fieldName) === -1;\n }\n\n var clearedFields = [];\n\n try {\n // Classic UI: use g_form.nameMap to get all fields\n var allFields = g_form.nameMap;\n allFields.forEach(function(field) {\n var fieldName = field.prettyName;\n if (shouldClear(fieldName)) {\n g_form.clearValue(fieldName);\n clearedFields.push(fieldName);\n }\n });\n } catch (e) {\n // Service Portal or Mobile: use getEditableFields()\n var editableFields = g_form.getEditableFields();\n editableFields.forEach(function(fieldName) {\n if (shouldClear(fieldName)) {\n g_form.clearValue(fieldName);\n clearedFields.push(fieldName);\n }\n });\n }\n\n return clearedFields;\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Combine variables into Description/README.md", "content": "OnSUbmit Catalog Client script is created to Combine all variable values required and display in Description field.\nSteps:\n1. Navigate to your instance open catalog client script table [catalog_script_client]\n2. Create new catalog client script -> click new\n3. Provide following values:\n - Name: Any relevant to your script\n - Applies to: A catalog Item\n - UI Type: All\n - Isolated script: checked\n - Application: Application scope applies to\n - Type: onSubmit\n - Catalog item: select your catalog item\n 4. create the script as per script.js file. \n" }, { "path": "Client-Side Components/Catalog Client Script/Combine variables into Description/script.js", "content": "// Combine variables into Description\n// Type: onSubmit\n\nfunction onSubmit()\n{\n \n // Combine provided all fields to Description field\n \n var description = g_form.getValue ('description');\n var first = g_form.getDisplayValue ('first_variable');\n var second = g_form.getDisplayValue ('second_variable');\n var third = g_form.getDisplayValue ('third_variable');\n \n g_form.setValue('description', ''+ description + '\\n\\nType: ' + first + '\\n Text: ' + second + '\\nText: ' + third);\n return true;\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Control all RITM variables in one go/README.md", "content": "# Control all RITM variables in one go\n\nRequirement : We need to make all the variables on the RITM (sc_req_item) form read only or editable\n\nProblem : If there are so many variables then it becomes difficult to write multiple UI policies or writing multiple lines of code in catalog client script for each variable seperately.\n\nSolution : With the above code snippet you can control(make read-only or editable) all the variables in the RITM form with very minimal code)\n" }, { "path": "Client-Side Components/Catalog Client Script/Control all RITM variables in one go/script.js", "content": "function onLoad()\n{\n \n g_form.setVariablesReadOnly(true); //if you want to make all variables read-only\n \n g_form.setVariablesReadOnly(false); //if you want to make all variables editable\n \n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Currency Validation/README.md", "content": "## Currency Validation \n\nUse this catalog client script to validate the value of a variable used to get currency. As of now 3 things are being checked in the script but you can make changes as per requirement.\n\n1) Characters after the $ sign should be numerics.\n2) Entered value should have a decimal point.\n3) There must be 2 digits only after the decimal.\n" }, { "path": "Client-Side Components/Catalog Client Script/Currency Validation/currency_validation.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || newValue == '') {\n return;\n }\n\n var cost = g_form.getValue('variable_name'); //update variable name used for currency\n cost = cost.trim();\n // first character should be dollar sign\n var firstChar = cost.substring(0, 1);\n if (firstChar != '$') {\n validationAlert(oldValue);\n }\n\n // characters after the $ sign should be numerics\n var costType = isNaN(cost.substring(1));\n if (costType == true) {\n validationAlert(oldValue);\n }\n\n // entered value should have a decimal point\n var num = cost.substring(1);\n if (num.indexOf('.') == -1) {\n validationAlert(oldValue);\n }\n\n // there must be 2 digits only after the decimal\n var decNum = num.substring(num.indexOf('.') + 1, num.length);\n if (decNum.length != 2) {\n validationAlert(oldValue);\n }\n}\n\nfunction validationAlert(oldValue) {\n g_form.setValue(\"variable_name\", oldValue);\n var gm = new GlideModal(\"glide_warn\");\n gm.setTitle(\"Currency formatting problem\");\n gm.setPreference(\"title\", \"Please enter cost in $0.00 format\");\n gm.render();\n return;\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/CustomAlert/README.md", "content": "These scripts helps you to create custom popup easily. follow the below steps to implement it on your instance.\n\nSteps\n1. Create UI page with name \"custom_alert_box\"\n2. Copy HTML section from customn_alert_box.js to HTML field of UI Page\n3. Copy Client Script section from customn_alert_box.js to Client Script field of UI Page\n4. UI Page is ready to be used.\n5. Refer the \"custom_alert.js\" to create client script or catalog client script to alert HTML messages or links in custom alert format.\n6. Refer the screenshots folder for quick look.\n" }, { "path": "Client-Side Components/Catalog Client Script/CustomAlert/Screenshots/README.md", "content": "Please see the example Screenshots\n" }, { "path": "Client-Side Components/Catalog Client Script/CustomAlert/custom_alert.js", "content": "function onLoad() {\n // Function to show a custom link in a GlideModal\n function showCustomLinkInGlideModal() {\n // Create an instance of GlideModal using the 'custom_alert_box' UI page\n // The second parameter 'true' indicates that the modal should be a dialog,\n // and '600' sets the width of the modal to 600 pixels.\n var gm = new GlideModal(\"custom_alert_box\", true, 600);\n\n // Set the modal's title to anything you want\n gm.setTitle('Important Information'); //for e.g. Important Information\n \n // Set a preference for the modal indicating the type of alert\n // This can be used to style the modal or control its behavior.\n // available choices {info, danger, warning, success}\n gm.setPreference('alertType', 'danger');\n\n // Custom HTML content to be displayed in the modal\n // This includes a paragraph and a link to an external website.\n var htmlContent = '

Please visit the following link:

' +\n 'Click here to go to Example.com';\n\n // Set the HTML content of the modal using the 'infoText' preference.\n // We disable escaping since we're providing our own HTML.\n gm.setPreference('infoText', htmlContent);\n\n // Render the modal on the screen\n gm.render();\n }\n\n // Call the function to display the modal when the form loads\n showCustomLinkInGlideModal();\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/CustomAlert/custom_alert_box.js", "content": "*****************HTML Section Start*****************\n\n\n \n var infoText = \"${RP.getWindowProperties().get('infoText')}\";\n infoText = new GlideStringUtil().unEscapeHTML(infoText);\n var warning = \"${RP.getWindowProperties().get('warning')}\";\n warning = new GlideStringUtil().unEscapeHTML(warning);\n var alertType = \"${RP.getWindowProperties().get('alertType')}\";\n \n \n \n \n\t\n \n \n\t\n \n \n \n \n \n \n
\n \n \n \n \n \n \n \n
\n \n
\n
\n\n*****************HTML Section End*****************\n\n*****************Client Script Start*****************\nfunction unescapeHTML(html) {\n var textarea = document.createElement('textarea');\n textarea.innerHTML = html; // Set the HTML content\n return textarea.value; // Return the unescaped text\n}\n\nvar infoText = \"${RP.getWindowProperties().get('infoText')}\";\ninfoText = unescapeHTML(infoText); // Unescape the HTML\n\n// Now set the title to your dialog or display it\ndocument.getElementById('bodycell').innerHTML = infoText; // Assuming there's a titleCell in your HTML\n\nfunction invokePromptCallBack() {\n var gdw = GlideDialogWindow.get();\n gdw.destroy();\n return false;\n}\n\nvar gdw = GlideDialogWindow.get();\ngel('ok_button').focus();\n*****************Client Script Start*****************\n" }, { "path": "Client-Side Components/Catalog Client Script/Date Management/Date Management.js", "content": "//Various useful ways to interact with dates on the client without needing to make a trip to the server\n\n\n//Use the following to take a date / date time variable and turn it to a JS Date value\n/*newValue = date(/time) variable value, i.e from an onChange script\n/*getDateFromFormat = This is a ServiceNow provided function loaded into the browser\n/*g_user_date_format = a variable loaded into the browser on session load that stores the users date format\n*/\nvar date = new Date(getDateFromFormat(newValue, g_user_date_format));\n\n\n//Validate a value is a date\n//This is a function loaded into the browser by ServiceNow\n//i.e isDate(newValue , g_user_date_format);\n//Returns a Boolean\n\nvar checkDate = isDate(value , format);\n\n\n//Compare two dates\n//This is a function loaded into the browser by ServiceNow\n//i.e compareDates(\"29-10-2021\" , \"dd-MM-yyyy\" , \"20-10-2021\" , \"dd-MM-yyyy\");\n//Returns -1 if either date value is not a valid date\n//Returns 1 if date1 is greater than date2\n//Returns 0 otherwise\n\nvar isSecondDateLarger = compareDates(\"29-10-2021\" , \"dd-MM-yyyy\" , \"20-10-2021\" , \"dd-MM-yyyy\");\n\n\n//Format a date value to the user session format to save in a variable/field\n\nvar date = formatDate(date,format);\n\n/*Exampe of the above in use*/\nvar dateNumber = getDateFromFormat(newValue , g_user_date_format);\nvar date = new Date(dateNumber);\ndate.setDate(date.getDate() - 1);\ng_form.setValue('date' , formatDate(date , g_user_date_format));\n" }, { "path": "Client-Side Components/Catalog Client Script/Date Management/README.md", "content": "#### Useful ways to interact with variable date/time values without needing to make a trip to the server\n\nThe following functions and variables are defined by ServiceNow and loaded at run-time. They are accessible from within the client script without the need to turn off script isolation.\n\n- g_user_date_format\n- g_user_date_time_format\n- isDate()\n- compareDates()\n- formatDate()\n- getDateFromFormat()\n" }, { "path": "Client-Side Components/Catalog Client Script/Document validation/Client script.JS", "content": "function onSubmit() {\n var ga = new GlideAjax('DocumentValidationHelper');\n ga.addParam('sysparm_name', 'validateAttachments');\n ga.addParam('sysparm_item_id', g_form.getUniqueValue());\n ga.getXMLAnswer(function(response) {\n if (response !== 'valid') {\n alert('Document validation failed: ' + response);\n return false;\n }\n });\n return true;\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Document validation/Readme.md", "content": "This project enhances a Service Catalog item by allowing users to upload supporting documents (e.g., ID proof, approval letters) and validating them before the request is submitted. It ensures compliance, completeness, and proper documentation for sensitive or regulated requests.\n" }, { "path": "Client-Side Components/Catalog Client Script/Document validation/Script include.js", "content": "var DocumentValidationHelper = Class.create();\nDocumentValidationHelper.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n validateAttachments: function() {\n var itemId = this.getParameter('sysparm_item_id');\n var attachmentGR = new GlideRecord('sys_attachment');\n attachmentGR.addQuery('table_name', 'sc_req_item');\n attachmentGR.addQuery('table_sys_id', itemId);\n attachmentGR.query();\n\n while (attachmentGR.next()) {\n var fileName = attachmentGR.file_name.toLowerCase();\n if (!fileName.endsWith('.pdf') && !fileName.endsWith('.docx')) {\n return 'Only PDF or DOCX files are allowed.';\n }\n if (attachmentGR.size_bytes > 5 * 1024 * 1024) {\n return 'File size exceeds 5MB limit.';\n }\n }\n\n return 'valid';\n }\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/Dynamically Update Reference Qualifier/Catalog Item onLoad.js", "content": "function onLoad() {\n\tvar filterString = 'sys_class_name=cmdb_ci_ip_router^ORsys_class_name=cmdb_ci_ip_switch^ORsys_class_name=cmdb_ci_vpn' //Reference qualifier for this Catalog Item\n\t//alternate method for Service Portal only\n\t// if (window == null){ //Service Portal method\n\t// \tvar setfilter = g_list.get('v_configuration_item');\n\t// \tsetfilter.setQuery(filterString);\n\t// } else { //native UI method\n\t\tvar ga = new GlideAjax('refQualUtils'); //Client callable Script Include Name\n\t\tga.addParam('sysparm_name', 'setSysProp'); //Function in Script Include\n\t\tga.addParam('sysparm_sys_prop_name', 'sr.ref_qual.ci'); //System Property Name used in Reference qualifier \n\t\tga.addParam('sysparm_sys_prop_value', filterString);\n\t\tga.getXML(getResponse);\n\t\t\t\n\t\tfunction getResponse(response) { //to avoid Service Portal 'There is a JavaScript error in your browser console'\n\t\t\tvar answer = response.responseXML.documentElement.getAttribute(\"answer\"); \n\t\t}\n\t//}\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Dynamically Update Reference Qualifier/README.md", "content": "When we have a reference variable that is used in a (single row) variable set, sometimes we want to update the Reference qualifier only for specific Catalog Item(s).\n\nIn this example, I have a Configuration item (named v_configuration_item) reference variable (cmdb_ci table) in a single row variable set that has been included in a number of Catalog Items. The simple Reference qualifier for this variable is:\nsys_class_name=cmdb_ci_ip_router^ORsys_class_name=cmdb_ci_ip_switch\n\nLet's say for one particular Catalog Item, I also want to include the class of VPN (cmdb_ci_vpn).\n\nTo do this without having to create another variable with the new qualifier and hiding the variable set variable, there are some preparation steps, including those which ensure that the other Catalog Items using the variable set are not disrupted:\n\n1) Change the advanced reference qualifier on the variable to: **javascript: gs.getProperty(\"sr.ref_qual.ci\");**\nusing a System Property Name of your choice\n\n2) Create a System Property with the same Name used in the Reference qualifier, leaving the Value empty.\n\n3) Add the included 'Variable Set onLoad' Catalog Client Script that applies to the Variable set with...\n\n4) The included Client Callable Script Include to update the System Property Value to the Reference Qualifier that was replaced. This Script Include uses parameters for the System Property Name and Value, so it can be re-used in every instance of this solution.\n\nNow that the other Catalog Items using the variable set are still working as they were, all you need to do to update the Reference qualifier on certain Catalog Item(s) is:\n\n5) Add the included 'Catalog Item onLoad' Catalog Client Script that applies to the Catalog Item. Set the Order of this script to a high number (10,000) so that it runs after the variable set one.\n\nThis solution works in both the Native UI and Service Portal. The Catalog Client scripts contain an alternate Service Portal only approach in the commented if block that can be used in conjunction with the native UI approach in the else block. This alternate Service Portal solution was developed in collaboration with Chris Perry.\n" }, { "path": "Client-Side Components/Catalog Client Script/Dynamically Update Reference Qualifier/Script Include.js", "content": "var refQualUtils = Class.create();\nrefQualUtils.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n \n \tsetSysProp: function(){\n\t\tvar propertyName = this.getParameter('sysparm_sys_prop_name');\n\t\tvar propertyValue = this.getParameter('sysparm_sys_prop_value');\n\t\tvar property = gs.getProperty(propertyName);\n\t\tgs.setProperty(propertyName, propertyValue);\n\t\treturn;\n\t},\n\t\t\n type: 'refQualUtils'\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/Dynamically Update Reference Qualifier/Variable Set onLoad.js", "content": "function onLoad() {\n\tvar filterString = 'sys_class_name=cmdb_ci_ip_router^ORsys_class_name=cmdb_ci_ip_switch' //Reference qualifier that was replaced\n\t//alternate method for Service Portal only\n\t// if (window == null){ //Service Portal method\n\t// \tvar setfilter = g_list.get('v_configuration_item');\n\t// \tsetfilter.setQuery(filterString);\n\t// } else { //native UI method\n\t\tvar ga = new GlideAjax('refQualUtils'); //Client callable Script Include Name\n\t\tga.addParam('sysparm_name', 'setSysProp'); //Function in Script Include\n\t\tga.addParam('sysparm_sys_prop_name', 'sr.ref_qual.ci'); //System Property Name used in Reference qualifier \n\t\tga.addParam('sysparm_sys_prop_value', filterString);\n\t\tga.getXML(getResponse);\n\t\t\t\n\t\tfunction getResponse(response) { //to avoid Service Portal 'There is a JavaScript error in your browser console'\n\t\t\tvar answer = response.responseXML.documentElement.getAttribute(\"answer\"); \n\t\t}\n\t//}\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Get Display Value of MRVS/README.md", "content": "## Get Display Value of MultiRow Variableset (MRVS)\n\nWhile there are different ways to do this, the easiest of them is to leverage an out of box script named **'VariableUtil'**. \n\nThe script is present in the global scope and contains an function named getDisplayValue aptly. This function seems to work on both the normal variable as well as multirow variableset. You just need to pass the sysid of the variable or the multirow variableset and its corresponding value.\n\n**new VariableUtil().getDisplayValue('sys_id of variable or MRVS','value of variable/MRVS');**\n" }, { "path": "Client-Side Components/Catalog Client Script/Get Display Value of MRVS/mrvs.js", "content": "\nvar script = new global.VariableUtil();\nvar gr = new GlideRecord(\"sc_req_item\");\ngr.addEncodedQuery(\"sys_id=\");\ngr.query();\nif (gr.next()) {\n gs.info(script.getDisplayValue('', gr.variables.MRVSName)); //MRVS Display Value\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Get MRVS Values from Parent/README.md", "content": "# Get Multi-row Variable Set Values from parent form\n\nSometimes you need to query the current set of values for a MRVS from the actual MRVS or another MRVS. \nThis requires getting the data from the parent form, the method to retrieve and the format of the data is different\nwhen running on the platform or portal.\n\nThis script gives a way of getting the values regardless of the platform in use.\n\nOn the platform (backend) this could be moved to a global UI Script, but that is not available to portal scripts.\n\nMake sure the UI Type is All, and Isolate Script is false (unchecked).\n" }, { "path": "Client-Side Components/Catalog Client Script/Get MRVS Values from Parent/onload.js", "content": "function onLoad() {\n\n /*\n * work out the parent form based on platform and return the given MRVS data\n * This could go in a global UI script but that wouldn't work for Portal, \n * would love anyone to suggest an alternative for portal :)\n */\n function getMRVSDataFromParent(mrvsName) {\n var parent_g_form = g_service_catalog.parent; // default for backend/platform\n if (parent.angular) {\n // this is portal so get a different way\n var parentItem = parent.angular.element(parent.$('#sc_cat_item').find('sp-variable-layout')[0]).scope();\n parent_g_form = parentItem.getGlideForm();\n }\n var vmData = parent_g_form.getValue(mrvsName);\n // on portal we get back an empty string rather than an empty array so convert\n return vmData == '' ? [] : JSON.parse(vmData);\n }\n\n var vmJSONData = getMRVSDataFromParent('virtual_machine');\n console.log(\"JSON \" + JSON.stringify(vmJSONData, '', 3));\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Hide Variables of Catalog Item on Order Guide/Hide Variables.js", "content": "function onLoad(){\n if(g_service_catalog.isOrderGuide()){\n //variable_name1, varaible_name2 are the fields already present on the Order guide, hence hiding below fields on the catalog form when the catalog form is used through an order guide.\n g_form.setDisplay('varible_name1',false);\n g_form.setDisplay('varible_name2',false);\n }\n" }, { "path": "Client-Side Components/Catalog Client Script/Hide Variables of Catalog Item on Order Guide/README.md", "content": "1. The onLoad catalog client script can be used to hide the catalog varaibles on catalog form when the catalog item is being used on OrderGuide and cascade varaibles field is enabled on Order guide.\n2. Cascading enables the transfer of values entered for variables in the initial order form to their corresponding variables in the catalog items that have been ordered.\n3. Assume that the variables variable_name1, varaible_name2 are already present on the order guide form, hence hiding these variables on the catalog form when the catalog form is opened through an order guide using the function isOrderGuide().\n" }, { "path": "Client-Side Components/Catalog Client Script/Hide attachment icon/Hide Attachment icon.js", "content": "//Hide attachment icon on catalog item\nfunction onLoad() {\n var document = document || top.document;\n (jQuery || top.jQuery)(\"#sc_attachment_button, #catItemTop > div > div.wrapper-md.row.no-margin.ng-scope > label\").hide();\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Hide attachment icon/README.md", "content": "# Hide Attachment Icon on Catalog Items\n\n## Use Case / Requirement\nHide the attachment icon on a specific catalog item when the end user should not submit supporting documents. This can reduce confusion and prevent oversized uploads.\n\n## Solution\nUse an onLoad catalog client script to target the attachment button rendered on the Service Portal form and hide it with jQuery. The snippet works for both classic and Service Portal experiences.\n\n## Implementation\n1. Create a new catalog client script with Type set to onLoad.\n2. Copy the contents of Hide Attachment icon.js into the script field.\n3. Adjust the selector if your catalog item uses a custom portal or markup.\n\n## Notes\n- Requires jQuery, which is available on standard Service Portal forms.\n- The DOM can change between releases; retest after theme or layout updates.\n- Remove the script if the catalog item later requires attachments.\n" }, { "path": "Client-Side Components/Catalog Client Script/Incident Sentiment Detector (Using Simple Word Matching, No AI)/SentimentAnalyzer.js", "content": "var SentimentAnalyzer = Class.create();\nSentimentAnalyzer.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n getSentiment: function() {\n var text = (this.getParameter('sysparm_text') || '').toLowerCase();\n var positive = ['thanks', 'great', 'resolved', 'appreciate'];\n var negative = ['issue', 'error', 'not working', 'fail', 'problem'];\n\n var score = 0;\n positive.forEach(function(word) { if (text.includes(word)) score++; });\n negative.forEach(function(word) { if (text.includes(word)) score--; });\n\n if (score > 0) return 'Positive';\n if (score < 0) return 'Negative';\n return 'Neutral';\n }\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/Incident Sentiment Detector (Using Simple Word Matching, No AI)/onChangeClientscript.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || !newValue) return;\n\n var ga = new GlideAjax('SentimentAnalyzer');\n ga.addParam('sysparm_name', 'getSentiment');\n ga.addParam('sysparm_text', newValue);\n ga.getXMLAnswer(function(sentiment) {\n g_form.addInfoMessage('Sentiment: ' + sentiment);\n g_form.setValue('u_sentiment', sentiment);\n });\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Incident Sentiment Detector (Using Simple Word Matching, No AI)/readme.md", "content": "Incident Sentiment Detector (No AI, Pure JavaScript)\n\nA lightweight ServiceNow utility that detects sentiment (Positive / Negative / Neutral) of an Incident’s short description or comments using simple keyword matching — no AI APIs or external libraries required.\n\nUseful for support teams to auto-tag sentiment and analyze user frustration or satisfaction trends without expensive integrations.\n\n🚀 Features\n\n✅ Detects sentiment directly inside ServiceNow ✅ Works without external APIs or ML models ✅ Instant classification on form update ✅ Adds detected sentiment to a custom field (u_sentiment) ✅ Simple to extend — just add more positive/negative keywords\n\n🧩 Architecture Overview\n\nThe solution consists of two main scripts:\n\nComponent Type Purpose SentimentAnalyzer Script Include Processes text and returns sentiment Client Script (onChange) Client Script Calls SentimentAnalyzer via GlideAjax on short description change 🧱 Setup Instructions 1️⃣ Create Custom Field\n\nCreate a new field on the Incident table:\n\nName: u_sentiment\n\nType: Choice\n\nChoices: Positive, Neutral, Negative\n" }, { "path": "Client-Side Components/Catalog Client Script/MRVS Email Validation with Mutation Observer/EmailValidationOnCatalogUI.js", "content": "/**\n * This is a client script that validates the email address in the MRVS field.\n * It uses MutationObserver to observe the changes in the MRVS field.\n * UseCase: Validate the email address in the catalog whenever user is going to add another email, \n * and show an error message if a duplicate email address is found. \n */\nfunction onLoad() {\n var document = document || top.document;\n\n var duplicateErrorMessageStatus = false; //adding this as corner case as observer will be called multiple times\n\n setTimeout(function () {\n var tbody = document.querySelector(\"#user_details > div > tbody\");\n\n if (tbody) {\n var observer = new MutationObserver(function (m, o) {\n\n var users = g_form.getValue('user_details');\n\n var hasDuplicateEmails = validateUserDetails();\n\n if (!users || hasDuplicateEmails) {\n if (hasDuplicateEmails && !duplicateErrorMessageStatus) {\n g_form.addErrorMessage('Duplicate email address found');\n duplicateErrorMessageStatus = true;\n }\n //disable the submit button\n } else {\n duplicateErrorMessageStatus = false;\n g_form.clearMessages();\n //enable the submit button\n }\n\n });\n observer.observe(tbody, {\n attributes: true,\n childList: true,\n subtree: true\n });\n }\n }, 3000);\n\n}\n\n// MRVS contains the user details in the form of JSON\nfunction validateUserDetails() {\n var userDetailsMRVS = g_form.getValue('user_details');\n if (userDetailsMRVS) {\n var multiRowData = JSON.parse(userDetailsMRVS);\n var emailSet = new Set();\n\n for (var i = 0; i < multiRowData.length; i++) {\n var row = multiRowData[i];\n\n var email = row.email.trim().toLowerCase();\n\n if (emailSet.has(email)) {\n\n return true;\n }\n emailSet.add(email);\n }\n }\n return false;\n}" }, { "path": "Client-Side Components/Catalog Client Script/MRVS Email Validation with Mutation Observer/README.md", "content": "# Email Validation on Catalog UI\n\nThis file contains a client script that validates email addresses in the MRVS (Multi-Row Variable Set) field using a MutationObserver. The script ensures that duplicate email addresses are not allowed in the catalog.\n\n## File Structure\n\n- `/code-snippets/Catalog Client Script/MRVS Email Validation with Mutation Observer/EmailValidationOnCatalogUI.js`\n\n## Description\n\nThe script observes changes in the MRVS field and validates the email addresses whenever a user attempts to add another email. If a duplicate email address is found, an error message is displayed, and the submit button is disabled.\n\n## Usage\n\n1. **onLoad Function**: This function initializes the MutationObserver to watch for changes in the MRVS field.\n2. **validateUserDetails Function**: This function checks for duplicate email addresses in the MRVS field.\n\n## How It Works\n\n1. The `onLoad` function sets up a MutationObserver on the MRVS field.\n2. When changes are detected, the `validateUserDetails` function is called to check for duplicate email addresses.\n3. If duplicates are found, an error message is displayed, and the submit button is disabled.\n" }, { "path": "Client-Side Components/Catalog Client Script/MRVS Interact With Parent Form/Portal onLoad.js", "content": "//Using this Catalog Client Script that Applies to the Catalog Item will enable g_form methods like setValue and clearValue which affect Catalog Item variables from a Catalog Client Script that applies to the multi-row variable set\nfunction onLoad() {\n\tif (this) {//we only need to do this for Service Portal\n\t\t//We need to make the g_form object for the parent item available from the MRVS window\n\t\tthis.cat_g_form = g_form;\n\t}\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/MRVS Interact With Parent Form/README.md", "content": "Use this code snippet to interact with the parent form (i.e the main Cataloge Item) from within a Catalog Client Script that applies to a multi-row variable set.\n\nThe g_service_catalog object allows for accessing the \"parent\" GlideForm (g_form) object for getValue only (for now?)\nTo affect a variable in the main catalogue item using setValue, clearValue, etc. parent.g_form... is available in the native UI, and this.cat_g_form... can be used for Service Portal, etc if an additional Catalog Client Script is used, this one onLoad that Applies to the Catalog Item (not the MRVS).\n" }, { "path": "Client-Side Components/Catalog Client Script/MRVS Interact With Parent Form/Write to Parent Form.js", "content": "//These methods can be used onLoad, onChange, or onSubmit in a script that Applies to the MRVS \n\n//Retrieve a variable value from the parent form - works in native UI as well as Service Portal, etc.\ng_service_catalog.parent.getValue('variable_name');\n\n//With this approach, you can set a variable value on the parent form - use similar code for other g_form methods like clearValue\n//Service Portal method requires an additional Catalog Client Script onLoad that Applies to the Catalog Item\nif (this) { //Service Portal method\n\t\tthis.cat_g_form.clearValue('variable_name');\n\t} else { //native UI method\n\t\tparent.g_form.clearValue('variable_name');\n\t}\n" }, { "path": "Client-Side Components/Catalog Client Script/MRVS Loop Rows/README.md", "content": "Use this to loop through a Multi Row Variable Set and create an array of objects with the variables in it.\n" }, { "path": "Client-Side Components/Catalog Client Script/MRVS Loop Rows/loopRows.js", "content": "var mrvsObj = [];\nvar multiRow = variable.mrvsName; //replace with the actual name of the mrvs\nif (multiRow.getRowCount()) { //if there are any entries on the MRVS loop through it\n\tvar eachRow = multiRow.getRowCount();\n\tfor (var i = 0; i < eachRow; i++) {\n\t\tvar row = multiRow.getRow(i);\n\t\tvar rowVars = {};\n\t\trowVars.var1 = row.var1; //replace with the variables in the mrvs\n\t\trowVars.var2 = row.var2;\n\t\trowVars.var3 = row.var3;\n\t\t// ... add rows as appropriate for your mrvs\n\t\tmrvsObj.push(rowVars); // creates an array of objects of the above fields from the MRVS\n\t}\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/MRVS Reference Qualifier from Catalog Item Variable/Catalog Client Script.js", "content": "function onLoad() {\n\tvar mgr = g_service_catalog.parent.getValue('v_manager'); //if using this script onLoad of the MRVS\n\t//var mgr = newValue; // if using this script onChange of the Catalog Item variable\n\tvar filterString = 'active=true^manager=' + mgr; //Reference qualifier following the 'javascript:'\n\t//alternate method for Service Portal only\n\t// if (window == null){ //Service Portal method\n\t// \tvar setfilter = g_list.get('v_employee');\n\t// \tsetfilter.setQuery(filterString);\n\t// } else { //native UI method\n\t\tvar ga = new GlideAjax('refQualUtils'); //Client callable Script Include Name\n\t\tga.addParam('sysparm_name', 'setSysProp'); //Function in Script Include\n\t\tga.addParam('sysparm_sys_prop_name', 'sr.mrvs.ref_qual.emp'); //System Property Name used in MRVS variable Reference qualifier \n\t\tga.addParam('sysparm_sys_prop_value', filterString);\n\t\tga.getXML(getResponse);\n\t\t\t\n\t\tfunction getResponse(response) { //to avoid Service Portal 'There is a JavaScript error in your browser console'\n\t\t\tvar answer = response.responseXML.documentElement.getAttribute(\"answer\"); \n\t\t}\n\t//}\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/MRVS Reference Qualifier from Catalog Item Variable/README.md", "content": "On a reference variable in a multi-row variable set, sometimes you want the reference qualifier to include the value of a variable that is part of the Catalog Item, not within the MRVS.\n\nIn this simplified example, I have a Manager (v_manager) reference variable (sys_user table) that belongs to the Catalog Item. In the MRVS, I have an Employee (v_employee) reference variable (sys_user table). I only want to be able to select user records that are active, and the Manager is the user I selected on the Catalog Item variable.\n\n1) Set the advanced reference qualifier on the MRVS variable to\n javascript: gs.getProperty(\"sr.mrvs.ref_qual.emp\");\n using a System Property Name of your choice\n\n2) Use the included onLoad Catalog Client Script that applies to the Variable set, or you can also use this onChange of the Catalog Item variable in a script that applies to the Catalog Item.\n\n3) Add the included Client callable Script Include for the Catalog Client Script to call via GlideAjax. This Script Include uses parameters for the System Property Name and Value, so it can be re-used in every instance of this solution.\n\nThis solution works in both the Native UI and Service Portal. The script contains an alternate Service Portal only approach in the commented if block that can be used in conjunction with the native UI approach in the else block. This alternate Service Portal solution was developed in collaboration with Chris Perry.\n" }, { "path": "Client-Side Components/Catalog Client Script/MRVS Reference Qualifier from Catalog Item Variable/Script Include.js", "content": "var refQualUtils = Class.create();\nrefQualUtils.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n \n \tsetSysProp: function(){\n\t\tvar propertyName = this.getParameter('sysparm_sys_prop_name');\n\t\tvar propertyValue = this.getParameter('sysparm_sys_prop_value');\n\t\tvar property = gs.getProperty(propertyName);\n\t\tgs.setProperty(propertyName, propertyValue);\n\t\treturn;\n\t},\n\t\t\n type: 'refQualUtils'\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/MRVS dependent ref qual 1st row/AccountUtils.js", "content": "var AccountUtils = Class.create();\nAccountUtils.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n\n //Populate the department name from the account in the session data for the reference qualifier to use:\n \n setSessionData: function() {\n var acct = this.getParameter('sysparm_account');\n\t\t var dept = '';\n\t\t var acctGR = new GlideRecord('customer_account'); //reference table for Account variable\n\t\t if (acctGR.get(acct)) {\n\t\t\t dept = '^dept_name=' + acctGR.dept_name; //department field name on account table\n\t\t }\n\t\t\n\t\t var session = gs.getSession().putClientData('selected_dept', dept);\n return;\n },\n\n type: 'AccountUtils'\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/MRVS dependent ref qual 1st row/README.md", "content": "This Catalog Client Script and Script Include are used with a reference qualifier similar to\njavascript: 'disable=false' + session.getClientData('selected_dept');\n\nThe 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.\n\nThe 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.\n" }, { "path": "Client-Side Components/Catalog Client Script/MRVS dependent ref qual 1st row/onLoad.js", "content": "function onLoad() {\n //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\n var mrvs = g_service_catalog.parent.getValue('my_mrvs'); //MRVS internal name\n\tvar acct = '';\n\tif (mrvs.length > 2) { //MRVS is not empty\n\t\tvar obj = JSON.parse(mrvs);\n \tacct = obj[0].account_mrvs;\n\t}\n\tvar ga = new GlideAjax('AccountUtils');\n ga.addParam('sysparm_name', 'setSessionData');\n ga.addParam('sysparm_account', acct);\n ga.getXMLAnswer(getResponse);\n}\n\nfunction getResponse(response) { \n //do nothing \n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Make OOB Attachment Mandatory/README.md", "content": "# Make out of the box attahcment mandatory onChange of a field in Catalog Item\n\nThis scripts makes the out of the box attachments to mandatory on the Service Portal for any Catalog Item.\n\nUsage:\n\nStep #1 - Create the UI Script \n* [Click here for script](UI Scripts/Make OOB Attachment Mandatory/setAttachmentMandatory.js)\n\nStep #2 - Include the UI Script in the Portal Theme under JS Includes\n\nStep #3 - Create a Catalog Client Script for the respective Catalog Item where you want to make the OOB attachment mandatory for certain criteria\n\n* [Click here for script](Catalog Client Script/Make OOB Attachment Mandatory/onChange.js)" }, { "path": "Client-Side Components/Catalog Client Script/Make OOB Attachment Mandatory/onChange.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || newValue == 'No') {\n\t\tsetAttachmentMandatory(false);\n return;\n }\n\n if (newValue == 'Yes') setAttachmentMandatory(true);\n}" }, { "path": "Client-Side Components/Catalog Client Script/Mandatory Attachments with 'n' numbers/README.md", "content": "# Enable Mandatory Attachments Count wtih 'n' numbers on Service Catalog item\n**Problem:** Check if exact 'n' number of attachments are added or not when user submit a request through service catalog from Portal/Platform UI.\n\n**For example:** We need to ensure there are exact 3 attachments added before submission\n\n**Note:** Ensure Isolate Script field is set to False for this Catalog Client Script to ensure DOM manipulation works\n\n* [Click here for script](onSubmitClientScript.js)\n" }, { "path": "Client-Side Components/Catalog Client Script/Mandatory Attachments with 'n' numbers/onSubmitClientScript.js", "content": "function onSubmit() {\n\t//Type appropriate comment here, and begin script below\n\nvar count = 3; //Pass the number to ensure given number of attachments are added\nvar alertMsg=\"You must add \"+count+\" attachments before submitting this request.\";\n\tif(window == null){\n\t\t// Service portal validation, Make sure Isolate Script is set to False\n\t\tif(this.document.getElementsByClassName('get-attachment').length != count) {\n\t\t\tspModal.alert(alertMsg);\n\t\t\treturn false;\n\t\t}\n\t}\n\telse{\n\t\t// Platform View\n var length = $j(\"li.attachment_list_items\").find(\"span\").length;\n\t\tif(length != count){\n\t\t\talertWindow(alertMsg);\n\t\t\treturn false;\n\t\t}\n\t}\n}\nfunction alertWindow(message) {\n var modal = new GlideModal(\"glide_warn\");\n modal.setTitle(\"Attachment issue\");\n modal.setPreference(\"title\", message);\n modal.render();\n}" }, { "path": "Client-Side Components/Catalog Client Script/Multi-User Collaboration/Readme.md", "content": "This project introduces a collaboration feature for Service Catalog requests, allowing multiple users to contribute to a single request. It’s ideal for scenarios like team onboarding, shared resource provisioning, or cross-functional workflows.\n" }, { "path": "Client-Side Components/Catalog Client Script/Multi-User Collaboration/Script include.JS", "content": "var CollaboratorHandler = Class.create();\nCollaboratorHandler.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n addCollaborators: function() {\n var requestId = this.getParameter('sysparm_request_id');\n var users = this.getParameter('sysparm_users').split(',');\n\n users.forEach(function(userId) {\n var gr = new GlideRecord('x_your_scope_collaborators');\n gr.initialize();\n gr.request = requestId;\n gr.collaborator = userId;\n gr.status = 'Pending';\n gr.insert();\n });\n\n return 'Collaborators added successfully';\n }\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/Multi-User Collaboration/client script.JS", "content": "function onSubmit() {\n var collaborators = g_form.getValue('collaborators'); // Multi-user reference field\n if (collaborators) {\n var ga = new GlideAjax('CollaboratorHandler');\n ga.addParam('sysparm_name', 'addCollaborators');\n ga.addParam('sysparm_request_id', g_form.getUniqueValue());\n ga.addParam('sysparm_users', collaborators);\n ga.getXMLAnswer(function(response) {\n alert('Collaborators added: ' + response);\n });\n }\n return true;\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Multi-User Collaboration/widget client controller.JS", "content": "function($scope, $http) {\n $scope.approve = function(sysId) {\n $http.post('/api/x_your_scope/collab_action', {\n action: 'approve',\n sys_id: sysId\n }).then(function(response) {\n $scope.server.update();\n });\n };\n\n $scope.reject = function(sysId) {\n $http.post('/api/x_your_scope/collab_action', {\n action: 'reject',\n sys_id: sysId\n }).then(function(response) {\n $scope.server.update();\n });\n };\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Multi-User Collaboration/widget server script.JS", "content": "(function() {\n var collabs = [];\n var gr = new GlideRecord('x_your_scope_collaborators');\n gr.addQuery('request', $sp.getParameter('request_id'));\n gr.query();\n while (gr.next()) {\n collabs.push({\n sys_id: gr.getUniqueValue(),\n name: gr.collaborator.name.toString(),\n status: gr.status.toString(),\n comments: gr.comments.toString()\n });\n }\n data.collaborators = collabs;\n})();\n" }, { "path": "Client-Side Components/Catalog Client Script/Normalise and Reset a MRVS based on Variable Changes/README.md", "content": "# MRVS - Normalise and Reset Rows on Change\n\n## What this solves\nWhen a controlling variable changes (for example, Environment), existing MRVS rows may no longer be valid. This client script:\n- Clears or normalises specific MRVS columns\n- Deduplicates rows\n- Optionally sorts rows for a cleaner UX\n- Works entirely client-side using MRVS JSON\n\n## Where to use\nCatalog Item → OnChange client script on your controlling variable.\n\n## How it works\n- Reads the MRVS value as JSON via `g_form.getValue('my_mrvs')`\n- Applies transforms (clear columns, unique by key, sort)\n- Writes back the JSON with `g_form.setValue('my_mrvs', JSON.stringify(rows))`\n\n## Setup\n1. Replace `CONTROLLING_VARIABLE` with your variable name.\n2. Replace `MY_MRVS` with your MRVS variable name.\n3. Adjust `COLUMNS_TO_CLEAR`, `UNIQUE_KEY`, and `SORT_BY` as needed.\n\n## Notes\n- To clear the MRVS entirely, set `rows = []` before `setValue`.\n- Works with Catalog Client Scripts; no server call required.\n\n## References\n- GlideForm API (client): `getValue`, `setValue`, `clearValue` \n https://www.servicenow.com/docs/bundle/zurich-api-reference/page/app-store/dev_portal/API_reference/GlideForm/concept/c_GlideFormAPI.html\n- Working with MRVS values on the client (community examples) \n https://www.servicenow.com/community/developer-articles/accessing-multi-row-variable-set-value-outside-the-multi-row/ta-p/2308876\n" }, { "path": "Client-Side Components/Catalog Client Script/Normalise and Reset a MRVS based on Variable Changes/mrvs_normalise_onchange.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading) return;\n\n var MRVS_NAME = 'MY_MRVS'; // your MRVS variable name\n var COLUMNS_TO_CLEAR = ['env', 'owner']; // MRVS column names to clear\n var UNIQUE_KEY = 'hostname'; // MRVS column that should be unique\n var SORT_BY = 'hostname'; // MRVS column to sort by\n\n try {\n var raw = g_form.getValue(MRVS_NAME);\n var rows = raw ? JSON.parse(raw) : [];\n if (!Array.isArray(rows)) rows = [];\n\n // Clear specified columns\n rows.forEach(function(row) {\n COLUMNS_TO_CLEAR.forEach(function(col) { if (row.hasOwnProperty(col)) row[col] = ''; });\n });\n\n // Deduplicate by UNIQUE_KEY\n if (UNIQUE_KEY) {\n var seen = {};\n rows = rows.filter(function(row) {\n var key = String(row[UNIQUE_KEY] || '').toLowerCase();\n if (!key || seen[key]) return false;\n seen[key] = true;\n return true;\n });\n }\n\n // Sort (case-insensitive)\n if (SORT_BY) {\n rows.sort(function(a, b) {\n var A = String(a[SORT_BY] || '').toLowerCase();\n var B = String(b[SORT_BY] || '').toLowerCase();\n if (A < B) return -1;\n if (A > B) return 1;\n return 0;\n });\n }\n\n g_form.setValue(MRVS_NAME, JSON.stringify(rows));\n } catch (e) {\n console.error('MRVS normalise failed', e);\n }\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Normalise and Reset a MRVS based on Variable Changes/variant_reset_specific_columns.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading) return;\n\n var MRVS_NAME = 'MY_MRVS';\n var COLUMNS_TO_CLEAR = ['env', 'region'];\n\n var rows = [];\n try { rows = JSON.parse(g_form.getValue(MRVS_NAME) || '[]'); } catch (e) {}\n if (!Array.isArray(rows)) rows = [];\n\n rows.forEach(function(row) {\n COLUMNS_TO_CLEAR.forEach(function(col) { if (row.hasOwnProperty(col)) row[col] = ''; });\n });\n\n g_form.setValue(MRVS_NAME, JSON.stringify(rows));\n}\n\n" }, { "path": "Client-Side Components/Catalog Client Script/Onsubmit validation/Readme.md", "content": "This project adds pre-validation for hardware availability in ServiceNow Catalog Items. Before submitting a request, the system checks if the requested hardware is available in inventory and blocks submission if stock is insufficient. we can easy to extend other validations (budget, licenses, etc.).Improves user experience by validating before approval.Prevents unnecessary approvals and fulfillment.\n" }, { "path": "Client-Side Components/Catalog Client Script/Onsubmit validation/on submit scriptinclude.JS", "content": "var HardwareValidationUtils = Class.create();\nHardwareValidationUtils.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n\n validateHardware: function() {\n var hardware = this.getParameter('sysparm_hardware');\n var qty = parseInt(this.getParameter('sysparm_quantity'), 10);\n\n if (!hardware || isNaN(qty)) {\n return 'Invalid input!';\n }\n\n var gr = new GlideRecord('u_hardware_inventory');\n if (gr.get(hardware)) {\n var availableQty = parseInt(gr.getValue('available_quantity'), 10);\n if (availableQty >= qty) {\n return 'OK';\n } else {\n return 'Not enough stock available!';\n }\n }\n return 'Hardware not found!';\n },\n\n type: 'HardwareValidationUtils'\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/Onsubmit validation/submit validation client script.js", "content": "function onSubmit() {\n \n\n var hardware = g_form.getValue('hardware_name');\n var qty = g_form.getValue('quantity');\n\n \n var ga = new GlideAjax('HardwareValidationUtils');\n ga.addParam('sysparm_name', 'validateHardware');\n ga.addParam('sysparm_hardware', hardware);\n ga.addParam('sysparm_quantity', qty);\n\n \n ga.getXMLAnswer(function(response) {\n \n\n if (response !== 'OK') {\n alert(response);\n \n g_form.addErrorMessage(response); // Optional inline error\n g_form.setSubmit(false); // Prevent submission in Service Portal\n } else {\n \n g_form.setSubmit(true); // Allow submission\n }\n });\n\n return false; \n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Open modal widget in an Onsubmit/README.md", "content": "Code snippet to stop submission of a form in an Onsubmit Client Script, use an asynchronous call, and open a Widget in Modal view. In the script provided, there are two buttons in the modal. The first continues with the submission to create a new record and the second one cancels it. We can use a Script Include to get some value that we want and based on that open the modal or continue with submission.\n" }, { "path": "Client-Side Components/Catalog Client Script/Open modal widget in an Onsubmit/openmodal.js", "content": " function onSubmit() {\n\n \n if (g_scratchpad.isFormValid)\n return true;\n\n //We can do some check using a Client Callable script include\n var getAnswer = new GlideAjax('example');\n getAnswer.addParam('sysparm_name', 'checkFor');\n getAnswer.addParam('sysparm_input1', g_user.userID);\n getAnswer.addParam('sysparm_input2', g_form.getUniqueValue());\n\n getAnswer.getXML(parsing);\n\n function parsing(response) {\n\n var answer = response.responseXML.documentElement.getAttribute('answer');\n if (answer) {\n var data = JSON.parse(answer);\n \n if (data == true) {\n\n spModal.open({\n title: \"Test title\",\n widget: \"mywidget\",\n buttons: [{\n label: 'Close',\n value: 'close'\n },\n {\n label: 'Create New Record',\n value: 'create'\n }\n ],\n size: 'md'\n }).then(function(answer) {\n //if button pressed is \"create\" then submit the form\n if (answer.value == 'create') {\n g_scratchpad.isFormValid = true;\n g_form.submit();\n }\n });\n } else {\n g_scratchpad.isFormValid = true;\n g_form.submit();\n }\n\n }\n\n }\n //Dont submit the form\n return false;\n }\n" }, { "path": "Client-Side Components/Catalog Client Script/PAN Validation/PAN Validation.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n var panNumber = g_form.getValue(\"pan_number\"); //Get the PAN card information\n var panRegex = /^[A-Z]{5}[0-9]{4}[A-Z]{1}$/; // Regex for the PAN Card\n\n if (panRegex.test(panNumber)) {\n g_form.showFieldMsg(\"pan_number\", \"Valid PAN card number.\", true); //Valid PAN card enterd populates this message \n } else {\n g_form.showErrorBox(\"pan_number\", \"InValid PAN card number.\", true); //In Valid PAN card details enterd populate this message \n }\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/PAN Validation/README.md", "content": "PAN is a ten-digit unique alphanumeric number issued by the Income Tax Department.\nIndian PAN (Permanent Account Number) card based on its standardized format. \nA PAN number is a unique 10-character alphanumeric identifier issued by the Indian government, and it follows a specific structure:\nFirst 5 characters: Uppercase English letters (A-Z).\nNext 4 characters: Numeric digits (0-9). \nLast character: A single uppercase English letter (A-Z).\n ![image](https://github.com/user-attachments/assets/37a6490b-912e-499c-9c41-c0cdf79491a5)\n\nWhen we provide the information in the mentioned format it validates as a valid PAN Card\nEg: ABCDE1234F\nResult \n![image](https://github.com/user-attachments/assets/779757b9-2d46-439b-bc8c-a468a5c0264a)\n\nMentioned formate was not used it will give an error message to the field\nEg:abcde1234f \n![image](https://github.com/user-attachments/assets/1dd214b8-aaf5-405d-aefb-8e46b786be3c)\n\nEg: 1234ABCDEF \n![image](https://github.com/user-attachments/assets/08f538b7-d1ac-4d26-8579-8342ca757c8c)\n\n\n" }, { "path": "Client-Side Components/Catalog Client Script/Passport Validation/README.md", "content": "This OnChange Catalog Client Script is for validating passport number, date of issue, and date of expiry. \n\nIt follows the specified rules(As per indian passport):- \n- 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).\n- The date of expiry should be calculated based on the date of issue:\n- 1. If the user is an adult (18 years or older), the expiry date should be exactly 5 years from the date of issue.\n 2. If the user is under 18, the expiry date should be exactly 10 years from the date of issue.\n \nPassport Number Validation:\nThe passportPattern uses a regular expression:\n^[A-Z] – The first character must be an uppercase letter.\n[1-9][0-9] – The second and third characters are numbers; the first is between 1-9, and the second between 0-9.\n[A-Z0-9]{5}$ – The last five characters are alphanumeric.\nIf the passport number does not match this pattern, the script displays an error message and clears the field.\n\nDate of Expiry Calculation:\n- 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).\n- The calculated expiry date is automatically set in the date_of_expiry field in the yyyy-MM-dd format.\n- Prompts are displayed if necessary fields like date_of_issue or age are missing before attempting the expiry date calculation.\n\nThis Client Script will ensure that the entered passport information and expiry date meet the requirements, providing a seamless and guided experience for the user.\n" }, { "path": "Client-Side Components/Catalog Client Script/Passport Validation/passportvalidity.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading) return;\n \n var passportNumber = g_form.getValue('passport_number');\n var dateOfIssue = g_form.getValue('date_of_issue');\n var age = parseInt(g_form.getValue('age'), 10);\n var dateOfExpiry = g_form.getValue('date_of_expiry');\n \n // Passport Number Validation\n var passportPattern = /^[A-Z][1-9][0-9][A-Z0-9]{5}$/;\n if (passportNumber && !passportPattern.test(passportNumber)) {\n 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\");\n g_form.clearValue('passport_number');\n } else {\n g_form.hideFieldMsg('passport_number');\n }\n \n // Date of Expiry Calculation based on date of issue\n if (dateOfIssue && age) {\n var issueDate = new GlideDate();\n issueDate.setValue(dateOfIssue);\n var expiryDate = new GlideDate();\n expiryDate.setValue(issueDate);\n \n if (age >= 18) {\n expiryDate.addYears(5); // Adult - add 5 years\n } else {\n expiryDate.addYears(10); // Under 18 - add 10 years\n }\n \n g_form.setValue('date_of_expiry', expiryDate.getByFormat('yyyy-MM-dd')); // Set expiry date in correct format\n g_form.hideFieldMsg('date_of_expiry');\n } else if (!dateOfIssue) {\n g_form.showFieldMsg('date_of_issue', \"Please enter the Date of Issue first.\", \"info\");\n } else if (!age) {\n g_form.showFieldMsg('age', \"Please enter your age first.\", \"info\");\n }\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Password Validation Script/README.md", "content": "Description of the Combined Password Validation Script\nPurpose\nThe script validates the password entered by the user in a ServiceNow catalog item form. It ensures that the password meets strong security criteria and does not include the user's first or last name, enhancing overall security.\n\nValidation Criteria\nStrong Password Requirements:\n\nAt least 8 characters long.\nContains at least one uppercase letter.\nContains at least one lowercase letter.\nContains at least one digit.\nContains at least one special character (e.g., @$!%*?&).\nFirst and Last Name Restrictions:\n\nThe password cannot contain the user's first name or last name.\n" }, { "path": "Client-Side Components/Catalog Client Script/Password Validation Script/Script.js", "content": "function onSubmit() {\n // Get the password value from the field\n var password = g_form.getValue('password'); // Change 'password' to your field name\n // Get the first and last name values from the fields\n var firstName = g_form.getValue('first_name'); // Change 'first_name' to your field name\n var lastName = g_form.getValue('last_name'); // Change 'last_name' to your field name\n // Define the regex pattern for a strong password\n var passwordPattern = /^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[@$!%*?&])[A-Za-z\\d@$!%*?&]{8,}$/;\n \n // Check if the password contains the first or last name\n if (password.includes(firstName) || password.includes(lastName)) {\n // Display an error message if validation fails\n g_form.showFieldMsg('password', 'Password cannot contain your first or last name.', 'error');\n return false; // Prevent form submission\n }\n // Validate the password against the pattern\n if (!passwordPattern.test(password)) {\n // Display an error message if validation fails\n g_form.showFieldMsg('password', 'Password must be at least 8 characters long, contain at least one uppercase letter, one lowercase letter, one digit, and one special character.', 'error');\n return false; // Prevent form submission\n }\n\n\n return true; // Allow form submission if all validations pass\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Percentage Symbol/readme.md", "content": "Sets the field value to the formatted percentage string (e.g., 45 becomes 45.00%).\n\nRetrieves the current value of the field.\nRemoves any existing % symbol to avoid duplication.\nValidates the input to ensure it's a number.\nConverts the value to a float.\nFormats it to two decimal places and appends a % symbol. \n" }, { "path": "Client-Side Components/Catalog Client Script/Percentage Symbol/script.js", "content": "/*Sets the field value to the formatted percentage string (e.g., 45 becomes 45.00%).\n\nRetrieves the current value of the field.\nRemoves any existing % symbol to avoid duplication.\nValidates the input to ensure it's a number.\nConverts the value to a float.\nFormats it to two decimal places and appends a % symbol. */\n\n\nfunction onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || newValue == '') {\n return;\n }\n\n function formatPercent(value) {\n if (value === null || value === undefined || value === '' || isNaN(value)) {\n return \"\";\n }\n var num = parseFloat(value);\n if (isNaN(num)) \n\treturn \"\";\n return num.toFixed(2) + \"%\";\n}\nvar des_amount = g_form.getValue(\"\").replace(\"%\",\"\");\n\ng_form.setValue(\"\", formatPercent(des_amount));\n \n}\n" }, { "path": "Client-Side Components/Catalog Client Script/PopulateDropdown/README.md", "content": "## Load / Populate the options for the second dropdown field (select box) based on what user chooses in the first dropdown\n![alt text](demo_catalog.png)\n\n### Use case\n\nYou need to dynamically populate the options for a dropdown (select box) field following another field.\n\nFor example, you need to create a catalog that has 2 fields: country and city, when the user chooses a country, the city field will only show the cities of that country.\n\nThis will especially come in handy when you have hundreds of options to populate, and easier to maintain than using catalog UI policies 👍\n\n### Set up\n\n- On the catalog, create 2 select box fields, for example: `city` and `country`\n- Add the question choices for the 1st dropdown\n- In the 2nd dropdwon, add any value for the question choices to bypass the mandatory\n- Create new client script, on change, for the FIRST dropdown. Only applies on Catalog Item view. It is recommended to set the variables readonly on the RITM and SCTASK view.\n" }, { "path": "Client-Side Components/Catalog Client Script/PopulateDropdown/script.js", "content": "// Please check readme for the set up\nvar data = {\n Japan: [\"Tokyo\", \"Osaka\"],\n USA: [\"New York\", \"Chicago\", \"San Diego\"],\n};\n\nfunction onChange(control, oldValue, newValue, isLoading) {\n var secondDropdown = \"city\";\n\n g_form.clearOptions(secondDropdown); // Remove all the options of the 2nd dropdown\n\n // When user switch to 'None' in country or when the form is loaded\n if (newValue == \"\" || isLoading) {\n return;\n }\n\n var cities = data[newValue];\n\n if (cities && cities.length) {\n cities.forEach(function (value) {\n g_form.addOption(secondDropdown, value, value);\n });\n }\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Prevent duplicate records on MRVS/README.md", "content": "# Prevent duplicate records to be selected in Multi row variable set\n\nWe have many ways to do this but this is bit unique compare to what you find in community, you can do it in one single script within the Variable set. \nOf course ServiceNow introduce a new feature in Quebec and have Unique checkbox field introuduced but to have a custom info message you need to go with the custom script.\n\n [ServiceNow Docs to disallow duplicate values](https://docs.servicenow.com/bundle/quebec-servicenow-platform/page/product/service-catalog-management/task/t_CreateAVariableForACatalogItem.html)\n \n [Click here for the script](script.js)\n" }, { "path": "Client-Side Components/Catalog Client Script/Prevent duplicate records on MRVS/script.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n\tif (isLoading || newValue == '') {\n\t\treturn;\n\t}\n\t\n\tvar MRVS_FIELD = \"field_name_here\"; //Multi row variable set name\n\t\n\tvar MRVS = (g_service_catalog.parent.getValue(MRVS_FIELD).length != 0) ? JSON.parse(g_service_catalog.parent.getValue(MRVS_FIELD)) : [];\n\t\n\t//If the MRVS is empty - exit\n\tif(MRVS.length == 0)return;\n\t\n\tvar valueExists = MRVS.some(function(obj){\n\t\treturn obj.Variable_Name == newValue; // Reference variable name which needs to be unique\n\t});\n\t\n\tif(valueExists){\n\t\tg_form.showFieldMsg(MRVS_FIELD , \"Field must be unique\");\n\t}\n\n\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Real time count of letters/Count letters.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading) {\n return;\n }\n\n var maxChars = 100;//count of charaters \n var currentLength = newValue.length;\n\n // Clear previous messages\n g_form.clearMessages();\n\n // Show info message\n g_form.addInfoMessage('Character count: ' + currentLength + ' / ' + maxChars);\n\n if (currentLength > maxChars) {\n // Show error message\n g_form.addErrorMessage('Character limit exceeded! Please shorten your text.');\n g_form.showFieldMsg('short_description', 'Too many characters!', 'error');\n\n // Make field mandatory to block submission\n g_form.setMandatory('short_description', true);\n } else {\n // Remove mandatory if valid\n g_form.setMandatory('short_description', false);\n }\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Real time count of letters/readme.md", "content": "This onChange Catalog Client Script displays the current character count for a text field and enforces a maximum limit by showing error messages and making the field mandatory to prevent form submission when exceeded.\n" }, { "path": "Client-Side Components/Catalog Client Script/Remove reference icon from portal/README.md", "content": "# Remove reference icon from portal using Catalog Client script of a Catalog Item\n\nThis catalog client script is design to remove the reference icon from the Portal for any reference field record.\nThis needs to be configured for each Catalog Item where the reference field is being used.\n\n* [Click here for script](remove-reference-icon-from-portal-onLoad.js)" }, { "path": "Client-Side Components/Catalog Client Script/Remove reference icon from portal/remove-reference-icon-from-portal-onLoad.js", "content": "function onLoad() {\n setTimeout(function() {\n var referenceElement = top.document.getElementsByClassName('btn btn-default bg-white lookup')[0];\n\n if (referenceElement != undefined || referenceElement != null)\n referenceElement.remove();\n \n }, 500);\n}" }, { "path": "Client-Side Components/Catalog Client Script/Restrict Number of rows in Multi Row Variable/README.md", "content": "## restrict_multi_row.js\nUse this to restrict multi row variable set rows to 1. this value can be changed to any number of rows as requirement.\n" }, { "path": "Client-Side Components/Catalog Client Script/Restrict Number of rows in Multi Row Variable/restrict_multi_row.js", "content": "function onLoad() {\n\tvar field = g_form.getField(\"mrvs_variable_set_name\");\n\tif (field != null) {\n\t\tfield.max_rows_size = 1;\n\t}\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Return Date Validation/README.md", "content": "This piece of code was written as a part of an usecase where the return date value validation was expected to be after start date as well as within 6 months from the start date. This code runs in an OnChange catalog client script for the field 'u_return_date' and validates the return date(u_return_date) in a ServiceNow Catalog item form to ensure:\n\n1. A start date(u_start_date) is entered before setting a return date(u_return_date).\n2. The return date is within 6 months after the start date.\n3. Return date must be after the start date, it can't be same as it or before it.\n\nLet’s say with an example:\n\na)\n u_start_date = 2025-10-01\n You enter u_return_date = 2026-04-15\n \n Steps:\n a)Difference = 196 days → More than 180 days\n b)Result: u_return_date is cleared and error shown: “Select Return Date within 6 months from Start Date”\n\nb)\n u_start_date = 2025-10-02\n You enter u_return_date = 2025-10-01\n \n Steps:\n a)Difference = -1 day → Return date put as 1 day before start date\n b)Result: u_return_date is cleared and error shown: “Select Return Date in future than Start Date”\n" }, { "path": "Client-Side Components/Catalog Client Script/Return Date Validation/validateReturndate.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || newValue == '') {\n return;\n }\n var u_start_date = g_form.getValue('u_start_date'); //start date validation to check to see whether filled or not\n if (!u_start_date) {\n g_form.clearValue('u_return_date');\n\t\t g_form.showFieldMsg('u_return_date', 'Please enter start date', 'error');\n } else {\n \t\tvar startTime = getDateFromFormat(u_start_date, g_user_date_format); //converting to js date object\n \t\tvar returnTime = getDateFromFormat(newValue, g_user_date_format);\n \t\tvar selectedStartDate = new Date(startTime);\n \t\tvar returnDate = new Date(returnTime);\n \t\tvar returnDateDifference = (returnDate - selectedStartDate) / 86400000; //converting the diff between the dates to days by dividing by 86400000 \n \t\tif (returnDateDifference > 180) {\n \t\t\tg_form.clearValue('u_return_date');\n \t\t\tg_form.showFieldMsg('u_return_date', 'Select Return Date within 6 months from Start Date', 'error');\n \t\t} else if (returnDateDifference < 1) {\n \t\t\tg_form.clearValue('u_return_date');\n \t\t\tg_form.showFieldMsg('u_return_date', 'Select Return Date in future than Start Date', 'error');\n\t\t }\n\t }\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Reusable GlideAjax Client Script/DynamicTableQueryUtil.js", "content": "var DynamicTableQueryUtil = Class.create();\nDynamicTableQueryUtil.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n\n getTableRow: function() {\n var tableName = this.getParameter('sysparm_table_name');\n var keyField = this.getParameter('sysparm_key_field');\n var keyValue = this.getParameter('sysparm_key_value');\n var fieldsParam = this.getParameter('sysparm_fields');\n var limitFields = !JSUtil.nil(fieldsParam);\n var desiredFields = limitFields ? fieldsParam.split(',') : [];\n\n var result = {};\n var tableObj = {};\n var gr = new GlideRecord(tableName);\n\n // Use addQuery for non-sys_id fields\n if (keyField === 'sys_id') {\n if (!gr.get(keyValue)) {\n return null;\n }\n } else {\n gr.addQuery(keyField, keyValue);\n gr.query();\n if (!gr.next()) {\n return null;\n }\n }\n\n // Handle variables (if present)\n if (gr.variables) {\n for (var key in gr.variables) {\n if (!JSUtil.nil(gr.variables[key])) {\n var variableObj = gr.variables[key];\n tableObj['variables.' + key] = {\n fieldDisplayVal: variableObj.getDisplayValue() || String(variableObj),\n fieldVal: String(variableObj)\n };\n }\n }\n }\n\n // Handle standard fields\n var fields = gr.getFields();\n for (var i = 0; i < fields.size(); i++) {\n var field = fields.get(i);\n var fieldName = field.getName();\n tableObj[fieldName] = {\n fieldDisplayVal: field.getDisplayValue() || String(field),\n fieldVal: String(field)\n };\n }\n\n // Add sys_id explicitly\n tableObj['sys_id'] = {\n fieldDisplayVal: 'Sys ID',\n fieldVal: gr.getUniqueValue()\n };\n\n // Filter fields if requested\n if (limitFields) {\n desiredFields.forEach(function(field) {\n field = field.trim();\n if (tableObj[field]) {\n result[field] = tableObj[field];\n }\n });\n } else {\n result = tableObj;\n }\n\n return new JSON().encode(result);\n }\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/Reusable GlideAjax Client Script/Readme.md", "content": "This solution provides a generic and reusable GlideAjax-based client-server interaction in ServiceNow that allows querying any table by passing:\n\nTable name\nKey field and value\nDesired fields to retrieve\n\nIt dynamically returns field values from the server and populates them on the form, making it ideal for use cases like CMDB enrichment, entitlement lookups, or dynamic form population.\n\n1. Client Script (onChange)\nTriggers on field change.\nSends parameters to the Script Include via GlideAjax.\nReceives JSON response and sets target field value.\n\nParameters:\nsysparm_table_name: Table to query (e.g., sys_user)\nsysparm_key_field: Field to match (e.g., sys_id)\nsysparm_key_value: Value to match\nsysparm_fields: Comma-separated list of fields to retrieve\n\n2. Script Include: DynamicTableQueryUtil\n \nProcesses incoming parameters.\nQueries the specified table and retrieves requested fields.\nSupports both standard fields and catalog item variables.\nReturns a JSON object with field values and display values.\n" }, { "path": "Client-Side Components/Catalog Client Script/Reusable GlideAjax Client Script/clientscript.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || newValue === '') {\n return;\n }\n\n // Define parameters dynamically\n var tableName = 'sys_user'; // Change as needed\n var keyField = 'sys_id'; // Change as needed\n var fieldsToFetch = 'email'; // Comma-separated list\n var targetField = 'user'; // Field to populate\n\n var ga = new GlideAjax('DynamicTableQueryUtil');\n ga.addParam('sysparm_name', 'getTableRow');\n ga.addParam('sysparm_table_name', tableName);\n ga.addParam('sysparm_key_field', keyField);\n ga.addParam('sysparm_key_value', newValue);\n ga.addParam('sysparm_fields', fieldsToFetch);\n ga.getXML(function(response) {\n var answer = response.responseXML.documentElement.getAttribute(\"answer\");\n if (!answer) {\n alert('No response from Script Include');\n return;\n }\n\n var parsedAnswer = JSON.parse(answer);\n if (parsedAnswer[fieldsToFetch]) {\n g_form.setValue(targetField, parsedAnswer[fieldsToFetch]['fieldVal']);\n } else {\n alert('error');\n }\n });\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Rounding Money or Price Field/README.md", "content": "This script is OnChange, and will automatically round the selected field to [x] value.\nThe script can either be applied to a Catalog Item, or a specific Variable in a Var Set.\n\nFor example, if prompting a user for a cost, and said cost should only be in multiples of $5.\n\nAny instance of `[VAR NAME]` in these files should be replaced with the name of the variable that the script is being applied to.\n\nMore information and a full write-up available on [Community](https://community.servicenow.com/community?id=community_article&sys_id=75ab01271bac5d10c17111751a4bcb40)." }, { "path": "Client-Side Components/Catalog Client Script/Rounding Money or Price Field/catalog_client_script.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n\n //Value for increment rounding\n var roundTo = [ROUNDING INCREMENT];\n\n //Standard onChange code + if the value is now empty, return\n if (isLoading || newValue == '') return;\n\n //Get the existing value, and remove the $, if it exists\n var existingVal = newValue.replace('$', '');\n\n //Make sure the field contains a valid numerical value\n if(!Number.isInteger(parseInt(existingVal))) return;\n\n //Round up if not a multiple of the increment\n if(existingVal % roundTo !=0) {\n\n //Calculate the rounded value\n var newVal = (Math.ceil(existingVal/roundTo)*roundTo);\n \n //Set the value of the field to the new, rounded value\n g_form.setValue('[VAR_NAME]', \"$\"+ newVal);\n\n //Show a message beneath the field indicating it was rounded, and the new value\n g_form.showFieldMsg('[VAR_NAME]', \"Rounded $\" + existingVal + \" to $\" + newVal);\n }\n} " }, { "path": "Client-Side Components/Catalog Client Script/Rounding Money or Price Field/catalog_client_script_config.md", "content": "Name: Round [Field] to nearest [Rounding Amount]\nUI Type: All\nType: onChange\n\nVariable name: [VAR NAME]\n\nScript: see `catalog_client_script.js` for code." }, { "path": "Client-Side Components/Catalog Client Script/Schedule Request/Readme.JS", "content": "This project allows users to schedule a Service Catalog request for a future date and time. Instead of submitting immediately, the request is stored and automatically submitted later using a Scheduled Job\n" }, { "path": "Client-Side Components/Catalog Client Script/Schedule Request/scheduled client script.js", "content": "function onSubmit() {\n var scheduledTime = g_form.getValue('scheduled_time');\n var currentTime = new Date().toISOString();\n\n if (scheduledTime > currentTime) {\n var ga = new GlideAjax('ScheduledRequestHelper');\n ga.addParam('sysparm_name', 'storeScheduledRequest');\n ga.addParam('sysparm_item', g_form.getUniqueValue());\n ga.addParam('sysparm_time', scheduledTime);\n ga.getXMLAnswer(function(response) {\n alert('Your request has been scheduled for: ' + scheduledTime);\n });\n return false; // Prevent immediate submission\n }\n\n return true; // Submit immediately if time is now or past\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Schedule Request/scheduled scriptinclude.JS", "content": "var ScheduledRequestHelper = Class.create();\nScheduledRequestHelper.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n storeScheduledRequest: function() {\n var itemID = this.getParameter('sysparm_item');\n var scheduledTime = this.getParameter('sysparm_time');\n\n var record = new GlideRecord('x_snc_scheduled_requests'); // Custom table\n record.initialize();\n record.catalog_item = itemID;\n record.scheduled_time = scheduledTime;\n record.insert();\n\n return 'Scheduled successfully';\n }\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/Schedule Request/scheduled_job.JS", "content": "var now = new GlideDateTime();\nvar gr = new GlideRecord('x_snc_scheduled_requests');\ngr.addQuery('scheduled_time', '<=', now);\ngr.query();\n\nwhile (gr.next()) {\n var request = new GlideRecord('sc_request');\n request.initialize();\n request.requested_for = gr.requested_for;\n request.cat_item = gr.catalog_item;\n request.insert();\n\n gr.deleteRecord(); // Remove after submission\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Set User Field Values on Load/README.md", "content": "On Load Catalog client script is created to auto set the field values and make that field read only\n - Navigate to your instance -> App Navigator > Open Catalog CLient Script [catalog_script_client]\n - Set following field Values\n - Name: xyz\n - Applies to: A Catalog item\n - Type: onLoad\n - Catalog item: Select your Catalog item\n - UI Type: All\n - Isolated script: Checked\n - Create the script as per script.js file.\n" }, { "path": "Client-Side Components/Catalog Client Script/Set User Field Values on Load/script.js", "content": "/*\nSet user field value on load using catalog cleint script and make the field readonly\n*/\n\nfunction onLoad()\n{\n var user_id = g_user.userID;\n g_form.setValue('field_name', user_id);\n g_form.setReadOnly('field_name', true);\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/Set and Lock Variable by Group/README.md", "content": "**Set and Lock Variable by Group**\n\nThis solution provides a secure and dynamic way to control data entry on a Service Catalog form based on the user's group membership. It is typically used to pre-fill and lock certain justification or approval bypass fields for authorized users (like managers or executive staff), improving their efficiency while maintaining an accurate audit trail.\n\nThis functionality requires a combined Client-side (Catalog Client Script) and Server-side (Script Include) approach to ensure the group check is done securely.\n" }, { "path": "Client-Side Components/Catalog Client Script/Set and Lock Variable by Group/set_lock_variable_by_grp.js", "content": "// onload Catalog Client Script with Catalog Name \nfunction onLoad() {\n var variableName = 'bypass_approval_reason';\n var targetGroupName = 'ServiceNow Support'; // The group authorized to skip this step\n var ga = new GlideAjax('UserUtils');\n ga.addParam('sysparm_name', 'isMemberOf');\n ga.addParam('sysparm_group_name', targetGroupName);\n ga.getXMLAnswer(checkAndLockVariable);\n function checkAndLockVariable(response) {\n var isMember = response;\n if (isMember == 'true') {\n var message = 'Value set and locked due to your ' + targetGroupName + ' membership.';\n var setValue = 'Bypassed by authorized ' + targetGroupName + ' member.';\n g_form.setValue(variableName, setValue);\n g_form.setReadOnly(variableName, true);\n g_form.showFieldMsg(variableName, message, 'info');\n } else {\n g_form.setReadOnly(variableName, false);\n }\n }\n}\n\n//Script Include\nvar UserUtils = Class.create();\nUserUtils.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n isMemberOf: function() {\n var groupName = this.getParameter('sysparm_group_name');\n var isMember = gs.getUser().isMemberOf(groupName);\n return isMember.toString();\n },\n\n type: 'UserUtils'\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/Set fields from URL Parameter 2/CatalogClientScript.js", "content": "function onLoad() {\n \n var taskId = getParameterValue(\"taskid\");\n \n if (taskId != \"\" && taskId != null && taskId != undefined) {\n console.log('=== CAMACHO Task id: ' + taskId);\n \n var gaGetTaskNumber = new GlideAjax('UtilsAjax');\n gaGetTaskNumber.addParam('sysparm_name', 'getTaskNumber');\n gaGetTaskNumber.addParam('sysparm_task_id', taskId);\n gaGetTaskNumber.getXMLAnswer(setmyFormValue);\n }\n }\n \n function setmyFormValue(answer) {\n \n //console.log('=== CAMACHO Entered setmyFormValue');\n if (answer) {\n var obj = JSON.parse(answer);\n var numero = obj.number.toString();\n console.log(numero);\n \n g_form.setValue('task_number', numero);\n \n }\n }\n \n function getParameterValue(name) {\n var url = top.location.href;\n var value = new URLSearchParams(url).get(name);\n if (value) {\n return value;\n } else {\n return null;\n }\n }" }, { "path": "Client-Side Components/Catalog Client Script/Set fields from URL Parameter 2/KMXOUtils.js", "content": "var KMXOUtils = Class.create();\nKMXOUtils.prototype = {\n initialize: function() {\n },\n\n /*\n * Receives a um sys_id and returns a Task table field value\n *\n * @param {String} - taskId\n * @return {Object}\n */\n getTaskNumber: function(taskId)\n {\n if (taskId != \"\" && taskId != null && taskId != undefined) {\n\n var grTask = new GlideRecord('x_770214_consultor_rwd_activity');\n\n if (grTask.get(taskId)) {\n \n var number = grTask.getValue('number');\n \n var obj = {};\n obj[\"number\"] = number;\n \n return obj;\n\n } else {\n\n return {};\n\n }\n \n }\n },\n\n type: 'KMXOUtils'\n};" }, { "path": "Client-Side Components/Catalog Client Script/Set fields from URL Parameter 2/README.md", "content": "# Set fields on a catalog item from URL parameters.\n\nThe mission was to get a sys_id from the URL, query a record and return a value to the front-end.\n\nIn the front-end we have a Record Producer (RP) with a String field.\n\nOn the onLoad event, we want to populate the field in order to show the value retrieved from the back-end.\n\nThe Use Case is defined so let's go to the step by step process.\n\n1. Create a Util class in the back-end\n\nOur Utils class will be a Script Include that receives a sys_id and returns a String. \n\n[KMXOUtils](KMXOUtils.js) \n\n2. Create a class to provide access for the Front-End\n\n2.1. To provide access in this class, the parameter Client callable should be True (checked)\n\n[UtilsAjax](UtilsAjax.js) \n\n3. I'll suppose that you have a String field called task_number in your RP\n\n3.1. Create a Catalog Client Script (Type: OnLoad) to get the URL parameter and call the back-end class:\n\n[CatalogClientScript](CatalogClientScript.js) \n" }, { "path": "Client-Side Components/Catalog Client Script/Set fields from URL Parameter 2/UtilsAjax.js", "content": "var UtilsAjax = Class.create();\nUtilsAjax.prototype = Object.extendsObject(global.AbstractAjaxProcessor, {\n\n getTaskNumber: function() {\n var taskId = this.getParameter('sysparm_task_id');\n gs.debug('=== Camacho UtilsAjax = Received the sys_id ' + taskId);\n return JSON.stringify(new KMXOUtils().getTaskNumber(taskId));\n \n },\n type: 'UtilsAjax'\n});" }, { "path": "Client-Side Components/Catalog Client Script/Set fields from URL Parameters/README.md", "content": "# Set fields on a catalog item from URL parameters.\n\nThis only works on both the classic ui and service portal.\n\nTo use this you must provide the technical name as a url parameter and then provide the value you would like set. This script is also console logging the techcnical names if you don't have them handy. Reference fields require using the sys_id.\n\n\n### Example\n\nFor the OOTB Password Reset catalog item it has a field \"Whose password needs to be reset?\" with a technical value of \"caller_id\" after adding this script you could use the below url parameter to auto populate the form with Abel Tuter.\n\n/sp?id=sc_cat_item&sys_id=29a39e830a0a0b27007d1e200ad52253&**caller_id=62826bf03710200044e0bfc8bcbe5df1**\n\n\n" }, { "path": "Client-Side Components/Catalog Client Script/Set fields from URL Parameters/script.js", "content": "function onLoad() {\n\n\ttry{ // Classic UI\n\t\tvar pFields = g_form.nameMap;\n\t\tconsole.log(pFields);\n\t\tpFields.forEach(function(field){\n\t\t\tif(getParam(field.prettyName)){\n\t\t\t\tg_form.setValue(field.prettyName, getParam(field.prettyName));\n\t\t\t}\n\t\t});\n\n\t}catch(e){ // Service Portal or Mobile\n\t\tvar fields = g_form.getEditableFields();\n\t\tconsole.log(fields);\n\t\tfields.forEach(function(field){\n\t\t\tif(getParam(field)){\n\t\t\t\tg_form.setValue(field, getParam(field));\n\t\t\t}\n\t\t});\n\t}\n}\n\nfunction getParam(name){\n\tvar url = new URL(top.location);\n\treturn url.searchParams.get(name);\n}" }, { "path": "Client-Side Components/Catalog Client Script/Validate a Credit Card Number/README.md", "content": "**Description of the Credit Card Number Validation Script**\nPurpose\nThe script validates a credit card number entered by the user in a ServiceNow form. \nIt checks if the number is a valid 16-digit credit card number using a combination of a regular expression and the Luhn algorithm for basic validation.\n\n**Validation Criteria**\nFormat:\nThe credit card number must consist of exactly 16 digits.\n**Luhn Algorithm:**\nThe script implements the Luhn algorithm to determine if the credit card number is potentially valid. \nThis algorithm helps catch common errors in credit card numbers, such as transposed digits.\n" }, { "path": "Client-Side Components/Catalog Client Script/Validate a Credit Card Number/Script.js", "content": "function onSubmit() {\n var cardNumber = g_form.getValue('credit_card'); // Change 'credit_card' to your field name\n var cardPattern = /^\\d{16}$/; // Simple pattern for 16-digit cards\n\n if (!cardPattern.test(cardNumber) || !isValidCardNumber(cardNumber)) {\n g_form.showFieldMsg('credit_card', 'Please enter a valid 16-digit credit card number.', 'error');\n return false;\n }\n return true;\n}\n\nfunction isValidCardNumber(number) {\n var sum = 0;\n var alternate = false;\n for (var i = number.length - 1; i >= 0; i--) {\n var n = parseInt(number.charAt(i), 10);\n if (alternate) {\n n *= 2;\n if (n > 9) n -= 9;\n }\n sum += n;\n alternate = !alternate;\n }\n return sum % 10 === 0;\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/catalog Draft/Readm.md", "content": "This project implements an Auto Save Draft feature for ServiceNow Catalog Items. It automatically saves the user’s progress (form variables) every few minutes to prevent data loss if the session times out or the browser closes. it Prevents data loss during long form filling.\n\n\n\nfeatures\nAuto-save catalog form data every 2 minutes.\n Stores draft data in a custom table.\nRestores saved data when the user reopens the catalog item.\n Works in Service Portal\n" }, { "path": "Client-Side Components/Catalog Client Script/catalog Draft/Script include.JS", "content": "var CatalogDraftUtils = Class.create();\nCatalogDraftUtils.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n saveDraft: function() {\n var userId = gs.getUserID();\n var catalogItem = this.getParameter('sysparm_catalog_item');\n var draftData = this.getParameter('sysparm_draft_data');\n\n var gr = new GlideRecord('u_catalog_draft');\n gr.addQuery('user', userId);\n gr.addQuery('catalog_item', catalogItem);\n gr.query();\n if (gr.next()) {\n gr.variables_json = draftData;\n gr.last_saved = new GlideDateTime();\n gr.update();\n } else {\n gr.initialize();\n gr.user = userId;\n gr.catalog_item = catalogItem;\n gr.variables_json = draftData;\n gr.last_saved = new GlideDateTime();\n gr.insert();\n }\n return 'Draft saved successfully';\n },\n type: 'CatalogDraftUtils'\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/catalog Draft/client script.js", "content": "function onLoad() {\n console.log('Auto Save Draft initialized');\n\n setInterval(function() {\n var draftData = {\n hardware_name: g_form.getValue('hardware_name'),\n quantity: g_form.getValue('quantity')\n };\n\n var ga = new GlideAjax('CatalogDraftUtils');\n ga.addParam('sysparm_name', 'saveDraft');\n ga.addParam('sysparm_catalog_item', g_form.getValue('sys_id')); // Catalog item sys_id\n ga.addParam('sysparm_draft_data', JSON.stringify(draftData));\n\n ga.getXMLAnswer(function(response) {\n console.log('Draft saved: ' + response);\n });\n }, 120000); // Every 2 minutes\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/onCellEdit Catalog Task State Change Restriction/README.md", "content": "# Catalog Task state should not be closed from list edit\nThe onCellEdit Client Script type is used for lists rather than forms and here \nit is being used so that the task should not be closed from the list edit without\nopening the form and filling other mandatory details like worknotes etc.\n" }, { "path": "Client-Side Components/Catalog Client Script/onCellEdit Catalog Task State Change Restriction/script.js", "content": "function onCellEdit(sysIDs, table, oldValues, newValue, callback) {\n var saveAndClose = true;\n //Type appropriate comment here, and begin script below\n // here the values are 7|closed skipped, 3|closed complete and 4|closed incomplete\n if(newValue == 7 || newValue == 3 || newValue == 4) {\n\tsaveAndClose = false;\n\talert('you cannot update from list');\n }\n callback(saveAndClose); \n}\n" }, { "path": "Client-Side Components/Catalog Client Script/previous Request/Readme.MD", "content": "Show previous request ON requested for selection\n\nThis feature enhances the Service Catalog experience by displaying previous requests for the selected Requested For user. When a user selects the Requested For variable in a catalog item form, a confirmation message appears showing the last few requests created for that user.\n" }, { "path": "Client-Side Components/Catalog Client Script/previous Request/previous request client script.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || newValue == '') return;\n\n var ga = new GlideAjax('PreviousRequestsUtils');\n ga.addParam('sysparm_name', 'getPreviousRequests');\n ga.addParam('sysparm_requested_for', newValue);\n ga.getXMLAnswer(function(response) {\n var requests = JSON.parse(response);\n if (requests.length === 0) {\n alert('No previous requests found for this user.');\n } else {\n var message = 'Previous Requests:\\n\\n';\n requests.forEach(function(req) {\n message += 'Number: ' + req.number + ' | Item: ' + req.item + ' | Date: ' + req.date + '\\n';\n });\n if (confirm(message + '\\nDo you want to continue?')) {\n // User clicked OK\n } else {\n // User clicked Cancel\n g_form.setValue('requested_for', oldValue);\n }\n }\n });\n}\n" }, { "path": "Client-Side Components/Catalog Client Script/previous Request/previous request script include.js", "content": "var PreviousRequestsUtils = Class.create();\nPreviousRequestsUtils.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n getPreviousRequests: function() {\n var requestedFor = this.getParameter('sysparm_requested_for');\n var result = [];\n var gr = new GlideRecord('sc_req_item');\n gr.addQuery('requested_for', requestedFor);\n gr.orderByDesc('sys_created_on');\n gr.setLimit(5); // Show last 5 requests\n gr.query();\n while (gr.next()) {\n result.push({\n number: gr.number.toString(),\n item: gr.cat_item.getDisplayValue(),\n date: gr.sys_created_on.getDisplayValue()\n });\n }\n return JSON.stringify(result);\n }\n});\n" }, { "path": "Client-Side Components/Catalog Client Script/spModal for Sweet Alerts/readme.md", "content": "In ServiceNow, Open catalog client Scripts [catalog_script_client] and paste the code snippet of [spModalSweetAlerts.js] file.\n\nSetup:\n1. A catalog item having variable name Rewards[rewards] of type 'Select Box'(include none as true) and 2 choices(Yes and No)\n2. A Single line type field named 'Reward Selected' [reward_selected] which will hold the value selected by user from the spModal popup.\n3. The onLoad catalog client script setup as below:\n4. Type: onChange\n5. Variable: rewards (as per step 1)\n6. Script: [[spModalSweetAlerts.js]]\n \n\n\nScreenshots:\n\n\n\"image\"\n\n\nRewards selected as 'Yes'\n\n\"image\"\n\nFrom the spModal popup select anyone of the reward, it should be populated in the Reward Selected field.\nAlong with that a message shows the same of the selection.\n\n\"image\"\n\n" }, { "path": "Client-Side Components/Catalog Client Script/spModal for Sweet Alerts/spModalSweetAlerts.js", "content": "function onChange(control, oldValue, newValue) {\n if (newValue == 'Yes') {\n spModal.open({\n title: \"Reward Type\",\n message: \"Please select the category of Reward\",\n buttons: [{\n label: \"Star Performer\",\n value: \"Star Performer\"\n },\n {\n label: \"Emerging Player\",\n value: \"Emerging Player\"\n },\n {\n label: \"High Five Award\",\n value: \"High Five Award\"\n },\n {\n label: \"Rising Star\",\n value: \"Rising Star\"\n }\n ]\n }).then(function(choice) {\n if (choice && choice.value) {\n\t\t\t\tg_form.addInfoMessage('Selected Reward: '+ choice.label);\n g_form.setValue('reward_selected', choice.value);\n }\n });\n } else {\n g_form.clearValue('reward_selected');\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Abort action when description is empty/Code.js", "content": "function onSubmit() {\n //Type appropriate comment here, and begin script below\n var description = g_form.getValue('description');\n\tvar state = g_form.getValue('state');\n\n if ((!description) && (state == 'completed')) {\n g_form.addErrorMessage('Please provide Description Value, Description Cannot be empty');\n\n return false;\n }\n\n}\n" }, { "path": "Client-Side Components/Client Scripts/Abort action when description is empty/ReadMe.md", "content": "When an Incident record is being closed, the system should validate that the Description field is not empty and state is completed.\nIf the Description field is blank and state is completed, the record submission (update) should be aborted, and the user should be prompted to provide a description before closing the incident.\n" }, { "path": "Client-Side Components/Client Scripts/Abort direct incident closure without Resolve State/readme.md", "content": "📘 README — Incident State Validation (Client Script)\nOverview\n\nThis Client Script enforces the correct ITIL incident lifecycle by preventing users from directly closing an incident without first transitioning it through the Resolved state.\nIf a user attempts to move the state directly to Closed Complete, the system reverts the change and displays a notification.\n\nWhat This Code Does\nMonitors changes to the state field on Incident form\nChecks if new selection is trying to skip the Resolved step\nReverts state to its previous value when the rule is violated\nAlerts the user with a clear and guided message\nRefreshes the form to maintain data consistency\nUsage Instructions\n\nCreate a Client Script on the Incident table\nType: onChange\nField Name: state\nPaste the script under the script section\nTest by trying to directly move an Incident to Closed Complete\nS\ncript Requirements\nState values must be configured as:\n6 → Resolved\n7 → Closed Complete\n\nScript runs only on Incident records\nMust be active in applicable ITIL views\nNotes for Developers\nThis code supports clean transition handling for ITSM workflows\nHelps enforce process compliance without server-side overhead\nRecommended for environments requiring strict closure governance\n" }, { "path": "Client-Side Components/Client Scripts/Abort direct incident closure without Resolve State/script.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n // Prevent execution during form load or when value is empty\n if (isLoading || newValue === '') {\n return;\n }\n\n // Dummy values for state comparison\n // Assuming:\n // 6 = Resolved\n // 7 = Closed Complete\n var RESOLVED = 6;\n var CLOSED = 7;\n\n // Prevent direct move to Closed without passing through Resolved\n if (newValue == CLOSED && oldValue != RESOLVED) {\n \n // Reset to previous state\n g_form.setValue('state', oldValue);\n\n // Show validation warning\n g_form.addErrorMessage(\n 'Direct closure is not allowed. Please first move the incident to Resolved state.'\n );\n\n // Reload page after showing error\n setTimeout(function() {\n location.reload();\n }, 3000);\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Add Field Decoration/Add Field Decoration.js", "content": "function onLoad() {\n // Adding Field Decorators\n g_form.addDecoration(\"caller_id\", \"icon-user-profile\", \"The Requester\");\n}\n" }, { "path": "Client-Side Components/Client Scripts/Add Field Decoration/README.md", "content": "# Client Script - Add Field Decoration\n\nA client script that added field decoration.\n\n## Usage\n\n- Create a new OnLoad script\n- Copy this script into it\n- Change the field name, icon and the message\n" }, { "path": "Client-Side Components/Client Scripts/Add Image to Field Based on Company/AddImageToFieldBasedOnCompany.js", "content": "function onLoad() {\n //Type appropriate comment here, and begin script below\n\t\n\t//Get element of the field\n var requestedForLabel = $('element.sc_req_item.request.requested_for');\n\tvar company = g_scratchpad.company;\n\n\t//Set the Position of the image\n\tvar bgPosition = \"5% 45%\";\n\t\n\tvar image = '';\n\t\n\t//Set the image based on the Company\n\tswitch (company) {\n case 'company 1':\n image = 'url(company1.png)';\n break;\n case 'company 2':\n image = 'url(company2.png)';\n break;\n case 'company 3':\n image = 'url(company3.png)';\n break;\n default:\n image = '';\n }\n\t\n\t//Update the Field Label\n requestedForLabel.down('label').setStyle({\n backgroundImage: image,\n backgroundRepeat: \"no-repeat\",\n backgroundPosition: bgPosition,\n paddingLeft: '30px'\n });\n\n}\n" }, { "path": "Client-Side Components/Client Scripts/Add Image to Field Based on Company/README.md", "content": "# Add Image to Field Based on Company\nFrom the User Profile get the Company associated to the User using a Display Business Rule and putting the value in the scratchpad. After that use the scratchpad value in the Client Script to check the company name and then associate the image accordingly. You would need to add all your images to the ServiceNow instance first with the correct names.\n" }, { "path": "Client-Side Components/Client Scripts/Add Image to Field Based on Company/SetCompanyScratchPadValue.js", "content": "(function executeRule(current, previous /*null when async*/) {\n\n\t// Set the Scratchpad value for Company which would be used in the Client Script\n\tg_scratchpad.company = current.request.requested_for.company.getDisplayValue();\n\n})(current, previous);\n" }, { "path": "Client-Side Components/Client Scripts/Adding Placeholder on Resolution Notes/README.md", "content": "# Adding Placeholder Text in Resolution Notes\n\nTo maintain consistency and ensure specific information is captured in resolution notes, process owners may require fulfillers to follow a predefined format when resolving tickets.\n\nBy 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.\n\n## How It Works\n\n### When?\n- The placeholder text is automatically added when the state of the ticket changes to Resolved (6).\n\n### What Happens?\n- A placeholder text appears in the resolution notes field to guide the fulfiller.\n- As soon as the fulfiller starts typing, the placeholder disappears.\n- This ensures consistency and alignment with the process requirements.\n" }, { "path": "Client-Side Components/Client Scripts/Adding Placeholder on Resolution Notes/script.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n var res = g_form.getElement('close_notes');\n if (newValue == 6)\n res.placeholder = \"1. Root Cause\" + \"\\n\" + \"2. Steps taken\" + \"\\n\" + \"3. Resolution provided\"; //Placeholder text as required\n else\n res.placeholder = \"\";\n}\n" }, { "path": "Client-Side Components/Client Scripts/Auto Update Priority based on Impact and Urgency/readme.md", "content": "🧩 Readme : Client Script: Auto Priority Update Based on Impact and Urgency\n📘 Overview\n\nThis client script automatically updates the Priority field on the Incident form whenever the Impact or Urgency value changes.\nIt follows the ITIL standard mapping to ensure the correct priority is always set automatically, improving data accuracy and efficiency for service desk agents.\n\n⚙️ Script Details\nField\tValue\nName\tAuto Priority Update based on Impact and Urgency\nType\tonChange\nApplies to Table\tIncident\nApplies on Fields\timpact, urgency\nUI Type\tAll (Classic, Mobile, Workspace)\nActive\t✅ Yes\nCondition\tLeave blank\n💻 Script Code\n// ==========================================================================\n// Script Name: Auto Priority Update based on Impact and Urgency\n// Table: Incident\n// Type: onChange | Fields: impact, urgency\n// UI Type: All\n// Version: 2025 Production Ready\n// ==========================================================================\n\nfunction onChange(control, oldValue, newValue, isLoading, isTemplate) {\n // Skip execution if form is loading or field is empty\n if (isLoading || newValue == '') {\n return;\n }\n\n // Get Impact and Urgency values\n var impact = g_form.getValue('impact');\n var urgency = g_form.getValue('urgency');\n\n // Define Priority Matrix (ITIL standard)\n var priorityMatrix = {\n '1': { '1': '1', '2': '2', '3': '3' },\n '2': { '1': '2', '2': '3', '3': '4' },\n '3': { '1': '3', '2': '4', '3': '5' }\n };\n\n // Find the new Priority\n var newPriority = priorityMatrix[impact]?.[urgency];\n\n // Update the Priority field if valid\n if (newPriority) {\n if (g_form.getValue('priority') != newPriority) {\n g_form.setValue('priority', newPriority);\n g_form.showFieldMsg('priority', 'Priority auto-updated based on Impact and Urgency', 'info');\n }\n } else {\n // Optional: Clear Priority if invalid combination is selected\n g_form.clearValue('priority');\n g_form.showFieldMsg('priority', 'Invalid Impact/Urgency combination — priority cleared', 'error');\n }\n}\n\n🧠 How It Works\n\nThe script runs automatically when Impact or Urgency changes.\nIt checks the ITIL-based matrix to determine the correct Priority.\nIf a valid combination is found, the Priority field updates automatically.\nA small info message appears to confirm the update.\n\n🔢 ITIL Mapping Table\nImpact\tUrgency\tResulting Priority\n1 (High)\t1 (High)\t1 (Critical)\n1\t2\t2\n1\t3\t3\n2\t1\t2\n2\t2\t3\n2\t3\t4\n3\t1\t3\n3\t2\t4\n3\t3\t5\n✅ Benefits\n\nAutomatically enforces ITIL priority standards\nReduces manual effort and user errors\nEnsures consistency in priority calculation\nCompatible with Classic UI, Next Experience, and Agent Workspace\n" }, { "path": "Client-Side Components/Client Scripts/Auto Update Priority based on Impact and Urgency/script.js", "content": "//Auto Priority Update based on Impact and Urgency\n\n// ==========================================================================\n// Script Name: Auto Priority Update based on Impact and Urgency\n// Table: Incident (or any Task-based table)\n// Type: onChange | Fields: impact, urgency\n// UI Type: All\n// ==========================================================================\n\nfunction onChange(control, oldValue, newValue, isLoading, isTemplate) {\n // Prevent the script from running when the form loads or when the field is empty\n if (isLoading || newValue == '') {\n return;\n }\n\n // ----------------------------------------------------------------------\n // Step 1: Fetch field values from the form\n // ----------------------------------------------------------------------\n var impact = g_form.getValue('impact'); // e.g., 1 - High, 2 - Medium, 3 - Low\n var urgency = g_form.getValue('urgency'); // e.g., 1 - High, 2 - Medium, 3 - Low\n\n // ----------------------------------------------------------------------\n // Step 2: Define the ITIL-based Priority Matrix\n // ----------------------------------------------------------------------\n // Each row represents \"Impact\", and each column represents \"Urgency\"\n // The resulting value sets the \"Priority\"\n var priorityMatrix = {\n '1': { '1': '1', '2': '2', '3': '3' }, // Impact = High\n '2': { '1': '2', '2': '3', '3': '4' }, // Impact = Medium\n '3': { '1': '3', '2': '4', '3': '5' } // Impact = Low\n };\n\n // ----------------------------------------------------------------------\n // Step 3: Determine the new priority based on selected Impact/Urgency\n // ----------------------------------------------------------------------\n var newPriority = priorityMatrix[impact]?.[urgency]; // optional chaining prevents errors\n\n // ----------------------------------------------------------------------\n // Step 4: Update the Priority field and inform the user\n // ----------------------------------------------------------------------\n if (newPriority) {\n // Only update if priority is different from current value\n if (g_form.getValue('priority') != newPriority) {\n g_form.setValue('priority', newPriority);\n\n // Show message (works in both Classic UI and Next Experience)\n g_form.showFieldMsg('priority', 'Priority auto-updated based on Impact and Urgency', 'info');\n }\n } else {\n // Optional: clear priority if invalid combination is selected\n g_form.clearValue('priority');\n g_form.showFieldMsg('priority', 'Invalid Impact/Urgency combination — priority cleared', 'error');\n }\n\n // ----------------------------------------------------------------------\n // End of Script\n // ----------------------------------------------------------------------\n}\n" }, { "path": "Client-Side Components/Client Scripts/Auto-Populate Planned End Date/README.md", "content": "An onChange client script that calls the script includes one that adds the specified number of business days to the planned start date and autopopulates the planned end date based on the type.\nFor the client callable script include refer to the README file in the Add Business Days Script include folder. Link: [Add Business Days Script Include](/Server-Side%20Components/Script%20Includes/Add%20Business%20Days/README.md)\n" }, { "path": "Client-Side Components/Client Scripts/Auto-Populate Planned End Date/autoPopulatePlannedEndDate.js", "content": "//Client script\n//Table: Change Request\n//UI Type: All\n//Type: onChange\n//Field: Planned Start Date\nfunction onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n } \n var daysToAdd;\n if(g_form.getValue('type') =='standard' || g_form.getValue('type') =='normal')\n daysToAdd = 3; \n else if(g_form.getValue('type') =='emergency')\n daysToAdd = 1;\n var ga = new GlideAjax(\"addBusinessDays\"); //Calling the add business days script include, which is in the Server-Side Components/Script Includes/Add Business Days/addBusinessDays.js\n ga.addParam('sysparm_name', 'addDays');\n ga.addParam('sysparm_days', daysToAdd); \n ga.addParam('sysparm_date', newValue);\n ga.getXML(processResponse);\n\n function processResponse(response) {\n var answer = response.responseXML.documentElement.getAttribute(\"answer\").toString();\n g_form.setValue('end_date', answer);\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Auto-Populate Short Discription/Auto populate short description.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n\n // Define category-to-short description mapping\n var categoryToShortDescription = {\n 'hardware': 'Hardware Issue - ',\n 'software': 'Software Issue - ',\n 'network': 'Network Issue - ',\n 'inquiry': 'Inquiry/Help - ',\n\t\t'database': 'Database - '\n };\n\n // Convert the selected value to lowercase for matching\n var selectedCategory = newValue.toLowerCase();\n\n // If category exists in mapping, update the short description\n if (categoryToShortDescription.hasOwnProperty(selectedCategory)) {\n var existingDesc = g_form.getValue('short_description') || '';\n var prefix = categoryToShortDescription[selectedCategory];\n\n // Only add prefix if it's not already there\n if (!existingDesc.startsWith(prefix)) {\n g_form.setValue('short_description', prefix + existingDesc);\n g_form.showFieldMsg('short_description', 'Short Description auto-updated based on category.', 'info');\n }\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Auto-Populate Short Discription/README.md", "content": "\n# Auto-Populate Short Description Client Script\n\n## Overview\n\nThis client script is designed to enhance the user experience in ServiceNow by automatically populating the 'Short Description' field when a user selects a category for an incident or request. It simplifies the data entry process, ensures consistency in short descriptions, and saves time for users.\n\n## How It Works\n\nWhen a user selects a category from the provided options, the script appends a predefined prefix to the existing 'Short Description' value, creating a more informative short description.\n\n### Configuration\n\nTo configure and use this client script in your ServiceNow instance, follow these steps:\n\n1. **Create a Client Script:**\n\n - Log in to your ServiceNow instance as an admin or developer.\n - Navigate to \"System Definition\" > \"Client Scripts.\"\n - Create a new client script and give it a name (e.g., \"Auto-Populate Short Description\").\n\n2. **Copy and Paste the Script:**\n\n - Copy the JavaScript code provided in this README.\n - Paste the code into your newly created client script.\n\n3. **Attach to 'category' Field:**\n\n - Save the client script and ensure it's active.\n - Attach the client script to the 'category' field of the relevant table (e.g., Incident, Request) where you want to enable this functionality.\n\n4. **Define Your Category-to-Short-Description Mappings:**\n\n - Modify the script to define your own mappings for categories and their corresponding short description prefixes. Customize the `categoryToShortDescription` object to match your requirements.\n\n5. **Testing:**\n\n - Test the functionality by creating or editing an incident or request record.\n - Select a category, and observe how the 'Short Description' field is automatically populated based on your mappings.\n\n## Example Mapping\n\nHere's an example of how you can define category-to-short-description mappings in the script:\n\n```javascript\nvar categoryToShortDescription = {\n 'Hardware': 'Hardware Issue - ',\n 'Software': 'Software Issue - ',\n 'Network': 'Network Issue - ',\n 'Other': 'Other Issue - '\n};\n```\n\nYou can customize these mappings to align with your organization's specific categories and short description conventions.\n\n## Benefits\n\n- Streamlines data entry for users.\n- Ensures consistent and informative short descriptions.\n- Saves time and reduces the risk of human error.\n- Enhances user experience in ServiceNow.\n" }, { "path": "Client-Side Components/Client Scripts/Auto-Populate Short Discription/Readme.md", "content": "# Auto-Populate Short Description (Client Script)\n## Overview\n\nThis client script automatically updates the Short Description field in ServiceNow whenever a user selects a category on the form. It improves data consistency, saves time, and ensures that short descriptions remain meaningful and standardized.\n\n## How It Works\n\nWhen a user selects a category such as Hardware, Software, or Network, the script automatically prefixes the existing short description with a corresponding label (for example, “Hardware Issue –”).\nThis makes incident records easier to identify and improves the quality of data entry.\n\n## Configuration Steps\n\n1. Log in to your ServiceNow instance with admin or developer access.\n2. Navigate to System Definition → Client Scripts.\n3. Create a new Client Script with the following details:\n\n```\nTable: Incident\nType: onChange\nField name: category\nCopy and paste the provided script into the Script field.\nSave the record and make sure the script is active.\n```\n\n## Testing\n\n1. Open any existing or new Incident record.\n2. Select a category such as Hardware or Software.\n3. The Short Description field will automatically update with the corresponding prefix.\n\n## Benefits\n\nSpeeds up data entry for users.\nMaintains consistency in short descriptions.\nReduces manual effort and human errors.\nEnhances clarity in incident listings and reports.\n" }, { "path": "Client-Side Components/Client Scripts/Auto-Populate Short Discription/autoPopulateSD.js", "content": "// Client Script to Auto-Populate Short Description based on Category\n\nfunction onChangeCategory() {\n var categoryField = g_form.getValue('category'); // Get the selected category\n var shortDescriptionField = g_form.getValue('short_description'); // Get the Short Description field\n\n // Define mappings for categories and corresponding short descriptions\n var categoryToShortDescription = {\n 'Hardware': 'Hardware Issue - ',\n 'Software': 'Software Issue - ',\n 'Network': 'Network Issue - ',\n 'Other': 'Other Issue - '\n };\n\n // Update Short Description based on the selected category\n if (categoryToShortDescription.hasOwnProperty(categoryField)) {\n var newShortDescription = categoryToShortDescription[categoryField] + shortDescriptionField;\n g_form.setValue('short_description', newShortDescription);\n }\n}\n\n// Attach the onChangeCategory function to the 'category' field\ng_form.observe('change', 'category', onChangeCategory);\n" }, { "path": "Client-Side Components/Client Scripts/Auto-populate watch_list based on company/README.md", "content": "Table: Incident\nType: onChange\nfield: caller_id\n\nSometimes customers have a requirement to add users or distribution lists to all tickets that are raised for their company. This script allows to automatically add a list of users or external email addresses to the watch_list field." }, { "path": "Client-Side Components/Client Scripts/Auto-populate watch_list based on company/script.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading) {\n return;\n }\n var callerID = g_form.getReference('caller_id', getUserCompany);\n}\n\nfunction getUserCompany(callerID) {\n switch (callerID.company) {\n case 'company_1_sys_id':\n g_form.setValue('watch_list', 'PEOPLE_TO_ADD');\n //PEOPLE_TO_ADD is a comma separated list of user sys_id\n //and external email addresses\n break;\n case 'company_2_sys_id':\n g_form.setValue('watch_list', 'PEOPLE_TO_ADD');\n break;\n default:\n break;\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Call SI to recover User data/README.md", "content": "# Call Script Include to recover User data\n\nIn this onChange Client Script, the scenario is this:\n- In a form, we have a reference field to the User table to allow our user to select any user within the platform.\n- Once a user is selected, we are passing that Sys ID to recover more information regarding the selected record.\n" }, { "path": "Client-Side Components/Client Scripts/Call SI to recover User data/script.js", "content": "/*\nType: onChange\nField: a reference to the User table\n*/\nfunction onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n\n var test = newValue;\n\n //The Script Include called here can be found in:\n //Server-Side Components / Script Includes / Get User Data by Id\n //It is in Global scope \n var ga = new GlideAjax('GetUserData');//script include name\n ga.addParam('sysparm_name', 'GetUserBy_id'); //method to be called\n ga.addParam('sysparm_userid', test); //send a parameter to the method.\n ga.getXMLAnswer(userInfoParse);\n\n function userInfoParse(response) {\n if (response == '') {\n g_form.addErrorMessage('User not found with the informed sys_id.');\n } else {\n //alert(response);\n var obj = JSON.parse(response);\n g_form.setValue('u_first_name', obj.first_name.toString());\n g_form.setValue('u_last_name', obj.last_name.toString());\n g_form.setValue('u_email', obj.email.toString());\n }\n\n }\n\n}\n" }, { "path": "Client-Side Components/Client Scripts/Change Label of Field/Change Label of Field.js", "content": "function onLoad() {\n //Type appropriate comment here, and begin script below\n if (g_form.getValue('priority') == '1') {\n g_form.setLabelOf('description', 'Please Explain Briefly');\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Change Label of Field/README.md", "content": "\n# Change Label of Field \n\n• Modify field labels dynamically in the ServiceNow platform.\n\n• Change labels through the UI form designer or through client/server-side scripts.\n\n• Implement Business Rules to change labels based on conditions.\n\n• Adjust field labels dynamically using Client Scripts based on user interactions.\n\n" }, { "path": "Client-Side Components/Client Scripts/Change incident Number label color based on priority/Script.js", "content": "function onLoad ()\n{\n var aPriority = g_form.getValue('priority');\n var label = g_form.getLable('number');\n label.style.backgroundColor = \"lightblue\";\n if(aPriority==1)\n {\n label.style.color = \"red\";\n }\n else if (aPriority==2)\n {\n label.style.color = \"yellow\";\n }\n else\n {\n label.style.color = \"blue\";\n }\n}\n\n" }, { "path": "Client-Side Components/Client Scripts/Change incident Number label color based on priority/readme.md", "content": "Write Client Script \nChange Incident Number Lable color based on priority\n" }, { "path": "Client-Side Components/Client Scripts/Check all mandatory fields using mandatoryCheck()/README.md", "content": "# Mandatory Field Check on Form Change\n\nThis client script demonstrates how to use `g_form.mandatoryCheck()` to validate whether all mandatory fields on a form are filled.\n\nIt is typically used in an **onChange** catalog client script to trigger validation when a specific field changes.\n\nIf mandatory fields are missing, the script:\n- Displays an info message listing the missing fields. Note: the red message is the existing functionality that will give you an error message.\n- Visually highlights each missing field using a flashing effect to guide the user.\n\nThis approach improves user experience by clearly indicating which fields require attention.\n\n**Example configuration**\n\"image\"\n\n**Example execution**\n\"image\"\n" }, { "path": "Client-Side Components/Client Scripts/Check all mandatory fields using mandatoryCheck()/script.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n\n // Check if all mandatory fields are filled\n if (!g_form.mandatoryCheck()) {\n //if not get all missing fields\n var missing = g_form.getMissingFields();\n //Info message displaying the fields that are missing\n g_form.addInfoMessage(\"Please complete the following mandatory fields: \" + missing.join(\", \"));\n //go through missing fields and flash them\n missing.forEach(function (fieldName) {\n g_form.flash(fieldName, \"#FFFACD\",0); // Flash to draw attention\n });\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Client Validation of Attachments by File Type and Count/README.md", "content": "This ServiceNow client script is designed to validate file attachments on a form before submission. It's most likely used as a \"Client Script\" or \"Client Script in a Catalog Item\" that runs in the browser when a user tries to submit a form.\n\nThis client script runs when a form is submitted in ServiceNow. It checks if the user has:\n\nAttached at least one file (shows an error if none).\nAttached no more than three files (shows an error if more).\nOnly uploaded files of type PDF or PNG (shows an error for other types).\nIf any of these checks fail, the form submission is blocked and an appropriate error message is displayed.\n" }, { "path": "Client-Side Components/Client Scripts/Client Validation of Attachments by File Type and Count/code.js", "content": "(function executeRule(gForm, gUser, gSNC) {\n var attachments = gForm.getAttachments();\n if (!attachments || attachments.length === 0) {\n gForm.addErrorMessage(\"You must attach at least one file.\");\n return false;\n }\n\n if (attachments.length > 3) {\n gForm.addErrorMessage(\"You can only upload up to 3 files.\");\n return false;\n }\n\n var allowedTypes = ['pdf', 'png'];\n for (var i = 0; i < attachments.length; i++) {\n var fileName = attachments[i].file_name.toLowerCase();\n var ext = fileName.split('.').pop();\n if (!allowedTypes.includes(ext)) {\n gForm.addErrorMessage(\"Only PDF and PNG files are allowed.\");\n return false;\n }\n }\n\n return true;\n})(gForm, gUser, gSNC);\n" }, { "path": "Client-Side Components/Client Scripts/Client script using getMessage() function without filling Messages field/README.md", "content": "# Client scripts using getMessage() function without filling Messages field\n\n**Problem scenario :**\nDevelopers while writing a client script uses getMessage() function but there are no messages preloaded in the 'Messages' field in client script form\n\n**Solution :**\nWrite an onSubmit client script to check the above scenario and prevent client script submission with an error message on top of the form.\n\nCheck the file `script.js` file for example.\n\nNote : As a best practice for this scenario use 'Checks' in the'Instance scan' feature of serviceNow. If Instance scan is not configured in your instance yet or if you want to avoid the problem during development itself then use this client script.\n" }, { "path": "Client-Side Components/Client Scripts/Client script using getMessage() function without filling Messages field/script.js", "content": "function onSubmit() {\n \n\tvar messages = g_form.getValue('messages');\n\tvar script = g_form.getValue('script');\n\tvar count = 0;\n\tif(messages == '' && script.includes('getMessage'))\n\t\t{\n\t\t\tg_form.addErrorMessage(\"Please add any message in the Messages field before using getMessage() function\");\n\t\t\treturn false;\n\t\t}\n \n}\n" }, { "path": "Client-Side Components/Client Scripts/Color-coded Priority field for improved UX/README.md", "content": "# Field Color-Coding Based on Choice Values\n\n## Purpose\nDynamically change the background color of any choice field on a form based on the selected backend value.\n\n## How to Use\n1. Create an OnChange client script on the desired choice field.\n2. Replace `'your_field_name'` in the script with your actual field name.\n3. Update the `colorMap` with relevant backend choice values and colors.\n4. Save and test on the form.\n\n## Key Points\n- Works with any choice field\n- Uses backend values of choices for mapping colors.\n\n## Demo\n\n\"image\"\n\n" }, { "path": "Client-Side Components/Client Scripts/Color-coded Priority field for improved UX/setColor.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n\n var colorMap = {\n '1': '#e74c3c', // Critical - strong red\n '2': '#e67e22', // High - bright orange\n '3': '#f1c40f', // Moderate - yellow\n '4': '#3498db', // Low - blue\n '5': '#27ae60' // Planning - green\n };\n\n var priorityField = g_form.getControl('priority');\n if (!priorityField) return;\n\n priorityField.style.backgroundColor = colorMap[newValue] || '';\n}\n" }, { "path": "Client-Side Components/Client Scripts/Conditional Auto-Routing and Dynamic Mandatory Fields/Conditional_AutoRouting_Dynamic_Mandatory_Fields.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading) return;\n\n if (newValue === 'hardware') {\n g_form.setMandatory('asset_tag', true);\n g_form.setDisplay('asset_tag', true);\n g_form.setValue('assignment_group', 'Hardware Support Group');\n } else if (newValue === 'software') {\n g_form.setMandatory('asset_tag', false);\n g_form.setDisplay('asset_tag', false);\n g_form.setValue('assignment_group', 'Software Support Group');\n } else {\n g_form.setMandatory('asset_tag', false);\n g_form.setDisplay('asset_tag', true);\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Conditional Auto-Routing and Dynamic Mandatory Fields/Readme.md", "content": "If an Incident Category = Hardware, make Asset Tag mandatory and automatically assign to Hardware Support Group.\nIf Software, assign to Software Support Group and hide Asset Tag.\n" }, { "path": "Client-Side Components/Client Scripts/Conditional Form Section based on Role/README.md", "content": "# Conditional Form Sections Based on User Role\n\n## Overview\nThis client script dynamically shows or hides specific sections of a form based on the logged-in user’s role. It ensures that only authorized users, such as managers, can view and interact with sensitive sections (e.g., budget approvals).\n\n## Use Case\n- Managers: Can see the Budget Approval section.\n- Other Users: The section remains hidden.\n\n## How It Works\n- The script runs onLoad of the form.\n- It checks if the logged-in user has the specified role (manager in this example).\n- If the user has the role, the Budget Approval section is shown. If not, it remains hidden.\n" }, { "path": "Client-Side Components/Client Scripts/Conditional Form Section based on Role/script.js", "content": "function onLoad() {\n var userHasRole = g_user.hasRole('case_manager'); // Check if user has specific role\n\n if (userHasRole) {\n g_form.setSectionDisplay('budget_approval', true); // Show section if user has specific role\n } else {\n g_form.setSectionDisplay('budget_approval', false);\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Control Form Behaviour from Reference Lookup/README.md", "content": "# Use Case\n\nClicking the lookup icon on a reference field opens the list view for the referenced table. On clicking the 'New' button to create new records on the reference table, 'Default' form view for that table is displayed. There might be a requirement to control the form's behaviour when the new record form is opened from a designated field on a specific table.\n\n\n# Usage\n\nWrite a client script/scripted UI policy on the reference table and add the code in ```script.js``` file.\n\n\n# Explanation\n\nThe URL parameters contains the necessary information about the originating table and field from where the lookup icon is clicked. These parameters can be extracted using the client-side class ```GlideURL```. Key parameters of interest here:\n - ```sysparm_nameofstack: \"reflist\"``` ==> Will always be reflist when form has originated from a reference lookup icon click\n - ```sysparm_target: \"change_request.cmdb_ci\"``` ==> Will be in the format .\n" }, { "path": "Client-Side Components/Client Scripts/Control Form Behaviour from Reference Lookup/script.js", "content": "\nvar url = new GlideURL();\nurl.setFromCurrent();\nvar source = url.getParam('sysparm_nameofstack'); // Always 'reflist' when opening from Reference Lookup Icon\nvar field = url.getParam('sysparm_target'); //Dot-walked path to the field (Example: cmdb_ci field on change_request form - change_request.cmdb_ci)\n\nif (source === 'reflist' && field === 'change_request.cmdb_ci') {\n\t// Add form control logic here\n\tg_form.setMandatory('name', true);\n}\n" }, { "path": "Client-Side Components/Client Scripts/Count Assigned To Field/README.md", "content": "Count Assigned To Field\n\n1. Write a Client Script name as getAssignedToCount\n2. Glide the Incident Table\n3. Use onChange Client Script\n4. Use the Field name as \"assigned_to\" field\n5. Glide the Script Include using \"GlideAjax\".\n6. Call the function \"getCount\" from Script Include\n7. Add the parameter for the newValue.\n8. Use the getXML for asynchronous response.\n9. Get the answer using the callback function\n10. Use the logic for the more than how many tickets that error needs to populate\n11. Use the addErrorMessage for marking the error message\n12. Use the setValue for the \"assigned_to\" field.\n" }, { "path": "Client-Side Components/Client Scripts/Count Assigned To Field/getAssignedToCount.js", "content": "function onChange(control,oldValue,newValue,isLoading,isTemplate) {\n if(isLoading || newValue === '') {\n return;\n }\n\n var ga = new GlideAjax('countAssignedUtil');\n ga.addParam('sysparm','getCount');\n ga.addParam('sysparm_assignedto', newValue);\n ga.getXML(callback);\n\n function callback(response){\n var answer = response.responseXML.documentElement.getAttribute(\"answer\");\n if(answer >=5){\n g_form.addErrorMessage(\"Please select another person to work on this Incident, selected user is already having 5 tickets in his/her Queue\");\n g_form.setValue(\"assigned_to\", \"\");\n }\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Date Range Validation (Within 30 Days)/README.md", "content": "Date Range Validation (Within 30 Days) in Client Side\n\nThis ServiceNow client script provides real-time date validation for form fields, ensuring users can only select dates within a specific 30-day window from today's date. The script runs automatically when a user changes a date field value, providing immediate feedback and preventing invalid date submissions.\n\nThe script validates that any date entered in a form field meets these criteria:\nMinimum Date: Today's date (no past dates allowed)\nMaximum Date: 30 days from today's date\nReal-time Validation: Instant feedback as users type or select dates\nUser-friendly Errors: Clear error messages explaining the valid date range\nAutomatic Field Clearing: Invalid dates are automatically cleared to prevent submission\n" }, { "path": "Client-Side Components/Client Scripts/Date Range Validation (Within 30 Days)/dateRangeValidation.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n \n var todayDate = new Date();\n var futureDate = new Date();\n futureDate.setDate(futureDate.getDate() + 30);\n \n var todayDateStr = formatDate(todayDate, g_user_date_format);\n var futureDateStr = formatDate(futureDate, g_user_date_format);\n \n var selectedDateNum = getDateFromFormat(newValue, g_user_date_format);\n var todayDateNum = getDateFromFormat(todayDateStr, g_user_date_format);\n var futureDateNum = getDateFromFormat(futureDateStr, g_user_date_format);\n \n if (selectedDateNum < todayDateNum || selectedDateNum > futureDateNum) {\n g_form.showFieldMsg(control, 'Date must be between today and 30 days from today', 'error');\n g_form.clearValue(control);\n } else {\n g_form.hideFieldMsg(control);\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Detect oldValue newValue and Operation in Glide List Type Fields/detectOldValuenewValueOperation.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading) {\n return;\n }\n\n var prevValue;\n if (g_scratchpad.prevValue == undefined)\n prevValue = oldValue;\n else {\n prevValue = g_scratchpad.prevValue;\n }\n g_scratchpad.prevValue = newValue;\n\n\n var oldGlideValue = prevValue.split(',');\n var newGlideValue = newValue.split(',');\n\n var operation;\n\n if (oldGlideValue.length > newGlideValue.length || newValue == '') {\n operation = 'remove';\n } else if (oldGlideValue.length < newGlideValue.length || oldGlideValue.length == newGlideValue.length) {\n operation = 'add';\n } else {\n operation = '';\n }\n\n var ajaxGetNames = new GlideAjax('watchListCandidatesUtil');\n ajaxGetNames.addParam('sysparm_name', 'getWatchListUsers');\n ajaxGetNames.addParam('sysparm_old_values', oldGlideValue);\n ajaxGetNames.addParam('sysparm_new_values', newGlideValue);\n ajaxGetNames.getXMLAnswer(function(response) {\n\n var result = JSON.parse(response);\n\n g_form.clearMessages();\n g_form.addSuccessMessage('Operation Performed : ' + operation);\n g_form.addSuccessMessage('OldValue : ' + result.oldU);\n g_form.addSuccessMessage('NewValue : ' + result.newU);\n\n });\n\n}\n" }, { "path": "Client-Side Components/Client Scripts/Detect oldValue newValue and Operation in Glide List Type Fields/readme.md", "content": "In Client Scripts, oldValue will display the value of last value/record which is stored in that field. \nFor new records, it is generally empty and for existing records it displays the value which is stored after load.\nIf we will try to change the value in that field, it will still show oldValue the same value which was there during the load of form.\n\nSo, In order to identify the oldValue on change(as it does in business rule(previous)), This script comes handy and also it will\ndetect the action performed.\n\n\nThis onChange Client script comes handy when dealing with Glide List type fields where we have to detect whether the value was added or removed and returns the display name of users who were added/removed along with name of operation performed.\n\nSetup details:\n\nonChange client Script on [incident] table\nField Name: [watch_list]\nScript: Check [detectOldValuenewValueOperation.js] file\nScript Include Name: watchListCandidatesUtil (client callable/GlideAjax Enabled - true), Check [watchListCandidatesUtil.js] file for script\n\n\n\nOutput:\n\nCurrently there is no one in the watchlist field:\n\n\"image\"\n\n\nAdding [Bryan Rovell], It shows the operation was addition, oldValue as 'No record found' as there was no value earlier.New Value shows the name of the user (Bryan Rovell)\n\"image\"\n\n\nAdding 2 users one by one:\n\n\"image\"\n\n\nRemoving 2 at once:\n\n\"image\"\n\n" }, { "path": "Client-Side Components/Client Scripts/Detect oldValue newValue and Operation in Glide List Type Fields/watchListCandidatesUtil.js", "content": "var watchListCandidatesUtil = Class.create();\nwatchListCandidatesUtil.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n\n\n getWatchListUsers: function() {\n\n var oldUsers = this.getParameter('sysparm_old_values');\n var newUsers = this.getParameter('sysparm_new_values');\n\n var result = {\n oldU: this._getUserNames(oldUsers),\n newU: this._getUserNames(newUsers)\n };\n\n return JSON.stringify(result);\n },\n\n \n _getUserNames: function(userList) {\n var names = [];\n\n var grUserTab = new GlideRecord('sys_user');\n grUserTab.addQuery('sys_id', 'IN', userList);\n grUserTab.query();\n if (grUserTab.hasNext()) {\n while (grUserTab.next()) {\n names.push(grUserTab.getDisplayValue('name'));\n }\n return names.toString();\n } else {\n return 'No record found';\n }\n },\n\n\n type: 'watchListCandidatesUtil'\n});\n" }, { "path": "Client-Side Components/Client Scripts/Display Custom Field Based on Incident Channel Field and populate with Caller Information/GlideAjaxCallerInfo.js", "content": "var CallerInfoHelper = Class.create();\nCallerInfoHelper.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n\n getCallerInfo: function() {\n var callerSysId = this.getParameter('sysparm_caller');\n if (!callerSysId)\n return JSON.stringify({ email: '', mobile: '' });\n\n var userGR = new GlideRecord('sys_user');\n if (!userGR.get(callerSysId))\n return JSON.stringify({ email: '', mobile: '' });\n\n var userObj = {\n email: userGR.email.toString(),\n mobile: userGR.mobile_phone.toString()\n };\n\n return JSON.stringify(userObj);\n },\n\n type: 'CallerInfoHelper'\n});\n" }, { "path": "Client-Side Components/Client Scripts/Display Custom Field Based on Incident Channel Field and populate with Caller Information/README.md", "content": "# Display Custom Email/Phone Field Based on Incident Channel Field and Populate those Field with Caller Information\n\nDisplays either the **Email** or **Phone** field on the **Incident** form based on the selected **Channel** value (Email or Phone) and populate the fields with the caller’s details.\n\n### Use Case\n- When **Channel = Email**, the **Email** field becomes visible and is auto-populated with the caller’s email address \n- When **Channel = Phone**, the **Phone** field becomes visible and is auto-populated with the caller’s mobile number \n- Both details fetched from the caller’s record from **sys_user** table. \n- The custom Email and Phone fields may also serve as placeholder to update if details differ from the caller record\n\n### Prerequisites\n- Create Two custom fields on Incident Table\n - **u_email** which captures store the caller’s email address\n - **u_phone** which capture caller’s mobile number\n- Create **Two UI Policies** which hides the u_email and u_phone field unless channel choice is phone or email\n- Create an onChange Client Script that calls a GlideAjax Script to fetch the caller’s contact details and populate the custom Email or Phone field on the Incident form\n- To further enhance usecase Regex used on Phone field. Refer (https://github.com/ServiceNowDevProgram/code-snippets/pull/2375)\n \n---\n\n### Incident Record when channel choice is other than Email or Phone \n\n![Display_CustomField_Autopopulate_Caller_3](Display_CustomField_Autopopulate_Caller_3.png)\n\n---\n\n### Incident Record when Channel choice is email and populate Email Field by caller's Email\n\n![Display_CustomField_Autopopulate_Caller_1](Display_CustomField_Autopopulate_Caller_1.png)\n\n---\n\n### Incident Record when channel choice is phone and populate Phone Field by caller's Phone Number\n\n![Display_CustomField_Autopopulate_Caller_2](Display_CustomField_Autopopulate_Caller_2.png)\n\n---\n\n\n\n\n\n\n" }, { "path": "Client-Side Components/Client Scripts/Display Custom Field Based on Incident Channel Field and populate with Caller Information/clientScriptOnChangeCaller.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || newValue === '') return;\n\n var ga = new GlideAjax('CallerInfoHelper');\n ga.addParam('sysparm_name', 'getCallerInfo');\n ga.addParam('sysparm_caller', newValue);\n\n ga.getXMLAnswer(function(answer) {\n // Confirm what you’re actually receiving\n console.log(\"GlideAjax raw answer:\", answer);\n\n if (!answer) return;\n\n var info;\n try {\n info = JSON.parse(answer);\n } catch (e) {\n console.log(\"Error parsing JSON:\", e);\n return;\n }\n\n g_form.setValue('u_email', info.email || '');\n g_form.setValue('u_phone', info.mobile || '');\n\n });\n}\n" }, { "path": "Client-Side Components/Client Scripts/Display Incident Count of Assigned-To User When Field Changes/README.md", "content": "## Display Info Message of Incident Count of Assigned-To User When Field Assigned-To Changes\n\nDisplays a message showing the count of **open incidents** assigned to a user whenever the **Assigned To** field changes on the Incident form. \n\n- Helps assess the assignee’s **current workload** by fetching and displaying active incident counts (excluding *Resolved*, *Closed*, and *Canceled* states)\n- Shows an **info message** with the count of the assignee's assigned incidents\n- Uses an **onChange Client Script** on the **Assigned To** field and a **GlideAjax Script Include** called from the client script to fetch the count dynamically\n\n---\n\n### Info Message Example 1 \n![Incident_Count_message_1](Incident_Count_message_1.png)\n\n### Info Message Example 2 \n![Incident_Count_message_2](Incident_Count_message_2.png)\n\n---\n" }, { "path": "Client-Side Components/Client Scripts/Display Incident Count of Assigned-To User When Field Changes/clientScript.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') return;\n\n // Clear any previous messages\n g_form.clearMessages();\n\n // Create GlideAjax object to call the Script Include\n var ga = new GlideAjax('IncidentAssignmentCheck');\n ga.addParam('sysparm_name', 'getIncidentCount');\n ga.addParam('sysparm_user', newValue);\n\n \n ga.getXMLAnswer(function(response) {\n var count = parseInt(response, 10);\n\n \n if (isNaN(count)) {\n g_form.addErrorMessage(\"Could not retrieve open incident count.\");\n return;\n }\n\n var userName = g_form.getDisplayValue('assigned_to');\n var msg = userName + \" currently has \" + count + \" incidents assigned \";\n\n if (count >= 5) {\n g_form.addInfoMessage(msg + \" Please review workload before assigning more incidents\");\n } else {\n g_form.addInfoMessage(msg);\n }\n });\n}\n" }, { "path": "Client-Side Components/Client Scripts/Display Incident Count of Assigned-To User When Field Changes/glideAjaxIncidentCount.js", "content": "var IncidentAssignmentCheck = Class.create();\nIncidentAssignmentCheck.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n\n getIncidentCount: function() {\n var user = this.getParameter('sysparm_user');\n var count = 0;\n\n if (user) {\n var gr = new GlideAggregate('incident');\n gr.addQuery('assigned_to', user);\n gr.addQuery('state', 'NOT IN', '6,7,8');\n gr.addAggregate('COUNT');a\n gr.query();\n\n if (gr.next()) {\n count = gr.getAggregate('COUNT');\n }\n }\n return count;\n },\n\n type: 'IncidentAssignmentCheck'\n});\n" }, { "path": "Client-Side Components/Client Scripts/Display Section on State/README.md", "content": "# Display Section Based on State\n\n## Overview\nThis client script dynamically displays specific sections on a form based on the selected State field value. It improves user experience by hiding or showing relevant sections as needed.\n\n## How It Works\n- When the State field changes, the script checks the new value.\n- For Example, if the state is changed to \"Resolved\", the Resolution Section becomes visible.\n- For other states, the section remains hidden.\n" }, { "path": "Client-Side Components/Client Scripts/Display Section on State/script.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n\n if (newValue == 6) //State on which section needs to be displayed\n\t\t g_form.setSectionDisplay('resolution_information', true); //Section which needs to be display\n\telse\n\t\tg_form.setSectionDisplay('resolution_information', false); \n}\n" }, { "path": "Client-Side Components/Client Scripts/Display a Live Word Count for Description Field/README.md", "content": "The script enhances a form field (specifically the description field) by:\n-Adding a live word counter below the field.\n-Visually warning the user if the word count exceeds 150 words.\n\nThis client-side script, intended for use in a ServiceNow form (e.g., catalog item or incident form), dynamically appends a custom `
` element below the `description` field to display a real-time word count. It leverages the `g_form.getControl()` API to access the field's DOM element and attaches an `input` event listener to monitor user input. The script calculates the word count by splitting the input text using a regular expression (`\\s+`) and updates the counter accordingly. It applies conditional styling to the counter (`green` if ≤150 words, `red` if >150), providing immediate visual feedback to the user to enforce input constraints.\n" }, { "path": "Client-Side Components/Client Scripts/Display a Live Word Count for Description Field/code.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === oldValue) {\n return;\n }\n\n var wordCount = newValue.trim().split(/\\s+/).length;\n var message = 'Word Count: ' + (newValue ? wordCount : 0);\n var messageType = (wordCount > 150) ? 'error' : 'info';\n\n g_form.showFieldMsg('description', message, messageType);\n}\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic Field Dependencies with GlideAjax/README.md", "content": "# Dynamic Field Dependencies with GlideAjax\n\nThis folder contains advanced Client Script examples demonstrating real-time field dependencies using GlideAjax for server-side data retrieval, cascading dropdowns, and dynamic form behavior.\n\n## Overview\n\nModern ServiceNow forms often require dynamic behavior based on user selections. This example demonstrates:\n- **Real-time field updates** using GlideAjax for server-side queries\n- **Cascading dropdown menus** that filter based on parent selections\n- **Conditional field visibility** based on complex business logic\n- **Debouncing** to prevent excessive server calls\n- **Loading indicators** for better user experience\n- **Error handling** for failed AJAX calls\n- **Performance optimization** with caching and batching\n\n## Script Descriptions\n\n- **dynamic_category_subcategory.js**: Client Script implementing cascading category/subcategory dropdowns with real-time filtering.\n- **conditional_field_loader.js**: Advanced example showing conditional field loading based on multiple dependencies.\n- **ajax_script_include.js**: Server-side Script Include (Client Callable) that provides data for the client scripts.\n- **debounced_field_validator.js**: Real-time field validation with debouncing to reduce server load.\n\n## Key Features\n\n### 1. GlideAjax Communication\nEfficient client-server communication:\n```javascript\nvar ga = new GlideAjax('MyScriptInclude');\nga.addParam('sysparm_name', 'getSubcategories');\nga.addParam('sysparm_category', categoryValue);\nga.getXMLAnswer(callback);\n```\n\n### 2. Cascading Dropdowns\nDynamic filtering of child fields:\n- Parent field change triggers child field update\n- Child options filtered based on parent selection\n- Multiple levels of cascading supported\n- Maintains previously selected values when possible\n\n### 3. Debouncing\nPrevents excessive server calls:\n- Waits for user to stop typing before making request\n- Configurable delay (typically 300-500ms)\n- Cancels pending requests when new input received\n- Improves performance and user experience\n\n### 4. Loading Indicators\nVisual feedback during AJAX calls:\n- Shows loading spinner or message\n- Disables fields during data fetch\n- Clears loading state on completion or error\n- Prevents duplicate submissions\n\n## Use Cases\n\n- **Category/Subcategory Selection**: Filter subcategories based on selected category\n- **Location-Based Fields**: Update city/state/country fields dynamically\n- **Product Configuration**: Show/hide fields based on product type\n- **Assignment Rules**: Dynamically populate assignment groups based on category\n- **Cost Estimation**: Calculate and display costs based on selections\n- **Availability Checking**: Real-time validation of resource availability\n- **Dynamic Pricing**: Update pricing fields based on quantity/options\n\n## Implementation Requirements\n\n### Client Script Configuration\n- **Type**: onChange (for field changes) or onLoad (for initial setup)\n- **Table**: Target table (e.g., incident, sc_req_item)\n- **Field**: Trigger field (e.g., category)\n- **Active**: true\n- **Global**: false (table-specific for better performance)\n\n### Script Include Configuration\n- **Name**: Descriptive name (e.g., CategoryAjaxUtils)\n- **Client callable**: true (REQUIRED for GlideAjax)\n- **Active**: true\n- **Access**: public or specific roles\n\n### Required Fields\nEnsure dependent fields exist on the form:\n- Add fields to form layout\n- Configure field properties (mandatory, read-only, etc.)\n- Set up choice lists for dropdown fields\n\n## Performance Considerations\n\n### Optimization Techniques\n1. **Cache responses**: Store frequently accessed data client-side\n2. **Batch requests**: Combine multiple queries into single AJAX call\n3. **Minimize payload**: Return only required fields\n4. **Use indexed queries**: Ensure server-side queries use indexed fields\n5. **Debounce input**: Wait for user to finish typing\n6. **Lazy loading**: Load data only when needed\n\n### Best Practices\n- Keep Script Includes focused and single-purpose\n- Validate input parameters server-side\n- Handle errors gracefully with user-friendly messages\n- Test with large datasets to ensure performance\n- Use browser developer tools to monitor network calls\n- Implement timeout handling for slow connections\n\n## Security Considerations\n\n### Input Validation\nAlways validate parameters server-side:\n```javascript\n// BAD: No validation\nvar category = this.getParameter('sysparm_category');\nvar gr = new GlideRecord('cmdb_ci_category');\ngr.addQuery('parent', category); // SQL injection risk\n\n// GOOD: Validate and sanitize\nvar category = this.getParameter('sysparm_category');\nif (!category || !this._isValidSysId(category)) {\n return '[]';\n}\n```\n\n### Access Control\n- Respect ACLs in Script Includes\n- Use GlideRecordSecure when appropriate\n- Don't expose sensitive data to client\n- Implement role-based filtering\n\n### XSS Prevention\n- Sanitize data before displaying\n- Use g_form.setValue() instead of innerHTML\n- Validate choice list values\n- Escape special characters\n\n## Error Handling\n\n### Client-Side\n```javascript\nga.getXMLAnswer(function(response) {\n if (!response || response === 'error') {\n g_form.addErrorMessage('Failed to load data. Please try again.');\n return;\n }\n // Process response\n});\n```\n\n### Server-Side\n```javascript\ntry {\n // Query logic\n} catch (ex) {\n gs.error('Error in getSubcategories: ' + ex.message);\n return 'error';\n}\n```\n\n## Testing Checklist\n\n- [ ] Test with empty/null values\n- [ ] Test with invalid input\n- [ ] Test with large datasets (1000+ records)\n- [ ] Test on slow network connections\n- [ ] Test concurrent user interactions\n- [ ] Test browser compatibility (Chrome, Firefox, Safari, Edge)\n- [ ] Test mobile responsiveness\n- [ ] Verify ACL enforcement\n- [ ] Check for console errors\n- [ ] Monitor network tab for performance\n\n## Browser Compatibility\n\nTested and compatible with:\n- Chrome 90+\n- Firefox 88+\n- Safari 14+\n- Edge 90+\n- ServiceNow Mobile App\n\n## Related APIs\n\n- **GlideAjax**: Client-server communication\n- **GlideForm (g_form)**: Form manipulation\n- **GlideUser (g_user)**: User context\n- **GlideRecord**: Server-side queries\n- **JSON**: Data serialization\n\n## Additional Resources\n\n- ServiceNow Client Script Best Practices\n- GlideAjax Documentation\n- Client-Side Scripting API Reference\n- Performance Optimization Guide\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic Field Dependencies with GlideAjax/ajax_script_include.js", "content": "/**\n * CategoryAjaxUtils Script Include\n * \n * Name: CategoryAjaxUtils\n * Client callable: true (REQUIRED)\n * Active: true\n * \n * Description: Server-side Script Include providing data for dynamic field dependencies\n * Supports multiple AJAX methods for category/subcategory and related field operations\n */\n\nvar CategoryAjaxUtils = Class.create();\nCategoryAjaxUtils.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n \n /**\n * Get subcategories for a given category\n * Parameters: sysparm_category, sysparm_table\n * Returns: JSON array of {value, label} objects\n */\n getSubcategories: function() {\n var category = this.getParameter('sysparm_category');\n var table = this.getParameter('sysparm_table') || 'incident';\n \n // Validate input\n if (!category) {\n return JSON.stringify([]);\n }\n \n var subcategories = [];\n \n try {\n // Query subcategory choices\n var gr = new GlideRecord('sys_choice');\n gr.addQuery('name', table);\n gr.addQuery('element', 'subcategory');\n gr.addQuery('dependent_value', category);\n gr.addQuery('inactive', false);\n gr.orderBy('sequence');\n gr.orderBy('label');\n gr.query();\n \n while (gr.next()) {\n subcategories.push({\n value: gr.getValue('value'),\n label: gr.getValue('label')\n });\n }\n \n // If no dependent choices found, get all subcategories\n if (subcategories.length === 0) {\n gr = new GlideRecord('sys_choice');\n gr.addQuery('name', table);\n gr.addQuery('element', 'subcategory');\n gr.addQuery('inactive', false);\n gr.orderBy('sequence');\n gr.orderBy('label');\n gr.setLimit(100); // Limit to prevent performance issues\n gr.query();\n \n while (gr.next()) {\n subcategories.push({\n value: gr.getValue('value'),\n label: gr.getValue('label')\n });\n }\n }\n \n } catch (ex) {\n gs.error('[CategoryAjaxUtils] Error in getSubcategories: ' + ex.message);\n return 'error';\n }\n \n return JSON.stringify(subcategories);\n },\n \n /**\n * Get all dependent field data in a single call (performance optimization)\n * Parameters: sysparm_category, sysparm_priority, sysparm_assignment_group, sysparm_table\n * Returns: JSON object with multiple field data\n */\n getDependentFields: function() {\n var category = this.getParameter('sysparm_category');\n var priority = this.getParameter('sysparm_priority');\n var assignmentGroup = this.getParameter('sysparm_assignment_group');\n var table = this.getParameter('sysparm_table') || 'incident';\n \n var result = {\n subcategories: [],\n suggested_assignment_group: null,\n sla_info: null,\n estimated_cost: null,\n recommendations: []\n };\n \n try {\n // Get subcategories\n result.subcategories = this._getSubcategoriesArray(category, table);\n \n // Get suggested assignment group based on category\n result.suggested_assignment_group = this._getSuggestedAssignmentGroup(category);\n \n // Get SLA information\n result.sla_info = this._getSLAInfo(category, priority);\n \n // Get estimated cost (if applicable)\n result.estimated_cost = this._getEstimatedCost(category, priority);\n \n // Get recommendations\n result.recommendations = this._getRecommendations(category, priority);\n \n } catch (ex) {\n gs.error('[CategoryAjaxUtils] Error in getDependentFields: ' + ex.message);\n return 'error';\n }\n \n return JSON.stringify(result);\n },\n \n /**\n * Validate field dependencies\n * Parameters: sysparm_category, sysparm_subcategory\n * Returns: JSON object with validation result\n */\n validateDependencies: function() {\n var category = this.getParameter('sysparm_category');\n var subcategory = this.getParameter('sysparm_subcategory');\n \n var result = {\n valid: false,\n message: ''\n };\n \n try {\n // Check if subcategory is valid for the category\n var gr = new GlideRecord('sys_choice');\n gr.addQuery('name', 'incident');\n gr.addQuery('element', 'subcategory');\n gr.addQuery('value', subcategory);\n gr.addQuery('dependent_value', category);\n gr.query();\n \n if (gr.hasNext()) {\n result.valid = true;\n result.message = 'Valid combination';\n } else {\n result.valid = false;\n result.message = 'Invalid subcategory for selected category';\n }\n \n } catch (ex) {\n gs.error('[CategoryAjaxUtils] Error in validateDependencies: ' + ex.message);\n result.valid = false;\n result.message = 'Validation error: ' + ex.message;\n }\n \n return JSON.stringify(result);\n },\n \n // ========================================\n // Private Helper Methods\n // ========================================\n \n /**\n * Get subcategories as array (internal method)\n * @private\n */\n _getSubcategoriesArray: function(category, table) {\n var subcategories = [];\n \n var gr = new GlideRecord('sys_choice');\n gr.addQuery('name', table);\n gr.addQuery('element', 'subcategory');\n gr.addQuery('dependent_value', category);\n gr.addQuery('inactive', false);\n gr.orderBy('sequence');\n gr.orderBy('label');\n gr.query();\n \n while (gr.next()) {\n subcategories.push({\n value: gr.getValue('value'),\n label: gr.getValue('label')\n });\n }\n \n return subcategories;\n },\n \n /**\n * Get suggested assignment group based on category\n * @private\n */\n _getSuggestedAssignmentGroup: function(category) {\n // This could be a lookup table or business rule\n // For demonstration, using a simple mapping\n var categoryGroupMap = {\n 'hardware': 'Hardware Support',\n 'software': 'Application Support',\n 'network': 'Network Operations',\n 'database': 'Database Team',\n 'inquiry': 'Service Desk'\n };\n \n var groupName = categoryGroupMap[category];\n if (!groupName) {\n return null;\n }\n \n // Look up the actual group sys_id\n var gr = new GlideRecord('sys_user_group');\n gr.addQuery('name', groupName);\n gr.addQuery('active', true);\n gr.query();\n \n if (gr.next()) {\n return gr.getUniqueValue();\n }\n \n return null;\n },\n \n /**\n * Get SLA information based on category and priority\n * @private\n */\n _getSLAInfo: function(category, priority) {\n // Simplified SLA calculation\n // In production, this would query actual SLA definitions\n var resolutionHours = 24; // Default\n \n if (priority == '1') {\n resolutionHours = 4;\n } else if (priority == '2') {\n resolutionHours = 8;\n } else if (priority == '3') {\n resolutionHours = 24;\n } else if (priority == '4') {\n resolutionHours = 72;\n }\n \n // Adjust based on category\n if (category === 'hardware') {\n resolutionHours *= 1.5; // Hardware takes longer\n }\n \n return {\n resolution_time: resolutionHours,\n response_time: resolutionHours / 4\n };\n },\n \n /**\n * Get estimated cost based on category and priority\n * @private\n */\n _getEstimatedCost: function(category, priority) {\n // Simplified cost estimation\n var baseCost = 100;\n \n var categoryMultiplier = {\n 'hardware': 2.0,\n 'software': 1.5,\n 'network': 1.8,\n 'database': 1.7,\n 'inquiry': 0.5\n };\n \n var priorityMultiplier = {\n '1': 3.0,\n '2': 2.0,\n '3': 1.0,\n '4': 0.5,\n '5': 0.3\n };\n \n var catMult = categoryMultiplier[category] || 1.0;\n var priMult = priorityMultiplier[priority] || 1.0;\n \n return Math.round(baseCost * catMult * priMult);\n },\n \n /**\n * Get recommendations based on category and priority\n * @private\n */\n _getRecommendations: function(category, priority) {\n var recommendations = [];\n \n // Add category-specific recommendations\n if (category === 'hardware') {\n recommendations.push('Attach hardware diagnostic logs');\n recommendations.push('Include serial number and model');\n } else if (category === 'software') {\n recommendations.push('Include application version');\n recommendations.push('Attach error screenshots');\n } else if (category === 'network') {\n recommendations.push('Run network diagnostics');\n recommendations.push('Include IP address and subnet');\n }\n \n // Add priority-specific recommendations\n if (priority == '1' || priority == '2') {\n recommendations.push('Consider escalating to manager');\n recommendations.push('Notify stakeholders immediately');\n }\n \n return recommendations;\n },\n \n /**\n * Validate if a string is a valid sys_id\n * @private\n */\n _isValidSysId: function(value) {\n if (!value || typeof value !== 'string') {\n return false;\n }\n // sys_id is 32 character hex string\n return /^[0-9a-f]{32}$/.test(value);\n },\n \n type: 'CategoryAjaxUtils'\n});\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic Field Dependencies with GlideAjax/conditional_field_loader.js", "content": "/**\n * Advanced Conditional Field Loader with Multiple Dependencies\n * \n * Table: incident\n * Type: onChange\n * Field: category, priority, assignment_group (multiple scripts or combined)\n * \n * Description: Shows/hides and populates fields based on multiple conditions\n * Demonstrates debouncing, caching, and complex business logic\n */\n\n// Global cache object (persists across onChange calls)\nif (typeof window.fieldDependencyCache === 'undefined') {\n window.fieldDependencyCache = {};\n window.fieldDependencyTimers = {};\n}\n\n/**\n * Main onChange handler for category field\n */\nfunction onChangeCategoryWithDependencies(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading) {\n return;\n }\n \n var priority = g_form.getValue('priority');\n var assignmentGroup = g_form.getValue('assignment_group');\n \n // Update field visibility based on category\n updateFieldVisibility(newValue);\n \n // Load dependent data with debouncing\n loadDependentFields(newValue, priority, assignmentGroup);\n}\n\n/**\n * Update field visibility based on category selection\n */\nfunction updateFieldVisibility(category) {\n // Example: Show additional fields for specific categories\n var showAdvancedFields = false;\n var showHardwareFields = false;\n \n // Check cache first\n var cacheKey = 'visibility_' + category;\n if (window.fieldDependencyCache[cacheKey]) {\n var cached = window.fieldDependencyCache[cacheKey];\n showAdvancedFields = cached.advanced;\n showHardwareFields = cached.hardware;\n } else {\n // Determine visibility (this could also be an AJAX call)\n if (category === 'hardware' || category === 'network') {\n showHardwareFields = true;\n }\n \n if (category === 'software' || category === 'database') {\n showAdvancedFields = true;\n }\n \n // Cache the result\n window.fieldDependencyCache[cacheKey] = {\n advanced: showAdvancedFields,\n hardware: showHardwareFields\n };\n }\n \n // Show/hide fields with animation\n if (showHardwareFields) {\n g_form.setSectionDisplay('hardware_details', true);\n g_form.setDisplay('cmdb_ci', true);\n g_form.setDisplay('hardware_model', true);\n g_form.setMandatory('cmdb_ci', true);\n } else {\n g_form.setSectionDisplay('hardware_details', false);\n g_form.setDisplay('cmdb_ci', false);\n g_form.setDisplay('hardware_model', false);\n g_form.setMandatory('cmdb_ci', false);\n g_form.clearValue('cmdb_ci');\n g_form.clearValue('hardware_model');\n }\n \n if (showAdvancedFields) {\n g_form.setDisplay('application', true);\n g_form.setDisplay('version', true);\n g_form.setMandatory('application', true);\n } else {\n g_form.setDisplay('application', false);\n g_form.setDisplay('version', false);\n g_form.setMandatory('application', false);\n g_form.clearValue('application');\n g_form.clearValue('version');\n }\n}\n\n/**\n * Load dependent fields with debouncing to prevent excessive AJAX calls\n */\nfunction loadDependentFields(category, priority, assignmentGroup) {\n // Clear existing timer\n if (window.fieldDependencyTimers.loadFields) {\n clearTimeout(window.fieldDependencyTimers.loadFields);\n }\n \n // Set new timer (debounce for 300ms)\n window.fieldDependencyTimers.loadFields = setTimeout(function() {\n executeDependentFieldLoad(category, priority, assignmentGroup);\n }, 300);\n}\n\n/**\n * Execute the actual AJAX call to load dependent data\n */\nfunction executeDependentFieldLoad(category, priority, assignmentGroup) {\n // Check cache first\n var cacheKey = 'fields_' + category + '_' + priority + '_' + assignmentGroup;\n if (window.fieldDependencyCache[cacheKey]) {\n applyDependentFieldData(window.fieldDependencyCache[cacheKey]);\n return;\n }\n \n // Show loading indicators\n showLoadingIndicators(['subcategory', 'assignment_group', 'assigned_to']);\n \n // Make AJAX call\n var ga = new GlideAjax('CategoryAjaxUtils');\n ga.addParam('sysparm_name', 'getDependentFields');\n ga.addParam('sysparm_category', category);\n ga.addParam('sysparm_priority', priority);\n ga.addParam('sysparm_assignment_group', assignmentGroup);\n ga.addParam('sysparm_table', g_form.getTableName());\n \n ga.getXMLAnswer(function(response) {\n // Hide loading indicators\n hideLoadingIndicators(['subcategory', 'assignment_group', 'assigned_to']);\n \n if (!response || response === 'error') {\n g_form.addErrorMessage('Failed to load dependent fields. Please refresh and try again.');\n return;\n }\n \n try {\n var data = JSON.parse(response);\n \n // Cache the response\n window.fieldDependencyCache[cacheKey] = data;\n \n // Apply the data\n applyDependentFieldData(data);\n \n } catch (ex) {\n g_form.addErrorMessage('Error processing field dependencies: ' + ex.message);\n console.error('Field dependency error:', ex);\n }\n });\n}\n\n/**\n * Apply dependent field data to the form\n */\nfunction applyDependentFieldData(data) {\n // Update subcategories\n if (data.subcategories) {\n g_form.clearOptions('subcategory');\n for (var i = 0; i < data.subcategories.length; i++) {\n var sub = data.subcategories[i];\n g_form.addOption('subcategory', sub.value, sub.label);\n }\n }\n \n // Update suggested assignment group\n if (data.suggested_assignment_group) {\n g_form.setValue('assignment_group', data.suggested_assignment_group);\n g_form.showFieldMsg('assignment_group', 'Auto-populated based on category', 'info', 3000);\n }\n \n // Update SLA information\n if (data.sla_info) {\n var slaMsg = 'Expected resolution time: ' + data.sla_info.resolution_time + ' hours';\n g_form.showFieldMsg('priority', slaMsg, 'info');\n }\n \n // Update estimated cost (if applicable)\n if (data.estimated_cost) {\n g_form.setValue('estimated_cost', data.estimated_cost);\n }\n \n // Show recommendations\n if (data.recommendations && data.recommendations.length > 0) {\n var recMsg = 'Recommendations: ' + data.recommendations.join(', ');\n g_form.addInfoMessage(recMsg);\n }\n}\n\n/**\n * Show loading indicators on multiple fields\n */\nfunction showLoadingIndicators(fields) {\n for (var i = 0; i < fields.length; i++) {\n var field = fields[i];\n g_form.showFieldMsg(field, 'Loading...', 'info');\n g_form.setReadOnly(field, true);\n }\n}\n\n/**\n * Hide loading indicators on multiple fields\n */\nfunction hideLoadingIndicators(fields) {\n for (var i = 0; i < fields.length; i++) {\n var field = fields[i];\n g_form.hideFieldMsg(field);\n g_form.setReadOnly(field, false);\n }\n}\n\n/**\n * Clear cache (useful for testing or when data changes)\n */\nfunction clearFieldDependencyCache() {\n window.fieldDependencyCache = {};\n console.log('Field dependency cache cleared');\n}\n\n/**\n * onLoad script to initialize form\n * Type: onLoad\n */\nfunction onLoadInitializeDependencies() {\n // Initialize cache\n if (typeof window.fieldDependencyCache === 'undefined') {\n window.fieldDependencyCache = {};\n window.fieldDependencyTimers = {};\n }\n \n // Load initial dependencies if category is already set\n var category = g_form.getValue('category');\n if (category) {\n updateFieldVisibility(category);\n }\n \n // Add cache clear button for admins (optional)\n if (g_user.hasRole('admin')) {\n console.log('Field dependency cache available. Use clearFieldDependencyCache() to clear.');\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic Field Dependencies with GlideAjax/dynamic_category_subcategory.js", "content": "/**\n * Dynamic Category/Subcategory Client Script\n * \n * Table: incident (or any table with category/subcategory fields)\n * Type: onChange\n * Field: category\n * \n * Description: Dynamically populates subcategory field based on selected category\n * using GlideAjax to fetch filtered options from server\n */\n\nfunction onChange(control, oldValue, newValue, isLoading, isTemplate) {\n // Don't run during form load or if value hasn't changed\n if (isLoading || newValue === '') {\n return;\n }\n \n // Clear subcategory when category changes\n g_form.clearValue('subcategory');\n \n // Show loading indicator\n g_form.showFieldMsg('subcategory', 'Loading subcategories...', 'info');\n g_form.setReadOnly('subcategory', true);\n \n // Make AJAX call to get filtered subcategories\n var ga = new GlideAjax('CategoryAjaxUtils');\n ga.addParam('sysparm_name', 'getSubcategories');\n ga.addParam('sysparm_category', newValue);\n ga.addParam('sysparm_table', g_form.getTableName());\n \n ga.getXMLAnswer(function(response) {\n // Clear loading indicator\n g_form.hideFieldMsg('subcategory');\n g_form.setReadOnly('subcategory', false);\n \n // Handle error response\n if (!response || response === 'error') {\n g_form.addErrorMessage('Failed to load subcategories. Please try again.');\n return;\n }\n \n // Parse response\n try {\n var subcategories = JSON.parse(response);\n \n // Clear existing options (except empty option)\n g_form.clearOptions('subcategory');\n \n // Add new options\n if (subcategories.length === 0) {\n g_form.addInfoMessage('No subcategories available for this category.');\n g_form.setReadOnly('subcategory', true);\n } else {\n // Add each subcategory as an option\n for (var i = 0; i < subcategories.length; i++) {\n var sub = subcategories[i];\n g_form.addOption('subcategory', sub.value, sub.label);\n }\n \n // Auto-select if only one option\n if (subcategories.length === 1) {\n g_form.setValue('subcategory', subcategories[0].value);\n }\n \n // Show success message\n g_form.showFieldMsg('subcategory', subcategories.length + ' subcategories loaded', 'info', 2000);\n }\n \n } catch (ex) {\n g_form.addErrorMessage('Error parsing subcategory data: ' + ex.message);\n console.error('Subcategory parsing error:', ex);\n }\n });\n}\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic Location Validation Approach/Readme.md", "content": "**User Location Validator**\nThis script restricts form submissions based on the physical location of the user. The current location is obtained using the browser’s geolocation API (latitude and longitude), and is then compared against the user's assigned business location stored in ServiceNow.\n\n**How It Works**\n- The **server-side Script Include**(UserLocationUtils.js) fetches the assigned business location’s latitude, longitude, and name for the logged-in user.\n- The **client-side script**(User Location Validator.js) uses the browser API to obtain the current latitude and longitude of the user at form submission.\n- It calculates the distance between these two points using the **Haversine formula**, which accounts for the spherical shape of the Earth.\n- The key constant `earthRadiusKm = 6371` defines the Earth's radius in kilometers and is essential for accurate distance calculation.\n- If the user’s current location is outside the predefined radius (default 10 km), the form submission is blocked with an error message showing the distance and allowed location.\n- If the user is within range, a confirmation info message is displayed and the submission proceeds.\n\n**Sample Output**\n- **Success:** \"Location validated successfully within range of Headquarters.\"\n- **Failure:** \"You are 15.23 km away from your registered location: Headquarters.\"\n\n**Usage Notes**\n- Requires user consent for geolocation access in the browser.\n- The script uses descriptive variable names for clarity and maintainability.\n- Suitable for scenarios requiring geo-fencing compliance or location-based workflow restrictions.\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic Location Validation Approach/User Location Validator.js", "content": "function onSubmit() {\n // Check if the browser supports geolocation\n if (\"geolocation\" in navigator) {\n // Request current user position\n navigator.geolocation.getCurrentPosition(function(position) {\n var currentLatitude = position.coords.latitude; // Current user latitude\n var currentLongitude = position.coords.longitude; // Current user longitude\n\n // Allowed business location coordinates fetched from server\n var allowedLatitude = locData.latitude;\n var allowedLongitude = locData.longitude;\n var locationName = locData.name;\n\n // Earth's radius in kilometers - constant used in distance calculation formula\n var earthRadiusKm = 6371;\n\n // Convert degree differences to radians\n var deltaLatitude = (currentLatitude - allowedLatitude) * Math.PI / 180;\n var deltaLongitude = (currentLongitude - allowedLongitude) * Math.PI / 180;\n\n // Haversine formula components\n var a = Math.sin(deltaLatitude / 2) * Math.sin(deltaLatitude / 2) +\n Math.cos(allowedLatitude * Math.PI / 180) *\n Math.cos(currentLatitude * Math.PI / 180) *\n Math.sin(deltaLongitude / 2) * Math.sin(deltaLongitude / 2);\n\n var c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a));\n\n // Calculate distance in kilometers between current and allowed locations\n var distanceKm = earthRadiusKm * c;\n\n // Check if user's current distance exceeds tolerance (e.g., 10 km)\n if (distanceKm > 10) {\n alert(\"You are \" + distanceKm.toFixed(2) + \" km away from your registered location: \" + locationName);\n g_form.addErrorMessage(\"Location validation failed: Submission outside the allowed radius.\");\n return false; // Cancel form submission\n } else {\n g_form.addInfoMessage(\"Location validated successfully within range of \" + locationName);\n return true; // Allow form submission\n }\n }, function(error) {\n alert(\"Geolocation error: \" + error.message);\n return false; // Stop submission if geolocation fails\n });\n\n // Prevent form submission while waiting for async geolocation result\n return false;\n } else {\n g_form.addErrorMessage(\"Geolocation is not supported by your browser.\");\n return false; // Block if geolocation API unsupported\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic Location Validation Approach/UserLocationUtils.js", "content": "var UserLocationUtils = Class.create();\nUserLocationUtils.prototype = {\n initialize: function() {\n\n },\n getUserLocationCoords: function() {\n var user = gs.getUser();\n var loc = user.getRecord().location;\n if (loc) {\n var locGR = new GlideRecord('cmn_location');\n if (locGR.get(loc))\n return {\n latitude: parseFloat(locGR.latitude),\n longitude: parseFloat(locGR.longitude),\n name: locGR.name.toString()\n };\n }\n return null;\n },\n\n type: 'UserLocationUtils'\n};\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic Reference Qualifier with Filtering/README.md", "content": "**Dynamic Reference Qualifier with Filtering**\nThis Client Script provides a solution for dynamically updating the available options in a Reference Field based on the value selected in another field on the same form.\n\nThis technique is essential for ensuring data quality and improving the user experience (UX). \n\nA typical use case is filtering the Assignment Group field to show only groups relevant to the selected Service, Category, or Location.\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic Reference Qualifier with Filtering/reference_qual_dynamic.js", "content": " function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n var controlledField = 'assignment_group'; \n var controllingField = 'u_service'; \n var serviceSysId = g_form.getValue(controllingField);\n var encodedQuery = 'typeLIKEITIL^u_related_service=' + serviceSysId;\n g_form.setQuery(controlledField, encodedQuery);\n var currentGroupSysId = g_form.getValue(controlledField);\n if (currentGroupSysId && oldValue !== '' && currentGroupSysId !== '') {\n g_form.setValue(controlledField, '');\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic UI Actions/README.md", "content": "# Dynamic Visible UI Actions\n\nThis code snippet can be used to dynamically change the visibility of an UI action via a Client Script or UI Policy.\nAs this happens on the client, it happens without the need of saving/reloading the form like you'd have to do if controlled via the UI Action's condition field (server-side). \n\nAs this uses DOM manipulation you might have to uncheck the \"Isolate Script\" field on the Client Script or UI Policy to make it work or make sure you have a system property \"glide.script.block.client.globals\" with a value of false if you're in a scoped application.\n\n**Note**: DOM manipulation should be used with caution. \n\n\n\n\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic UI Actions/script.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n\n // Adjust condition to your needs\n if (newValue === \"true\") { \n $$('button[data-action-name^=action_name').each(function(e) { // replace action_name with the action name of the UI Action\n e.hide();\n });\n } else {\n $$('button[data-action-name^=action_name').each(function(e) { // replace action_name with the action name of the UI Action\n e.show();\n });\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic script to make fields read only/reame.md", "content": "Dynamic script to make fields read only\n\nIt runs when the field value changes.On change client script\nIf the new value equals '7', it retrieves all editable fields using g_form.getEditableFields().\nThen it loops through each field and sets it to read-only using g_form.setReadOnly().\n" }, { "path": "Client-Side Components/Client Scripts/Dynamic script to make fields read only/script.js", "content": "/*\nIt runs when the field value changes.\nIf the new value equals '7', it retrieves all editable fields using g_form.getEditableFields().\nThen it loops through each field and sets it to read-only using g_form.setReadOnly().\n\n*/\n\n\nfunction onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n\n\n if (newValue == '7') { // update condition as required\n var fields = g_form.getEditableFields();\n for (var i = 0; i < fields.length; i++) {\n g_form.setReadOnly(fields[i].getName(), true);\n }\n \n" }, { "path": "Client-Side Components/Client Scripts/Dynamically Switch Form View Based on Field Value/README.md", "content": "## Dynamically Switch Form View Based on Field Value\n\nThis client script demonstrates how to **automatically switch form views** based on the value of a field.\n\n**Use case:** \nFor example, if the **Category** field is set to *Hardware*, the form view switches to **ess**. \nYou can extend this by updating the mapping object to support additional fields and values (e.g., *Software → itil*, *Network → support*).\n\n**Benefit:** \nImproves user experience by guiding users to the **most relevant form view**, ensuring the right fields are shown for the right scenario.\n\n**Test:** \n- Change the **Category** field to *Hardware* → Form view should switch to **ess**. \n- Update mapping to add new conditions (e.g., *Software → itil*) and verify the view switches accordingly.\n\n**How to Use:** \n1. **Modify the table name** in the `switchView` function to match your target table:\n ```javascript\n switchView(\"section\", \"\", targetView);\n2. **Modify the view mapping**\n" }, { "path": "Client-Side Components/Client Scripts/Dynamically Switch Form View Based on Field Value/dynamic-form-view-onchange.js", "content": "/**\n * dynamic-form-view-onchange.js\n *\n * Dynamically switches the form view automatically depending on the value of a specific field.\n * Example: If Category = Hardware → switch to ess view.\n * Extendable by modifying the mapping object for different fields/values.\n *\n */\n\nfunction onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || !newValue) {\n return;\n }\n\n // Field value → view name mapping\n var viewMapping = {\n \"hardware\": \"ess\",\n \"software\": \"itil\",\n \"network\": \"support\"\n };\n\n var fieldValue = newValue.toLowerCase();\n var targetView = viewMapping[fieldValue];\n\n if (targetView) {\n try {\n // Here for example the table name is incident\n switchView(\"section\", \"incident\", targetView);\n } catch (e) {\n console.error(\"View switch failed: \", e);\n }\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Enable VIP and Senior VIP Checkboxes and read only/README.md", "content": "This script is to enable The VIP and Senior VIP check boxes on the user form to be visible but read-only for any user who is not a system administrator. ths script helps to better manage the VIP users and better administration of the Platform. \nYou need to run this client script on the sys_user table and UI Type as Desktop and Type as \"On load\" and make this as Global.\n" }, { "path": "Client-Side Components/Client Scripts/Enable VIP and Senior VIP Checkboxes and read only/ScriptToEnableVIP_superVIP users", "content": "function onLoad() {\n //Type appropriate comment here, and begin script below\n var myRole= g_user.hasRole(\"admin\");\n\tif(myRole!=true){\n\t\tg_form.setReadOnly(\"vip\",true);\n\t\t\t}else{\n\t\tg_form.setReadOnly(\"vip\",false);\n\t\t\t}\n}\n" }, { "path": "Client-Side Components/Client Scripts/End Date can't be before Start Date/README.md", "content": "This script is for an onChange client script\n\nThis is using an example where you have two date variables and need to ensure the user does not choose an end date that's before the start date\n\n1. replace 'start_date' in the script with your actual start date field name\n2. replace 'end_date' in the script with yoru actual start date field name\n3. replace showFieldMsg and showErrorBox messages with your own message, if applicable\n\nThis script works for both the standard (desktop) UI and Service Portal\n" }, { "path": "Client-Side Components/Client Scripts/End Date can't be before Start Date/code.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || newValue == '') {\n return;\n }\n var sDate = g_form.getValue('start_date'); //this gets the value from your start date field\n\tif (sDate == '') { //if the start date hasn't been populated then clear the end-date and inform user to please choose a stating date first\n\t\tg_form.clearValue('end_date');\n\t\tg_form.showFieldMsg('end_date', \"Please choose a starting date first\");\n\t}\n if (newValue < sDate) { //if the end date is before the start date, clear the field value, and inform the user that the end date cannot be before the start date\n g_form.clearValue('end_date');\n\t\tg_form.showErrorBox('end_date', \"End date cannot be before the Start date\");\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Expanding Info Message/README.md", "content": "This is an expanding info message. It can even run a script when an element is clicked." }, { "path": "Client-Side Components/Client Scripts/Expanding Info Message/script.js", "content": "function onLoad() {\n var message = '';\n\n message += 'This is an expanding info message. It can even run code! Click \"Show more\" to see!';\n message += '
';\n message += '

Show more

';\n message += '
';\n message += '
    ';\n message += '
  • This is the expanded info in the message.
    • ';\n message += '
  • You can include any details you like here, including info retreived from a script like the sys_id of the current record: ' + g_form.getUniqueValue() + '
    • ';\n message += '
';\n message += '

You can even run a script when an element is clicked like this. You just have to escape your code in the HTML.

';\n message += '
';\n message += '
';\n\n g_form.addInfoMessage(message);\n\n}" }, { "path": "Client-Side Components/Client Scripts/Field Completion Counter/README.md", "content": "# Field Completion Counter\n\n## Use Case / Requirement\nDisplay a simple message showing how many fields are completed vs total fields on a form. This helps users track their progress while filling out forms.\n\n## Solution\nA simple onLoad client script that:\n- Counts filled vs empty fields\n- Shows completion status in an info message\n- Updates when fields are modified\n\n## Implementation\nAdd this as an **onLoad** client script on any form.\n\n## Notes\n- Excludes system fields and read-only fields\n- Updates in real-time as users fill fields\n- Simple and lightweight solution" }, { "path": "Client-Side Components/Client Scripts/Field Completion Counter/script.js", "content": "function onLoad() {\n // Display field completion counter\n showFieldProgress();\n \n // Set up listener for field changes\n setupProgressUpdater();\n \n function showFieldProgress() {\n var allFields = g_form.getFieldNames();\n var visibleFields = [];\n var filledFields = 0;\n \n // Count visible, editable fields\n for (var i = 0; i < allFields.length; i++) {\n var fieldName = allFields[i];\n \n // Skip system fields and hidden/readonly fields\n if (fieldName.indexOf('sys_') === 0 || \n !g_form.isVisible(fieldName) || \n g_form.isReadOnly(fieldName)) {\n continue;\n }\n visibleFields.push(fieldName);\n \n // Check if field has value\n if (g_form.getValue(fieldName)) {\n filledFields++;\n }\n }\n var totalFields = visibleFields.length;\n var percentage = totalFields > 0 ? Math.round((filledFields / totalFields) * 100) : 0;\n \n g_form.addInfoMessage('Form Progress: ' + filledFields + '/' + totalFields + ' fields completed (' + percentage + '%)');\n }\n \n function setupProgressUpdater() {\n // Simple debounced update\n var updateTimer;\n \n function updateProgress() {\n clearTimeout(updateTimer);\n updateTimer = setTimeout(function() {\n g_form.clearMessages();\n showFieldProgress();\n }, 500);\n }\n \n // Listen for any field change\n var allFields = g_form.getFieldNames();\n for (var i = 0; i < allFields.length; i++) {\n g_form.addElementChangeListener(allFields[i], updateProgress);\n }\n }\n}" }, { "path": "Client-Side Components/Client Scripts/Field Placeholder/README.md", "content": "Hint that appears inside an input field to indicate the type of data the user should enter. \nIt is typically shown in a lighter font colour and disappears once the user starts typing. \nThis helps guide users by providing an example or context without taking up additional space on the form.\nFor example, a field placeholder in an short description input might read: \"Please give the issue details here\"\n \n![image](https://github.com/user-attachments/assets/600d8ba7-2322-4b7f-b769-41f464082341)\n" }, { "path": "Client-Side Components/Client Scripts/Field Placeholder/fieldplaceholder.js", "content": "function onLoad() {\n //Type appropriate comment here, and begin script below\n var shortDescription = g_form.getControl(\"short_description\");\n shortDescription.placeholder = \"Please give the issue details here\";\n}\n" }, { "path": "Client-Side Components/Client Scripts/Field Validations/README.md", "content": "An `onLoad` client script that validates required fields in specific ServiceNow form views.\n\nThis ServiceNow client script provides automatic validation of required form fields when users access specific form views. The script runs immediately when a form loads and checks that critical fields are populated, displaying user-friendly error messages for any missing required information. This ensures data completeness and improves form submission success rates by catching validation issues early in the user workflow.\n\nWhat This Script Does:\nThe onLoad client script performs comprehensive field validation with these key capabilities:\nView-Specific Validation: Only triggers validation when accessing a designated form view\nMultiple Field Support: Validates multiple required fields simultaneously in a single operation\nSmart Field Detection: Uses field labels (not technical names) in error messages for better user experience\nConsolidated Error Display: Shows all missing required fields in a single, clear error message\nImmediate Feedback: Provides instant validation results as soon as the form loads\nNon-Intrusive Design: Displays informational errors without blocking form interaction\n" }, { "path": "Client-Side Components/Client Scripts/Field Validations/fieldValidation.js", "content": "function onLoad(){\n var targetViewName = 'your_target_view_name';\n var requiredFields = ['field1', 'field2', 'field3'];\n \n var currentViewName = g_form.getViewName();\n \n if (currentViewName === targetViewName) {\n var emptyFields = [];\n \n for (var i = 0; i < requiredFields.length; i++) {\n var fieldValue = g_form.getValue(requiredFields[i]);\n if (!fieldValue || fieldValue.trim() === '') {\n emptyFields.push(g_form.getLabelOf(requiredFields[i]));\n }\n }\n \n if (emptyFields.length > 0) {\n var errorMessage = \"The following required fields cannot be empty: \" + \n emptyFields.join(', ');\n g_form.addErrorMessage(errorMessage);\n }\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Form Dirty State Prevention/README.md", "content": "# Form Dirty State Prevention\n\n## Overview\nDetects form changes and warns users before navigating away or closing the form, preventing accidental data loss.\n\n## What It Does\n- Tracks form field changes (dirty state)\n- Warns user before leaving unsaved form\n- Allows user to cancel navigation\n- Works with all form fields\n- Prevents accidental data loss\n- Clean, reusable pattern\n\n## Use Cases\n- Complex multi-field forms\n- Long data entry forms\n- Forms with expensive operations\n- Critical data entry (financial, medical)\n- Any form where accidental exit would cause issues\n\n## Files\n- `form_dirty_state_manager.js` - Client Script to manage form state\n\n## How to Use\n\n### Step 1: Create Client Script\n1. Go to **System Definition > Scripts** (any table)\n2. Create new Client Script\n3. Set **Type** to \"onChange\"\n4. Copy code from `form_dirty_state_manager.js`\n5. Set to run on any field\n\n### Step 2: Add Navigation Handler\n1. Add to form's onLoad script:\n```javascript\n// Initialize dirty state tracking\nvar formStateManager = new FormDirtyStateManager();\n```\n\n### Step 3: Test\n1. Open form and make changes\n2. Try to navigate away without saving\n3. User sees warning dialog\n4. User can choose to stay or leave\n\n## Example Usage\n```javascript\n// Automatically tracks all field changes\n// When user tries to close/navigate:\n// \"You have unsaved changes. Do you want to leave?\"\n// - Leave (discard changes)\n// - Stay (return to form)\n```\n\n## Key Features\n- ✅ Detects any field change\n- ✅ Persistent across form interactions\n- ✅ Works with new records and updates\n- ✅ Ignores read-only fields\n- ✅ Resets after save\n- ✅ No performance impact\n\n## Output Examples\n```\nUser opens form and changes a field\n→ Form marked as \"dirty\"\n\nUser clicks close/back button\n→ Warning dialog appears: \"You have unsaved changes\"\n\nUser clicks Leave\n→ Form closes, changes discarded\n\nUser clicks Save then navigates\n→ No warning (form is clean)\n```\n\n## Customization\n```javascript\n// Customize warning message\nvar warningMessage = \"Warning: You have unsaved changes!\";\n\n// Add specific field tracking\ng_form.addOnFieldChange('priority', myCustomHandler);\n\n// Reset dirty flag after save\ng_form.save(); // Automatically triggers cleanup\n```\n\n## Requirements\n- ServiceNow instance\n- Client Script access\n- Any table form\n\n## Browser Support\n- Chrome, Firefox, Safari, Edge (all modern browsers)\n- Works with ServiceNow classic and modern UI\n\n## Related APIs\n- [g_form API](https://docs.servicenow.com/bundle/sandiego-application-development/page/app-store/dev_apps/concept/c_FormAPI.html)\n- [Client Script Events](https://docs.servicenow.com/bundle/sandiego-application-development/page/app-store/dev_apps/concept/c_ClientScriptEvents.html)\n- [Form Field Changes](https://docs.servicenow.com/bundle/sandiego-application-development/page/app-store/dev_apps/concept/c_FieldChanges.html)\n\n## Best Practices\n- Apply to important data entry forms\n- Test with real users\n- Consider accessibility for screen readers\n- Use with save shortcuts (Ctrl+S)\n- Combine with auto-save patterns\n" }, { "path": "Client-Side Components/Client Scripts/Form Dirty State Prevention/form_dirty_state_manager.js", "content": "// Client Script: Form Dirty State Manager\n// Purpose: Track form changes and warn user before leaving with unsaved changes\n\nvar FormDirtyStateManager = Class.create();\nFormDirtyStateManager.prototype = {\n initialize: function() {\n this.isDirty = false;\n this.setupFieldChangeListeners();\n this.setupNavigationWarning();\n },\n \n // Mark form as changed when any field is modified\n setupFieldChangeListeners: function() {\n var self = this;\n g_form.addOnFieldChange('*', function(control, oldValue, newValue, isLoading) {\n // Ignore system updates and form loads\n if (isLoading || oldValue === newValue) {\n return;\n }\n self.setDirty(true);\n });\n },\n \n // Warn user before navigating away with unsaved changes\n setupNavigationWarning: function() {\n var self = this;\n \n // Warn on form close attempt\n window.addEventListener('beforeunload', function(e) {\n if (self.isDirty && !g_form.isNewRecord()) {\n e.preventDefault();\n e.returnValue = 'You have unsaved changes. Do you want to leave?';\n return e.returnValue;\n }\n });\n \n // Warn on GlideForm navigation\n g_form.addOnSave(function() {\n // Reset dirty flag after successful save\n self.setDirty(false);\n return true;\n });\n },\n \n setDirty: function(isDirty) {\n this.isDirty = isDirty;\n if (isDirty) {\n // Optional: Show visual indicator\n document.title = '* ' + document.title.replace(/^\\* /, '');\n gs.info('[Form State] Unsaved changes detected');\n }\n },\n \n isDirtyState: function() {\n return this.isDirty;\n }\n};\n\n// Initialize on form load\nvar formDirtyState = new FormDirtyStateManager();\n" }, { "path": "Client-Side Components/Client Scripts/Get Field Value From List on Client/README.md", "content": "# Use Case\n\nLet;s consider a scenario. Some validation logic needs to be executed on click of a list banner button. The field values to be validated are present right on the screen, so why bother writing a GlideAjax code + client-callable Script Include to call the server and run the same validation on the server. Client-side ```GlideList``` API provides the ```getCell()``` method to fetch visible cell values from the list.\n\n\n# Usage\n\nWrite a client-side code on the UI Action and add the code in ```script.js``` file.\n```g_list.getCell(String recSysId, String fieldName)```\n\n\n# Explanation\n\nValues of visible fields/cells can be extracted using the ```getCell(String recSysId, String fieldName)``` method of client-side class ```GlideList (g_list)```. Required parameters:\n - ```String recSysId``` - SysID of the record/row whose value is to be fetched\n - ```String fieldName``` - Name of the field whose value is to be fetched\n\n**Returns:** ```HTMLElement (HTMLTableCellElement)```, string content can be extracted using ```.innerText``` property\n" }, { "path": "Client-Side Components/Client Scripts/Get Field Value From List on Client/script.js", "content": "/* g_list.getCell(rowSysId, ) - Accepts two parameters\n * recordSysID (to identify the row) - For example: 23d7584c977a611056e8b3e6f053af6b\n * field_name - name of the field whose value is to be fetched\n */\n\nvar recSysId = g_list.getChecked(); // 23d7584c977a611056e8b3e6f053af6b - Can be modified to pass Sys ID by other means\nvar fieldName = 'short_description'; // Modify as per requirement\n\nvar cellVal = g_list.getCell(recSysId, fieldName).innerText;\n\ng_GlideUI.addOutputMessage({\n msg: cellVal,\n type: 'success',\n preventDuplicates: true\n}); // Using this fancy notification trick because g_form is not supported on list view\n" }, { "path": "Client-Side Components/Client Scripts/Get Form Elements/README.MD", "content": "This script is a Client Script (onLoad) for ServiceNow which retrieves all field names present on the current form and displays them in an alert message.\n\nExample: Hi Sai, please find the elements of the form short_description, description, number, etc.\n" }, { "path": "Client-Side Components/Client Scripts/Get Form Elements/getFormElements.js", "content": "function onLoad() {\n //Type appropriate comment here, and begin script below\n var arr = [];\n for (var i = 0; i < g_form.elements.length; i++) {\n arr.push(g_form.elements[i].fieldName);\n }\n alert(\"Hi Sai, please find the form elements: \" + arr.join(\",\"));\n}\n" }, { "path": "Client-Side Components/Client Scripts/Get Logged in User Information/README.md", "content": "# The Glide User (g_user) is a global object available within the client side. It provides information about the logged-in user.\n\nProperty Description\n\ng_user.userID Sys ID of the currently logged-in user\ng_user.name User's Full name\ng_user.firstName User's First name\ng_user.lastName User's Last name\n\n# It also has some methods available within the client side.\n\nMethod Description\n\ng_user.hasRole() Determine whether the logged-in user has a specific role\ng_user.hasRoleExactly() Do not consider the admin role while evaluating the method\ng_user.hasRoles() You can pass two or more roles in a single method\n" }, { "path": "Client-Side Components/Client Scripts/Get Logged in User Information/script.js", "content": "if (g_user.hasRole('admin') || g_user.hasRole('itil')) {\n // User has at least one of the roles\n g_form.setDisplay('internal_notes', true);\n}\n\nif (g_user.hasRole('admin') && g_user.hasRole('itil')) {\n // User must have both roles\n g_form.setDisplay('advanced_settings', true);\n}\n\n//Using the parameters to set a field value\ng_form.setValue('short_description', g_user.firstName);\n\ng_form.setValue('short_description', g_user.lastName);\n\ng_form.setValue('short_description', g_user.name);\n\ng_form.setValue('short_description', g_user.userID);\n" }, { "path": "Client-Side Components/Client Scripts/Get URL Parameters/README.md", "content": "# Get URL Parameters in Global,Scoped Application for Record & Catalog Item\n\nMany times there is a need to grab parameters from URL. This could be required at table form load or catalog item load and either in Global scope or custom scope application when redirection happened. Given script will help you in achieving this:\n\n[Click here for the script](script.js)\n" }, { "path": "Client-Side Components/Client Scripts/Get URL Parameters/script.js", "content": "function onLoad() {\n //Type appropriate comment here, and begin script below\n\n if (typeof spModal != \"undefined\") { // For Service Portal\n var url = top.location.href;\n var value = new URLSearchParams(url).get(\"sys_id\"); //provide the parameter name\n console.log(value);\n } else { //For Native UI\n var glideURL = new GlideURL();\n glideURL.setFromCurrent();\n var id = glideURL.getParam(\"sysparm_id\"); // provide the parameter name\n console.log(id);\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Get Value from URL Parameter/README.md", "content": "Script that can be used in Client scripts to get URL parameter value.\n\n** Isolate script should be **false**\n" }, { "path": "Client-Side Components/Client Scripts/Get Value from URL Parameter/script.js", "content": "//Isolate Script should be false\nfunction onLoad() {\n\n var getUrlParameter = function(url, parameterName) {\n return new URLSearchParams(url).get();\n };\n //should not use top.location, in UI16 this will \"break out\" of the iFrame and return the \"nav_to.do?uri=xyz\" URL.\n var winURL = window.location.href;\n console.log(getUrlParameter(winURL, \"\"));\n}" }, { "path": "Client-Side Components/Client Scripts/Health Scan Prevent Insert Update in Before BRs/README.md", "content": "**Client script Deatils**\n1. Table: sys_script\n2. Type: onSubmit\n3. UI Type: Desktop\n\n**Benefits**\n1. This client script will prevent admin users to do insert/update operation in onBefore business rules.\n2. It will help to avoid HealthScan findings thus increasing healthscan score.\n3. Will prevent recursive calls.\n\nLink to ServiceNow Business Rules best Practise : https://developer.servicenow.com/dev.do#!/guide/orlando/now-platform/tpb-guide/business_rules_technical_best_practices\n" }, { "path": "Client-Side Components/Client Scripts/Health Scan Prevent Insert Update in Before BRs/script.js", "content": "function onSubmit() {\n /*\n\tThis client script will prevent insert and update operation in onBefore business rules.\n Table: sys_script\n Type: onSubmit\n Ui Type: Desktop\n */\n var whenCond = g_form.getValue('when'); // when condition of business rule\n var scriptVal = g_form.getValue('script'); // script value of business rule.\n\n if (whenCond == 'before' && (scriptVal.indexOf('insert()') > -1 || scriptVal.indexOf('update()')) > -1) {\n alert(\"As per ServiceNow best Practise insert and update should be avoided in onBefore BRs. If you still want tp proceed try deactivating client script : \" + g_form.getUniqueValue());\n return false;\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Hide Dependent Choice field if there no dependent choices/HideDepnedentField.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n var fieldToHide = 'subcategory'; // I have taken subcategory as an example\n if (newValue === '') {\n g_form.setDisplay(fieldToHide, false);\n return;\n }\n var ga = new GlideAjax('NumberOfDependentChoices');\n ga.addParam('sysparm_name', 'getCountOfDependentChoices');\n ga.addParam('sysparm_tableName', g_form.getTableName());\n ga.addParam('sysparm_element', fieldToHide);\n ga.addParam('sysparm_choiceName', newValue);\n ga.getXMLAnswer(callBack);\n\n function callBack(answer) {\n g_form.setDisplay(fieldToHide, parseInt(answer) > 0 ? true : false);\n }\n\n}\n" }, { "path": "Client-Side Components/Client Scripts/Hide Dependent Choice field if there no dependent choices/NumberOfDependentChoices.js", "content": "var NumberOfDependentChoices = Class.create();\nNumberOfDependentChoices.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n getCountOfDependentChoices: function() {\n\t\tvar dependentChoiceCount = 0;\n\t\tvar choiceName = this.getParameter('sysparm_choiceName');\n\t\tvar tableName = this.getParameter('sysparm_tableName');\n\t\tvar element = this.getParameter('sysparm_element');\n\t\tvar choiceCountGa = new GlideAggregate('sys_choice');\n\t\tchoiceCountGa.addAggregate('COUNT');\n\t\tchoiceCountGa.addQuery('dependent_value',choiceName);\n\t\tchoiceCountGa.addQuery('inactive','false');\n\t\tchoiceCountGa.addQuery('name',tableName);\n\t\tchoiceCountGa.addQuery('element',element);\n\t\tchoiceCountGa.query();\n\t\twhile(choiceCountGa.next()){\n\t\t\tdependentChoiceCount = choiceCountGa.getAggregate('COUNT');\n\t\t}\n\t\treturn dependentChoiceCount;\n\t},\n type: 'NumberOfDependentChoices'\n});\n" }, { "path": "Client-Side Components/Client Scripts/Hide Dependent Choice field if there no dependent choices/README.md", "content": "Hide the dependent choice field when there are no available options for the selected parent choice.\n\nFor example, if a selected category on the incident form has no subcategories, then the subcategory field should be hidden.\n\nThe file NumberOfDependentChoices.js is a client callable script include file which has a method which returns number of dependent choices for a selected choice of parent choice field.\n\nHideDepnedentField.js is client script which hides the dependent choice field(ex:subcategory field on incident form) if there are no active choices to show for a selected choices of it's dependent field (example: category on incident form)\n" }, { "path": "Client-Side Components/Client Scripts/Hide Work Notes section/README.md", "content": "**Client Script**\n\nClient Script for hiding work notes section on incident form. In this example it is configured to hide work notes section, when incident is in state new, but you can adjust condition to fit your requirements. \n\n**Example configuration of Client Script**\n\n![Coniguration](ScreenShot_1.PNG)\n\n**Example effect of execution**\n\nWhen incident is in state NEW (Work notes section not visible):\n\n![Not Visible](ScreenShot_2.PNG)\n\nWhen incident is not in state NEW (Work notes section visible):\n\n![Visible](ScreenShot_3.PNG)\n" }, { "path": "Client-Side Components/Client Scripts/Hide Work Notes section/script.js", "content": "function onLoad() {\n //Script to hide work notes section, when incident is in state NEW\n\n //Get incident state\n var state = g_form.getValue('state');\n\n //Check if incident is in state NEW (value = 1)\n if (state == 1) {\n\n //Hide work notes section \n g_form.setSectionDisplay('notes', false);\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/How to adjust the Date format within a client script to align with the User Date format/README.md", "content": "# When getting a date from another table, it's usually in the format (YYYY-MM-DD). To display it in the user's preferred format on the client side, use the method below.\n\nIf date is fetched from a query(like GlideAjax), date returned from query pass that date object into \"new Date()\"\n\n# Example\n\n```\nvar user_date = formatDate(new Date(), g_user_date_format)\n\ng_form.setValue('',user_date);\n\n```\n" }, { "path": "Client-Side Components/Client Scripts/How to adjust the Date format within a client script to align with the User Date format/code.js", "content": "var currentDateObj = new Date();\nvar currentDateUsr = formatDate(currentDateObj, g_user_date_format);\n" }, { "path": "Client-Side Components/Client Scripts/Incident Count of Selected CI with Clickable Link to Related Incidents/README.md", "content": "# Incident Count of Selected Configuration Item with Info Message and Link to its Related Incident \n\nDisplays a message showing the count of open incidents associated with a selected **Configuration Item (CI)** whenever the **Configuration Item** field changes on the Incident form.\n\n- Helps quickly identify whether the selected CI has existing incident by fetching and displaying active incident counts (excluding *Resolved*, *Closed*, and *Canceled* states). \n- Shows an **info message** with a **clickable link** that opens a filtered list of related incidents for that CI \n- If more than five incidents are linked, a **warning message** appears suggesting Problem investigation for frequent or repeated CI issues.\n- Uses an **onChange Client Script** on the *Configuration Item* field and a **GlideAjax Script Include** called from the client script to fetch the incident count \n\n---\n\n## Warning Message displayed on form when CI has 5 or more incidents \n\n![CI_Incident_Message_Count_1](CI_Incident_Message_Count_1.png)\n\n---\n\n## Info Message displayed on form when CI has no incidents\n\n![CI_Incident_Message_Count_2](CI_Incident_Message_Count_2.png)\n\n---\n\n## Info Message displayed on form when CI has incidents less than 5\n\n![CI_Incident_Message_Count_3](CI_Incident_Message_Count_3.png)\n\n---\n\n## Upon clicking the url link filter list opens with incidents associated with CI\n\n![CI_Incident_Message_Count_4](CI_Incident_Message_Count_4.png)\n\n---\n" }, { "path": "Client-Side Components/Client Scripts/Incident Count of Selected CI with Clickable Link to Related Incidents/clientScriptCiIncident.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') return;\n\n g_form.clearMessages();\n\n // Call Script Include to count incidents by CI\n var ga = new GlideAjax('ConfigurationIncidentCheck');\n ga.addParam('sysparm_name', 'getIncidentCount');\n ga.addParam('sysparm_ci', newValue);\n\n ga.getXMLAnswer(function(response) {\n var count = parseInt(response, 10);\n if (isNaN(count)) {\n g_form.addErrorMessage(\"Could not retrieve incident count for this CI.\");\n return;\n }\n\n var ciName = g_form.getDisplayValue('cmdb_ci');\n var url = '/incident_list.do?sysparm_query=cmdb_ci=' + newValue + '^stateNOT IN6,7,8';\n var msg = 'Configuration Item ' + ciName + ' has ' + count + ' related incident(s).';\n\n if (count === 0) {\n g_form.addInfoMessage(\n 'Configuration Item ' + ciName + ' has no incidents associated with it.'\n );\n} else {\n if (count >= 5) {\n g_form.addWarningMessage(\n msg + ' consider Problem investigation.'\n );\n } else {\n g_form.addInfoMessage(msg);\n }\n}\n });\n}\n" }, { "path": "Client-Side Components/Client Scripts/Incident Count of Selected CI with Clickable Link to Related Incidents/glideAjaxIncidentCiCount.js", "content": "var ConfigurationIncidentCheck = Class.create();\nConfigurationIncidentCheck.prototype = Object.extendsObject(AbstractAjaxProcessor, {\ngetIncidentCount: function() {\n var ci = this.getParameter('sysparm_ci');\n if (!ci) return 0;\n\n var gr = new GlideAggregate('incident');\n gr.addQuery('cmdb_ci', ci);\n gr.addQuery('state', 'NOT IN', '6,7,8'); \n gr.addAggregate('COUNT');\n gr.query();\n\n return gr.next() ? gr.getAggregate('COUNT') : 0;\n },\n\n type: 'ConfigurationIncidentCheck'\n});\n" }, { "path": "Client-Side Components/Client Scripts/Live Character Counter and Validator/README.md", "content": "This solution dynamically provides users with real-time feedback on the length of a text input field (like short_description or a single-line text variable).\nIt immediately displays a character count beneath the field and uses visual cues to indicate when a pre-defined character limit has been reached or exceeded.\n\nThis is a vital User Experience (UX) enhancement that helps agents and users write concise, actionable information, leading to improved data quality and better integration reliability.\n\nName\tLive_Character_Counter_ShortDesc_OnLoad\t\nTable\t: Custom Table or Incident\nType\tonChange \nField : Description \nUI Type\tAll\t\nIsolate Script\tfalse\n" }, { "path": "Client-Side Components/Client Scripts/Live Character Counter and Validator/character_counter.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n \n var FIELD_NAME = 'short_description';\n var MAX_CHARS = 100;\n var currentLength = newValue.length;\n var counterId = FIELD_NAME + '_counter_label';\n if (typeof g_form.getControl(FIELD_NAME) !== 'undefined' && !document.getElementById(counterId)) {\n var controlElement = g_form.getControl(FIELD_NAME);\n var counterLabel = document.createElement('div');\n counterLabel.setAttribute('id', counterId);\n counterLabel.style.fontSize = '85%';\n counterLabel.style.marginTop = '2px';\n controlElement.parentNode.insertBefore(counterLabel, controlElement.nextSibling);\n }\n var counterElement = document.getElementById(counterId);\n\n if (counterElement) {\n var remaining = MAX_CHARS - currentLength;\n \n \n counterElement.innerHTML = 'Characters remaining: ' + remaining + ' (Max: ' + MAX_CHARS + ')';\n\n // Apply red color if the limit is exceeded\n if (remaining < 0) {\n counterElement.style.color = 'red';\n } else {\n // Revert color if back within limits\n counterElement.style.color = 'inherit';\n }\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/MRVS variables validations/README.md", "content": "Multi Row Variable Set (MRVS) variables validations which are based on variables out of MRVS\n\nfor this we need to use \"g_service_catalog\" client side API of ServiceNow\n\nExample:\nRequirement is like there is an adaptation leave form, where the user can take 30 leaves in batches not all at once. \nUsers can enter the last working date which is a normal variable in catalog item and batched leaves in MRVS where the Extended leave start and end dates will populate.\nWe are restricting here only to enter extended leave start date after the last working date. \n\n![image](https://user-images.githubusercontent.com/46869542/193416763-27fb52c9-e15b-48b5-99fd-6c146a6819c3.png)\n\n\n\n" }, { "path": "Client-Side Components/Client Scripts/MRVS variables validations/script.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || newValue == '') {\n return;\n }\n\n //Type appropriate comment here, and begin script below\n if (g_form.getValue('extended_leave_start') <= g_service_catalog.parent.getValue(\"last_working_date\")) { // extended leave start date is earlier or equal to last working date\n g_form.clearValue('extended_leave_start');\n g_form.showFieldMsg('extended_leave_start', \"Entended leave start can't be earlier or equal to last working day\", 'error');\n }\n\n}\n" }, { "path": "Client-Side Components/Client Scripts/Major Incident Proposal/Client_Script.js", "content": "function onSubmit() {\n var priority = g_form.getValue('priority');\n\n if (priority == '1') {\n // is already a Major Incident\n var gaCheck = new GlideAjax('CreateMajorIncident');\n gaCheck.addParam('sysparm_name', 'isAlreadyMajorIncident');\n gaCheck.addParam('sysparm_sysid', g_form.getUniqueValue());\n\n var response = gaCheck.getXMLWait();\n var isMajorIncident = response.documentElement.getAttribute('answer'); \n \n // not yet a Major Incident\n if (isMajorIncident == 'false') {\n var resp = confirm(getMessage('Please confirm that you would like to propose a Major Incident Candidate?'));\n\n if (resp) {\n // propose the Major Incident\n var ga = new GlideAjax('CreateMajorIncident');\n ga.addParam('sysparm_name', 'majorIncCreate');\n ga.addParam('sysparm_sysid', g_form.getUniqueValue());\n\n var majorIncidentResponse = ga.getXMLWait(); \n var incidentNumber = majorIncidentResponse.documentElement.getAttribute('answer');\n\n alert(\"Incident \" + incidentNumber + \" has been proposed as a Major Incident candidate.\");\n } else {\n // cancels\n return false;\n }\n }\n }\n\n return true; // Allow if priority is not 1 or after processing\n}\n" }, { "path": "Client-Side Components/Client Scripts/Major Incident Proposal/README.md", "content": "

Major Incident Proposal - Client Script & Script Include

\n\n

This solution asks the users to propose an incident as a Major Incident candidate. The process is initiated from the Incident form when the priority is set to 1 (Critical), and the system checks if the incident has already been proposed as a Major Incident. If not, the user is prompted to confirm whether they wish to propose the incident. Upon confirmation, the incident is updated, and the Major Incident status is assigned.

\n\n

This solution consists of a Client Script and a Script Include, which handle the user interaction and the back-end logic, respectively.

\n\n

Functionality

\n\n

1. Client Script - onSubmit()

\n

The Client Script is triggered when the user submits an Incident form with a priority of 1 (Critical). It performs the following actions:

\n
    \n
  • Checks if the incident is already marked as a Major Incident by calling the Script Include via GlideAjax.
    • \n
  • If the incident is not already marked as a Major Incident, the user is prompted to confirm whether they wish to propose it as a Major Incident.
    • \n
  • Upon confirmation, the incident is proposed as a Major Incident candidate, and a success message is displayed with the incident number.
    • \n
\n\n

Key Features:

\n
    \n
  • Priority Check: The script only runs when the priority is set to 1 (Critical).
    • \n
  • GlideAjax Call: Uses GlideAjax to communicate with the server-side Script Include to check and propose the Major Incident.
    • \n
  • User Confirmation: The user is prompted to confirm the proposal of the Major Incident before proceeding.
    • \n
  • Synchronous Execution: The script waits for a response from the server using getXMLWait() to ensure the process completes before submitting the form.
    • \n
\n\n\n\n

2. Script Include - CreateMajorIncident

\n

The Script Include provides the back-end logic for:

\n
    \n
  • Checking whether the incident is already proposed as a Major Incident.
    • \n
  • Proposing the incident as a Major Incident by updating its major_incident_state, proposed_by, and proposed_on fields, and adding work notes.
    • \n
\n\n\n\n

Usage Example:

\n
    \n
  1. When the priority of an incident is set to 1 (Critical), the client script checks whether the incident is already a Major Incident.
    2. \n
  2. If not, the user is prompted to confirm the Major Incident proposal.
    3. \n
  3. Upon confirmation, the CreateMajorIncident Script Include updates the incident record to reflect its proposed Major Incident status and returns the incident number.
    4. \n
\n\n

Customization

\n

You can easily customize this functionality by:

\n
    \n
  • Adding more validation rules to the Script Include.
    • \n
  • Modifying the client script to handle different priorities or additional fields.
    • \n
  • Updating the work notes or other fields when proposing the incident.
    • \n
\n" }, { "path": "Client-Side Components/Client Scripts/Major Incident Proposal/Script_Include.js", "content": "var CreateMajorIncident = Class.create();\nCreateMajorIncident.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n\n majorIncCreate: function() {\n\n var incSysId = this.getParameter('sysparm_sysid');\n\n var ginc = new GlideRecord('incident');\n\n if (ginc.get(incSysId)) {\n\n ginc.major_incident_state = 'proposed';\n ginc.proposed_by = gs.getUserID();\n ginc.proposed_on = new GlideDateTime();\n ginc.work_notes = \"Hello World! \" + new GlideDateTime();\n ginc.update();\n\n return ginc.number.toString();\n }\n\n return 'false';\n },\n\n\n isAlreadyMajorIncident: function() {\n var incSysId = this.getParameter('sysparm_sysid');\n var ginc = new GlideRecord('incident');\n\n if (ginc.get(incSysId)) {\n return ginc.major_incident_state == 'proposed' ? 'true' : 'false';\n }\n\n return 'false';\n },\n\n type: 'CreateMajorIncident'\n});\n" }, { "path": "Client-Side Components/Client Scripts/Make Variable Editor Read Only for Catalog Items containing MRVS/CheckMRVSDetails.js", "content": "var CheckMRVSDetails = Class.create();\nCheckMRVSDetails.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n\n\tcheckMRVS: function(){\n\t\tvar itemID = this.getParameter('sysparm_itemID');\n\t\tvar grMultiRow = new GlideRecord('io_set_item');\n\t\tgrMultiRow.addEncodedQuery('variable_set.type=one_to_many'); // Variable Set is MRVS\n\t\tgrMultiRow.addQuery('sc_cat_item',itemID);\n\t\tgrMultiRow.setLimit(1);\n\t\tgrMultiRow.query();\n\t\tif(grMultiRow.next()){\n\t\t\treturn true;\n\t\t}\n\t\treturn false;\n\t},\n\t\n\t\n\t\n type: 'CheckMRVSDetails'\n});\n" }, { "path": "Client-Side Components/Client Scripts/Make Variable Editor Read Only for Catalog Items containing MRVS/MakeVariableSetReadOnly.js", "content": "function onLoad() {\n //Type appropriate comment here, and begin script below\n var catItem = g_form.getValue('cat_item'); //Sys Id of the Catalog Item\n\n var ga = new GlideAjax('CheckMRVSDetails'); // SI Name\n ga.addParam('sysparm_name', 'checkMRVS'); // Function Name\n ga.addParam('sysparm_itemID', catItem);\n ga.getXML(checkMRVS);\n\n function checkMRVS(response) {\n\n var answer = response.responseXML.documentElement.getAttribute(\"answer\");\n if (answer == 'true') {\n g_form.setVariablesReadOnly(true);\n }\n\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Make Variable Editor Read Only for Catalog Items containing MRVS/README.md", "content": "# Make Variable Editor Read Only for Catalog Items which have a Multi Row Variable Set\nCreate an onLoad Client Script which would call a Script Include and pass in the Catalog Item sys_id to check if the Catalog Item contains a MRVS. The script has been tailored to work with the Requested Item table. To make it work for any other table which has the Variable Editor replace the field \"cat_item\" with the field containing the details of the Catalog Item\n" }, { "path": "Client-Side Components/Client Scripts/Make all fields read only/README.md", "content": "Use this script to make all fields readonly via client script.\n\n**Tested in Global scope\n**You can't make mandatory fields as readonly\n**Best Practice is to use ACLs\n" }, { "path": "Client-Side Components/Client Scripts/Make all fields read only/script.js", "content": "function onLoad() {\n var fields = g_form.getEditableFields();\n \n var skippedFields = [\n 'sys_created_on',\n 'sys_created_by',\n 'sys_updated_on',\n 'sys_updated_by',\n ];\n\n for (var i = 0; i < fields.length; i++) {\n var field = fields[i];\n\n // Skip fields in the designated array\n if (skippedFields.indexOf(field) !== -1) {\n continue;\n }\n\n g_form.setMandatory(fields[i], false);\n g_form.setReadOnly(fields[i], true);\n\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Make fields read only in specific states/Make fields read only in specific state.md", "content": "# Make editable fields read only on load in specific state for example state is On Hold.\n" }, { "path": "Client-Side Components/Client Scripts/Make fields read only in specific states/code.js", "content": "function onLoad() {\n var getStateValue = g_form.getValue('state');\n if (getStateValue == '3') {\n var fields = g_form.getEditableFields();\n for (var fieldLength = 0; fieldLength < fields.length; fieldLength++) {\n g_form.setReadOnly(fields[fieldLength], true);\n }\n }\n}" }, { "path": "Client-Side Components/Client Scripts/Mandatory Field Highlighter/README.md", "content": "# Mandatory Field Highlighter\n\n## Use Case\nProvides 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.\n\n## Requirements\n- ServiceNow instance\n- Client Script execution rights\n- Forms with mandatory fields\n\n## Implementation\n1. Create a new Client Script with Type \"onLoad\"\n2. Copy the script code from script.js\n3. **Customize the fieldsToCheck string** with your form's mandatory field names\n4. Apply to desired table/form\n5. Save and test on a form with mandatory fields\n\n## Configuration\nEdit the `fieldsToCheck` variable to include your form's mandatory fields as a comma-separated string:\n\n```javascript\n// Example configurations for different forms:\n\n// For Incident forms:\nvar fieldsToCheck = 'short_description,priority,category,caller_id,assignment_group';\n\n// For Request forms:\nvar fieldsToCheck = 'short_description,requested_for,category,priority';\n\n// For Change Request forms:\nvar fieldsToCheck = 'short_description,category,priority,assignment_group,start_date,end_date';\n\n// For Problem forms:\nvar fieldsToCheck = 'short_description,category,priority,assignment_group';\n\n// Custom fields (add as needed):\nvar fieldsToCheck = 'short_description,priority,u_business_justification,u_cost_center';\n```\n\n## Features\n- Shows error messages under empty mandatory fields on form load\n- Easy configuration with comma-separated field names\n- Automatically skips fields that don't exist on the form\n- Only processes fields that are actually mandatory and visible\n- Uses proper ServiceNow client scripting APIs\n- No DOM manipulation or unsupported methods\n\n## Common Field Names\n- `short_description` - Short Description\n- `priority` - Priority\n- `category` - Category \n- `caller_id` - Caller\n- `requested_for` - Requested For\n- `assignment_group` - Assignment Group\n- `assigned_to` - Assigned To\n- `state` - State\n- `urgency` - Urgency\n- `impact` - Impact\n- `start_date` - Start Date\n- `end_date` - End Date\n- `due_date` - Due Date\n- `location` - Location\n- `company` - Company\n- `department` - Department\n\n## Notes\n- Uses g_form.showFieldMsg() method to display error messages\n- Uses g_form.hasField() to safely check field existence (built into the safety checks)\n- Only runs on form load - provides initial validation feedback\n- Easy to customize for different forms by modifying the field list\n- Compatible with all standard ServiceNow forms\n- Lightweight and focused on essential functionality\n\n## Example Usage\nFor a typical incident form, simply change the configuration line to:\n```javascript\nvar fieldsToCheck = 'short_description,priority,category,caller_id,assignment_group';\n```\nSave the Client Script and test on an incident form to see error messages appear under empty mandatory fields." }, { "path": "Client-Side Components/Client Scripts/Mandatory Field Highlighter/script.js", "content": "function onLoad() {\n\n // USER CONFIGURATION: Add field names you want to check (comma-separated)\n var fieldsToCheck = 'short_description,priority,category,caller_id';\n \n // Convert to array and process\n var fieldArray = fieldsToCheck.split(',');\n \n // Check each field\n for (var i = 0; i < fieldArray.length; i++) {\n var fieldName = fieldArray[i];\n \n // Skip if field is not mandatory or not visible\n if (!g_form.isMandatory(fieldName) || !g_form.isVisible(fieldName)) {\n continue;\n }\n \n // Get current field value\n var value = g_form.getValue(fieldName);\n \n // Show error message if field is empty\n if (!value || value === '') {\n g_form.showFieldMsg(fieldName, 'This field is required', 'error');\n }\n }\n}" }, { "path": "Client-Side Components/Client Scripts/MultiSelect in Portal/README.md", "content": "The custom widget that enables you to select multiple incidents in the portal page.\n" }, { "path": "Client-Side Components/Client Scripts/MultiSelect in Portal/script.js", "content": "//HTML code that displays the incidents to select multiple at once.\n
\n
\n

Complaints

\n\n
\n \n
\n
\n \n \n \n \n
\n
\n
\n
\n\n
\n \n
0\" style=\"margin-bottom: 8px;\">\n \n {{c.getSelectedCount()}} complaint 1\">s selected\n (across pages)\n \n
\n\n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n \n Run Date\n \n \n \n \n Case ID\n \n \n \n Policy ID\n \n \n
\n \n {{item.batchno}}{{item.caseid}}{{item.policyid}}
No incidents found.
\n\n \n
\n \n Page {{c.pageNumber}} of {{c.totalPages}} \n \n
\n
\n
\n" }, { "path": "Client-Side Components/Client Scripts/On load Switch-Case Testing/README.md", "content": "This is code snippet of switch case, and it will easily help to understand the usage of switch case and how we can implement it into the environment as per our requirements.\n" }, { "path": "Client-Side Components/Client Scripts/On load Switch-Case Testing/Switch-Case code snippet.js", "content": " function onLoad() {\n // Switch Case code snippet using in ServiceNow\n\nvar category = g_form.getValue(\"category\"); // It will capture the value of category field.\n\nswitch(category){\ncase \"hardware\": // if the value would be 'hardware' in category field.\ng_form.addInfoMessage(\"Yes category is hardware\") // This function will add a infomessage.\nbreak; //This keyword is used to stop the execution inside a switch block.\n\ncase \"software\": // if the value would be 'software' in category field.\ng_form.addInfoMessage(\"Yes category is software\") // This function will add a infomessage.\nbreak;\n\ncase \"network\": // if the value would be 'Network' in category field.\ng_form.addInfoMessage(\"Yes category is Network\") // This function will add a infomessage.\nbreak;\n\ncase \"database\": // if the value would be 'Database' in category field.\ng_form.addInfoMessage(\"Yes category is Database\") // This function will add a infomessage.\nbreak;\ndefault: // This will execute only if the category field have the value apart from mentioned cases.\ng_form.addInfoMessage(\"Oh! no category is something else\") // This function will add a infomessage.\n}\n}\n" }, { "path": "Client-Side Components/Client Scripts/Only number validation for input/OnChange.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n\t\t\t\n\tif (isLoading || newValue === '') {\n\t\treturn;\n\t}\n\n // Change the name of the field to your field name\n var FIELD_NAME = ''; \n\n\t// allow number only\n\tvar reg = new RegExp(/^\\d+$/);\n\t\n\tif (!reg.test(newValue)) {\n\t\tg_form.hideFieldMsg(FIELD_NAME);\n\t\tg_form.showFieldMsg(FIELD_NAME, g_form.getLabelOf(FIELD_NAME) + ' may contain digits only.', 'error');\n\t\t\n\t} else {\n\t\tg_form.hideFieldMsg(FIELD_NAME);\n\t}\n}" }, { "path": "Client-Side Components/Client Scripts/Only number validation for input/README.md", "content": "# Client Script - Input is number only\n\nA client script that validates that the input entry is number only\n\n## Usage\n\n\n- Create a new client script\n- Set the type to OnChange. Update the field in the client script to \n- Select a field field that you want to be number\n- Navigate to the form and set the field to a string\n- There will be a validation error close to the field\n" }, { "path": "Client-Side Components/Client Scripts/Open Record in Agne Workspace Tab/README.md", "content": "This code helps to open a record in readonly mode irrespective of ACLS, UI Policies via client script in a Agent workspace tab.\n\nHere we are opening a story that is stored in the parent field on the incident record in the agent workspace.\n" }, { "path": "Client-Side Components/Client Scripts/Open Record in Agne Workspace Tab/openrecawtab.js", "content": "// Opens a Story attached to a Incident record in the parent field in the readonly mode.\n function onLoad(g_form) {\ng_aw.openRecord('rm_story', g_form.getValue('parent'), {readOnlyForm: true}); \n }\n" }, { "path": "Client-Side Components/Client Scripts/Populate Jelly Slushbucket with Values/ClientScript.js", "content": "//Called when the form loads\naddLoadEvent(function () {\n //Load the groups when the form loads\n slush.clear();\n var ajax = new GlideAjax(\"example_ajax_call\"); // Can use this to get values to fill the slushbucket\n ajax.addParam(\"sysparm_example\", \"example\");\n ajax.getXML(loadResponse);\n return false;\n});\n\n//Called when we get a response from the 'addLoadEvent' function\nfunction loadResponse(response) {\n //Process the return XML document and add groups to the left select\n var xml = response.responseXML;\n var e = xml.documentElement;\n var items = xml.getElementsByTagName(\"item\");\n if (items.length == 0) return;\n //Loop through item elements and add each item to left slushbucket\n for (var i = 0; i < items.length; i++) {\n var item = items[i];\n slush.addLeftChoice(\n item.getAttribute(\"example\"),\n item.getAttribute(\"example_2\") +\n \": \" +\n item.getAttribute(\"example_3\") +\n \": \" +\n item.getAttribute(\"example_4\")\n ); //This is what will be displayed in the left side of the slushbucket\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Populate Jelly Slushbucket with Values/README.md", "content": "This code is used to populate the Jelly tag within a UI Page.\n\nIn the UI Page, must ensure that this tag is located in the HTML section.\n\nThen in the client script, include the code provided in the example.\n" }, { "path": "Client-Side Components/Client Scripts/Prevent Rejection Without Comments/readme.md", "content": "🧩 Readme: Prevent Rejection Without Comments – Client Script\n📘 Overview\n\nThis Client Script enforces that approvers must enter comments before rejecting a record in the Approval [sysapproval_approver] table.\nIt ensures accountability, audit readiness, and clear justification for rejection decisions.\n\n🧠 Use Case\nField\tDetails\nTable\tsysapproval_approver\nType\tClient Script – onSubmit\nPurpose\tPrevent users from rejecting approvals without comments\nBusiness Value\tEnsures transparency and proper audit trail in approval workflows\n⚙️ Configuration Steps\n\nNavigate to System Definition → Client Scripts.\n\nClick New.\n\nFill the form as follows:\n\nField\tValue\nName\tPrevent Rejection Without Comments\nTable\tsysapproval_approver\nUI Type\tAll\nType\tonSubmit\nActive\t✅\nApplies on\tUpdate\n\nPaste the following script in the Script field.\n\n💻 Script\nfunction onSubmit() {\n // Get the current state value of the approval record\n var state = g_form.getValue('state');\n\n // Get the comments entered by the approver\n var comments = g_form.getValue('comments');\n\n // Check if the approver is trying to REJECT the record\n // The out-of-box (OOB) value for rejection in sysapproval_approver is \"rejected\"\n // If state is 'rejected' and comments are empty, stop the submission\n if (state == 'rejected' && !comments) {\n\n // Display an error message to the user\n g_form.addErrorMessage('Please provide comments before rejecting the approval.');\n\n // Prevent the form from being submitted (block save/update)\n return false;\n }\n\n // Allow the form submission if validation passes\n return true;\n}\n\n🧪 Example Scenario\nField\tValue\nApprover\tJohn Doe\nState\tRejected\nComments\t(empty)\n\nUser Action: Clicks Update\nSystem Response: Shows error message —\n\n“Please provide comments before rejecting the approval.”\nRecord submission is blocked until comments are provided.\n\n✅ Expected Outcome\n🚫 Prevents rejection without comments\n⚠️ Displays user-friendly validation message\n📝 Ensures that every rejection has a reason logged for compliance\n\n\n" }, { "path": "Client-Side Components/Client Scripts/Prevent Rejection Without Comments/script.js", "content": "//Prevent Rejection Without Comments\nfunction onSubmit() {\n // Get the current state value of the approval record\n var state = g_form.getValue('state');\n\n // Get the comments entered by the approver\n var comments = g_form.getValue('comments');\n\n // Check if the approver is trying to REJECT the record\n // The out-of-box (OOB) value for rejection in sysapproval_approver is \"rejected\"\n // If state is 'rejected' and comments are empty, stop the submission\n if (state == 'rejected' && !comments) {\n\n // Display an error message to the user\n g_form.addErrorMessage('Please provide comments before rejecting the approval.');\n\n // Prevent the form from being submitted (block save/update)\n return false;\n }\n\n // Allow the form submission if validation passes\n return true;\n}\n" }, { "path": "Client-Side Components/Client Scripts/Price field restriction to one currency/README.md", "content": "\n# Client Script - Set Price type field to only one currency\n\nIn a multi currecny enabled servicenow environment, if you have a requirement to enable only one currency choice for a particular table and field of type Price.\n\n## Usage\n\n- Create a new client script\n- Set the type to OnLoad.\n- Copy the script to your client script.\n- Update the in the client script to 'Your field name'\n- Add your currency code and symbol in place of USD & $\n- Save" }, { "path": "Client-Side Components/Client Scripts/Price field restriction to one currency/price_field_restriction_to_one_currency.js", "content": "function onLoad(){\n // Remove all currency options\n g_form.clearOptions('.currency_type');\n\n // Add only one currency option (e.g., USD)\n g_form.addOption('.currency_type', 'USD', '$');\n\n // Set the currency field to the only available option\n g_form.setValue('.currency_type', 'USD');\n}" }, { "path": "Client-Side Components/Client Scripts/Redact Sensitive Information/README.md", "content": "# Redact Sensitive Information\n\nWhen users create an incident or HR case via the self-service portal, they may occasionally enter sensitive information (e.g., personal identifiers, account numbers). \nTo prevent misuse of such data, **fulfillers** can redact sensitive information from the short description or description fields.\n\nThis ensures that confidential information is safeguarded and not accessible for unauthorized use or distribution.\n\n## Prerequisites\n\n1. Custom Field:\n Add a custom field to the form to hold the redacted text.\n Example: u_redact (Redact).\n \n2. OnSubmit Client Script:\n Create an onsubmit client script to redact sensitive information.\n This script will update the **short description** and **description** field with custom value as required.\n\n**Note**: Data that has been redacted cannot be recovered.\n" }, { "path": "Client-Side Components/Client Scripts/Redact Sensitive Information/script.js", "content": "function onSubmit() {\n var redact = g_form.getValue(\"u_redact\"); //custom field on the form to redact information\n if (redact == true) {\n var answer = confirm(getMessage('Do you want to redact sensitive information')); //Confirm the user who wants to redact information \n if (answer) {\n g_form.setValue('short_description', 'Short Description is redacted as it contained sensitive information'); //Custom short_description post redacting\n g_form.setValue('description', 'Description is redacted as it contained sensitive information'); //Custom description post redacting\n 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\n g_form.setReadOnly('short_description', true);\n g_form.setReadOnly('description', true);\n g_form.setReadOnly('u_redact', true)\n } else {\n g_form.setValue('u_redact', false);\n return false;\n }\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Reinstate Error status/README.md", "content": "Table: Time Worked [task_time_worked]\nType: onsubmit\n\n#Objective :\nEnsure that time entries (represented by the work_date field) are not submitted after 8:00 PM CST on two key dates:\nThe 16th of the month and The last day of the month\nIf a user tries to submit time for a current or past date after the cut-off time, the submission is blocked and a clear error message is displayed.\n\n#Business Scenario\nImagine a consulting firm where employees log billable hours against customer cases. There are internal controls in place that lock the timekeeping system after a certain cut-off time to ensure accurate payroll and billing.\n\nThe finance department requires that:\nOn the 16th and last day of each month, submissions must be in before 8:00 PM CST.\nIf employees miss the deadline, they can only log time for future dates (not today or the past).\n" }, { "path": "Client-Side Components/Client Scripts/Reinstate Error status/script.js", "content": "function onSubmit() {\n // Cutoff time for submission in CST.\n var cutoffTime = \"20:00:00\";\n\n // Get the current date and time in CST\n var currentDate = new Date();\n var currentCSTDate = new Date(\n currentDate.toLocaleString(\"en-US\", {\n timeZone: \"America/Chicago\"\n })\n );\n\n // Get time from current CST date\n var currentCSTTime = currentCSTDate.toTimeString().substring(0, 8);\n\n // Get last day of the month\n var dayOfMonth = currentCSTDate.getDate();\n var lastDayOfMonth = new Date(\n currentCSTDate.getFullYear(),\n currentCSTDate.getMonth() + 1,\n 0\n ).getDate();\n\n if ((dayOfMonth === 16 || dayOfMonth === lastDayOfMonth) && currentCSTTime > cutoffTime) {\n var workDate = g_form.getValue(\"work_date\");\n\n if (workDate) {\n var formattedWorkDate = new Date(workDate + \"T00:00:00\");\n // If work_date is on or before current date, block submission\n if (formattedWorkDate <= currentCSTDate) {\n g_form.addErrorMessage(\n \"The time period closed for time submission at 8:00 PM CST. Time must be billed in the next time period.\" + \": \" + lastDayOfMonth\n );\n return false;\n }\n }\n }\n return true;\n}\n" }, { "path": "Client-Side Components/Client Scripts/Remove Option from Choice List/README.md", "content": "**Purpose:**\nThis onChange function automatically reacts when the \"Category\" field is changed. If the new category selected is \"inquiry,\" the function removes the options for \"Impact\" and \"Urgency\" that have a value of 1.\nWhenever a user selects a new category, the script checks if it’s set to \"inquiry.\" If so, it removes the specified options for \"Impact\" and \"Urgency\".\n**How to Use This Function**\nYou can use this Onchange client script on any form and maanage your field choice options.\n\n" }, { "path": "Client-Side Components/Client Scripts/Remove Option from Choice List/Remove Options from Choice List.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\nif (isLoading || newValue == '') {\nreturn;\n}\nif (newValue == 'inquiry') { //Onchange of Category\ng_form.removeOption('impact', '1');\ng_form.removeOption('urgency', '1');\n}\n}\n" }, { "path": "Client-Side Components/Client Scripts/Require comment onPriority change/README.md", "content": "Table: sn_customerservice_case\nType: OnChange\nField: Priority\n\nUse Case:\nMake additional comments mandatory on priority change for the case table.\n" }, { "path": "Client-Side Components/Client Scripts/Require comment onPriority change/script.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n if ((!g_form.isNewRecord()) && (newValue != oldValue)) {\n g_form.setMandatory('comments', true);\n g_form.addErrorMessage('Additional comment required when changing Priority.');\n } else {\n g_form.setMandatory('comments', false);\n }\n" }, { "path": "Client-Side Components/Client Scripts/Restrict Creation of P1, P2 Incidents/README.md", "content": "The code snippet can be used to restrict the creation of priority P1, P2 incidents except for the admins and a particular group members.\n\nTo achieve this requirement, I have created a onChange client script for the field name \"Priority\" and also created a script include to get the necessary data from the server side.\n" }, { "path": "Client-Side Components/Client Scripts/Restrict Creation of P1, P2 Incidents/Restrict_Creation_Of_P1_P2_Incidents.js", "content": "//Client Script\n\n//Type onChnage, Field name: Priority\n\n// To restrict creation of priority P1, P2 incidents except for the admins and a particular group members\n\nvar checkAjax = '';\n// if logged in user is admin then skip the code execution\nif(!g_user.hasRole('admin')){\n\tif(newValue == 1 || newValue == 2){\n\t\tif(g_form.isNewRecord()){\n\t\n\t\tcheckAjax = new GlideAjax('checkMemberOfGroup');\n\t\tcheckAjax.addParm('sysparm_name', 'checkAccessNew');\n\t\tcheckAjax.getXMLWait();\n\t\tvar ans = checkAjax.getAnswer();\n\t\tif(and == 'false'){\n\t\t\tg_form.setValue('impact', 3);\n\t\t\tg_form.setValue('urgency', 3);\n\t\t\tg_form.addErrorMessage('Creation of P1, P2 incidents is restricted to Admins and IT ServiceDesk');\n\t\t}\n\t\telse{\n\t\t\tvar incNumber = g_form.getValuye('number');\t\n\t\t\tcheckAjax = newGlideAjax('checkMemberOfGroup');\n\t\t\tcheckAjax.addParm('sysparm_name', 'checkAccess');\n\t\t\tcheckAjax.addParm('sysparm_number', incNumber); // passing the current incident number so that if the logged in user is an end user, then get the previous values of impact and urgency values.\n\t\t\tcheckAjax.getXMLWait();\n\t\t\tvar ans = checkAjax.getAnswer();\n\t\t\tans = ans.split(\",\");\n\t\t\t// if value returned false, then logged in user is neither admin nor member of a particluar gorup, \n\t\t\tif(ans[2] == 'false'){\n\t\t\t\tvar imp = parseInt(ans[0]);\n\t\t\t\tvar urg = parseInt(ans[1]);\n\t\t\t\t// setting back the impact and urgency values to their previous values if logged in user is not part of a particular group and not an admin.\n\t\t\t\tg_form.setValue('impact', imp);\n\t\t\t\tg_form.setValue('urgency', urg);\n\t\t\t\tg_form.addErrorMessage('Creation of P1, P2 incidents is restricted to Admins and IT ServiceDesk');\n\t\t\t}\n\t\t}\n\t}\n}\n\n\n\n//Script Include\n\nvar checkMemberOfGroup = Class.create();\ncheckMemberOfGroup.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n// The below method is used to restrict the creation of P1, P2 incidents for existing incidents\ncheckAccess: function(){\n \tvar arr = [];\n\tvar number = this.getParameter('sysparm_number');\n\tvar glideInc = new GlideRecord('incident');\n\tglideInc.addquery('number', number);\n\tglideInc.query();\n\tif(glideInc.next()){\n\t\tarr.push(glideInc.impact);\n\t\tarr.push(glideInc.urgency);\n\t}\n\tvar checkGroupMember = gs.getUser().isMemberOf('Group_Name');\n\tif(checkGroupMember){\n\t\tarr.push('true');\n\t}\n\telse{\n\t\tarr.push('false');\n\t}\n\treturn arr.toString();\n},\n// The below function is used to restict the creation of priority P1, P2 incidents for new incidents\n\ncheckAccessNew: function(){\n\t\n\tvar checkGroupMember = gs.getUser().isMemberOf('Group_Name');\n\tif(checkGroupMember){\n\t\treturn true;\n\t}\n\treturn false;\n},\ntype: 'checkMemberOfGroup\n});\n" }, { "path": "Client-Side Components/Client Scripts/Restrict Fields on Template/README.md", "content": "**Details**\n\nThis is a on change client script on sys_template table. This script will restrict users to select defined fields while template creation.\nType: OnChange\nField: Template\nTable: sys_template\n\n**Use Case**\n\nThere is an OOB functionality to restrict fields using \"**save as template**\" ACL, but it has below limitations:\n1. If the requirement is to restrcit more number of fields (example: 20), 20 ACLs will have to be created.\n2. The ACls will have instance wide effect, this script will just restrict on client side.\n" }, { "path": "Client-Side Components/Client Scripts/Restrict Fields on Template/script.js", "content": "/*\nType: onChnage\nTable: sys_template\nField: Template\n*/\nfunction onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n if (g_form.getValue('table') == 'incident') { // table on which sys_template is being created.\n var fields = ['active', 'comments']; // array of fields to be restricted while template creation.\n for (var i = 0; i < fields.length; i++) {\n if (newValue.indexOf(fields[i]) > -1) {\n alert(\"You Cannot Add \" + fields[i]); // alert if user selects the restricted field.\n var qry = newValue.split(fields[i]);\n g_form.setValue('template', qry[0] + 'EQ'); // set the template value to previous values (oldValue does not work in this case).\n }\n }\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Set Severity, state & assigned to/README.md", "content": "Use the script provided in script_include.js and script.js to set fetch multiple values from server to client side by passing an\nobject from server to the client side and setting values on your form. This can be used to pass multiple parameters from server to\nclient side.\n\nUse Case:\nConsider you have a reference field on your form referring to \"sn_si_incident\" and you need to set Severity, state and assigned to\nonChange of the reference field.\n\nSolution:\nCreate a client callable script include as mentioned in script_include.js and pass the required values to your client script.\nThen use the onChange client script in script.js to set values on the form.\n" }, { "path": "Client-Side Components/Client Scripts/Set Severity, state & assigned to/script.js", "content": "//onChange client script\n\nfunction onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n \n return;\n }\n\n\n //Type appropriate comment here, and begin script below\n var ga = new GlideAjax('getSIRDetails'); // calling script include\n ga.addParam('sysparm_name', 'getDetails');\n ga.addParam('sysparm_sir', newValue); //passing newValue to the script include\n ga.getXMLAnswer(callBackFunction);\n\n\n function callBackFunction(response) {\n var ans = JSON.parse(response);\n g_form.setValue('severity', ans.severity); // setting values from the obj to appropriate fields\n g_form.setValue('soc_sir_state', ans.state);\n g_form.setValue('soc_sir_assigned_to', ans.assignedto);\n\n\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Set Severity, state & assigned to/script_include.js", "content": "//Client callable script include\nvar getSIRDetails = Class.create();\ngetSIRDetails.prototype = Object.extendsObject(global.AbstractAjaxProcessor, {\n getDetails: function() {\n var sir = this.getParameter('sysparm_sir'); //getting the newValue of Security Inc from onChange client script\n var obj = {}; //declare an object\n var gr = new GlideRecord('sn_si_incident');\n gr.addQuery('sys_id', sir); //Query to security incident table with the newValue\n gr.query();\n if (gr.next()) {\n obj.severity = gr.severity.getDisplayValue(); //Setting values in the obj\n obj.state = gr.state.getDisplayValue();\n obj.assignedto = gr.assigned_to.getDisplayValue();\n }\n return JSON.stringify(obj); //passing the object to client script\n },\n type: 'getSIRDetails'\n});\n" }, { "path": "Client-Side Components/Client Scripts/Set Urgency to High onChange of caller field/README.md", "content": "This is a client script that change urgency to high automatically when changing caller field with the caller name whose vip is true\n" }, { "path": "Client-Side Components/Client Scripts/Set Urgency to High onChange of caller field/script.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n\n var vipalert = g_form.getReference('caller_id',vipFunction);\n function vipFunction(vipAlert){\n\t if(vipAlert.vip == 'true'){\n g_form.setValue('urgency','1');\n\t }\n }\n \n}\n" }, { "path": "Client-Side Components/Client Scripts/Set field style like font and background/OnLoad client script.js", "content": "\n// your condition to apply the style e.g. user is a VIP user\nvar condition = true; // Set the condition as needed\n\n// Find the control\nvar fieldToSetStyle = g_form.getControl('sys_display.incident.caller_id');\n\n\nif (condition == true) {\n fieldToSetStyle.style.fontWeight = 'bold';\n fieldToSetStyle.style.backgroundColor = 'red';\n} else {\n fieldToSetStyle.style.fontWeight = 'normal';\n fieldToSetStyle.style.backgroundColor = 'white';\n}" }, { "path": "Client-Side Components/Client Scripts/Set field style like font and background/README.md", "content": "# Client Script - Change field style\n\nA client script that changes field font, and background based on some condition\nAnd example would be if the currently raised incident is by a VIP user and hightlight the caller...\n\n## Usage\n\n- Create a new OnLoad script\n- Copy this script into it\n- Set the condition and the field that requires to be changed\n" }, { "path": "Client-Side Components/Client Scripts/Show Current Domain/DomainCheckUtil.js", "content": "var DomainCheckUtil = Class.create();\nDomainCheckUtil.prototype = Object.extendsObject(global.AbstractAjaxProcessor, {\n //get current domain of user session\n getCurrentDomainName: function() {\n var sessionDomainId = gs.getSession().getCurrentDomainID();\n var gr = new GlideRecord('domain');\n if (gr.get(sessionDomainId)){\n return gr.name;\n\t\t}\n //Return global domain name \n return 'Global';\n },\n\n type: 'DomainCheckUtil'\n});\n" }, { "path": "Client-Side Components/Client Scripts/Show Current Domain/Readme.md", "content": "Domain Separation Current Domain Display\nOverview\nThis functionality provides real-time awareness to users about the current selected domain within ServiceNow's Domain Separation framework. It displays an informational message on form load indicating the active domain context, helping prevent accidental configuration or data entry in the wrong domain.\n\nComponents\nScript Include: DomainCheckUtil\nGlobal, client-callable Script Include allowing client scripts to query the current domain name via GlideAjax.\n\nMethods:\nisCurrentDomain(domainSysId) — Checks if a given domain sys_id matches the current session domain.\n\nClient Script\nAn onLoad client script configured globally on the Global table, set to true to load on all forms.\nCalls the Script Include via GlideAjax to retrieve current domain name asynchronously.\n\nDisplays the domain name as an informational message (g_form.addInfoMessage) on the form header on every page load.\n\nUsage\nUpon loading any record form, users see a message stating:\n\"You are currently working in Domain Separation domain: [domain_name].\"\n" }, { "path": "Client-Side Components/Client Scripts/Show Current Domain/Show Current Domain.js", "content": "function onLoad() {\n\tvar ga = new GlideAjax('DomainCheckUtil');\n ga.addParam('sysparm_name', 'getCurrentDomainName');\n ga.getXMLAnswer(showDomainMessage);\n function showDomainMessage(response) {\n\t\tvar message = 'You are currently working in Domain Separation domain: ' + response + '.';\n\t\tg_form.addInfoMessage(message);\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Show Message On Both Form and List/README.md", "content": "# Use Case\nThe OOB `GlideForm (g_form)` API has documentation on displaying messages of info, warning and error types on form view, but lack a success message. Moreover, this `g_form` API is not accessible on lists and hence makes it difficult to display list level messages.\nHowever, SN provides another client-side method `GlideUI.get().addOutputMessage({options})` that can be used to display messages in native UI irrespective of form or list views. Even the popular `g_form.addInfoMessage(params)` API actually leverages the same `addOutputMessage(options)` method to render messages.\nCustom icons can also be included, but the background colour is lost due to the way `.addOutputMessage()` method has been implemented.\n\n**Allowed icons (as per SN documentation):**\n> icon-user, icon-user-group, icon-lightbulb, icon-home, icon-mobile, icon-comment, icon-mail, icon-locked, icon-database, icon-book, icon-drawer, icon-folder, icon-catalog, icon-tab, icon-cards, icon-tree-right, icon-tree, icon-book-open, icon-paperclip, icon-edit, icon-trash, icon-image, icon-search, icon-power, icon-cog, icon-star, icon-star-empty, icon-new-ticket, icon-dashboard, icon-cart-full, icon-view, icon-label, icon-filter, icon-calendar, icon-script, icon-add, icon-delete, icon-help, icon-info, icon-check-circle, icon-alert, icon-sort-ascending, icon-console, icon-list, icon-form, and icon-livefeed\n\n\n# Output Screenshot\n\n![image](https://github.com/annaydas/code-snippets/assets/29729050/7c93828c-d30a-4255-a97c-a2ee4f9126ac)\n\n\n# Usage\n\n### Success Message\n```javascript\nGlideUI.get().addOutputMessage({\n msg: 'Success',\n type: 'success',\n preventDuplicates: true\n});\n```\n\n### Warning Message\n```javascript\nGlideUI.get().addOutputMessage({\n msg: 'Warning',\n type: 'warning',\n preventDuplicates: true\n});\n```\n\n### Error Message\n```javascript\nGlideUI.get().addOutputMessage({\n msg: 'Error',\n type: 'error',\n preventDuplicates: true\n});\n```\n\n### Info Message\n```javascript\nGlideUI.get().addOutputMessage({\n msg: 'Info',\n type: 'info',\n preventDuplicates: true\n});\n```\n\n### Custom Icon (but it loses the background colour)\n```javascript\nGlideUI.get().addOutputMessage({\n msg: 'Custom Icon, but styling is lost',\n icon: 'icon-lightbulb',\n type: 'custom-message',\n preventDuplicates: true\n});\n```\n" }, { "path": "Client-Side Components/Client Scripts/Show Message On Both Form and List/script.js", "content": "// Success Message\nGlideUI.get().addOutputMessage({\n msg: 'Success',\n type: 'success',\n preventDuplicates: true\n});\n\n// Warning Message\nGlideUI.get().addOutputMessage({\n msg: 'Warning',\n type: 'warning',\n preventDuplicates: true\n});\n\n// Error Message\nGlideUI.get().addOutputMessage({\n msg: 'Error',\n type: 'error',\n preventDuplicates: true\n});\n\n// Info Message\nGlideUI.get().addOutputMessage({\n msg: 'Info',\n type: 'info',\n preventDuplicates: true\n});\n" }, { "path": "Client-Side Components/Client Scripts/Show field if x things are checked/README.md", "content": "Use this script to show a field after `n` checkboxes are checked and not before.\n\n**Tested in Global scope\n**You can't make mandatory fields as readonly\n**Best Practice is to use UI Policies\n**Sometimes you have a lot of check marks and that logic gets narly\n" }, { "path": "Client-Side Components/Client Scripts/Show field if x things are checked/script.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n //Set the mandatory checkbox variable names and total mandatory count here\n var mandatoryVars = ['option1', 'option2', 'option3', 'option4', 'option5'];\n var variableToShow = 'someothervariable';\n var requiredCount = 2;\n var actualCount = 0;\n for (var x = 0; x < mandatoryVars.length; x++) {\n if (g_form.getValue(mandatoryVars[x]) == 'true') {\n actualCount++;\n }\n }\n if (requiredCount <= actualCount) {\n g_form.setDisplay(variableToShow, true);\n } else {\n g_form.setDisplay(variableToShow, false);\n }\n}" }, { "path": "Client-Side Components/Client Scripts/Smart-Field-Suggestions/README.md", "content": "# Smart Field Suggestions Based on Keywords\n\n## Category\nClient-Side Components / Client Scripts\n\n## Description\nThis is an onChange Client Script designed for the Incident table that dynamically suggests and populates the Category, Subcategory, and Priority fields based on keywords detected in the Short Description field. By matching keywords, it prompts users to confirm applying suggestions aligned with backend choice values for seamless integration.\n\n## Use Case\nDuring incident creation or update, manually categorizing tickets correctly is critical for IT operations efficiency. This snippet automates early triage by analyzing user-entered short descriptions, providing actionable suggestions to improve categorization accuracy, accelerate routing, and enhance resolution speed.\n\n## How to Use\n- Add this script as an \"onChange\" client script on the Incident table's `short_description` field.\n- Ensure the Category, Subcategory, and Priority fields have choice lists aligned with backend values specified in the snippet.\n- Modify the keyword list to align with your organizational terminologies if needed.\n- The user will be prompted with suggestions and may confirm or dismiss them, allowing balanced automation and human control.\n\n## Why This Use Case is Unique and Valuable\n\n- Dynamically assists in categorizing incidents early, improving routing and resolution time.\n- Uses only platform APIs (`g_form`) without custom backend code or external integrations, making it lightweight and maintainable.\n- Uses real backend choice values ensuring seamless compatibility with existing configurations, reducing errors.\n- Provides prompt suggestions with user confirmation, balancing automation and user control.\n- Easily adaptable for other fields, keywords, or use cases beyond Incident management.\n- Designed without fragile DOM manipulations, following ServiceNow best practices, tailored for real environments.\n\n## Compatibility\nThis client script is compatible with all standard ServiceNow instances without requiring ES2021 features.\n\n## Files\n- `Smart Field Suggestions Based on Keyword.js` — the client script implementing the logic.\n\n\n" }, { "path": "Client-Side Components/Client Scripts/Smart-Field-Suggestions/Smart Field Suggestions Based on Keyword.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || !newValue || newValue.length < 10) {\n return;\n }\n\n var keywords = [\n { \n pattern: /password|login|access/i, \n category: 'inquiry | Help ', \n subcategory: 'antivirus', \n priority: '3', \n suggestion: 'This appears to be a Inquiry issue.' \n },\n { \n pattern: /slow|performance|hanging/i, \n category: 'software', \n subcategory: 'email', \n priority: '2', \n suggestion: 'This appears to be a Software issue.' \n },\n { \n pattern: /printer|print|printing/i, \n category: 'hardware', \n subcategory: 'monitor', \n priority: '3', \n suggestion: 'This appears to be a Hardware issue.' \n },\n { \n pattern: /database|data/i, \n category: 'database', \n subcategory: 'db2', \n priority: '3', \n suggestion: 'This appears to be an Database issue.' \n },\n { \n pattern: /network|internet|wifi|connection/i, \n category: 'network', \n subcategory: 'vpn', \n priority: '2', \n suggestion: 'This appears to be a network issue.' \n }\n \n ];\n\n var lowerDesc = newValue.toLowerCase();\n var matched = null;\n\n for (var i = 0; i < keywords.length; i++) {\n if (keywords[i].pattern.test(lowerDesc)) {\n matched = keywords[i];\n break;\n }\n }\n\n g_form.hideFieldMsg('short_description', true);\n g_form.clearMessages();\n\n if (matched) {\n g_form.showFieldMsg('short_description', matched.suggestion, 'info', false);\n\n if (confirm(matched.suggestion + \"\\n\\nApply these suggestions?\")) {\n g_form.setValue('category', matched.category);\n g_form.setValue('subcategory', matched.subcategory); // Make sure you use backend value for subcategory!\n g_form.setValue('priority', matched.priority);\n g_form.addInfoMessage('Suggestions applied automatically!');\n } else {\n g_form.addInfoMessage('Suggestions dismissed.');\n g_form.hideFieldMsg('short_description', true);\n }\n } else {\n g_form.addInfoMessage('No keywords matched in description.');\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/State changes to On Hold then worknotes should be mandatory/README.md", "content": "## This is OnChange client Script\n# whenever the 'State' on incident table will change to 'on Hold' the 'work notes' will become mandatory\nWhile using this script the table should be selected as 'incident' and type should be 'onChange' and field should be selected as 'State'. then write the script.\n" }, { "path": "Client-Side Components/Client Scripts/State changes to On Hold then worknotes should be mandatory/worknotes.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\nif(newValue == '3') // here 3 is the value of On Hold\n{\n\tg_form.setMandatory('work_notes',true);\n}\n else {\n\tg_form.setMandatory('work_notes',false);\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Sync Ajax with no getXMLWait/README.md", "content": "# onSubmit Ajax validation with no getXMLWait\n\nUsing getXMLWait() ensures the order of execution, but can cause the application to seem unresponsive, significantly degrading the user experience of any application that uses it.\n\nAlso, the getXMLWait method is not available in scoped applications.\n\nThis snippet simulates the behavior of the getXMLWait method." }, { "path": "Client-Side Components/Client Scripts/Sync Ajax with no getXMLWait/script.js", "content": "function onSubmit() {\n\tif (g_scratchpad.isFormValid) {\n\t\treturn true;\n\t}\n\n\tvar actionName = g_form.getActionName();\n\tvar ga = new GlideAjax('scriptIncludeName');\n\tga.addParam('sysparm_name', 'methodName');\n\tga.addParam('sysparm_additional_parm', 'parmValue');\n\tga.getXMLAnswer(function (answer) {\n\t\tif (answer == 'true') {\n\t\t\tg_scratchpad.isFormValid = true;\n\t\t\t// It will trigger the same UI action that was used to submit the form\n\t\t\tg_form.submit(actionName);\n\t\t}\n\t});\n\n\treturn false;\n}" }, { "path": "Client-Side Components/Client Scripts/Toggle Annotation On Forms With Script/README.md", "content": "# Use Case\nThis method can be used to show/hide/toggle form annotations through client-side script.\n\n# Limitation\nThis script works only with form annotations of the following types:\n- Info Box Blue\n- Info Box Red\n- Section Details\n- Text\n\n# Usage\n\n### Show form annotations\n```javascript\nSN.formAnnotations.show();\n```\n\n### Hide form annotations\n```javascript\nSN.formAnnotations.hide();\n```\n\n### Toggle form annotations\n```javascript\nSN.formAnnotations.toggle();\n```\n" }, { "path": "Client-Side Components/Client Scripts/Toggle Annotation On Forms With Script/script.js", "content": "// Show form annotations\nSN.formAnnotations.show();\n\n// Hide form annotations\nSN.formAnnotations.hide();\n\n// Toggle form annotations\nSN.formAnnotations.toggle();\n" }, { "path": "Client-Side Components/Client Scripts/Toggle form section visibility/README.md", "content": "\n# Toggle Form Section Visibility Client Script\n\n## Overview\n\nThis client script enhances the user experience in ServiceNow by providing a dynamic way to toggle the visibility of a form section based on the state of a checkbox or switch field. It simplifies complex forms and allows users to control which sections they want to view, making the form more user-friendly.\n\n## How It Works\n\nWhen a user interacts with the designated checkbox field, the corresponding form section is either displayed or hidden in real-time. This behavior improves form navigation and streamlines the user experience.\n\n### Configuration\n\nTo use this client script in your ServiceNow instance, follow these steps:\n\n1. **Create a Client Script:**\n\n - Log in to your ServiceNow instance as an admin or developer.\n - Navigate to \"System Definition\" > \"Client Scripts.\"\n - Create a new client script and provide it with a meaningful name (e.g., \"Toggle Section Visibility\").\n\n2. **Copy and Paste the Script:**\n\n - Copy the JavaScript code provided in this README.\n - Paste the code into your newly created client script.\n\n3. **Customize Field and Section:**\n\n - Modify the script to specify the checkbox field that triggers the visibility toggle and the ID of the section you want to control.\n\n4. **Activate and Test:**\n\n - Save and activate the client script.\n - Test the functionality by creating or editing a form with the designated checkbox and section.\n\n## Example Usage\n\nImagine you have a form with a checkbox labeled \"Show Additional Details.\" When users check this box, the \"Additional Details\" section of the form becomes visible, and when unchecked, it is hidden. This feature simplifies long forms and allows users to focus on the information that matters to them.\n\n## Benefits\n\n- Improves user experience by offering dynamic form sections.\n- Simplifies complex forms, making them more user-friendly.\n- Enhances form navigation and efficiency.\n- Reduces clutter on forms and improves user satisfaction.\n\n## Code Explanation\n\n- The toggleFormSection function is defined to be executed when the checkbox field changes.\n- It retrieves the checkbox field's control and the section's HTML element by their respective IDs.\n- When the checkbox is checked (checkboxField.checked is true), it sets the section's display style property to 'block', making the section visible.\n- When the checkbox is unchecked, it sets the section's display property to 'none', hiding the section.\n- The g_form.observe method attaches the toggleFormSection function to the change event of the checkbox field, so it triggers whenever the checkbox state changes." }, { "path": "Client-Side Components/Client Scripts/Toggle form section visibility/toggleFormSection.js", "content": "// Client Script to Toggle Form Section Visibility\n\nfunction toggleFormSection() {\n var checkboxField = g_form.getControl('checkbox_field'); // Replace 'checkbox_field' with your field name\n var section = gel('section_id'); // Replace 'section_id' with the ID of the section to toggle\n\n if (checkboxField.checked) {\n section.style.display = 'block'; // Show the section when the checkbox is checked\n } else {\n section.style.display = 'none'; // Hide the section when the checkbox is unchecked\n }\n}\n\n// Attach the toggleFormSection function to the checkbox field's change event\ng_form.observe('change', 'checkbox_field', toggleFormSection);\n" }, { "path": "Client-Side Components/Client Scripts/Translate Message/README.md", "content": "# Translate your messages in client script using getMessage method\n\n *[getMessage() code snippet](getMessage.js)\n \n *[Translate message in client script doc](https://docs.servicenow.com/bundle/rome-platform-administration/page/administer/localization/task/t_TranslateAClientScriptMessage.html)\n" }, { "path": "Client-Side Components/Client Scripts/Translate Message/getMessage.js", "content": "/* Translate messages according to the logged in user's preferred language in client script using getMessage() method.\n Note: Make sure to add an entry under [sys_ui_message] table and add the key in your client script Message fied (Not available in form by default) for preventing an extra round trip to server for fetching the message.\n\n Code :- */\n\nvar msg = getMessage('message_key'); //message_key defined in [sys_ui_message] table and added to the Message field of the client script. Fetching and storing the translated message to msg variable.\ng_form.addInfoMessage(msg); // Showing the translated message as an info message.\n" }, { "path": "Client-Side Components/Client Scripts/Update Category from Short Description Keywords/README.md", "content": "## Client Script that looks for category keywords in the Short Description updates the category field\n\n* Name: Set Category From Desc Keyword \n* Table: Incident\n* Type: onChange\n* Field Name: Short Description\n" }, { "path": "Client-Side Components/Client Scripts/Update Category from Short Description Keywords/script.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '')\n return;\n //Query the short description field\n\n var x = g_form.getValue('short_description');\n var shortDescription = x.toLowerCase();\n\n\n\n //Define a mapping of keywords to assignment groups\n var keywordMapping = {\n \"network\": \"network\",\n \"ip\": \"network\",\n \"software\": \"software\",\n \"adobe\": \"software\",\n \"outlook\": \"software\",\n \"hardware\": \"hardware\",\n \"laptop\": \"hardware\",\n \"printer\": \"hardware\",\n \"database\": \"database\",\n \"oracle\": \"database\",\n \"how\": \"inquiry\",\n \"support\": \"inquiry\",\n\n };\n\n //Loop through the keywords and check if they are present in the short description\n for (var keyword in keywordMapping) {\n if (shortDescription.indexOf(keyword) !== -1) {\n //Set the Category based on the matching keyword\n g_form.setValue('category', keywordMapping[keyword]);\n break;\n }\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Use case of addOption() and removeOption()/README.md", "content": "# onChange client script for table 'change_request' where field is 'priority'\nif priority is critical, impact can be high and medium i.e, low will be removed from choice list using removeOption()\nand for other priority ,impact can be high, medium and low i.e, low option will be added, using addOption()\n" }, { "path": "Client-Side Components/Client Scripts/Use case of addOption() and removeOption()/script.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n\treturn;\n }\n if(newValue == 1) {\n\tg_form.removeOption('impact',3); // 3 is the value for impact 'low'\n } else {\n\tg_form.addOption('impact',3,'3 - Low');\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Validate Interaction record for FCR(First Call Resolution)/readme.md", "content": "README — Client Script: Validate Interaction Resolution\n📌 Purpose\nThis Client Script ensures proper validation when resolving an Interaction record in ServiceNow.\nIt prevents a user from marking an Interaction as Closed Complete without proper justification.\n\n🎯 What It Does\n\nWhen a user attempts to submit the form:\n✔ Allows submission only if:\nInteraction Type is \"walkup\"\nAnd Related Task Boolean is true\n\nOR\n\n✔ If work notes are provided for First Contact Resolution (FCR)\n❌ Prevents submission if:\nState = Closed Complete\nWork Notes are empty\nAnd no related task condition is met\n\n🧠 Validations Performed\nField\tCondition\tAction\nstate\tclosed_complete\tTrigger validation\ntype\twalkup AND u_boolean_no_related_task = true\tSubmission allowed ✅\nwork_notes\tMust not be empty\tShow error & stop submission ❌\n🔔 User Feedback\n\nIf work notes are missing:\nDisplays inline field message\n\nShows popup alert:\n\"Provide Worknotes for FCR Interaction\"\n\n📍 Script Location\n\nClient Script → Type: onSubmit()\nApplicable to Interaction table (interaction)\n\n📌 Script Code\n//Client Script to validate an Interaction record is resolved with out any related record created.\nfunction onSubmit() {\n var relatedTask = g_form.getValue('u_boolean_no_related_task');\n var state = g_form.getValue('state');\n var type = g_form.getValue('type');\n var workNotes = g_form.getValue('work_notes'); // Get the value of work notes\n\n // Clear previous field messages\n g_form.clearMessages();\n\n // Check if state is changing to 'Closed Complete'\n if (state == 'closed_complete') {\n // Check additional conditions\n if (type == 'walkup' && relatedTask == 'true') {\n return true; // Allow form submission\n } else if (!workNotes) { // Check if work notes is empty\n g_form.showFieldMsg('work_notes', 'Provide Worknotes for FCR Interaction', 'error');\n alert('Provide Worknotes for FCR Interaction');\n return false; // Prevent form submission\n }\n }\n return true; // Allow form submission for other states\n}\n\n✅ Benefits\n\nMaintains consistent resolution standards\nEnsures justification/documentation for FCR interactions\nReduces incorrect closure of requests without related actions\n\n\n\n" }, { "path": "Client-Side Components/Client Scripts/Validate Interaction record for FCR(First Call Resolution)/script.js", "content": "//Client Script to validate an Interaction record is resolved with out any related record created.\nfunction onSubmit() {\n var relatedTask = g_form.getValue('u_boolean_no_related_task');\n var state = g_form.getValue('state');\n var type = g_form.getValue('type');\n var workNotes = g_form.getValue('work_notes'); // Get the value of work notes\n\n // Clear previous field messages\n g_form.clearMessages();\n\n // Check if state is changing to 'Closed Complete'\n if (state == 'closed_complete') {\n // Check additional conditions\n if (type == 'walkup' && relatedTask == 'true') {\n return true; // Allow form submission\n } else if (!workNotes) { // Check if work notes is empty\n g_form.showFieldMsg('work_notes', 'Provide Worknotes for FCR Interaction', 'error');\n\t\t\talert('Provide Worknotes for FCR Interaction');\n return false; // Prevent form submission\n }\n }\n return true; // Allow form submission for other states\n}\n" }, { "path": "Client-Side Components/Client Scripts/Validate Short Description/README.md", "content": "This Client Script validates the \"Short Description\" field before the form is submitted.\n If the description is more than 100 characters, it displays an alert and prevents submission. \nThis helps maintain data quality by ensuring adequate information is provided.\n" }, { "path": "Client-Side Components/Client Scripts/Validate Short Description/ShortDescriptionLength.js", "content": "\nfunction onSubmit() {\n var shortDescription = g_form.getValue('short_description');\n if (shortDescription.length > 100) {\n alert('Short Description must be not be more than 100 characters long.');\n return false; // Prevent form submission\n }\n return true; // Allow form submission\n}\n" }, { "path": "Client-Side Components/Client Scripts/Validate Short Description/validShortDescription.js", "content": "function onSubmit() {\n var shortDescription = g_form.getValue('short_description');\n if (shortDescription.length < 10) {\n alert('Short Description must be at least 10 characters long.');\n return false; // Prevent form submission\n }\n return true; // Allow form submission\n}\n" }, { "path": "Client-Side Components/Client Scripts/Validate Short Description/validateSpecialChar.js", "content": "// Client Script to Validate Special Charecters\nfunction onSubmit() {\n var shortDescription = g_form.getValue('short_description');\n var specialCharsRegex = /[^a-zA-Z0-9\\s]/g;\nvar specialChars = description.match(specialCharsRegex);\n if (specialChars) {\n alert('Description contains invalid characters: ' + specialChars.join(', '));\n return false;\n } else {\n return true;\n }\n \n" }, { "path": "Client-Side Components/Client Scripts/Validate date is in future without GlideAjax/OnChange Client Script.js", "content": "/*\n Client script that validates a date is in future without the need of a GlideAjax and Script Include\n*/\n\nfunction onChange(control, oldValue, newValue, isLoading, isTemplate) {\n if (isLoading || newValue === '') {\n return;\n }\n\n var fieldToValidate = ''\n\n var currentDate = formatDate(new Date(), g_user_date_format);\n var currentDateInMs = getDateFromFormat(currentDate, g_user_date_format);\n var dateToValidateInMs = getDateFromFormat(g_form.getValue(fieldToValidate), g_user_date_format);\n\n if (dateToValidateInMs <= currentDateInMs) {\n g_form.showFieldMsg(fieldToValidate, \"Enter a valid future date.\", 'error');\n return false;\n }\n}" }, { "path": "Client-Side Components/Client Scripts/Validate date is in future without GlideAjax/README.md", "content": "# Client Script - Date in future\n\nA client script that validates that a specified date is in future without the need for a GlideAjax and Script Include\n\n## Usage\n\n- Create a new client script\n- Set the type to OnChange\n- Select a date field that you want to validate\n- Navigate to the form and set the date field to the past\n- There will be a validation error close to the field\n" }, { "path": "Client-Side Components/Client Scripts/Verify if e-mail already exists with Ajax call/README.md", "content": "**Client Script**\n\nClient script for verification if changed e-mail adders on user record is not already existing in sys_user table (real-time information about duplicated e-mail). Check is performed using asynchronous Ajax call and processed in callback function. In case e-mail already exists in sys_user table, message is displayed under email field with information which has have that e-mail.\n\n**How to use**\n\nYou need to prepare both Script Include (which is processing check on backed) and Client Script (which is sending Ajax call after change on email field and display message).\n\nExample Script Include configuration (code in [scriptInclude.js](scriptInclude.js)):\n![Coniguration_SI](ScreenShot_2.PNG)\n\nExample Client Script configuration (code in [clientScript.js](clientScript.js)):\n![Coniguration_CS](ScreenShot_1.PNG)\n\n**Example effect of execution**\n\n![Coniguration_SI](ScreenShot_3.PNG)\n" }, { "path": "Client-Side Components/Client Scripts/Verify if e-mail already exists with Ajax call/clientScript.js", "content": "function onChange(control, oldValue, newValue, isLoading, isTemplate) {\n\n //Return if page is loading or new value of e-mail is empty\n if (isLoading || newValue === '') {\n return;\n }\n\n //Make Ajax call to check if e-mail already exists in sys_user table\n var ga = new GlideAjax('user_CheckEmail'); //user_CheckEmail - Script Include name\n ga.addParam('sysparm_name', 'validateEmail'); //sysparm_name - Parameter with function name in Script Include\n ga.addParam('sysparm_emailString', newValue); //sysparm_emailString - Parameter with new value of e-mail \n ga.getXMLAnswer(verifyDuplicates); //verifyDuplicates - Name of asynchronous callback function \n\n //Asynchronous callback function to process response\n function verifyDuplicates(response) {\n\n //If repsonse is not null (in case if e-mail was not find)\n if (response) {\n\n //Parse response and show message about found duplicate\n var data = JSON.parse(response);\n g_form.showFieldMsg('email', 'User with that e-mail already exists: ' + data.name + '(' + data.sys_id + ')', 'error');\n }\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/Verify if e-mail already exists with Ajax call/scriptInclude.js", "content": "var user_CheckEmail = Class.create();\nuser_CheckEmail.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n validateEmail: function() {\n\n //Get new value of e-mail field\n var emailString = this.getParameter('sysparm_emailString');\n\n //Query user table to verify if new e-mail already exists\n var user = new GlideRecord('sys_user');\n user.addQuery('email', emailString);\n user.query();\n\n //If e-mail already exists, return user name and sys_id\n if (user.next()) {\n\n var results = {\n \"sys_id\": user.getValue(\"sys_id\"),\n \"name\": user.getValue(\"name\")\n };\n return JSON.stringify(results);\n\n //If e-mail not exists, return null\n } else {\n return null;\n }\n }\n});\n" }, { "path": "Client-Side Components/Client Scripts/Verify whether a date falls within a hour range/README.md", "content": "A code snippet that verifies whether a date falls within a specific hour range.\n" }, { "path": "Client-Side Components/Client Scripts/Verify whether a date falls within a hour range/verifyWhetherADateFallsWithinAHourRange.js", "content": "/**\n * Verify whether a date falls within a hour range\n */\nfunction onChange() {\n var dateNow = new Date();\n\tvar dateOpenedAt = new Date(g_form.getValue('opened_at'));\n\tvar differenceInMilliseconds = dateOpenedAt.getTime() - dateNow.getTime();\n\tvar differenceInHours = diffInMs / (1000 * 60 * 60);\n\t\n\tif (differenceInHours < 24) {\n\t g_form.showFieldMsg('opened_at', 'Please choose a date and time that is at least 24 hours in the future.');\n\t\treturn false;\n\t}\n\t\n\treturn true;\n}\n" }, { "path": "Client-Side Components/Client Scripts/Whitespace Validation/README.md", "content": "This Client Script will validate whether the field contains any whitespace.\n" }, { "path": "Client-Side Components/Client Scripts/Whitespace Validation/whitespaceValidation.js", "content": "// Client Script to Validate Whitespaces\nvar reg = /\\s/;\nvar value = g_form.getValue('field_name');\nvar k = reg.test(value);\n\nif (k == true) {\n alert('Field Name cannot have spaces!'); // Alert if field contains whitespace\n g_form.setValue('field_name', ''); // Empty field for any whitespaces\n}\n" }, { "path": "Client-Side Components/Client Scripts/Zurich - Upgraded info messages/README.md", "content": "**This feature will be used in the instance of Zurich++ release**\n\nDemonstrate different messages that has been introduced as part of Zurich release.\n\nUse Case: Display different information messages based on priority of the incident that will be showed on load and state is not Closed, Resolved or Cancelled.\n" }, { "path": "Client-Side Components/Client Scripts/Zurich - Upgraded info messages/infoMessages.js", "content": "function onLoad() {\n var state = g_form.getValue('state'); //Get value of 'state' field\n\n if (state != '6' && state != '7' && state != '8') {\n var priority = g_form.getValue('priority'); // Get value of 'priority' field\n switch (priority) {\n case '1':\n g_form.addErrorMessage('Critical Incident'); \n break; \n case '2':\n g_form.addHighMessage('High Priority Incident'); // addHighMessage() method will display message in orange color\n break;\n case '3':\n g_form.addModerateMessage('Medium Priority Incident'); // addModerateMessage() method will display message in purple color\n break;\n case '4':\n g_form.addLowMessage('Low Priority Incident'); // addLowMessage() method will display message in grey color\n break;\n }\n } else if (state == '6' || state == '7') {\n g_form.addSuccessMessage('Incident closed'); // addSuccessMessage() method will display message in green color\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/field-character-counter/README.md", "content": "# Field Character Counter\n\n## Use Case\nProvides real-time character count feedback for text fields in ServiceNow forms. Shows remaining characters with visual indicators to help users stay within field limits.\n\n## Requirements\n- ServiceNow instance\n- Client Script execution rights\n- Text fields with character limits\n\n## Implementation\n1. Create a new Client Script with Type \"onChange\"\n2. Copy the script code from `script.js`\n3. Configure the field name and character limit in the script\n4. Apply to desired table/form\n5. Save and test\n\n## Configuration\nEdit these variables in the script:\n\n```javascript\nvar fieldName = 'short_description'; // Your field name\nvar maxLength = 160; // Your character limit\n```\n\n## Features\n- Real-time character counting as user types\n- Visual indicators: info (blue), warning (yellow), error (red)\n- Shows \"X characters remaining\" or \"Exceeds limit by X characters\"\n- Automatically clears previous messages\n\n## Common Examples\n```javascript\n// Short Description (160 chars)\nvar fieldName = 'short_description';\nvar maxLength = 160;\n\n// Description (4000 chars)\nvar fieldName = 'description';\nvar maxLength = 4000;\n\n// Work Notes (4000 chars)\nvar fieldName = 'work_notes';\nvar maxLength = 4000;\n```\n\n## Message Thresholds\n- **50+ remaining**: Info message (blue)\n- **1-20 remaining**: Warning message (yellow)\n- **Over limit**: Error message (red)\n\n## Notes\n- Uses standard ServiceNow APIs: `g_form.showFieldMsg()` and `g_form.hideFieldMsg()`\n- Create separate Client Scripts for multiple fields\n- Works with all text fields and text areas\n- Character count includes all characters (spaces, punctuation, etc.)" }, { "path": "Client-Side Components/Client Scripts/field-character-counter/script.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading) return;\n \n // USER CONFIGURATION: Set field name and character limit\n var fieldName = 'Description'; // Change to your field name\n var maxLength = 80; // Change to your character limit\n \n var currentLength = newValue ? newValue.length : 0;\n var remaining = maxLength - currentLength;\n \n // Clear any existing messages\n g_form.hideFieldMsg(fieldName);\n \n // Show appropriate message based on remaining characters\n if (remaining < 0) {\n g_form.showFieldMsg(fieldName, 'Exceeds limit by ' + Math.abs(remaining) + ' characters', 'error');\n } else if (remaining <= 20) {\n g_form.showFieldMsg(fieldName, remaining + ' characters remaining', 'warning');\n } else if (remaining <= 50) {\n g_form.showFieldMsg(fieldName, remaining + ' characters remaining', 'info');\n }\n}" }, { "path": "Client-Side Components/Client Scripts/g_form console access in workspace/README.md", "content": "# Access g_form instance inside Agent Workspace from DevTools Console\nWhen developing forms in ServiceNow it can be useful to try stuff out directly in the DevTools Console.\nIn UI16 this was pretty straightforward because g_form was available globally, Agent Workspace makes this a little bit more complicated.\nSo this script provides access to the g_form object of the currently active tab in a Workspace.\n\nJust copy the Script in the DevTools Console and run `var g_form = getGlideFormAW()` \nnow you should be able to do stuff like `g_form.setValue(\"short_description\", \"Lorem ipsum\")`" }, { "path": "Client-Side Components/Client Scripts/g_form console access in workspace/script.js", "content": "function getGlideFormAW() {\n document.getElementsByTagName(\"sn-workspace-content\")[0].shadowRoot.querySelectorAll(\"now-record-form-connected\")[0]\n\n var firstContentChild = document.getElementsByTagName(\"sn-workspace-content\")[0].shadowRoot\n .querySelectorAll(\".chrome-tab-panel.is-active\")[0].firstChild;\n\n var snWorkspaceFormEl;\n if (firstContentChild.tagName == \"NOW-RECORD-FORM-CONNECTED\") {\n snWorkspaceFormEl = firstContentChild.shadowRoot.querySelectorAll(\".sn-workspace-form\")[0];\n } else {\n snWorkspaceFormEl = firstContentChild.shadowRoot.querySelectorAll(\"now-record-form-connected\")[0]\n .shadowRoot.querySelectorAll(\".sn-workspace-form\")[0];\n }\n if (!snWorkspaceFormEl) throw \"Couldn't find sn-workspace-form\";\n\n var reactInternalInstanceKey = Object.keys(snWorkspaceFormEl).find(function (objKey) {\n if (objKey.indexOf(\"__reactInternalInstance$\") >= 0) {\n return true;\n }\n return false;\n });\n return snWorkspaceFormEl[reactInternalInstanceKey].return.stateNode.props.glideEnvironment._gForm;\n}" }, { "path": "Client-Side Components/Client Scripts/onfocus and onblur/README.md", "content": "Using \"onfocus\" & \"onblur\" Show/Hide field messages while updating a field.\n\nExample:On load Client script on the incident form\n\n![image](https://user-images.githubusercontent.com/42912180/195825979-e69e5798-a241-4fe8-8f49-7f70f1f3ae6e.png)\n\n\n\n**Quick video how it works:**\n\n\nhttps://user-images.githubusercontent.com/42912180/195825799-aff13ca5-0b85-4660-98a3-ea1af8b61974.mp4\n\n" }, { "path": "Client-Side Components/Client Scripts/onfocus and onblur/script.js", "content": "g_form.getElement(\"Field Name\").onfocus = focus;\ng_form.getElement(\"Field Name\").onblur = blur;\n}\n\n//function definition \n\nfunction focus() {\n g_form.showFieldMsg(\"Field Name\", \"Message you want to display\");\n}\n\nfunction blur() {\n g_form.hideFieldMsg(\"Field Name\");\n}\n" }, { "path": "Client-Side Components/Client Scripts/state-edit-for-grpmem/README.md", "content": "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.\n\n" }, { "path": "Client-Side Components/Client Scripts/state-edit-for-grpmem/grpmemstateedit.js", "content": "//Create a Display Business Rule with the following code and then the following code on \"On-Load\" client script\n\n//Display Business Rule Code:\n/*****\ng_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.\n*****/\n\nif(g_scratchpad.grpmember == false)\n{\ng_form.setReadonly(\"state\", true);\n}\n" }, { "path": "Client-Side Components/Client Scripts/validate phone number/README.md", "content": "Purpose: Ensures that users enter their phone numbers in a specific format. Phone number must be in format(123) 456-7890.\nThe regex:- \n1) ^\\(\\d{3}\\) \\d{3}-\\d{4}$ validates phone numbers in the format:\n2) An area code enclosed in parentheses (e.g., (123)),\n3) Followed by a space,\n4) Then three digits,\n5) A hyphen,\n6) And finally four digits.\n\nFunctionality: This script is triggered when the phone field changes. It uses a regular expression to validate the format. If the format is incorrect, it displays an error message and clears the field.\n" }, { "path": "Client-Side Components/Client Scripts/validate phone number/Readme.md", "content": "Phone Number Validation — Client Script \nOverview\n\nThis Client Script validates that users enter their phone numbers in the strict format: (123) 456-7890.\n\nIt is triggered whenever the Phone field changes on a sys_user record. If the input does not match the required format, the script:\n\nDisplays an inline error message directly below the field.\n\nClears the invalid input so the user can re-enter the correct value.\n\nThis script is designed to be dynamic, simple, and user-friendly.\n\nFeatures\n\nEnsures phone numbers follow the exact format (123) 456-7890.\n\nProvides immediate feedback via field-level error messages.\n\nClears invalid entries automatically to prevent submission errors.\n\nWorks on Classic UI forms and provides clear messaging to the user.\n\nUsage Instructions\n1. Create the Client Script\n\nNavigate to System Definition → Client Scripts.\n\nClick New to create a client script.\n\n2. Configure the Script\n\nName: Phone Number Validation\n\nTable: sys_user \n\nType: onChange\n\nField: phone\n" }, { "path": "Client-Side Components/Client Scripts/validate phone number/validate phone number.js", "content": "// Client Script: Validate Phone Number\n// Table: sys_user\n// Type: onChange\n// Field: phone\n\nfunction onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || newValue === '') return;\n\n var phoneRegex = /^\\(\\d{3}\\) \\d{3}-\\d{4}$/; // Format: (123) 456-7890\n if (!phoneRegex.test(newValue)) {\n g_form.showFieldMsg('phone', 'Phone number must be in the format (123) 456-7890', 'error');\n g_form.setValue('phone', '');\n }\n}\n" }, { "path": "Client-Side Components/Client Scripts/validate phone number/validate_phone_format_(123)_456-7890_no_regex.js.js", "content": "function onChange(control, oldValue, newValue, isLoading) {\n if (isLoading || !newValue) return;\n\n var fieldName = control.name;\n\n // Split the string\n var area = newValue.substring(1, 4);\n var firstThree = newValue.substring(6, 9);\n var lastFour = newValue.substring(10, 14);\n\n if (\n newValue[0] !== '(' || newValue[4] !== ')' || newValue[5] !== ' ' || newValue[9] !== '-' ||\n isNaN(parseInt(area)) || isNaN(parseInt(firstThree)) || isNaN(parseInt(lastFour))\n ) {\n g_form.showFieldMsg(\n fieldName,\n 'Phone Number must be in the format (123) 456-7890',\n 'error',\n false\n );\n g_form.setValue(fieldName, '');\n }\n}\n" }, { "path": "Client-Side Components/UI Actions/Add Loggedin user as Incident assigned to/ReadMe.md", "content": ">**UI Action**\nWhen a new Incident record is created, user can come to incident ticket and assigned to themself. Once they click on UI Action.\n" }, { "path": "Client-Side Components/UI Actions/Add Loggedin user as Incident assigned to/code.js", "content": "var currentUser = gs.getUserID(); //Getting loggedIn User Id\n\n//Checing wheather user is available or not in Assignee field\nif(current.assigned_to == \"\"){ //checking assigned to is there or not\n\tcurrent.assigned_to = currentUser; //Setting the current loggedIn user\n\tcurrent.update(); //updating the record.\n\tgs.addInfoMessage(\"Incident has been assigned to You.\");\n\taction.setRedirectURL(current);\n} else {\n\tgs.addErrorMessage(\"Incident is already assigned\");\n\taction.setRedirectURL(current);\n}\n" }, { "path": "Client-Side Components/UI Actions/Add Show Workflow Related link/README.md", "content": "There are many cases where,we would have workflows on custom tables or non task tables , where we would like to see the \"Show Workflow\" Related Link for ease of accessibility to the workflow.\nThe shared code will help show this related link on any rable record that has a workflow associated with it.\n\nBelow has to be set for this to work on UI action form:\n\n•\tTable: Select the table that you would like this UI action to be available on (preferably table with workflows)\n\n•\tOnclick : showWorkflow()\n\n•\tActive : True\n\n•\tShow Update : True\n\n•\tClient : True\n\n•\tForm Link : True\n\n•\tCondition : new global.Workflow().hasWorkflow(current)\n" }, { "path": "Client-Side Components/UI Actions/Add Show Workflow Related link/script.js", "content": "// -----------------------------\n// Open workflow in a new window\n// -----------------------------\nfunction showWorkflow() {\n var url = new GlideURL('/context_workflow.do');\n url.addParam('sysparm_stack', 'no');\n url.addParam('sysparm_document', g_form.getUniqueValue());\n\turl.addParam('sysparm_table', g_form.getTableName());\n\tg_navigation.open(url.getURL(), \"_blank\");\n}\n" }, { "path": "Client-Side Components/UI Actions/Add collapsible element in knowledge article/README.md", "content": "This code snippet will allow you to use collapsible element within knowledge atricle which will make articles clean, organized and effective.\n\n![Demo](https://github.com/abhrajyotikanrar/code-snippets/assets/25823899/e3ad356e-a5c5-4f2d-aafa-20f89b0da248)\n\nPlease check out the above demo on how this code-snippet can be used.\n" }, { "path": "Client-Side Components/UI Actions/Add collapsible element in knowledge article/UI_Action.js", "content": "/*\nThis script should be placed in the UI action on the table kb_knowledge form view.\nThis UI action should be marked as client.\nUse addCollapsible() function in the Onclick field.\n*/\n\nfunction addCollapsible() {\n var gm = new GlideModal(\"add_collapsible\");\n gm.setTitle('Add collapsible');\n gm.setWidth(1000);\n gm.render();\n}" }, { "path": "Client-Side Components/UI Actions/Add collapsible element in knowledge article/add_collapsible.js", "content": "******HTML*****\n\n\n\n\t\n\n\t\n \n\n\t
\n\n\t\n \n\n\t
\n\n\t
\n\t\tTitle and Content body should not be empty.\n\t
\n\n\t
\n\t\n\t\n\n****************\n\n**Client Script**\nfunction updateForm() {\n $j(\"#alert\").removeClass(\"show\");\n $j(\"#alert\").addClass(\"hide\");\n\n var title = $j(\"#collapsibleTitle\").val();\n var content = $j(\"#collapsibleContent\").val();\n\n if (title.trim() == \"\" || content.trim() == \"\") {\n $j(\"#alert\").removeClass(\"hide\");\n $j(\"#alert\").addClass(\"show\");\n\n return;\n }\n\n var articleText = g_form.getValue(\"text\");\n var collapsibleElement = \"
\" + title.trim() + \"
\" + content.trim() + \"
\";\n\n\tg_form.setValue(\"text\", articleText + collapsibleElement);\n\tGlideDialogWindow.get().destroy()\n}" }, { "path": "Client-Side Components/UI Actions/Call Subflow/README.md", "content": "# Call Subflow from UI Action\n\nThis UI Action enables calling a subflow from ServiceNow Flow Designer using the FlowAPI.\n\n### Instruction\n\nThe call can either be done synchronously or asynchronously, depending on the requirement. \n```javascript\n//Synchronous Call: \nsn_fd.FlowAPI.getRunner().subflow('global.subflow_name').inForeground().withInputs(inputs).run();\n//Asynchronous Call: \nsn_fd.FlowAPI.getRunner().subflow('global.subflow_name').inBackground().withInputs(inputs).run();\n```\n\nThe API call requires the subflow internal name and scope. The internal name is shown as a second column in the subflow overview in ServiceNow Flow Designer, while the scope is shown in the third column. In the above example the subflow internal name is **subflow_name** and it was created in the **global** scope.\n\n### Benefits\n- Enable Citizen Developers to create complex UI Actions with low code Flow Designer capabilities instead of scripting\n- Run complex server side UI Actions asynchronously via Flow Designer for better user experience (avoids long loading times in the current user session)\n- Re-use already created subflows and actions as well as provided spokes in UI actions\n" }, { "path": "Client-Side Components/UI Actions/Call Subflow/script.js", "content": "(function() {\n\t\n\ttry {\n \t\t// Provide subflow inputs\n\t\tvar inputs = {};\n\t\tinputs['incident'] = current; //the current incident record can be provided as input to the subflow\n \n \t\t//The subflow can either be executed synchronously (running in foreground) or asynchronously (running in background)\n \t\t//If the flow runs asynchronously the FlowAPI will not provide the outputs of the subflow\n \n \t\t//Asynchronous call\n\t\t// sn_fd.FlowAPI.getRunner().subflow('global.subflow_name').inBackground().withInputs(inputs).run();\n \n \t\t//Synchronous call\n\t\t// sn_fd.FlowAPI.getRunner().subflow('global.subflow_name').inForeground().withInputs(inputs).run();\n \n \t\t//In this case we are calling the subflow global.create_problem_from_incident synchronously and then access the subflow outputs\n\t\tvar result = sn_fd.FlowAPI.getRunner().subflow('global.create_problem_from_incident').inForeground().withInputs(inputs).run();\n\t\tvar outputs = result.getOutputs();\n\n\t\t// Get subflow outputs:\n\t\tvar problem_number = outputs['problem_number'];\n\t\tvar assignment_group = outputs['assignment_group'];\n\t\t\n\t} catch (ex) {\n\t\tvar message = ex.getMessage();\n\t\tgs.error(message);\n\t}\n\t\n})();\n" }, { "path": "Client-Side Components/UI Actions/CallingPopUpBoxInListView/README.md", "content": "Overview\nThis document explains how to implement a custom UI action that triggers a UI page from the list view of a table in ServiceNow. Specifically, it demonstrates how to open a modal dialog when multiple items are selected in the list view. The modal dialog will display a UI page and pass the selected record sys_ids as parameters. This allows users to update multiple records simultaneously through the UI page, streamlining processes such as mass updates. This approach enhances user efficiency by enabling the execution of actions on multiple records at once, reducing manual effort and improving workflow automation\nPurpose of the UI Action\nThe purpose of this UI action is to allow users to select multiple records from the list view and trigger a modal popup that displays a custom UI page. The user can interact with the popup to perform actions to update field value by slecting field values from the pop up. The selected records are passed to the UI page as parameters, ensuring the action is applied to all the checked items.\n\nDocument: Using UI Action to Call a Custom UI Page in List View\nOverview\nThis document explains how to implement a custom UI action that calls a UI page from the list view of a table in ServiceNow. Specifically, it demonstrates how to open a modal dialog when multiple items are selected in the list view. The modal dialog will display a UI page and pass selected record sys_ids as parameters. This can be useful for tasks like requesting an exception, remediation, or other custom actions that require user interaction.\n\nPurpose of the UI Action\nThe purpose of this UI action is to allow users to select multiple records from the list view and trigger a modal popup that displays a custom UI page. The user can interact with the popup to perform actions such as remediation, request handling, or exception requests, depending on the implementation of the UI page. The selected records are passed to the UI page as parameters, ensuring the action is applied to the correct items.\n\nHow It Works\nUI Action Creation:\nA UI action is created in ServiceNow, configured to be available in the list view of a specific table. In this example, the UI action is configured on the Incident table.\n\nJavaScript Function:\nThe function showExceptiondialog() is triggered when the UI action button is clicked. This function does the following:\n\nCheck for selected records:\nThe script checks if any records have been selected in the list view. If no records are selected, an error message is shown to the user.\nOpen Modal Popup:\nIf records are selected, the function opens a modal dialog using either GlideModal or GlideDialogWindow, depending on the environment. The dialog displays a UI page specified by name (incident_pop_up in the example).\nPass Selected Records:\nThe selected record sys_ids are passed as a parameter (sysparm_sys_id) to the UI page, allowing the page to perform actions on those records.\nUI Action Configuration\nTable:\nThe UI action is configured for a specific table, such as the Incident table (incident).\n\nList Context:\nThe UI action should be available in the list view, where multiple records can be selected.\n\nOnClick Event:\nThe UI action calls the JavaScript function showExceptiondialog() when clicked.\n Testing\nNavigate to List View:\nGo to the list view of the table where the UI action is configured (e.g., Incident table).\n\nSelect Records:\nCheck one or more records in the list view.\n\nClick the UI Action Button:\nClick the UI action button that triggers the showExceptiondialog() function. If no records are selected, an error message will appear. If records are selected, the modal dialog will open and display the custom UI page.\n\nVerify Modal:\nEnsure that the modal popup displays the correct UI page and that the selected records’ sys_ids are passed as parameters.\nBenefits\nUser-Friendly:\nThe modal popup provides an intuitive interface for users to perform actions on multiple selected records without leaving the list view.\n\nCustomizable:\nThe UI page can be customized to handle a variety of actions based on the selected records. For example, it can be used for remediation tasks, exception requests, approvals, or other workflows.\n\nEfficiency:\nUsers can quickly perform actions on multiple records at once, reducing the need for repetitive manual operations.\n\nError Handling:\nThe script includes error handling to ensure users are prompted if they attempt to perform an action without selecting records.\n" }, { "path": "Client-Side Components/UI Actions/CallingPopUpBoxInListView/calling_pop_up_box_in_list_view.js", "content": "function showExceptiondialog() {\n // Alert to display the checked records\n alert(g_list.getChecked());\n \n // Check if any records are selected in the list\n if ((g_list.getChecked()).length > 0) {\n var title = getMessage(\"Remediation Task\");\n var dialogClass = GlideModal || GlideDialogWindow;\n \n // Initialize the modal dialog with a custom UI page\n var dialog = new dialogClass(\"incident_pop_up\", true, 750);\n dialog.setTitle(title);\n \n // Pass selected record sys_ids as parameters to the UI page\n dialog.setPreference(\"sysparm_sys_id\", g_list.getChecked());\n \n // Render the modal dialog\n dialog.render();\n } else {\n // Show error messages if no records are selected\n g_form.addErrorMessage(getMessage('Please Select Vulnerable Items before creating remediation'));\n alert('Please Select Vulnerable Items before creating remediation');\n }\n}\n" }, { "path": "Client-Side Components/UI Actions/Cancel Flow Executions/README.md", "content": "# CancelFlow UI Action\n\nA ServiceNow utility that dynamically cancels flows associated with the current record, ensuring seamless process management.\n\n## Challenge\n\nManaging running flows in ServiceNow can be challenging, particularly when multiple flows are tied to a single record. This utility streamlines the process by offering a dynamic solution to identify and cancel running flows, minimizing manual intervention and ensuring seamless operations.\n\nThis tool is especially useful in scenarios where you need to halt the current execution and initiate a new flow or process. Additionally, it can be leveraged to forcefully terminate the automation lifecycle when necessary, providing greater control over flow management.\n\n## Description\n\nThis UI Action is designed to identify and cancel all running flows associated with the current record in a ServiceNow instance. It provides a user-friendly interface for administrators and developers to manage flow cancellations efficiently. This utility is particularly useful in scenarios where flows need to be terminated to prevent conflicts or errors during record updates.\n\n## Functionality\n\nThe CancelFlow UI Action provides the following capabilities:\n- Dynamically identifies running flows for the current record.\n- Cancels the identified flows programmatically.\n- Displays success or error messages to the user for better visibility.\n- Ensures smooth handling of flow cancellations without manual intervention.\n\n## Usage Instructions\n\n### UI Action Script\n\nAdd the given script to your UI Action:\n\n\n### Example Usage\n\n1. Open the record where you want to cancel the associated flows.\n2. Click on the **Cancel Flow** UI Action button.\n3. The system will identify and cancel all running flows for the current record.\n4. The same can be used in Business rules as well based on trigger conditions\n\n\n### Visibility for UI Action\n\nIn certain scenarios, it may be necessary to restrict the visibility of this operation to specific user groups. For example, only HR administrators or members of a designated group (e.g., \"X Group\") should have access to this functionality. These requirements can be addressed by configuring the **Condition** field in the UI Action. You can tailor the conditions to align with your specific use case, ensuring that only authorized users can execute this operation. One edge case about not having an active flow execution can also be handled in the condition which will restrict the visibility if no active flow execution is present.\n\n\n## Dependencies\n\n- `sn_fd.FlowAPI`\n\n## Category\n\nClient-Side Components / UI Actions \n" }, { "path": "Client-Side Components/UI Actions/Cancel Flow Executions/cancelFlow.js", "content": "function cancelRunningFlows() {\n\n try {\n var grFlowExecution = new GlideRecord(\"sys_flow_context\");\n grFlowExecution.addQuery(\"source_record\", current.sys_id);\n grFlowExecution.query();\n\n while (grFlowExecution.next()) {\n sn_fd.FlowAPI.cancel(grFlowExecution.getUniqueValue(), \"Canceling Flows\");\n }\n } catch (error) {\n gs.error(\"Error cancelling flows: \" + error.message);\n }\n}\n\n\n" }, { "path": "Client-Side Components/UI Actions/Cancel Incident/README.md", "content": "# Cancel Incident UI Action\n\nA UI Action in ServiceNow is a script that defines an action or button within the platform's user interface. It enables users to perform specific operations on forms and lists, such as creating, updating, or deleting records, or executing custom scripts. UI Actions enhance the user experience by providing functional buttons, links, or context menus.\n\n## Overview\n\nThis UI Action allows users to cancel incidents directly from the incident form. It provides a confirmation dialog to prevent accidental cancellations and updates the incident state to \"Cancelled\" (state value 8) when confirmed.\n\n## Features\n\n- **Confirmation Dialog**: Uses GlideModal to display a confirmation prompt before cancelling\n- **State Management**: Updates incident state to \"Cancelled\" (value 8)\n- **Client-Side Validation**: Runs client-side for better user experience\n- **Conditional Display**: Only shows when incident state is \"New\" (state value 1)\n\n## Configuration\n\nCreate a UI Action with the following field values:\n\n**Name**: Cancel Incident\n\n**Action Name**: cancel_incident\n\n**Table**: Incident [incident]\n\n**Client**: checked (true)\n\n**Onclick**: cancelIncident();\n\n**Condition**: current.state == '1'\n\n**Script**: Use the provided script.js file\n\n## Usage\n\n1. Navigate to an incident record in \"New\" state\n2. Click the \"Cancel Incident\" button\n3. Confirm the action in the modal dialog\n4. The incident state will be updated to \"Cancelled\"\n\n## Technical Details\n\n- **Client-Side Function**: `cancelIncident()` - Displays confirmation modal\n- **Server-Side Function**: `serverCancel()` - Updates the incident state\n- **Modal Configuration**: Uses `glide_ask_standard` modal with custom title\n- **State Value**: Sets incident state to '8' (Cancelled)\n\n## Prerequisites\n\n- User must have write access to the incident table\n- Incident must be in \"New\" state (state = 1) for the UI Action to be visible\n\n## Notes\n\n- This UI Action only appears on incident forms when the state is \"New\"\n- The confirmation dialog helps prevent accidental cancellations\n- The server-side script executes only after user confirmation\n" }, { "path": "Client-Side Components/UI Actions/Cancel Incident/SETUP.md", "content": "# Setup Instructions for Cancel Incident UI Action\n\nThis document provides detailed step-by-step instructions for implementing the Cancel Incident UI Action in your ServiceNow instance.\n\n## Prerequisites\n\n- Administrative access to ServiceNow instance\n- Access to System Definition > UI Actions module\n- Understanding of ServiceNow UI Actions and client-server scripting\n\n## Step-by-Step Setup\n\n### 1. Navigate to UI Actions\n\n1. In ServiceNow, go to **System Definition > UI Actions**\n2. Click **New** to create a new UI Action\n\n### 2. Configure Basic Settings\n\nFill in the following fields:\n\n| Field | Value | Description |\n|-------|-------|-------------|\n| **Name** | Cancel Incident | Display name for the UI Action |\n| **Table** | Incident [incident] | Target table for the UI Action |\n| **Action name** | cancel_incident | Unique identifier for the action |\n| **Active** | ✓ (checked) | Enables the UI Action |\n\n### 3. Configure Display Settings\n\n| Field | Value | Description |\n|-------|-------|-------------|\n| **Form button** | ✓ (checked) | Shows button on form view |\n| **Form link** | ☐ (unchecked) | Optional: Show as link instead |\n| **List banner button** | ☐ (unchecked) | Not needed for this action |\n| **List choice** | ☐ (unchecked) | Not needed for this action |\n\n### 4. Configure Client Settings\n\n| Field | Value | Description |\n|-------|-------|-------------|\n| **Client** | ✓ (checked) | Enables client-side execution |\n| **Onclick** | `cancelIncident();` | Client-side function to call |\n\n### 5. Configure Conditions\n\n| Field | Value | Description |\n|-------|-------|-------------|\n| **Condition** | `current.state == '1'` | Only show for \"New\" incidents |\n\n### 6. Add the Script\n\nCopy the entire content from `script.js` and paste it into the **Script** field of the UI Action.\n\n### 7. Configure Advanced Settings (Optional)\n\n| Field | Value | Description |\n|-------|-------|-------------|\n| **Order** | 100 | Display order (adjust as needed) |\n| **Hint** | Cancel this incident | Tooltip text |\n| **Comments** | UI Action to cancel incidents in New state | Internal documentation |\n\n## Verification Steps\n\n### 1. Test the UI Action\n\n1. Navigate to an incident in \"New\" state\n2. Verify the \"Cancel Incident\" button appears\n3. Click the button and confirm the modal appears\n4. Test both \"OK\" and \"Cancel\" in the confirmation dialog\n\n### 2. Verify State Changes\n\n1. After confirming cancellation, check that:\n - Incident state changes to \"Cancelled\"\n - Work notes are added with cancellation details\n - Success message appears\n\n### 3. Test Edge Cases\n\n1. Try accessing the UI Action on incidents in other states (should not appear)\n2. Test with different user roles to ensure proper permissions\n3. Verify error handling works correctly\n\n## Troubleshooting\n\n### Common Issues\n\n**UI Action doesn't appear:**\n- Check that the incident is in \"New\" state (state = 1)\n- Verify the condition field: `current.state == '1'`\n- Ensure the UI Action is marked as Active\n\n**Script errors:**\n- Check browser console for JavaScript errors\n- Verify the script is properly copied from `script.js`\n- Ensure proper syntax and formatting\n\n**Permission issues:**\n- Verify user has write access to incident table\n- Check ACL rules for incident cancellation\n- Ensure proper role assignments\n\n### Debug Mode\n\nTo enable debug logging, add this line at the beginning of the `serverCancel()` function:\n\n```javascript\ngs.info('Debug: Starting incident cancellation for ' + current.number);\n```\n\n## Security Considerations\n\n- The UI Action respects existing ACL rules\n- Only users with incident write permissions can cancel incidents\n- All cancellations are logged for audit purposes\n- Work notes provide cancellation history\n\n## Customization Options\n\n### Modify Confirmation Message\n\nEdit line 33 in the script to customize the confirmation dialog:\n\n```javascript\ngm.setPreference(\"question\", \"Your custom message here\");\n```\n\n### Change Cancellation Reason\n\nModify the work note in the `serverCancel()` function (line 79):\n\n```javascript\nvar workNote = 'Custom cancellation reason: ' + gs.getUserDisplayName() + ' on ' + gs.nowDateTime();\n```\n\n### Add Additional Validations\n\nAdd custom validation logic in the `cancelIncident()` function before showing the modal.\n\n## Support\n\nFor issues or questions:\n1. Check ServiceNow system logs\n2. Review browser console for client-side errors\n3. Test in a development instance first\n4. Consult ServiceNow documentation for UI Actions\n" }, { "path": "Client-Side Components/UI Actions/Cancel Incident/script.js", "content": "/**\n * Client-side function to initiate incident cancellation\n * Displays a confirmation modal before proceeding with the cancellation\n */\nfunction cancelIncident() {\n try {\n // Validate that we have a valid form and record\n if (!g_form || !g_form.getUniqueValue()) {\n alert('Error: Unable to access incident record. Please refresh the page and try again.');\n return;\n }\n\n // Check if incident is in the correct state for cancellation\n var currentState = g_form.getValue('state');\n if (currentState !== '1') {\n alert('Error: This incident cannot be cancelled. Only incidents in \"New\" state can be cancelled.');\n return;\n }\n\n // Create confirmation modal with improved messaging\n var gm = new GlideModal(\"glide_ask_standard\", false, 600);\n gm.setPreference(\"title\", \"Cancel Incident Confirmation\");\n gm.setPreference(\"warning\", true);\n gm.setPreference(\"onPromptComplete\", function() {\n // Show loading message\n g_form.addInfoMessage('Cancelling incident...');\n \n // Submit the form to trigger server-side processing\n gsftSubmit(null, g_form.getFormElement(), 'cancel_incident');\n });\n \n // Set the confirmation message\n gm.setPreference(\"question\", \"Are you sure you want to cancel this incident?\\n\\nThis action will change the incident state to 'Cancelled' and cannot be easily undone.\");\n \n // Render the modal\n gm.render();\n \n } catch (error) {\n // Handle any unexpected errors\n console.error('Error in cancelIncident function:', error);\n alert('An unexpected error occurred. Please contact your system administrator.');\n }\n}\n\n/**\n * Server-side execution block\n * This code runs on the server when the UI Action is submitted\n */\nif (typeof window == 'undefined') {\n serverCancel();\n}\n\n/**\n * Server-side function to cancel the incident\n * Updates the incident state to 'Cancelled' and adds a work note\n */\nfunction serverCancel() {\n try {\n // Validate that we have a current record\n if (!current || !current.isValidRecord()) {\n gs.addErrorMessage('Error: Invalid incident record.');\n return;\n }\n\n // Double-check the current state before cancelling\n if (current.state.toString() !== '1') {\n gs.addErrorMessage('Error: This incident cannot be cancelled. Only incidents in \"New\" state can be cancelled.');\n return;\n }\n\n // Store original values for logging\n var incidentNumber = current.number.toString();\n var originalState = current.state.getDisplayValue();\n \n // Update the incident state to 'Cancelled' (state value 8)\n current.state = '8';\n \n // Add a work note to document the cancellation\n var workNote = 'Incident cancelled by ' + gs.getUserDisplayName() + ' on ' + gs.nowDateTime();\n if (current.work_notes.nil()) {\n current.work_notes = workNote;\n } else {\n current.work_notes = current.work_notes + '\\n\\n' + workNote;\n }\n \n // Update the record\n current.update();\n \n // Log the action for audit purposes\n gs.info('Incident ' + incidentNumber + ' cancelled by user ' + gs.getUserName() + \n '. State changed from \"' + originalState + '\" to \"Cancelled\"');\n \n // Provide user feedback\n gs.addInfoMessage('Incident ' + incidentNumber + ' has been successfully cancelled.');\n \n } catch (error) {\n // Handle server-side errors\n gs.error('Error cancelling incident: ' + error.message);\n gs.addErrorMessage('An error occurred while cancelling the incident. Please contact your system administrator.');\n }\n}\n" }, { "path": "Client-Side Components/UI Actions/Clone incident on Agent Workspace/README.md", "content": "Agent can use this UI Action on incident form to clone/copy any existing incident.\n\nThis UI Action will create a copy of incident once agent confirm the action.\n\nCaller field will not be copeied to newly created incident, only basic information of ticket like Company, Short Description, Category, Sub-Category \n\nCreate an UI Action with below field values:\n\nName - Clone Incident\n\nAction Name - clone_incident\n\nTable - Incident\n\nClient - checked (true)\n\nOnclick - cloneIncident();\n\nWorkspace Form Button - checked (true)\n\nScript - use clone_incident.js\n\nWorkspace Client script - use workspace_client_script.js\n" }, { "path": "Client-Side Components/UI Actions/Clone incident on Agent Workspace/clone_incident.js", "content": "function cloneIncident() {\n var answer = confirm(getMessage(\"Are you sure you want to Clone this Incident?\"));\n if (answer)\n gsftSubmit(null, g_form.getFormElement(), 'clone_incident');\n else\n return false;\n}\n\nif (typeof window == 'undefined') {\n //Clone Incident\n var grInc = new GlideRecord('incident');\n grInc.initialize();\n grInc.company = current.company;\n grInc.short_description = current.short_description;\n grInc.description = current.description;\n grInc.contact_type = \"Self-service\";\n grInc.category = current.category;\n grInc.subcategory = current.subcategory;\n grInc.setDisplayValue('assignment_group', \"Assignment Group Name\"); // or use grInc.assignment_group = current.assignment_group.toString();\n /*\n\tuncomment this code if comments need to be copied\n //Remove Timestamp from Comments\n var getComments = current.comments.getJournalEntry(1);\n var regex = new RegExp(\"\\n\");\n var returnComments = getComments;\n var getRegex = getComments.search(regex);\n if (getRegex > 0) {\n returnComments = getComments.substring(getRegex + 1, getComments.length);\n }\n gr.comments = returnComments;\n */\n grInc.insert();\n action.setRedirectURL(grInc);\n}\n" }, { "path": "Client-Side Components/UI Actions/Clone incident on Agent Workspace/workspace_client_script.js", "content": "function onClick() {\ngetMessage(\"Are you sure you want to Clone this Incident?\", function (msg) {\n\t\tg_modal.confirm(getMessage(\"Confirmation\"), msg, function (confirmed) {\n\t\t\tif (confirmed) {\n\t\t\t\tg_form.submit('clone_incident');\n\t\t\t}\n\t\t});\n\t});\n}\n" }, { "path": "Client-Side Components/UI Actions/Close Related HR cases & HR tasks/README.md", "content": "Scenario:-\n\nTable: HR Case\n\nCreate a form button named \"Check related item and Close Complete\" feature and list down the related child HR cases and HR tasks\nin the pop-up message.\nUpon confirmation, it will close the current case and other listed items.\n\nThis will help in reducing the manual effort of closing items manually.\n\nScripts:\nClient UI script to handle the confirmation popup and state of current case.\n\nGlideAJAX enabled script include to fetch the data and close the related items.\n" }, { "path": "Client-Side Components/UI Actions/Close Related HR cases & HR tasks/Script Include.js", "content": "var close_item = Class.create();\nclose_item.prototype = Object.extendsObject(global.AbstractAjaxProcessor, {\n\tgetRelatedItems: function() {\n var caseId = this.getParameter('sysparm_case_id');\n var results = [];\n\n // Get child HR cases\n var childCases = new GlideRecord('sn_hr_core_case');\n childCases.addQuery('parent', caseId);\n childCases.query();\n while (childCases.next()) {\n results.push({ type: 'HR Case', number: childCases.getValue('number') });\n }\n\n // Get tasks\n var tasks = new GlideRecord('sn_hr_core_task');\n tasks.addQuery('hr_case', caseId);\n tasks.query();\n while (tasks.next()) {\n results.push({ type: 'HR Task', number: tasks.getValue('number') });\n }\n\n return JSON.stringify(results);\n },\n\tcloseRelatedItems: function() {\n var caseId = this.getParameter('sysparm_case_id');\n\n // Close child cases\n var childCases = new GlideRecord('sn_hr_core_case');\n childCases.addQuery('parent', caseId);\n childCases.query();\n while (childCases.next()) {\n childCases.setValue('state', '3');\n childCases.update();\n }\n\n // Close tasks\n var tasks = new GlideRecord('sn_hr_core_task');\n tasks.addQuery('hr_case', caseId);\n tasks.query();\n while (tasks.next()) {\n tasks.setValue('state', '3');\n tasks.update();\n }\n\n return \"done\";\n\t\t\n },\n type: 'close_task'\n});\n" }, { "path": "Client-Side Components/UI Actions/Close Related HR cases & HR tasks/UI Action script.js", "content": "// Demo- OnClick function to execute\nfunction demo() {\n var ga = new GlideAjax('sn_hr_core.close_items');\n ga.addParam('sysparm_name', 'getRelatedItems');\n ga.addParam('sysparm_case_id', g_form.getUniqueValue());\n ga.getXMLAnswer(function(response) {\n // If there exist related items\n var items = JSON.parse(response);\n if (items.length > 0) {\n var msg = \"This case has related items:\\n\";\n items.forEach(function(item) {\n msg += \"- \" + item.type + \": \" + item.number + \"\\n\";\n });\n msg += \"\\nDo you want to close them as well?\";\n if (confirm(msg)) {\n // close current HR case\n\t\t\t\tg_form.setValue('state', '3');\n\t\t\t\tg_form.save();\n }\n } else {\n // If no related item is associated\n if (confirm(\"No related items found. Close this case?\")) {\n g_form.setValue('state', '3');\n g_form.save();\n }\n }\n });\n}\n" }, { "path": "Client-Side Components/UI Actions/Close child incident/README.md", "content": "This is a ui actions that close the child incident directly from the parent incident\n\nTwo actions for this :\n1. Client side ui action from which button is shown and onClick of that button server side action will be performed\n2. Server side ui action that update the state of that child incident to closed\n\n### update\nUpdated client script to replace JavaScript function confirm() with GlideModal() API.\nTo complete a on issue #745 (Close child incident UI Action)\n" }, { "path": "Client-Side Components/UI Actions/Close child incident/clientScript.js", "content": "function popUpClientScript(){\n\t\n\tvar actionCallbackOK = function() {\n \tgsftSubmit(null,g_form.getFormElement(),'sys_demoaction'); // calling server ui action to update state\n \t};\n \tvar actionCallbackCancel = function() {\n \t//do nothing\n \t};\n\n\tvar gm = new GlideModal('glide_confirm_basic',false); //UI page with logic to confirm\n \tgm.setTitle(\"Are you sure you want to close the attached child incident\"); // confirm message to ask for confirmation\n\tgm.setPreference('onPromptComplete', actionCallbackOK.bind(this)); //bind to local function to take action when selected Ok\n \tgm.setPreference('onPromptCancel', actionCallbackCancel.bind(this)); //bind to local function to take action when selected Cancel\n \tgm.render();\n}\n" }, { "path": "Client-Side Components/UI Actions/Close child incident/serverScript.js", "content": "var gr = new GlideRecord('incident');\ngr.addQuery('parent_incident',current.sys_id); //querying over particular parent incident\ngr.query();\nwhile(gr.next()){\n\tgr.state = '7'; //updating the state of the child incident to closed\n\tgr.update();\n}\n" }, { "path": "Client-Side Components/UI Actions/CloseChildCases/CloseChildCases.js", "content": "(function executeAction() {\n var grCase = new GlideRecord('sn_customerservice_case');\n grCase.addQuery('parent', current.sys_id);\n grCase.query();\n \n var counter = 0;\n while (grCase.next()) {\n if (grCase.state != 3) { // 3 = Closed\n grCase.resolution_code = '16';\n grCase.close_notes = 'This case was auto closed from the parent case.';\n grCase.state = 3;\n grCase.update();\n counter++;\n }\n }\n\n // Show info message only if any cases were closed\n if (counter > 0) {\n gs.addInfoMessage(counter + ' child case(s) have been closed.');\n }\n\n action.setRedirectURL(current);\n})();\n" }, { "path": "Client-Side Components/UI Actions/CloseChildCases/README.md", "content": "Name: Close all Child Case\nTable:sn_customerservice_case\nCondition: (gs.hasRole('sn_customerservice_agent') || gs.hasRole('admin') ) && (new GlideRecord('sn_customerservice_case').addQuery('parent', current.sys_id).query().hasNext())\n\nUse Case: \nProvide UI action button to close all the associated child cases from the parent Case.\n" }, { "path": "Client-Side Components/UI Actions/Convert Request to Incident/README.md", "content": "This is a UI Action that creates an Incident using the field values of the current Request and closes the Request as \"Closed Skipped\".\nIt also compliles all the worknotes and comments into a single worknote on the Incident.\n\nThis action has an OnClick function as well as a server-side function that runs using:\n\nif (typeof current != 'undefined')\n\nThe OnClick function opens a confirmation window to protect against misclicks.\n\nSetting up the UI Action:\n\n![alt text](https://github.com/ezratkim/code-snippets/blob/main/UI%20Actions/Convert%20Request%20to%20Incident/UIActionScreenshot.png)\n" }, { "path": "Client-Side Components/UI Actions/Convert Request to Incident/script.js", "content": "//Prompts confirmation window on click\nfunction ReqWarning() {\n var answer = confirm(\"Please confirm Request to Incident Action. \\n This will set the current Request to 'Closed Skipped' and create a new Incident.\");\n\n if (answer == false) {\n return false;\n }\n\n gsftSubmit(null, g_form.getFormElement(), 'create_inc_cancel_req');\n\n}\n\n// Ensure this runs on the server side\nif (typeof current != 'undefined') {\n // Create a new incident record\n var inc = new GlideRecord('incident');\n inc.initialize();\n\n // Map fields from the task to the incident\n inc.short_description = current.short_description;\n\tinc.description = current.special_instructions;\n inc.caller_id = current.requested_for;\n\tinc.watch_list = current.watch_list;\n\tinc.assigned_to = current.assigned_to;\n\tinc.state = 1; // Sets state to 'New'\n\tinc.contact_type = 'self-service';\n\tinc.assignment_group = 'group_sys_id'; // Assign to your preferred assignment group's sys_id\n\n\t// Construct the initial work note for the Incident with a link back to the original\n\tvar callerName = current.requested_for.getDisplayValue();\n\tvar currentLink = \"[code]\" + current.number + \"[/code]\";\n\tvar initialJournalEntry = gs.getMessage(\"This incident was converted from {0} on behalf of {1}\" , [currentLink, callerName]);\n\tinc.work_notes = initialJournalEntry;\n\t\n // Initialize a variable to compile the work notes and comments\n var compiledEntries = \"Compiled Work Notes and Comments:\\n=================================\\n\\n\";\n\t\n // Query combined work notes and comments from the current task\n var journal = new GlideRecord('sys_journal_field');\n journal.addQuery('element_id', current.sys_id);\n journal.addQuery('element', 'IN', 'work_notes,comments'); // Fetch work notes and comments\n journal.orderBy('sys_created_on'); // Ensures chronological order\n journal.query();\n\n while (journal.next()) {\n\t\tvar entryType = journal.element == 'work_notes' ? 'Work Note' : 'Comment';\n\t\tvar entryTimestamp = journal.sys_created_on.getDisplayValue();\n\n\t\tvar userRecord = new GlideRecord('sys_user');\n\t\tvar entryCreatedBy = 'Unknown User'; // Default value in case user is not found\n\n\t\t// Query the sys_user table based on the user_name stored in sys_created_by\n\t\tuserRecord.addQuery('user_name', journal.sys_created_by);\n\t\tuserRecord.query();\n\n\t\tif (userRecord.next()) {\n\t\t\tvar firstName = userRecord.first_name;\n\t\t\tvar lastName = userRecord.last_name;\n\n\t\t\t// Concatenate first name and last name to form the full name\n\t\t\tentryCreatedBy = firstName + ' ' + lastName;\n\t\t}\n\t\tvar entryText = journal.value;\n\n\t\t// Format the entry with structured and visually separated format\n\t\t\tcompiledEntries += entryType + \" - \" + entryTimestamp + \" - \" + entryCreatedBy + \":\\n\" +\n\t\t\t\t\t\t\t\"--------------------------------------------------------\\n\" +\n\t\t\t\t\t\t\t\"\\\"\" + entryText + \"\\\"\\n\" +\n\t\t\t\t\t\t\t\"--------------------------------------------------------\\n\\n\";\t\n\t}\n\n // Add the compiled entries as a work note to the new incident\n if (compiledEntries != \"Compiled Work Notes and Comments:\\n=================================\\n\\n\") {\n inc.work_notes = compiledEntries;\n }\n\n // Insert the new incident record to get a sys_id for work notes and comments transfer\n var incSysId = inc.insert();\n\n // Check if successful incident record creation, set closing fields, and inform user\n if (incSysId) {\n\t\t// Set fields on current record\n\t\tcurrent.request_state = 'closed_cancelled';\n\t\tcurrent.state = 7; // Sets state to 'Closed Skipped'\n\t\tvar incLink = \"[code]\" + inc.number + \"[/code]\";\n\t\tcurrent.work_notes = gs.getMessage(\"Converted to Incident: \" + incLink);\n\t\tcurrent.update();\n\n gs.addInfoMessage(\"Incident created from Request: \" + inc.number);\n\n\t\t// Redirect to the newly created incident\n\t\taction.setRedirectURL(inc);\n } else {\n\t\tgs.addErrorMessage(\"Failed to convert\");\n\t}\n}\n" }, { "path": "Client-Side Components/UI Actions/Copy Bulk SysIDs/Copy Bulk Sysids.js", "content": "var sysIds = g_list.getChecked();\ncopyToClipboard(sysIds);\n" }, { "path": "Client-Side Components/UI Actions/Copy Bulk SysIDs/README.md", "content": "# Copy SysIDs in Bulk — ServiceNow Utility\n\n> Simplify copying checked sys_ids from a list view with a one-click UI Action. \n\n---\n\n## Purpose / Use Case\n\nOften, you may need to extract sys_ids from records listed in a ServiceNow list view (for scripting, validations, data workflows, etc.). Instead of exporting CSVs or manually gathering IDs, this utility enables direct copying of the selected records’ sys_ids (comma-separated) from the list itself.\n\n---\n\n## How It Works\n\nIt adds a global UI Action (on lists) that, when clicked, collects the sys_ids of checked records and copies them to the clipboard using a small client-side script.\n\n---\n\n## Installation Steps\n\n1. Navigate to **System Definition > UI Actions**.\n2. Create a **new UI Action** with these settings:\n - **Name**: e.g. `Copy Bulk SysIDs`\n - **Table**: `Global` (so it works on every list)\n - **Check** the **Client** and **List** checkboxes (so it appears in list context on client side) \n3. In the **Onclick / Client script** field, paste:\n\n ```javascript\n var sysIds = g_list.getChecked();\n copyToClipboard(sysIds);\n\n## Result\n\"image\"\n" }, { "path": "Client-Side Components/UI Actions/Copy Variable Set/README.md", "content": "This UI action will help create a copy of the Variable set, including the Catalog Client Script, Catalog UI actions and Variable.\n\nBelow Configurations need to be performed on the UI action form on creation\n\nTable : Variable Set\nActive: True\nShow Update : True\nClient : True\nAction name : copyQuestionSet\nOn Click : clientConfirm()\n\n### update\nTo complete a task on issue #745 \nReplace JavaScript function confirm() with GlideModal() API.\n" }, { "path": "Client-Side Components/UI Actions/Copy Variable Set/scripts.js", "content": "/****************Client Code****************/\n\nfunction clientConfirm() {\n\n var actionCallbackOK = function() {\n \t gsftSubmit(null, g_form.getFormElement(), 'copyQuestionSet');\n \t};\n \tvar actionCallbackCancel = function() {\n \treturn false;\n \t};\n\n\t var gm = new GlideModal('glide_confirm_basic',false); //UI page with logic to confirm\n \tgm.setTitle(\"This will create a copy of this variable set including all variables, choices, UI policies, UI policy actions and client scripts. Do you want to proceed?\"); // confirm message to ask for confirmation\n\t gm.setPreference('onPromptComplete', actionCallbackOK.bind(this)); //bind to local function to take action when selected Ok\n \tgm.setPreference('onPromptCancel', actionCallbackCancel.bind(this)); //bind to local function to take action when selected Cancel\n \tgm.render();\n}\n\n/****************Server Code****************/\n//set some new default values\nvar name = current.title;\ncurrent.title = 'Copy of ' + name;\n\n//insert a copy of the variable set\nvar oldid = current.sys_id.toString();\nvar newid = current.insert();\nvar allVars = {};\n\nif (typeof window == 'undefined') {\n main(oldid, newid);\n}\n\nfunction main(oldid, newid) {\n\n createVariables(oldid, newid);\n createCatalogClientScript(oldid, newid);\n createCatalogUiPolicy(oldid, newid);\n}\n\n//creates a copy of the variables and associates them to the new variable set\nfunction createVariables(oldid, newid) {\n var vars = new GlideRecord('item_option_new');\n vars.addQuery('variable_set', oldid);\n vars.query();\n while (vars.next()) {\n var varoldid = vars.sys_id.toString();\n vars.variable_set = newid;\n var varnewid = vars.insert();\n allVars['IO:' + varoldid] = 'IO:' + varnewid.toString();\n\n var qc = new GlideRecord('question_choice');\n qc.addQuery('question', varoldid);\n qc.query();\n while (qc.next()) {\n qc.question = varnewid;\n qc.insert();\n }\n }\n}\n\n//creates a copy of the client scripts and associates to the variable set.\nfunction createCatalogClientScript(oldid, newid) {\n var ccs = new GlideRecord('catalog_script_client');\n ccs.addQuery('variable_set', oldid);\n ccs.query();\n while (ccs.next()) {\n if (ccs.type == 'onChange') {\n var cv = ccs.cat_variable;\n ccs.cat_variable = allVars[cv];\n }\n ccs.variable_set = newid;\n ccs.insert();\n }\n}\n\n//creates a copy of the UI Policies and associates them to the new variable set\nfunction createCatalogUiPolicy(oldid, newid) {\n var cup = new GlideRecord('catalog_ui_policy');\n cup.addQuery('variable_set', oldid);\n cup.query();\n while (cup.next()) {\n var uipoldid = cup.sys_id.toString();\n cup.variable_set = newid;\n var newuip = cup.insert();\n\n var cupa = new GlideRecord('catalog_ui_policy_action');\n cupa.addQuery('ui_policy', uipoldid);\n cupa.query();\n while (cupa.next()) {\n cupa.ui_policy = newuip;\n cupa.variable_set = newid;\n var cv = cupa.catalog_variable;\n cupa.catalog_variable = allVars[cv];\n cupa.insert();\n }\n }\n}\n\n//Return the user to the new variable set record\naction.setRedirectURL(current);\n" }, { "path": "Client-Side Components/UI Actions/Copy incident details and create a child incident/README.md", "content": "# Copy incident details and create a child incident\n\nUse case : A button on the header of incident form to copy details(fields) of current incident and create a child incident with those copied details.\n\nSolution : Added a code snippet for UI action script that copies few fields of current incident and creates a child for the current incident with those details.\n" }, { "path": "Client-Side Components/UI Actions/Copy incident details and create a child incident/ui_action_script.js", "content": "var gr = new GlideRecord('incident');\ngr.initialize();\ngr.short_description = current.short_description; //copy short description field\ngr.caller_id = current.caller_id; //copy caller id field\n//you can copy few more fields as per requirement\ngr.parent_incident = current.sys_id;\ngr.work_notes = \"This incident is a child and copy of \" + current.number; //you can customize work notes if needed\ngr.insert();\n\naction.setRedirectURL(gr); //use this line if you want to redirect to newly created child incident after execution\naction.setRedirectURL(current) //use this line if you want to stay in parent incident after execution.\n" }, { "path": "Client-Side Components/UI Actions/Create Incident from Record - Open in both Platform and Workspace/README.md", "content": "Script that can be used in the Script section of a UI Action to create an Incident, or any record type, from another record and will open the record that was just created. \nThis script will work both in Platform UI and Workspace UI, as long as one of the Workspace Form/Menu buttons are checked. This reduced the need to create a script\nfor both Platform and Workspace within one UI Action. For more information: https://www.ashleysn.com/post/action-opengliderecord\n" }, { "path": "Client-Side Components/UI Actions/Create Incident from Record - Open in both Platform and Workspace/script.js", "content": "//Placed in the Script field of the UI Action, in order to work on Workspace the Workspace Form Action button/or menu must be checked\nvar incGr = new GlideRecord('incident');\nincGr.newRecord();\nincGr.setValue('caller_id', current.getValue('contact')); //This can be whatever field your record is housing the user in, this example is from the Case record.\nincGr.setValue('short_description', current.short_description);\nincGr.insert();\naction.openGlideRecord(incGr);\n" }, { "path": "Client-Side Components/UI Actions/Create New blank incident from the incident/README.md", "content": "A UI Action in ServiceNow is a script that defines an action or button within the platform's user interface. \nIt enables users to perform specific operations on forms and lists, such as creating, updating, or deleting records, or executing custom scripts. \nUI Actions enhance the user experience by providing functional buttons, links, or context menus.\n\nIn this UI action script when clicked Creates New blank incident form, from the incident. \n\naction.setRedirectURL() is a method used in server-side scripting within UI Actions to redirect users to a specific URL after a UI action is performed. \nIt is commonly used to navigate users to different records, forms, or list views after they have completed an action.\n\nSyntax - action.setRedirectURL(URL);\nParameters:\nURL: The URL to which the user will be redirected. This can be a string representing a GlideURL object or a hardcoded URL. It must point to a valid ServiceNow page (record, list, form, etc.).\nReturn:\nNone. It performs a redirection after the script completes.\n\nGlideURL is a class in ServiceNow used for constructing URLs dynamically in server-side scripts. It allows developers to programmatically create and manipulate URLs to redirect users, perform navigation, or link to specific ServiceNow resources (e.g., forms, lists, reports).\n" }, { "path": "Client-Side Components/UI Actions/Create New blank incident from the incident/script.js", "content": "//UI Action - Create New blank incident from the incident.\n\nvar newFormURL = new GlideURL('incident.do');\nnewFormURL.addParam('sys_id', '-1'); // Open a new blank form\naction.setRedirectURL(newFormURL.toString());\n" }, { "path": "Client-Side Components/UI Actions/Create Problem Record from any Table/CreateProblemRecord.js", "content": "//This UI action helps in generating a problem record from a chnage or an incident form\nvar createPrb = new GlideRecord(\"problem\"); // Gliding the problem table\ncreatePrb.initialize();\ncreatePrb.short_description = current.short_description; // taking current records short description as problem short description(problem statement)\ncreatePrb.first_reported_by_task = current.getUniqueValue();\ncreatePrb.cmdb_ci = current.cmdb_ci; //taking the affected in configuration item\ncreatePrb.insert(); //inserting the record into the problem table\ngs.addInfoMessage(\"problem number\" + createPrb.number.getDisplayValue()); // informing the user with the created problem record number for easy reference.\naction.setRedirectURL(current);\n" }, { "path": "Client-Side Components/UI Actions/Create Problem Record from any Table/README.md", "content": "This UI action helps in creating a problem record from an incident or even from a change table, and we can modify this code by changing the table name we can use it for any sort of table to create a problem record.\n" }, { "path": "Client-Side Components/UI Actions/Create Problem Task from the Problem/README.md", "content": "UI Action Create Problem Task from the Problem\n\nA UI Action in ServiceNow is a script that defines an action or button within the platform's user interface. \nIt enables users to perform specific operations on forms and lists, such as creating, updating, or deleting records, or executing custom scripts. \nUI Actions enhance the user experience by providing functional buttons, links, or context menus.\n\nUsing this UI action script we can create a Problem task from a Problem and associate it to the current problem.\n\nUI Action will be available as Form Button on the Problem Form.\nWhen Clicked Problem Task will be Created and associated to the current Problem.\n\nShort description of the problem task is \"Problem Task Created for problem \" + current.number\nSame will be added to the Description as well.\nsys_id of the current problem record will be added to the problem field of the Problem Task. This will create relation between Problem and Problem Task.\nProblem Task Type will be General\n" }, { "path": "Client-Side Components/UI Actions/Create Problem Task from the Problem/script.js", "content": "//UI Action - Create a Problem task from a Problem. Problem Task Type is General\n\nvar gr = new GlideRecord('problem_task');\ngr.initialize();\ngr.short_description = \"Problem Task Created for problem \" + current.number;\ngr.description = current.short_description;\ngr.problem = current.sys_id;\ngr.problem_task_type = 'general';\ngr.insert();\n" }, { "path": "Client-Side Components/UI Actions/Create Update Set on DEV/README.md", "content": "# Create Update Set on DEV\n\nA client UI Action for the Story form that opens up a new browser window with the Create New Update Set form on a specified DEV instance with Update Set name pre-filled with the Story number and short description.\n\nHelps reducing copy/paste work and to keep up with Update Set naming standards.\n" }, { "path": "Client-Side Components/UI Actions/Create Update Set on DEV/script.js", "content": "function openDevUpdateSetForm() {\n\n // Name of the DEV instance where Update sets should be created:\n var dev_instance_name = 'my_org_dev_instance';\n // Update set name format:\n var update_set_name = g_form.getValue('number') + ' ' + g_form.getValue('short_description');\n\n var instanceURL = 'https://' + dev_instance_name + '.service-now.com/nav_to.do?uri=';\n var updatesetURL = '/sys_update_set.do?sys_id=-1&sysparm_query=name=' + update_set_name;\n var encodedUpdateSetURL = encodeURIComponent(updatesetURL);\n var gotoURL = instanceURL + encodedUpdateSetURL;\n\n g_navigation.open(gotoURL, '_blank');\n}\n" }, { "path": "Client-Side Components/UI Actions/Create incident task and relate to incident/README.md", "content": "This UI Action loads a modal for to create a new incident task that is linked to the incident that you generated it from.\n\nSuggested values:\nName: Create Incident Task\nTable: Incident\nClient: true\nList v2: true\nForm Link: true\n\nOnclick: createIncidentTask()\nCondition: current.state != 7" }, { "path": "Client-Side Components/UI Actions/Create incident task and relate to incident/script.js", "content": "function createIncidentTask() {\n\t\n\tvar sysID = g_form.getUniqueValue();\n\t\n\tvar gm = new GlideModalForm('Create Incident Task', 'incident_task');\n\tgm.setPreference('focusTrap', true);\n\tgm.setPreference('table', 'incident_task');\n\tgm.setPreference('sysparm_query', 'incident='+sysID);\n\tgm.setWidth(650);\n\n\t//Opens the dialog\n\tgm.render();\n\t\n}\n" }, { "path": "Client-Side Components/UI Actions/Create story/Create story from other task.js", "content": "createStory();\n\nfunction createStory() {\n\n // (1) Copy item fields into a new story\n var story = new GlideRecord(\"rm_story\");\n story.priority = current.priority;\n story.short_description = current.short_description;\n story.assignment_group = current.assignment_group;\n story.assigned_to = current.assigned_to;\n story.description = current.description;\n story.work_notes = current.work_notes;\n story.type=\"Development\";\n story.opened = current.opened;\n story.opened_by = current.opened_by;\n story.product = null;\n story.state = -6; //default to draft\n story.original_task = current.sys_id;\n var storySysID = story.insert();\n \n current.agile_story = storySysID;\n current.update();\n\n // (2) Redirect webpage to the new story (Ensure story displayed in scrum view)\n gs.addInfoMessage(gs.getMessage(\"Story {0} created\", story.number)); \n action.setRedirectURL(story);\n var redirectURL = action.getRedirectURL();\n redirectURL = redirectURL.replace(\"sysparm_view=\", \"sysparm_view=scrum\");\n action.setRedirectURL(redirectURL);\n action.setReturnURL(current);\n}\n" }, { "path": "Client-Side Components/UI Actions/Create story/README.md", "content": "Code Snippet for UI Action to create an Agile Story from another task. For example Incident -> Story, Task -> Story, Requested Item -> Story\n" }, { "path": "Client-Side Components/UI Actions/Display a 2-choice confirmation dialog/README.md", "content": "# Display a 2-choice confirmation dialog\nWhen you press the button on the Form screen, a two-choice dialog is displayed.\n\nClick the Complete button to execute Serverside processing.\n\n## Please set the following values.\n* UI Action \n * Name: Example Dialog\n * Table: incident (anything) \n * Action name: example_dialog\n * Client: ture\n * Form button: ture\n * Onclick: onClickExampleDialog()\n * Script\n\n```javascript\nfunction onClickExampleDialog() {\n var dialogClass = typeof GlideModal != 'undefined' ? GlideModal : GlideDialogWindow;\n var dialog = new dialogClass('glide_modal_confirm');\n dialog.setTitle('Dialog title');\n dialog.setPreference(\"focusTrap\", true); // Restrict focus from moving out of Dialog\n dialog.setPreference('body', 'Approve this change?');\n dialog.setPreference('buttonLabelCancel', 'Cancel'); // Cancel button label\n dialog.setPreference('buttonLabelComplete', 'Complete'); // Complete button label\n dialog.setPreference('buttonClassComplete', 'btn btn-destructive'); // Complete button CSS\n dialog.setPreference('onPromptComplete', dialogComplete.bind(this)); // Complete button function\n dialog.setPreference('onPromptCancel', dialogCancel.bind(this)); // Cancel button function\n dialog.render();\n return true;\n}\n\n// Complete button function\nfunction dialogComplete() {\n //Press Submit Button and call UIAction(Server side 'example_dialog') again.\n gsftSubmit(null, g_form.getFormElement(), 'example_dialog');\n}\n// Cancel button function\nfunction dialogCancel() {\n //alert('Dialog Cancel');\n}\n\n//Judge Server side\nif (typeof window == 'undefined') {\n serversideTask();\n}\n// Server side function\nfunction serversideTask() {\n current.update();\n gs.info('Serverside Task');\n action.setRedirectURL(current);\n}\n```\n" }, { "path": "Client-Side Components/UI Actions/Display a 2-choice confirmation dialog/choice_dialog.js", "content": "// Display a 2-choice confirmation dialog.\n// When you press the button on the Form screen, a two-choice dialog is displayed.\n// Click the Complete button to execute Serverside processing.\n// Please set the following values.\n// * UI Action\n// * Name: Example Dialog\n// * Table: incident (anything)\n// * Action name: example_dialog\n// * Client: ture\n// * Form button: ture\n// * Onclick: onClickExampleDialog()\n// * Script\nfunction onClickExampleDialog() {\n var dialogClass = typeof GlideModal != 'undefined' ? GlideModal : GlideDialogWindow;\n var dialog = new dialogClass('glide_modal_confirm');\n dialog.setTitle('Dialog title');\n dialog.setPreference(\"focusTrap\", true); // Restrict focus from moving out of Dialog\n dialog.setPreference('body', 'Approve this change?');\n dialog.setPreference('buttonLabelCancel', 'Cancel'); // Cancel button label\n dialog.setPreference('buttonLabelComplete', 'Complete'); // Complete button label\n dialog.setPreference('buttonClassComplete', 'btn btn-destructive'); // Complete button CSS\n dialog.setPreference('onPromptComplete', dialogComplete.bind(this)); // Complete button function\n dialog.setPreference('onPromptCancel', dialogCancel.bind(this)); // Cancel button function\n dialog.render();\n return true;\n}\n\n// Complete button function\nfunction dialogComplete() {\n //Press Submit Button and call UIAction(Server side 'example_dialog') again.\n gsftSubmit(null, g_form.getFormElement(), 'example_dialog');\n}\n// Cancel button function\nfunction dialogCancel() {\n //alert('Dialog Cancel');\n}\n\n//Judge Server side\nif (typeof window == 'undefined') {\n serversideTask();\n}\n// Server side function\nfunction serversideTask() {\n current.update();\n gs.info('Serverside Task');\n action.setRedirectURL(current);\n}\n" }, { "path": "Client-Side Components/UI Actions/Email Watermark Utility/GenericEmailUtility.js", "content": "var GenericEmailUtility = Class.create();\nGenericEmailUtility.prototype = {\n initialize: function() {},\n \n // Generate an Outlook (mailto) link with watermark tracking\n get_Outlook_link: function() {\n try {\n const email_payload = JSON.stringify({\n \"REQUESTOR_ID\": \"\",\n \"TITLE\": \"\",\n \"BODY\": \"\",\n \"REQUEST_ID\": \"\",\n \"TABLE_ID\": \"\"\n });\n\n var mailtoLink = false;\n const raw_data = this.getParameter(\"sysparm_email_body\") || email_payload;\n\n if (global.JSUtil.notNil(raw_data)) {\n var email_data = JSON.parse(raw_data);\n\n const to = this.getEmail(email_data.REQUESTOR_ID);\n const cc = gs.getProperty(\"instanceEmailAddress\"); // instance default CC\n const subject = email_data.TITLE || '';\n const body = email_data.BODY || '';\n\n const watermark = this.getWatermark(email_data.REQUEST_ID, email_data.TABLE_ID);\n\n // Construct mailto link\n mailtoLink = 'mailto:' + to + '?cc=' + cc;\n\n if (subject)\n mailtoLink += '&subject=' + encodeURIComponent(subject);\n\n if (body)\n mailtoLink += '&body=' + encodeURIComponent(body);\n\n if (watermark)\n mailtoLink += encodeURIComponent(\"\\n\\nRef: \" + watermark);\n }\n\n return mailtoLink;\n\n } catch (ex) {\n gs.error(\"Error in get_Outlook_link(): \" + ex.message);\n return false;\n }\n },\n\n // Fetch watermark ID (creates one if missing)\n getWatermark: function(record_id, table_name) {\n var wm = new GlideRecord('sys_watermark');\n wm.addQuery('source_id', record_id);\n wm.orderByDesc('sys_created_on');\n wm.query();\n\n if (wm.next()) {\n return wm.getValue('number');\n }\n\n wm.initialize();\n wm.source_id = record_id;\n wm.source_table = table_name;\n wm.insert();\n\n return wm.getValue('number');\n },\n\n // Retrieve user’s email address\n getEmail: function(user_id) {\n if (global.JSUtil.notNil(user_id)) {\n var user = new GlideRecordSecure('sys_user');\n if (user.get(user_id))\n return user.email.toString();\n }\n return '';\n },\n\n type: 'GenericEmailUtility'\n};\n" }, { "path": "Client-Side Components/UI Actions/Email Watermark Utility/README.md", "content": "# Outlook Email Watermark Utility for ServiceNow\n\n# Overview\nThis reusable utility allows users to send emails **outside ServiceNow** (e.g., using Outlook or any default mail client) while still maintaining the conversation within ServiceNow. \nBy embedding a unique watermark reference, any replies to the email will automatically append to the original record's activity feed.\n\nThis helps teams collaborate externally without losing internal record visibility — ideal for customers or vendors who communicate via Outlook.\n\n---\n\n# Objective\n- Enable ServiceNow users to send Outlook emails directly from a record. \n- Maintain conversation history in ServiceNow using watermark tracking. \n- Make the solution **generic**, reusable across tables (Incident, Change, Request, etc.). \n- Prevent dependency on outbound mail scripts or custom integrations. \n\n# Components\n\n## 1. Script Include: GenericEmailUtility\nHandles the logic for:\n- Constructing the mailto: link. \n- Fetching recipient and instance email addresses. \n- Generating or retrieving the watermark ID. \n- Returning a formatted Outlook link to the client script.\n\n## Key Methods\n1. get_Outlook_link() - Builds the full Outlook mail link with subject, body, and watermark.\n2. getWatermark(record_id, table_name) - Ensures a watermark exists for the record.\n3. getEmail(user_id) - Fetches the email address for the target user.\n\n## 2. UI Action (Client Script)\nExecutes on the record form when the button/link is clicked. \nIt gathers record data, constructs a payload, calls the Script Include using GlideAjax, and opens Outlook.\n\n## Key Steps\n1. Collect field data like requestor, short description, and description. \n2. Pass record details to the Script Include (GenericEmailUtility). \n3. Receive a ready-to-use Outlook link. \n4. Open the mail client with prefilled details and watermark reference. \n\n## How It Works\n1. User clicks \"Send Outlook Email\" UI Action on a record.\n2. Script gathers record data and passes it to GenericEmailUtility.\n3. The utility builds a 'mailto:' link including the watermark.\n4. Outlook (or default mail client) opens with pre-filled To, CC, Subject, and Body fields.\n5. When the recipient replies, ServiceNow uses the watermark to append comments to the correct record.\n\n## Example Usage\n**User clicks “Send Outlook Email”** on a Request record: \nOutlook opens prefilled like this:\n\n\"image\"\n\n\n\"image\"\n\n" }, { "path": "Client-Side Components/UI Actions/Email Watermark Utility/Send Email UI Action.js", "content": "function onClick(g_form) {\n var separator = \"\\n--------------------------------\\n\";\n var email_body = \"Record URL:\\n\" + g_form.getDisplayValue('number') + separator;\n email_body += \"Short Description:\\n\" + g_form.getValue('short_description') + separator;\n email_body += \"Description:\\n\" + g_form.getValue('description') + separator;\n\n var email_data = {};\n email_data.REQUESTOR_ID = g_form.getValue('caller_id') || g_form.getValue('opened_by') || g_form.getValue('requested_for');\n email_data.TITLE = g_form.getValue('short_description') || 'ServiceNow Communication';\n email_data.BODY = email_body;\n email_data.REQUEST_ID = g_form.getUniqueValue();\n email_data.TABLE_ID = g_form.getTableName();\n\n var ga = new GlideAjax('GenericEmailUtility');\n ga.addParam('sysparm_name', 'get_Outlook_link');\n ga.addParam('sysparm_email_body', JSON.stringify(email_data));\n ga.getXMLAnswer(function(response) {\n var mailto_link = response;\n if (mailto_link && mailto_link != 'false') {\n window.open(mailto_link);\n } else {\n g_form.addErrorMessage('Unable to generate Outlook link.');\n }\n });\n}\n" }, { "path": "Client-Side Components/UI Actions/Expire Timer in Flows/README.md", "content": "This UI Action adds an admin-only button to Flow Context records in ServiceNow. It is designed to expire active timers within a flow, allowing developers and testers to bypass waiting stages during sub-production testing. This helps accelerate flow validation and debugging during development cycles, especially useful during events like Hacktoberfest.\n\nFlows in ServiceNow often include Wait for Condition or Wait for Duration steps that can delay testing. This UI Action provides a quick way to expire those timers, enabling the flow to proceed immediately without waiting for the configured duration or condition. Features\n\nAdds a button labeled \"Expire Timers\" to Flow Context records. Visible only to users with the admin role. Executes a script to expire all active timers associated with the selected Flow Context. Ideal for sub-production environments (e.g., development, test, or staging). Speeds up flow development and validation.\n\n\"image\"\n" }, { "path": "Client-Side Components/UI Actions/Expire Timer in Flows/script.js", "content": "/*\nThis script should be placed in the UI action on the table sys_flow_context form view.\nThis UI action should be marked as client.\nUse runClientCode() function in the Onclick field.\n*/\nfunction runClientCode() {\n\n if (confirm('Are you sure you want to Expire the Timer activity ?\\n\\nThis Action Cannot Be Undone!')) {\n //Call the UI Action and skip the 'onclick' function\n gsftSubmit(null, g_form.getFormElement(), 'ExpireTimer'); //MUST call the 'Action name' set in this UI Action\n } else {\n return false;\n }\n}\n\nif (typeof window == 'undefined') {\n ExpireTimer();\n}\n\nfunction ExpireTimer() {\n var grTrigger = new GlideRecord('sys_trigger');\n grTrigger.addQuery('name', 'flow.fire');\n grTrigger.addQuery('script', 'CONTAINS', current.sys_id);\n grTrigger.addQuery('state', 0);\n grTrigger.setLimit(1);\n grTrigger.query();\n if (grTrigger.next()) {\n var grEvent = new GlideRecord('sysevent');\n grEvent.initialize();\n grEvent.setNewGuid();\n grEvent.setValue('name', 'flow.fire');\n grEvent.setValue('queue', 'flow_engine');\n grEvent.setValue('parm1', grTrigger.getValue('job_context').toString().slice(6));\n grEvent.setValue('parm2', '');\n grEvent.setValue('instance', current.sys_id);\n grEvent.setValue('table', 'sys_flow_context');\n grEvent.setValue('state', 'ready');\n grEvent.setValue('process_on', new GlideDateTime().getValue()); //aka run immediately\n grEvent.insert();\n grTrigger.deleteRecord();\n gs.addInfoMessage(\"You have chosen to end any timers related to this flow.\");\n }\n\n\n action.setRedirectURL(current);\n}\n" }, { "path": "Client-Side Components/UI Actions/Field Review of User Record when on form using action button/README.md", "content": "## Field Review of User Record when on form using action button\n\nDisplays informational messages suggesting improvements to field formatting on the User Table (**sys_user**) form when the **Fields Check** button is clicked.\n\n- Helps maintain consistency in user data by checking capitalization of names and titles, validating email format, ensuring phone numbers contain only digits, and preventing duplicate phone entries. \n- Also suggests users not to leave the **user_name** field empty.\n- Shows Info messages below each field highlighting fields that may need attention.\n- Simple Prerequisite is that: when form loads give Info message to check **Field Check** button to bring user's attention\n- Uses a Client-side UI Action (**Fields Check**) that to review entered data and display friendly suggestions\n - Name: Fields Check\n - Table: User (sys_user)\n - Client: true\n - Form button: true\n - Onclick: onClickCheckDetails()\n\n---\n\n### Grab user's attention on Field Check Button using Info message at top\n\n![Field Review on User Table_1](Field_Review_userTable_1.png)\n\n---\n\n### After clicking Field Check Button where suggestions are displayed below fields\n\n![Field Review on User Table_2](Field_Review_userTable_2.png)\n\n---\n\n### When user fixes the suggested issues and click the **Fields Check** button again, a message confirms that all fields are correctly formatted\n\n![Field Review on User Table_3](Field_Review_userTable_3.png)\n\n---\n" }, { "path": "Client-Side Components/UI Actions/Field Review of User Record when on form using action button/actionButtonScript.js", "content": "function onClickCheckDetails() {\n // Friendly helper for field normalization guidance\n g_form.hideAllFieldMsgs();\n g_form.clearMessages();\n\n // --- Get Field values ---\n var firstName = g_form.getValue('first_name');\n var lastName = g_form.getValue('last_name');\n var title = g_form.getValue('title');\n var userId = g_form.getValue('user_name');\n var email = g_form.getValue('email');\n var businessPhone = g_form.getValue('phone');\n var mobilePhone = g_form.getValue('mobile_phone');\n\n // --- Regex patterns ---\n var capitalRegex = /^[A-Z][a-zA-Z\\s]*$/; // Names & titles start with a capital\n var emailRegex = /^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$/; \n var phoneRegex = /^\\d+$/; \n\n var suggestions = [];\n\n if (firstName && !capitalRegex.test(firstName)) {\n g_form.showFieldMsg('first_name', 'Suggestion: Start the name with a capital letter.', 'info');\n suggestions.push('First Name');\n }\n\n if (lastName && !capitalRegex.test(lastName)) {\n g_form.showFieldMsg('last_name', 'Suggestion: Start the name with a capital letter.', 'info');\n suggestions.push('Last Name');\n }\n\n if (title && !capitalRegex.test(title)) {\n g_form.showFieldMsg('title', 'Suggestion: Titles usually start with a capital letter.', 'info');\n suggestions.push('Title');\n }\n\n if (!userId) {\n g_form.showFieldMsg('user_name', 'Suggestion: Do not keep the User ID empty.', 'info');\n suggestions.push('User ID');\n }\n\n if (email && !emailRegex.test(email)) {\n g_form.showFieldMsg('email', 'Suggestion: Please use a valid email format like name@example.com.', 'info');\n suggestions.push('Email');\n }\n\n if (businessPhone && !phoneRegex.test(businessPhone)) {\n g_form.showFieldMsg('phone', 'Suggestion: Use digits only avoid letters.', 'info');\n suggestions.push('Business Phone');\n }\n\n if (mobilePhone && !phoneRegex.test(mobilePhone)) {\n g_form.showFieldMsg('mobile_phone', 'Suggestion: Use digits only avoid letters.', 'info');\n suggestions.push('Mobile Phone');\n }\n\n /\n if (businessPhone && mobilePhone && businessPhone === mobilePhone) {\n g_form.showFieldMsg('phone', 'Work and mobile numbers appear identical, use different Numbers!', 'info');\n suggestions.push('Phone Numbers');\n }\n\n if (suggestions.length > 0) {\n g_form.addInfoMessage('Quick review complete! Please check: ' + suggestions.join(', ') + '.');\n } else {\n g_form.addInfoMessage('looks good! Nicely formatted data.');\n }\n}\n" }, { "path": "Client-Side Components/UI Actions/Force to Update Set/README.md", "content": "# Introduction\n\nManually Add a Record to an Update Set\n\n1. Check to make sure the current table isn’t already recording updates\n2. Push the current record into the currently-selected update set\n3. Reload the form and add an info. message indicating the addition\n\n# Settings\nName: Force to Update Set\nTable: Wherever you need it!\nAction name: force_update\nForm link: True\nCondition: gs.hasRole(‘admin’)\nScript: \n//Commit any changes to the record\ncurrent.update();\n\n//Check to make sure the table isn't synchronized already\nvar tbl = current.getTableName();\nif(tbl.startsWith('wf_') || tbl.startsWith('sys_ui_') || tbl == 'sys_choice' || current.getED().getBooleanAttribute('update_synch') || current.getED().getBooleanAttribute('update_synch_custom')){\n gs.addErrorMessage('Updates are already being recorded for this table.');\n action.setRedirectURL(current); \n}\nelse{\n //Push the update into the current update set\n var um = new GlideUpdateManager2();\n um.saveRecord(current);\n\n //Query for the current update set to display info message\n var setID = gs.getPreference('sys_update_set');\n var us = new GlideRecord('sys_update_set');\n us.get(setID);\n\n //Display info message and reload the form\n gs.addInfoMessage('Record included in ' + us.name + ' update set.');\n action.setRedirectURL(current);\n}" }, { "path": "Client-Side Components/UI Actions/Force to Update Set/script.js", "content": "//Check to make sure the table isn't synchronized already\nvar tbl = current.getTableName();\nif(tbl.startsWith('wf_') || tbl.startsWith('sys_ui_') || tbl == 'sys_choice' || current.getED().getBooleanAttribute('update_synch') || current.getED().getBooleanAttribute('update_synch_custom')){\n gs.addErrorMessage('Updates are already being recorded for this table.');\n action.setRedirectURL(current); \n}\nelse{\n //Push the update into the current update set\n var um = new GlideUpdateManager2();\n um.saveRecord(current);\n\n //Query for the current update set to display info message\n var setID = gs.getPreference('sys_update_set');\n var us = new GlideRecord('sys_update_set');\n us.get(setID);\n\n //Display info message and reload the form\n gs.addInfoMessage('Record included in ' + us.name + ' update set.');\n action.setRedirectURL(current);\n}" }, { "path": "Client-Side Components/UI Actions/Generate QR for Assets/ReadMe.md", "content": "# 🧩 ServiceNow Asset QR Code Generator (UI Action)\n\nThis repository contains a **ServiceNow UI Action** script that generates and displays a QR Code for an Asset record from list view. \nWhen the user selects a record and clicks the UI Action, a modal window pops up showing a dynamically generated QR Code that links to asset details.\n\n\nA supporting **Script Include** (server-side) is required in your ServiceNow instance but **is not included** in this repository.\nAt the bottom of file , a sample Script Include Code is given , check for the reference.\n\n---\n\n## 🚀 Features\n\n- Generates a QR Code for the selected Asset record.\n- Displays the QR Code inside a ServiceNow modal (`GlideModal`).\n- Uses **QrIckit API** for quick and free QR code generation.\n- Clean, modular client-side code that integrates seamlessly with UI Actions.\n- Includes a `qr-code-image` file showing example QR Code generated.\n\n---\n\n## 🧠 How It Works\n\n1. The `onClickQR()` function is triggered when the user clicks a UI Action button.\n2. It calls `generateQRCodeForAsset(sys_id)` and passes the record’s `sys_id`.\n3. A `GlideAjax` request fetches asset data from a **Script Include** on the server.\n4. That data is encoded and sent to the **QrIckit** API to generate a QR Code image.\n5. A ServiceNow modal (`GlideModal`) displays the generated QR Code to the user.\n\n---\n\n\n**Note :**\n1) As the UI action calls a Script Include , in this folder no script include is present\n2) You can modify script include part as required(i.e Which fields are to be shown when QR is scanned)\n3) A sample Client Callable Script-Include is given here.\n\n``` Script Include Code\n var GenerateAssetQR = Class.create();\nGenerateAssetQR.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n getAssetQRData: function() {\n var sys_id = this.getParameter('sysparm_sys_id');\n var asset = new GlideRecord('alm_asset');\n if (asset.get(sys_id)) {\n return 'Asset: ' + asset.name + ', Serial: ' + asset.serial_number;\n }\n return 'Invalid asset record.';\n }\n});\n```\n" }, { "path": "Client-Side Components/UI Actions/Generate QR for Assets/ui-action-script.js", "content": "function onClickQR() {\n generateQRCodeForAsset(g_sysId);//get the sysid of selected record\n}\n\nfunction generateQRCodeForAsset(sys_id) {\n var ga = new GlideAjax('GenerateAssetQR');//Script Include which stores data to be presented when QR-Code is Scanned\n ga.addParam('sysparm_name', 'getAssetQRData');\n ga.addParam('sysparm_sys_id', sys_id);\n\n ga.getXMLAnswer(function(response) {\n var qrData = response;\n var qrURL = 'https://qrickit.com/api/qr.php?d=' + encodeURIComponent(qrData) + '&addtext=Get Asset Data';\n //QrIckit is a tool using which Customized QR-Codes can be generated\n var modalHTML = `\n
\n \"QR\n

Scan to view asset details

\n
\n `;\n\n var gModal = new GlideModal(\"QR Code\");\n gModal.setTitle('Asset QR Code');\n gModal.setWidth(500);\n gModal.renderWithContent(modalHTML);\n });\n}\n" }, { "path": "Client-Side Components/UI Actions/Generate a PDF/README.md", "content": "# Introduction\nGenerating a PDF using PDFGenerationAPI\nCalling an OOTB convertToPDFWithHeaderFooter() method to generate a PDF with your header and footer.\nPDFGenerationAPI – convertToPDFWithHeaderFooter(String html, String targetTable, String targetTableSysId, String pdfName, Object headerFooterInfo, String fontFamilySysId, Object documentConfiguration)\n\n# Example:\n\"image\"\n\n" }, { "path": "Client-Side Components/UI Actions/Generate a PDF/serverscript.js", "content": "//Table: Change Request\n// UI action button on the change form that exports all the related incidents into a PDF format.\n//ServiceNows PDFGenerationAPI allows you to customize the page size, header, footer, header image, page orientation, and more.\n\nvar inc = new GlideRecord('incident'),\n incidentsList = [],\n v = new sn_pdfgeneratorutils.PDFGenerationAPI,\n html = '',\n hfInfo = new Object(),\n result;\ninc.addQuery('rfc', current.sys_id);\ninc.query();\nwhile (inc.next()) {\n incidentsList.push(inc.number);\n incidentsList.push(inc.getDisplayValue('caller_id')); \n incidentsList.push(inc.getDisplayValue('category'));\n incidentsList.push(inc.getDisplayValue('subcategory'));\n incidentsList.push(inc.getValue('priority')); \n incidentsList.push(inc.getValue('short_description')); \n incidentsList.push(inc.getValue('description')); \n incidentsList.push(inc.getDisplayValue('assignment_group')); \n}\nvar json = { \n incidents: incidentsList.toString()\n};\n\n JSON.stringify(json);\nhtml = '

Incidents Related to the Change: ' + current.number + '


';\n\n\nhtml += '

Incidents List  

';\nhtml += '' + getIncidentsTable(json.incidents) + '
NumberCallerCategorySub CategoryPriorityShort DescriptionDescriptionAssignment Group
';\nhfInfo[\"FooterTextAlignment\"] = \"BOTTOM_CENTER\";\nhfInfo[\"FooterText\"] = \"Incidents List\";\nhfInfo[\"PageOrientation\"] = \"LANDSCAPE\";\nhfInfo[\"GeneratePageNumber\"] = \"true\";\n\nresult = v.convertToPDFWithHeaderFooter(html, 'change_request', current.sys_id, \"Incidents Related to the Change:_\" + current.number, hfInfo);\naction.setRedirectURL(current);\n\nfunction getIncidentsTable(incidents) {\n if (incidents == '')\n return '';\n var table = '',\n i;\n incidents = incidents.split(',');\n for (i = 0; i < incidents.length; i += 8)\n table += '' + incidents[i] + '' + incidents[i + 1] + '' + incidents[i +2] + '' + incidents[i + 3] + '' + incidents[i + 4] + '' + incidents[i + 5] + '' + incidents[i + 6] + '' + incidents[i + 7] + '';\n return table;\n}\n" }, { "path": "Client-Side Components/UI Actions/GlideModalForm - Open New Record and Pass Query/README.md", "content": "This is an example of using the GlideModalForm API to open a brand new record on a specific table, passing along query parameters to it to assist with loading filling out the form\n\nWithin the UI Action settings it's recommended to ensure:\n- Active is true\n- Either show insert and/or show update is true\n- Client is true\n- Your appropriate List v2 or V3 compatible checkbox is true\n- Onclick contains your function name that matches the function within your Script field -- the code related to this snipped would be: **functionName()**\n- Set true to however you wish to display this UI Action to the user; whether that's via Form button, Form context menu, Form link, etc.\n" }, { "path": "Client-Side Components/UI Actions/GlideModalForm - Open New Record and Pass Query/code.js", "content": "function functionName() { //specify the function name you listed within the UI Action \"onClick\" field\nvar tableName = \"table_name\"; //specify what table the new record should be created on\nvar dialog = new GlideModalForm('modal_form_title', tableName); //set your modal form title here\ndialog.setSysID(-1); //sys_id -1 will open a brand new record\ndialog.addParm('sysparm_view', 'view_name'); //optional: you can specify a specific view name here\ndialog.addParm('sysparm_view_forced', 'true'); //optional: you can force the view so it overrides\ndialog.addParm('sysparm_form_only', 'true'); //optional: you can specify to show the form only, removing related lists from the screen\nvar sDesc = g_form.getValue('short_description'); //example retrieving the short description on the current record\nvar query = \"short_description=\" + sDesc; //example setting the query JavaScript variable to the sDesc JavaScript variable that contains our current record's short description\ndialog.addParm('sysparm_query', query); //sets the query to the JavaScript variable from the line above, this will populate the related field(s) on the new form with the values specified\ndialog.render(); //displays the modal form to the user\n}\n" }, { "path": "Client-Side Components/UI Actions/GlideModalUiPagePopUp/README.md", "content": "Overview\nModal alerts and confirmations in ServiceNow are interactive user interface elements that allow users to receive important messages or confirm actions before proceeding. These modals enhance the user experience by providing clear feedback during key interactions, ensuring that users are well-informed before performing potentially critical actions, such as closing a record or saving changes.\n\nTwo key modal functions used in ServiceNow are:\n\ng_modal.alert(): Displays an informational message to the user.\ng_modal.confirm(): Requests user confirmation before proceeding with an action.\nKey Features:\nClarity: Provides clear messaging for users, helping them understand the consequences of their actions.\nUser Control: Allows users to confirm or cancel actions, reducing mistakes.\nCustomizable: Modal messages can be tailored to different scenarios, ensuring contextual and relevant feedback.\nTesting\nTo test the modal alerts and confirmations, follow these steps:\n\n1. User Scenario Setup:\nCreate a form with an assigned_to field and ensure that different users can access the form.\nSet up a button or UI action that triggers the onClick() function.\n2. Test Case 1: Unauthorized User\nLog in as a user who is not assigned to the task.\nClick the button to trigger the action.\nExpected Result: The user should receive an alert stating \"Only the assigned user can perform this action.\" The process should stop here.\n3. Test Case 2: Authorized User\nLog in as the user who is assigned to the task.\nClick the button to trigger the action.\nExpected Result: A confirmation dialog should appear asking, \"Are you sure you want to take this action?\"\nIf the user clicks \"Cancel,\" no action should be taken.\nIf the user clicks \"OK,\" the task's state should be set to \"Closed Complete,\" and the form should be saved.\n4. Edge Cases:\nTest what happens if the task has no assigned user.\nTest if the modals display correctly on different devices (desktop, mobile, etc.).\n5. Performance:\nEnsure that the modals load quickly and do not interfere with other form functions.\nHow It Works\nThe modal alert and confirmation functions are built on the ServiceNow UI framework and use JavaScript to control the interactions.\n\nAlert Modal (g_modal.alert()):\nThis function is used to inform the user without requiring any further input.\nIt takes three arguments: the title of the alert, the message to display, and an optional callback function that can execute code after the alert is closed.\nOnce triggered, the user sees a message box with only an \"OK\" button.\nConfirmation Modal (g_modal.confirm()):\nThis function prompts the user to confirm their action with two options: \"OK\" or \"Cancel.\"\nIt takes three arguments: the title of the confirmation modal, the message, and a callback function.\nThe callback function receives a confirmed argument that is true if the user clicks \"OK\" and false if they click \"Cancel.\"\nThis is useful in scenarios where user confirmation is critical (e.g., deleting a record, submitting a form).\nProcess Flow:\nThe system checks if the logged-in user has permission to perform the action (e.g., checking if the user matches the assigned_to field).\nIf the user is not authorized, an alert modal is displayed, and the process stops.\nIf the user is authorized, a confirmation modal is displayed to ask for final approval.\nIf confirmed, the system proceeds with the action (e.g., changing the record state and saving the form).\nBenefits\n1. Improved User Experience:\nModal alerts and confirmations provide immediate feedback to users. By using clear language in modals, users understand exactly what actions they can or cannot perform.\nConfirmation dialogs prevent accidental actions, which is especially useful in critical workflows (e.g., closing or deleting records).\n2. Reduced Errors:\nAlerts help users understand why an action is restricted, while confirmations ensure that actions are intentional.\nThis reduces the risk of accidental data changes or loss.\n3. Increased Control:\nBy requiring confirmation before a critical action is taken, users feel more in control of their tasks. They are prompted to reconsider their choices, which minimizes hasty decisions.\n4. Customization:\nModal alerts and confirmations can be easily customized for various forms and records, allowing tailored feedback depending on the context of the action.\n5. Asynchronous Operations:\nModals are asynchronous, meaning they don't block the user interface while waiting for input. This ensures that other parts of the application continue functioning smoothly.\n" }, { "path": "Client-Side Components/UI Actions/GlideModalUiPagePopUp/glide_modal_ui_pop_up.js", "content": "function onClick(g_form) {\n // Check if the current user is the assigned user\n if (g_user.userID != g_form.getValue('assigned_to')) {\n // Alert if the user is not the assigned user\n g_modal.alert('Only the assigned user can perform this action.');\n return;\n }\n\n // Confirmation message\n var msg = getMessage(\"Are you sure you want to take this action?\");\n \n // Confirmation modal before closing the task\n g_modal.confirm(getMessage(\"Confirmation\"), msg, function (confirmed) {\n if (confirmed) {\n // If confirmed, close the task\n g_form.setValue('state', 'closed_complete');\n g_form.save();\n }\n });\n\n return false;\n}\n" }, { "path": "Client-Side Components/UI Actions/Go to Agent Workspace Home Page/README.md", "content": "\n" }, { "path": "Client-Side Components/UI Actions/Go to Agent Workspace Home Page/ui_action_script.js", "content": "function onClick() {\n\ttop.window.location ='now/workspace/agent/home';\n}" }, { "path": "Client-Side Components/UI Actions/Group Membership Admin Util/README.md", "content": "# Group Membership Utility\n\nThe **Group Membership Utility** is a ServiceNow server-side tool designed to streamline the management of user membership in assignment groups. It provides administrators with two UI actions on the Assignment Group table to add or remove themselves from a group, ensuring efficient group membership management. Super helpful when doing group membership testing.\n\n## Challenge\n\nManaging assignment group memberships manually can be time-consuming and frustrating when doing group change related testings.\n\n## Features\n\n- **Add Me**: Adds the current user to the selected assignment group, ensuring quick inclusion.\n- **Remove Me**: Removes the current user from the selected assignment group, simplifying group updates.\n- **Admin-Only Visibility**: Both actions are restricted to users with administrative privileges i.e admin user role, ensuring controlled access.\n\n## Functionality\n\nThe Group Membership Utility provides the following capabilities:\n- Detects the current user's membership status in the selected group.\n- Dynamically enables or disables the **Add Me** and **Remove Me** actions based on the user's membership.\n- Ensures visibility of these actions only for users with administrative privileges.\n\n## Visibility\n\nAdd below condition script for the \"Add Me\" UI action \n```javascript\ngs.hasRole('admin') && !gs.getUser().isMemberOf(current.sys_id);\n```\nAdd below condition script for the \"Remove Me\" UI action \n```javascript\ngs.hasRole('admin') && gs.getUser().isMemberOf(current.sys_id);\n```\n\n## Usage Instructions\n\n1. Navigate to the Assignment Group table.\n2. Select a group.\n3. Use the **Add Me** button to add yourself to the group if you're not already a member.\n4. Use the **Remove Me** button to remove yourself from the group if you're already a member.\n\n\n" }, { "path": "Client-Side Components/UI Actions/Group Membership Admin Util/addMeUIActionScript.js", "content": "try {\n var groupSysId = current.sys_id;\n var userSysId = gs.getUserID();\n\n // Validate input\n if (!groupSysId || !userSysId) {\n throw new Error(\"Group Sys ID and User Sys ID are required.\");\n }\n\n // Create a new record in the sys_user_grmember table\n var gr = new GlideRecord(\"sys_user_grmember\");\n gr.initialize();\n gr.group = groupSysId;\n gr.user = userSysId;\n var sysId = gr.insert();\n\n if (sysId) {\n gs.addInfoMessage(\n \"User successfully added to the group. Record Sys ID: \" + sysId\n );\n } else {\n throw new Error(\"Failed to add user to the group.\");\n }\n} catch (error) {\n gs.addErrorMessage(\"Error adding user to group: \" + error.message);\n}\n" }, { "path": "Client-Side Components/UI Actions/Group Membership Admin Util/removeMeUIActionScript.js", "content": "try {\n var groupSysId = current.sys_id;\n var userSysId = gs.getUserID();\n\n // Validate input\n if (!groupSysId || !userSysId) {\n throw new Error(\"Group Sys ID and User Sys ID are required.\");\n }\n\n // Query the sys_user_grmember table to find the record\n var gr = new GlideRecord(\"sys_user_grmember\");\n gr.addQuery(\"group\", groupSysId);\n gr.addQuery(\"user\", userSysId);\n gr.query();\n\n if (gr.next()) {\n // Delete the record\n var deleted = gr.deleteRecord();\n if (deleted) {\n gs.addInfoMessage(\"User successfully removed from the group.\");\n } else {\n throw new Error(\"Failed to remove user from the group.\");\n }\n } else {\n throw new Error(\"No matching record found for the user in the group.\");\n }\n} catch (error) {\n gs.addErrorMessage(\"Error removing user from group: \" + error.message);\n}" }, { "path": "Client-Side Components/UI Actions/Group dependency/README.md", "content": "Easily assess where a user group is used across your ServiceNow instance — before you retire, modify, or repurpose it.\n\nThis solution adds a UI Action to the sys_user_group form that opens a clean, dynamic UI Page showing all the dependencies across modules like Tasks, Script Includes, Business Rules, Workflows, Catalog Items, Reports, and more.\n\nKey Features:\n\n• One-click access to group dependency insights\n\n• Displays usage across 10+ key modules\n\n• Modular architecture using UI Page, Script Include, and client-side UI Action\n\n• Easily extensible to include custom tables or rules\n\n\nUse Cases:\n\n• Pre-deactivation impact checks for groups\n\n• Governance and cleanup tasks\n\n• Platform documentation and audit support\n\n• Extensible framework for users, catalog items, or roles\n" }, { "path": "Client-Side Components/UI Actions/Group dependency/uiaction.js", "content": "/*\nThis script should be placed in the UI action on the table sys_user_group form view.\nThis UI action should be marked as client.\nUse popupDependency() function in the Onclick field.\ncondition - gs.hasRole('admin') \n*/\n\nfunction popupDependency() {\n var groupSysId = gel('sys_uniqueValue').value;\n var gdw = new GlideDialogWindow('display_group_dependency_list');\n gdw.setTitle('Group Dependency');\n gdw.setPreference('sysparm_group', groupSysId);\n gdw.render();\n}\n" }, { "path": "Client-Side Components/UI Actions/Group dependency/uipage.js", "content": "\n\n\n\t\n\t\n\t\tvar groupSysId = trim(jelly.sysparm_group);\n\t\tvar groupName = '';\n\t\tvar taskRecords = 0;\n\t\tvar reportRecords = 0;\n\t\tvar workflowRecords = 0;\n\t\tvar workflowVersions = '';\n\t\tvar scriptIncludeRecords = 0;\n\t\tvar businessRulesRecords = 0;\n\t\tvar clientScriptRecords = 0;\n\t\tvar maintainItemRecords = 0;\n\t\tvar businessServiceRecords=0;\n\t\tvar systemPropertiesRecords=0;\n\t\tvar avaiforGroupsRecords = 0;\n\t\tvar grACLRecords = 0;\n\t\t\n\t\tvar grGroupName = new GlideRecord('sys_user_group');\n\t\tif (grGroupName.get('sys_id', groupSysId)) {\n\t\t\tgroupName = grGroupName.name;\n\t\t}\n\t\t\n\t\t// TASK\n\t\tvar grTask = new GlideRecord(\"task\");\n\t\tgrTask.addEncodedQuery('sys_created_onRELATIVEGE@month@ago@9^assignment_group.sys_id='+groupSysId+'^active=true^GROUPBYsys_class_name^ORDERBYsys_created_on');\n\t\tgrTask.query(); \n\t\ttaskRecords = grTask.getRowCount();\n\n\t\t// REPORTS\n\t\tvar grReport = new GlideRecord(\"sys_report\");\n\t\tgrReport.addEncodedQuery('filterLIKE'+groupSysId+'^ORfilterLIKEE'+groupName);\n\t\tgrReport.query(); \n\t\treportRecords = grReport.getRowCount();\n\n\t\t\n\t\t// WORKFLOWS\n\t\tvar grWFActivity = new GlideRecord('wf_activity'); \n\t\tgrWFActivity.addQuery('sys_id', 'IN', getWfActivities(groupSysId, groupName)); \n\t\tgrWFActivity.addQuery('workflow_version.published', 'true'); \n\t\tgrWFActivity.query(); \n\t\twhile (grWFActivity.next()) { \n\t\t\n\t\t\n var grh = new GlideRecord(\"wf_workflow_version\");\n grh.addEncodedQuery(\"sys_id=\" + grWFActivity.workflow_version.sys_id);\n grh.query();\n while (grh.next()) {\n\n workflowVersions += grWFActivity.workflow_version.sys_id + ',';\t\t\n}\n}\t\t\n\t\tworkflowRecords = getCount(workflowVersions);\n\t\tif(workflowRecords == 1){\n\t\tvar sci = sciWorkflow(grh.workflow.sys_id.toString());\n\t\tif(sci){\t\n\t\tworkflowRecords =0;\n\t\tworkflowVersions ='';\n\t\t}\n\t\t}\n\t\t\n\t\tfunction sciWorkflow(workflow){\nvar gr12 = new GlideRecord(\"sc_cat_item\");\ngr12.addEncodedQuery(\"active=false^workflow=\"+workflow);\ngr12.query();\nif (gr12.next()) {\n return true;\n}\n\t\t}\n\t\t\n\t\tfunction getCount(sysid){\n var gr = new GlideRecord('wf_workflow_version');\n gr.addQuery('sys_id','IN',sysid);\n gr.query();\n return gr.getRowCount();\n }\n\t\t\n\t\tfunction getWfActivities(group_id, group_name) { \n\t\t\tvar grVariables = new GlideRecord('sys_variable_value'); \n\t\t\tgrVariables.addEncodedQuery('valueLIKE'+group_name+'^ORvalueLIKE'+group_id+'^document=wf_activity');\t\n\t\t\tgrVariables.query(); \n\t\t\tvar results = []; \n\t\t\twhile (grVariables.next()) {\n\t\t\t\tresults.push(grVariables.document_key + ''); \n\t\t\t}\n\t\t\treturn results; \n\t\t}\n\t\t\n\t\t// SCRIPT INCLUDES\n\t\tvar grScriptInclude = new GlideRecord(\"sys_script_include\");\n\t\tgrScriptInclude.addEncodedQuery('scriptLIKE'+groupSysId+'^ORscriptLIKE'+groupName+'^active=true');\n\t\tgrScriptInclude.query(); \n\t\tscriptIncludeRecords = grScriptInclude.getRowCount();\n\t\t\n\t\t// BUSINESS RULES\n\t\tvar grBusinessRules = new GlideRecord(\"sys_script\");\n\t\tgrBusinessRules.addEncodedQuery('active=true^scriptLIKE'+groupName+'^ORscriptLIKE'+groupSysId);\n\t\tgrBusinessRules.query(); \n\t\tbusinessRulesRecords = grBusinessRules.getRowCount();\n\t\t\n\t\t// CLIENT SCRIPT\n\t\tvar grClientScript = new GlideRecord(\"sys_script_client\");\n\t\tgrClientScript.addEncodedQuery('sys_class_name=sys_script_client^active=true^scriptLIKE'+groupName+'^ORscriptLIKE'+groupSysId);\n\t\tgrClientScript.query(); \n\t\tclientScriptRecords = grClientScript.getRowCount();\n\t\t\n\t\t\n\t\t// MAINTAIN ITEMS (CATALOG ITEMS)\n\t\tvar grMaintainItems = new GlideRecord(\"sc_cat_item\");\ngrMaintainItems.addEncodedQuery('u_approval_group_1='+groupSysId+'^ORu_approval_group_2='+groupSysId+'^ORgroup='+groupSysId+'^ORu_fulfillment_group_2='+groupSysId+'^active=true');\t\n\t\tgrMaintainItems.query(); \n\t\tmaintainItemRecords = grMaintainItems.getRowCount();\n\t\t\n\t\t//CMDB CI's\n\t\t\n\t\tvar grBusinessServices = new GlideRecord('cmdb_ci');\ngrBusinessServices.addEncodedQuery('install_status!=7^change_control='+groupSysId+'^ORsupport_group='+groupSysId)\n\tgrBusinessServices.query();\n\t\tbusinessServiceRecords= grBusinessServices.getRowCount();\n\t\t\n\t\t//System Properties\n\tvar grsysProperties = new GlideRecord('sys_properties');\n\t\tgrsysProperties.addEncodedQuery('valueLIKE'+groupSysId);\n\t\tgrsysProperties.query();\n\t\tsystemPropertiesRecords = grsysProperties.getRowCount();\n\t\t\n\t\t//Available for Groups\n\t\tvar grAvaiForGroups = new GlideRecord(\"sc_cat_item_group_mtom\");\n\t\tgrAvaiForGroups.addEncodedQuery('sc_cat_item.active=true^sc_avail_group='+ groupSysId);\n\t\t\n\t\tgrAvaiForGroups.query(); \n\t\tavaiforGroupsRecords = grAvaiForGroups.getRowCount();\n\t\t\n\t\t//Available for Notifications\n\t\tvar grAvaiForNotifications = new GlideRecord(\"sysevent_email_action\");\n\t\tgrAvaiForNotifications.addEncodedQuery('active=true^conditionLIKE'+ groupSysId +'^ORrecipient_groupsLIKE'+ groupSysId + '^ORadvanced_conditionLIKE'+ groupSysId);\n\t\t\n\t\tgrAvaiForNotifications.query(); \n\t\tNotificationRecords = grAvaiForNotifications.getRowCount();\n\t\t\n\t\t//ACL for Groups\n\t\t\n\t\tvar grACL = new GlideRecord(\"sys_security_acl\");\n grACL.addEncodedQuery('scriptLIKE' + groupName + '^ORscriptLIKE' + groupSysId + '^ORconditionLIKE' + groupName + '^ORconditionLIKE' + groupSysId + '^active=true');\ngrACL.query(); \ngrACLRecords = grACL.getRowCount();\n\t\t\n\t\n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n\t\t\n\t\t
\n\t\t\t
ModuleRecordsDetails
TASK${taskRecords}\n\t\t\t\tView records\n\t\t\t
Workflows${workflowRecords}View records
Reports${reportRecords}View records
Catalog Items${maintainItemRecords}View records
\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t
timer sys_idnext actiontime leftkill?
\n\t\t\t\t\t\t\t\t${jvar_timer.sys_id}\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t${jvar_timer.waitUntil}\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t${jvar_timer.timeLeft}\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t
\n\t\t\t\n\t\t
\n\t\n\n\n//Client script:\n// handler for clicking ok on modal. gathers the sys_ids for the timers that have checked checkbox\nfunction okDialog() {\n\tvar c = gel('sysids');\n\tvar sysids = [];\n\t$j('input[type=\"checkbox\"]:checked').each(function () {\n\t\tvar checkboxId = $j(this).attr('id').replace(\"ni.\", \"\");\n\t\tsysids.push(checkboxId);\n\t});\n\tc.value = sysids.toString();\n\treturn true;\n}\n\n//Processing script:\n// queries for timer jobs and sets the job and new flow.fire event to process instantly -> timer on flow completes \nvar waitJob = new GlideRecord(\"sys_trigger\");\nwaitJob.addQuery(\"sys_id\", \"IN\", sysids);\nwaitJob.query();\nwhile (waitJob.next()) {\n\tvar currentScript = waitJob.getValue(\"script\");\n\tvar now = new GlideDateTime().getValue();\n\tvar replaceScript = currentScript.replace(/gr\\.setValue\\('process_on',\\s*'[^']*'\\)/, \"gr.setValue('process_on','\" + now + \"')\");\n\twaitJob.setValue(\"script\", replaceScript);\n\twaitJob.setValue(\"next_action\", now);\n\twaitJob.update();\n}\n//redirect back to bottom of nav stack\nvar urlOnStack = GlideSession.get().getStack().bottom();\nresponse.sendRedirect(urlOnStack);\n" }, { "path": "Client-Side Components/UI Actions/Knowledge Link Validator/Readme.md", "content": "This utility script helps ServiceNow administrators and content managers ensure the integrity and usability of hyperlinks embedded within knowledge articles. It scans article content to identify and classify links pointing to catalog items and other knowledge articles, providing detailed insights into:\n\nCatalog Item Links: Detects and categorizes links as active, inactive, or not found.\nKnowledge Article Links: Flags outdated articles based on workflow state and expiration (valid_to).\nNon-Permalink KB Links: Identifies knowledge article links that do not follow the recommended permalink format (i.e., missing sysparm_article=KBxxxxxxx), even if they use kb_view.do.\nThe solution includes a Jelly-based UI that displays categorized results with direct links to the affected records, enabling quick remediation. It's ideal for improving content quality, ensuring consistent user experience, and maintaining best practices in knowledge management.\n\n\"image\"\n" }, { "path": "Client-Side Components/UI Actions/Knowledge Link Validator/uiaction.js", "content": "/*\nThis script should be placed in the UI action on the table kb_knowledge form view.\nThis UI action should be marked as client.\nUse validateLinksInArticle() function in the Onclick field.\n*/\n\nfunction validateLinksInArticle() {\n var articleSysId = g_form.getUniqueValue();\n var gdw = new GlideDialogWindow('validate_links_dialog');\n gdw.setTitle('Validate Article Links');\n gdw.setPreference('sysparm_article_id', articleSysId);\n gdw.render();\n}\n" }, { "path": "Client-Side Components/UI Actions/Knowledge Link Validator/uipage.js", "content": "\n \n \n tags\n var regex = /]+href=[\"']([^\"']+)[\"']/gi;\n var urls = [];\n var match;\n while ((match = regex.exec(content)) !== null) {\n\t\t\t\t\n urls.push(match[1]);\n }\n for (var i = 0; i < urls.length; i++) {\n var url = urls[i];\n\t\t\t\t\n // --- 1. Check if link is a Catalog Item ---\n var sysId = extractSysId(url, 'sysparm_id') || extractSysId(url, 'sys_id');\n if (sysId) {\n var grItem = new GlideRecord('sc_cat_item');\n if (grItem.get(sysId)) {\n if (grItem.active){\n activeIds.push(sysId);\n activeCount++;\n }\n else if(grItem.active == false){\n inactiveIds.push(sysId);\n inActiveCount++;\n }\n } else {\n notFoundIds.push(sysId);\n notFoundCount++;\n }\n }\n // --- 2. Check if link is a Knowledge Article ---\n // --- 1. Check for outdated knowledge articles via permalink ---\n\n// --- 1. Check for outdated knowledge articles via permalink ---\nvar decodedUrl = decodeURIComponent(url + '');\ndecodedUrl = decodedUrl.replace(/&amp;amp;amp;/g, '&');\n\n// Extract KB number or sys_id\nvar kbNumber = extractSysId(decodedUrl, 'sysparm_article');\nvar kbSysId = extractSysId(decodedUrl, 'sys_kb_id') || extractSysId(decodedUrl, 'sys_id');\n\nvar grKb = new GlideRecord('kb_knowledge');\n\nif (kbNumber && grKb.get('number', kbNumber)) {\n var isOutdated = false;\n if (grKb.workflow_state != 'published') {\n isOutdated = true;\n } else if (grKb.valid_to && grKb.valid_to.getGlideObject()) {\n var now = new GlideDateTime();\n if (grKb.valid_to.getGlideObject().compareTo(now) <= 0) {\n isOutdated = true;\n }\n }\n\n if (isOutdated) {\n outdatedArticles.push(grKb.sys_id.toString());\n outdatedCount++;\n }\n} else if (kbSysId && grKb.get(kbSysId)) {\n var isOutdated = false;\n if (grKb.workflow_state != 'published') {\n isOutdated = true;\n } else if (grKb.valid_to && grKb.valid_to.getGlideObject()) {\n var now = new GlideDateTime();\n if (grKb.valid_to.getGlideObject().compareTo(now) <= 0) {\n isOutdated = true;\n }\n }\n\n if (isOutdated) {\n outdatedArticles.push(grKb.sys_id.toString());\n outdatedCount++;\n }\n}\n\n// --- 2. Check for non-permalink knowledge links ---\nif (\n decodedUrl.indexOf('kb_knowledge.do?sys_id=') !== -1 || // form view\n (\n decodedUrl.indexOf('/kb_view.do') !== -1 && \n decodedUrl.indexOf('sysparm_article=KB') === -1 // missing KB number\n )\n) {\n var kbSysId = extractSysId(decodedUrl, 'sys_kb_id') || extractSysId(decodedUrl, 'sys_id');\n if (kbSysId) {\n var grBadKB = new GlideRecord('kb_knowledge');\n if (grBadKB.get(kbSysId)) {\n badPermalinks.push(kbSysId);\n badPermalinkCount++;\n }\n }\n}\n }\n }\n }\n function extractSysId(url, param) {\n try {\n var decoded = decodeURIComponent(url + '');\n decoded = decoded\n .replace(/&amp;amp;/g, '&')\n .replace(/&amp;/g, '&')\n .replace(/&/g, '&')\n .replace(/=/g, '=')\n .replace(/&#61;/g, '=');\n\n var parts = decoded.split(param + '=');\n if (parts.length > 1) {\n var id = parts[1].split('&')[0];\n return id && id.length === 32 ? id : null;\n }\n } catch (e) {\n var parts = url.split(param + '=');\n if (parts.length > 1) {\n var id = parts[1].split('&')[0];\n return id && id.length === 32 ? id : null;\n }\n }\n return null;\n}\n // Expose variables to Jelly\ninactiveQuery = \"sys_idIN\"+inactiveIds.join(',');\nactiveQuery = \"sys_idIN\"+activeIds.join(',');\nnotFoundQuery = \"sys_idIN\"+notFoundIds.join(',');\noutdatedQuery = \"sys_idIN\"+outdatedArticles.join(',');\nbadPermalinkQuery = \"sys_idIN\"+badPermalinks.join(',');\n ]]>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ModuleRecordsDetails
Active Catalog Items${activeCount}\n View records\n
Inactive Catalog Items${inActiveCount}\n View records\n
Not Found Items${notFoundCount}\n View records\n
Outdated Knowledge Articles${outdatedCount}\n View records\n
Non-Permalink Knowledge Links${badPermalinkCount}\n View records\n
\n\n" }, { "path": "Client-Side Components/UI Actions/Mark Records Inactive - List Action/README.md", "content": "Above two scripts will help you to select records in list view and mark them inactive. You can create your UI action(list action) on any table and then you should be able to\nmark the records as inactive by calling the reusable script include. Process is pretty simple as shown below:\n1. Create a List action - list banner button or list choice.\n2. Check the client checkbox. Use the script and do any necessary modifications.\n3. Keep your script include ready with the function to make records inactive and done.\n\nYou can even modify the scrip include to change other fields too based on your requirements. And you do not need to pass any table name also. This is complete generic.\n\n**UPDATE:**\n_Replaced standard Javascript Window method 'alert' with GlideModal as per issue #745. This completes the task 'Mark Records Inactive UI Action'_\n" }, { "path": "Client-Side Components/UI Actions/Mark Records Inactive - List Action/listAction.js", "content": "// Create a List Action. Make it as List Banner Button or List choice. Keep the client checkbox checked and the use the below script.\n\nvar selRecords;\n\nfunction markInactive() {\n selRecords = g_list.getChecked(); //Get the sysIds of selected records from list view\n\n var ga_inactive = new GlideAjax('MarkRecordsInactive'); // call the script include for the same\n\n ga_inactive.addParam('sysparm_name', 'markInactiveRecords');\n ga_inactive.addParam('sysparm_ids', selRecords);\n ga_inactive.addParam('sysparm_table', g_list.getTableName());\n\n ga_inactive.getXML(ResponseFunction);\n\n function ResponseFunction(response) {\n var answer = response.responseXML.documentElement.getAttribute(\"answer\");\n //alert(answer.toString());\n // Commented above code and replaced it with GlideModal\n var gm = new GlideModal(\"glide_alert_standard\", false, 600);\n gm.setTitle(\"Info Message\");\n gm.setPreference(\"title\", answer.toString());\n gm.setPreference(\"warning\", \"false\");\n gm.render();\n }\n}\n" }, { "path": "Client-Side Components/UI Actions/Mark Records Inactive - List Action/scriptInclude.js", "content": "var MarkRecordsInactive = Class.create();\nMarkRecordsInactive.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n\n markInactiveRecords: function() {\n var sysIds = this.getParameter('sysparm_ids');\n var tableName = this.getParameter('sysparm_table');\n \n\t\tvar recs = new GlideRecordSecure(tableName);\n\t\trecs.addEncodedQuery('sys_idIN'+sysIds);\n\t\trecs.query();\n\t\twhile(recs.next())\n\t\t\t{\n\t\t\t\trecs.active = false;\n\t\t\t\trecs.update();\n\t\t\t}\n\t\treturn 'All the selected records are marked Inactive';\n },\n type: 'MarkRecordsInactive'\n});\n" }, { "path": "Client-Side Components/UI Actions/Open Email Client using UI Action/README.md", "content": "When an agent needs a button on the form to open Email Client in a single click, This UI action can be used, which works similar to the out of box Email button. Some user may not prefer the out of box button because it is two clicks.\nTo use this UI action, mark the UI action as Client and add the openEmailClient function in the onClick Field in the UI action. Then use the script provided in the script field.\n" }, { "path": "Client-Side Components/UI Actions/Open Email Client using UI Action/open_email_client.js", "content": "// This is a Client UI action. In the onClick field, call the function openEmailClient() and use below script in the script section.\nfunction openEmailClient(){\n emailClientOpenPop('');\n}\n" }, { "path": "Client-Side Components/UI Actions/Open LIST UI Action/README.md", "content": "This UI Action opens the LIST view for the current table in another tab.\nUI action will run on Onclick openinLIST()\n" }, { "path": "Client-Side Components/UI Actions/Open LIST UI Action/UIActionscript.js", "content": "function openinLIST() {\n var taskTable = g_form.getTableName();\n\n // Construct the hardcoded LIST URL\n var listURL = '/' + taskTable + '_list.do?sysparm_clear_stack=true';\n\n // Open in new window\n var w = getTopWindow();\n w.window.open(listURL, '_blank');\n}\n" }, { "path": "Client-Side Components/UI Actions/Open Record in Alternate Instance/README.md", "content": "This set of:\n\n- RESTMessage\n- Script Includes\n- Scripted REST API (SRAPI)\n- UI Action\n\nWill allow you to open a record in alternate corresponding instance(s) of ServiceNow.\nFor example, from a record in a PROD instance, you can open the correlating record in your DEV instance.\n\nThe 'Starting Instance', refers to the instance you are currently in, and the 'Target Instance' refers to the instance you want to open the record in.\nAny instance of `[Target Instance]` in these files will need to be replaced.\n\n- The RESTMessage will need to exist on the 'Starting' Instance\n- The Script Includes will need to exist on the 'Starting' Instance\n- The UI Action will need to exist on the 'Starting' Instance\n- The SRAPI will need to exist on the Target Instance\n\nAny file ending in `_config.md` relates to field configuration of the record." }, { "path": "Client-Side Components/UI Actions/Open Record in Alternate Instance/RESTMessageV2/sys_rest_message_config.md", "content": "Name: Cross-Instance Record Checking\nEndpoint: [An Instance Url]/api/[api subpath, i.e., riot]/recordapi/record_exists\n\nSee `sys_rest_message_fn_config.md` for HTTP Method setup." }, { "path": "Client-Side Components/UI Actions/Open Record in Alternate Instance/RESTMessageV2/sys_rest_message_fn_config.md", "content": "Name: [Target Instance] Record Exists\nHTTP Method: PATCH\nEndpoint: [Target Instance Url]/api/[api subpath]/.../record_exists\n\nHTTP Request Parameters:\n\n {\n \"table\": \"${table}\",\n \"sysId\": \"${sysId}\"\n }" }, { "path": "Client-Side Components/UI Actions/Open Record in Alternate Instance/Script Includes/README.md", "content": "\n!! The switch statement in CrossInstanceHelper.js will need to be reconfigured to match instance names, and RESTMessage naming." }, { "path": "Client-Side Components/UI Actions/Open Record in Alternate Instance/Script Includes/sys_script_include.js", "content": "var CrossInstanceHelper = Class.create();\nCrossInstanceHelper.prototype = {\n initialize: function() {\n },\n\t\n\t//Defines a filter so that tables that will never exist in other environments are not checked.\n\t_goodTable: function(table){\n\t\t\n\t\tvar disallowedTables = [\n\t\t\t'sys_update_set_source',\n\t\t\t'sys_update_set',\n\t\t\t'sys_email',\n\t\t\t'syslog'\n\t\t];\n\t\t\n\t\t//If the table is disallowed, return false\n\t\tif(disallowedTables.indexOf(table) != -1) return false;\n\t\t\n\t\t//If the table extends task, or extends a table that extends task, return false\n\t\treturn !(new TableUtils('task').getTableExtensions().indexOf(table) != -1 || new TableUtils(table).getAbsoluteBase() == 'task');\n\t},\n\t\n\texists: function(instance, table, sys_id){\n\t\t\n\t\t//If the table is disallowed, return\n\t\tif(!_goodTable(table)) return false;\n\t\t\n\t\t//Determine endpoint from instance\n\t\tvar endpoint;\n\t\tinstance = instance.toLowerCase();\n\n /*\n These are example instance names and their corresponding endpoints. You will need to add your own instances and endpoints here.\n */\n\t\tswitch(instance){\n\t\t\tcase 'prod':\n\t\t\t\tendpoint = 'PROD Exists';\n\t\t\t\tbreak;\n\t\t\tcase 'test':\n\t\t\t\tendpoint = 'TEST Exists';\n\t\t\t\tbreak;\n\t\t\tcase 'dev':\n\t\t\t\tendpoint = 'DEV Exists';\n\t\t\t\tbreak;\n\t\t}\n\t\t\n\t\t//Build the REST Message\n\t\tvar r = new sn_ws.RESTMessageV2('Cross-Instance Record Checking', endpoint);\n\t\tr.setStringParameterNoEscape('table', table);\n\t\tr.setStringParameterNoEscape('sysId', sys_id);\n\t\t\n\t\t//Execute the request\n\t\tvar response = r.execute();\n\t\t\n\t\t//Return whether or not the record exists (true if it exists)\n\t\treturn(response.getStatusCode().toString() == '200');\n\t},\n\n type: 'CrossInstanceHelper'\n};" }, { "path": "Client-Side Components/UI Actions/Open Record in Alternate Instance/Script Includes/sys_script_include_config.md", "content": "Name: CrossInstanceHelper\nClient callable: false\n\nScript: See `sys_script_include.js` for code." }, { "path": "Client-Side Components/UI Actions/Open Record in Alternate Instance/Scripted REST API/sys_ws_definition_config.md", "content": "General:\n\n Name: RecordAPI\n API ID: recordapi\n\nContent Negotiation:\n\n Supported request formats: application/json,application/xml,text/xml\n Supported response formats: application/json,application/xml,text/xml" }, { "path": "Client-Side Components/UI Actions/Open Record in Alternate Instance/Scripted REST API/sys_ws_operation/sys_ws_operation.js", "content": "(function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {\n\n\tfunction isNull(obj){\n\t\treturn(obj == '' || obj == undefined || obj == 'undefined' || obj == null || obj == 'null');\n\t}\n\n\t//Get data from request\n\tvar requestBody = request.body;\n\tvar requestData = requestBody.data;\n\t\n\t//Get table name from request\n\tvar tableName = requestData.table;\n\n\t//Get sys_id from request\n\tvar sysId = requestData.sysId;\n\n\t//Make sure data exists\n\tif(isNull(tableName) || isNull(tableName.toString()) || isNull(sysId) || isNull(sysId.toString())){\n\t\tresponse.setStatus(400);\n\t\treturn;\n\t}\n\t\n\t//Start lookup\n\tvar rGr = new GlideRecord(tableName);\n\trGr.get('sys_id', sysId);\n\n\tvar recordExists = !rGr.sys_id == '';\n\n\tresponse.setBody(recordExists ? \"Resource exists.\" : \"Resource does not exist.\");\n\tresponse.setStatus(recordExists ? 200 : 404);\n\n})(request, response);" }, { "path": "Client-Side Components/UI Actions/Open Record in Alternate Instance/Scripted REST API/sys_ws_operation/sys_ws_operation_config.md", "content": "General:\n\n HTTP Method: PATCH\n Relative Path: /record_exists\n\nContent Negotiation:\n\n Request formats: application/json,application/xml,text/xml\n Response formats: application/json,application/xml,text/xml\n\nScript: see `sys_ws_operation.js` for code." }, { "path": "Client-Side Components/UI Actions/Open Record in Alternate Instance/UI Action/sys_ui_action.js", "content": "function openInInstance(){\n\n //Since we are in a client action, get the current record utilizing the URL\n if(!top.location) return;\n var href = top.location.href.toString();\n\n //Grab record from current URL\n var recordHref = href.split('.com/')[1];\n\n //Open the record in the new instance\n window.open('https://[Target Instance].service-now.com/nav_to.do?uri=' + recordHref, '_blank');\n\n}" }, { "path": "Client-Side Components/UI Actions/Open Record in Alternate Instance/UI Action/sys_ui_action_config.md", "content": "!! If your instances use vanity urls, or otherwise do not end in `.com`, the `split()` in code.js will need to be edited\n\nName: Open Record in [Target Instance]\nTable: Global [global]\nAction Name: Open Record in [Target Instance]\n\nClient: true\nList v2 Compatible: true\nList v3 Compatible: true\n\nIsolate script: false\n\nOnclick: openInInstance()\n\nCondition:\n\n gs.getProperty('[Target Instance]') != '[target instance name]' && !current.isNewRecord() && new CrossInstanceHelper().exists('[Target Instance]', current.getTableName(), current.sys_id.toString())\n\nScript: See `sys_ui_action.js` for code." }, { "path": "Client-Side Components/UI Actions/Open Record producer from Form Button In Configurable workspace/OpenItem.js", "content": "/* \nUI Action\n Client - true\n action name - open_item\n show update - true ( As per your requirement)\n onClick - openItem();\n Workspace Form button - true\n Format for Configurable Workspace - true \n*/\n\n//Workspace client script: \nfunction onClick() {\n var result = g_form.submit('open_item');\n if (!result) {\n return;\n }\n result.then(function() {\n var params = {};\n params.sysparm_parent_sys_id = g_form.getUniqueValue();\n params.sysparm_shortDescription = g_form.getValue('short_description');\n //add params as required, These params can be parsed and used in the record producer.\n g_service_catalog.openCatalogItem('sc_cat_item', 'recordproducer_sysid_here', params); \n //Use the record producer sys_id in second parameter.\n });\n}\n" }, { "path": "Client-Side Components/UI Actions/Open Record producer from Form Button In Configurable workspace/ParseUrl.js", "content": "/*\nCatalog Client script on the record producer/catalog item you want to open from ui action\n Name - ParseURL\n Type - Onload\n Applies on catalog item view - true\n*/\n\nfunction onLoad() {\n\n \n\tg_form.setValue('task',parseURL('sysparm_parent_sys_id'));\n\tg_form.setValue('description',parseURL('sysparm_description));\n\t\n\tfunction parseURL(paramName) {\n\t\t\n\t\tvar url = decodeURIComponent(top.location.href); //Get the URL and decode it\n\t\tvar workspaceParams = url.split('extra-params/')[1]; //Split off the url on Extra params\n\t\tvar allParams = workspaceParams.split('/'); //The params are split on slashes '/'\n\t\t\n\t\t//Search for the parameter requested\n\t\tfor (var i=0; i< allParams.length; i++) {\n\t\t\tif(allParams[i] == paramName) {\n\t\t\t\treturn allParams[i+1];\n\t\t\t}\n\t\t}\n\t}\n}\n/*\npass the parameter name which was used in the ui action to parse the value here.\nExample - parseURL('sysparm_description) as I am passing description value in the params from ui action.\n*/\n" }, { "path": "Client-Side Components/UI Actions/Open Record producer from Form Button In Configurable workspace/README.md", "content": "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.\n\nThis 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.\n\n1. UI Action\n Client - true\n action name - open_item\n show update - true ( As per your requirement)\n onClick - openItem();\n Workspace Form button - true\n Format for Configurable Workspace - true \n\n2. Catalog Client script.\n Type - Onload\n Applies on catalog item view - true\n Name - ParseURL\n\nNote : Above UI Action works in Configurable workspace and opens the catalog item/record producer in workspace itself.\n" }, { "path": "Client-Side Components/UI Actions/Open a new blank form/README.md", "content": "UI Action - This script is server side script add it to the UI action to create a new blank form.\n\nWhen clicked on it will create a New Blank form and will redirect user to this newly created blank form.\n\nincident.do is used as URL paramenter will open new blank form for incident , we can change this to any other table ( for example - problem.do will open new blank problem form)\n\naction.setRedirectURL() is a method used in server-side scripting within UI Actions to redirect users to a specific URL after a UI action is performed. \nIt is commonly used to navigate users to different records, forms, or list views after they have completed an action.\nSyntax - action.setRedirectURL(URL);\nParameters:\nURL: The URL to which the user will be redirected. This can be a string representing a GlideURL object or a hardcoded URL. It must point to a valid ServiceNow page (record, list, form, etc.).\nReturn:\nNone. It performs a redirection after the script completes.\n\nGlideURL is a class in ServiceNow used for constructing URLs dynamically in server-side scripts. \nIt allows developers to programmatically create and manipulate URLs to redirect users, perform navigation, or link to specific ServiceNow resources (e.g., forms, lists, reports).\n" }, { "path": "Client-Side Components/UI Actions/Open a new blank form/script.js", "content": "//Create New blank incident form\n//Server side Script\n\nvar newFormURL = new GlideURL('incident.do');\nnewFormURL.addParam('sys_id', '-1'); // Open a new blank form\naction.setRedirectURL(newFormURL.toString());\n" }, { "path": "Client-Side Components/UI Actions/Open in Service Operations Workspace/README.md", "content": "# Open in Service Operation Workspace\n\nCreate UI Action with:\n\nTable: `Task`\n\nOnclick: `openInServiceOperationWorkspace()`\n\nWill open any task record in SOW\n" }, { "path": "Client-Side Components/UI Actions/Open in Service Operations Workspace/ui_action_script.js", "content": "function openInServiceOperationWorkspace() {\n var taskSysID = g_form.getUniqueValue();\n var taskTable = g_form.getTableName();\n \n // Construct the hardcoded Service Operation Workspace URL\n var workspaceURL = '/now/sow/record/' + taskTable + '/' + taskSysID;\n \n // Open in new window\n var w = getTopWindow();\n w.window.open(workspaceURL, '_blank');\n}\n" }, { "path": "Client-Side Components/UI Actions/Populate Due Date based on Priority/Readme.md", "content": "**Calculate the due date based on the Priority**\n\nScript Type: UI Action, Table: incident, Form button: True, Show update: True, Condition: (current.due_date == '' && current.priority != '5'), OnClick: functionName()\n\nScript Type: Script Include, Glide AJAX enabled: False\n\nSchedule- Name: Holidays, Time Zone: GMT\n\nSchedule Entry - Name: New Year's Day, Type: Exclude, Show as: Busy, When: 31-12-2024, To: 01-01-2025\nSchedule Entry - Name: Christmas Day, Type: Exclude, Show as: Busy, When: 24-12-2025, To: 25-12-2025\nSchedule Entry - Name: Thanksgiving Day, Type: Exclude, Show as: Busy, When: 26-11-2025, To: 27-11-2025\nSchedule Entry - Name: Diwali, Type: Exclude, Show as: Busy, When: 19-10-2025, To: 20-10-2025\n\n**Goal:** To Calculate Due-Date based on Priority with some conditions.\n\n**Walk through of code:** So in this use case the UI Action is been used and then Script Include for server calculate is used.So the main to calculate the due-date by the user trigger.\n\nUI Action- So this button will check the priority and check the due date field is empty or not if not then will fetch the value of \"Priority\" and \"Created date\" and pass the data to the Script Include for calculation once it gets the response will populate the value to the due_date field in the incident table and then update it.\n\nScript Include- The role of this is to get the \"Priority\" and \"Created date\" based on prioriy this will calculate the time and date by using th GlidDateTime API and the will do some additional changes based on each priorit which is mentioned below and then return the response back to the UI Action,\n\nSchedule & Schedule Entry- It is used for the P3 and P4 Priority which is mentioned below for the use case.To exclude the Holidays.\n\nThese are the use case which the above functionality works,\n\n**1-> P1** - add 4hrs to the Created date\n**2-> P2 **- add 4hrs to the Created date but if it's exceed the working hrs of of 5 PM the add to the next day or if the is before the working hours of 8 AM set 5 PM to the same Created date.\n**3-> P3 or P4** - Kind of low priority so add the due date to the next day but it should exclude the holidays and the weekend's and the populate the next business working day.\n**4-> P5 **- User manually will populate the due date based on the process.\n\nThe UI Action on the Incident Form\n\"Button\"\n\nUI Action which will call the Script Include\n\"UI\n\nScript Include\n\"SI\"\n\nSchedules and Schedule Entry\n\"Schedules\"\n\"Schedule\n\nOutput\n\"Priority\n\"Priority\n\"Priority\n" }, { "path": "Client-Side Components/UI Actions/Populate Due Date based on Priority/ScriptInclude.js", "content": "/* \r\n\r\nInput\r\n1. Created Date\r\n2. Priority\r\n\r\nOutput\r\n1. Due Date\r\n\r\nBased on Priority equivalent due dates\r\n\r\nP1 - add 4hrs to the Created date\r\nP2 - add 4hrs to the Created date but if it's exceed the working hrs of of 5 PM the add to the next day or if the is before the working hours of 8 AM set 5 PM to the same Created date.\r\nP3 or P4 - Kind of low priority so add the due date to the next day but it should exclude the holidays and the weekend's and the populate the next business working day.\r\n\r\n*/\r\n\r\n\r\n// This SI findDueDate() function will help to calculate the duration based on the each priority.\r\n\r\nvar CalculateDueDates = Class.create();\r\nCalculateDueDates.prototype = {\r\n initialize: function() {},\r\n\r\n findDueDate: function(priority, created) {\r\n var dueDateVal;\r\n\r\n\r\n\t\t// For the Priority 1 and adding 4 hours in reagrd less of 8-5 working hours and then holidays\r\n if (priority == 1) {\r\n var now = new GlideDateTime(created);\r\n now.addSeconds(60 * 60 * 4); // Add 4 hours\r\n dueDateVal = now;\r\n return dueDateVal;\r\n\r\n } \r\n\r\n\t\t// For the Priority 2 and adding the 4 hours if exceed the workin hours then add the next day before 5'o Clock\r\n\t\telse if (priority == 2) {\r\n var dueDate = new GlideDateTime(created);\r\n dueDate.addSeconds(60 * 60 * 4); // Add 4 hours\r\n dueDate = dueDate+'';\r\n var hours = Number((dueDate + '').slice(11, 13));\r\n \r\n if (hours >= 0 && hours < 12) {\r\n gs.addInfoMessage('if Inside 8-5/7');\r\n dueDateVal = dueDate.slice(0, 10) + \" 17:00:00\";\r\n return dueDateVal;\r\n\r\n } else if (hours >= 17 && hours <= 23) {\r\n var nextDate = new GlideDateTime(created);\r\n nextDate.addDaysUTC(1);\r\n var newDue = new GlideDateTime(nextDate.getDate().getValue() + \" 17:00:00\");\r\n dueDateVal = newDue;\r\n return dueDateVal;\r\n } else {\r\n dueDateVal = dueDate;\r\n return dueDateVal;\r\n }\r\n\r\n } \r\n\t\t\r\n\t\t// For the Priority 3 or 4 add the next day and then if the due date is holiday or weekend populate the next working day in a respective field\r\n\t\telse if (priority == 3 || priority == 4) {\r\n var schedule = new GlideSchedule();\r\n\t\t\t// cmn_schedule for the Holidays\r\n var scheduleId = 'bd6d74b2c3fc72104f7371edd40131b7';\r\n schedule.load(scheduleId);\r\n\r\n var nextDay = new GlideDateTime(created);\r\n nextDay.addDaysUTC(1);\r\n\r\n\r\n //Checking for weekends\r\n var dayOfWeek = nextDay.getDayOfWeekUTC();\r\n\r\n var isWeekend = (dayOfWeek == 6 || dayOfWeek == 7);\r\n\r\n\r\n // Loop until next working day (weekdays excluding holidays)\r\n while (schedule.isInSchedule(nextDay) || isWeekend) {\r\n nextDay.addDaysUTC(1);\r\n dayOfWeek = nextDay.getDayOfWeekUTC();\r\n isWeekend = (dayOfWeek == 6 || dayOfWeek == 7);\r\n }\r\n\r\n // Set to 12:00 PM on that valid day\r\n var validDate = new GlideDateTime(nextDay.getDate().getValue() + \" 17:00:00\");\r\n return validDate;\r\n }\r\n },\r\n\r\n type: 'CalculateDueDates'\r\n};" }, { "path": "Client-Side Components/UI Actions/Populate Due Date based on Priority/UI Action.js", "content": "/* \r\nTable - incident\r\nShow Update - True\r\nForm Button - True\r\nCondition - (current.due_date == '' && current.priority != '5')\r\n\r\nInput\r\n1. Created Date\r\n2. Priority\r\n\r\nValidation\r\nWill not appeare if the value is already there and the priority is 5\r\n\r\nOutput\r\n1. Due Date\r\n\r\n*/\r\n\r\n\r\n// The function duedate is used to pass the priority and then created display value to the script include where the calculate of Due date is done will get the response and the set the value to the due_date field of incident.\r\nfunction duedate() {\r\n\r\n var priority = current.getValue('priority');\r\n var created = current.getDisplayValue('sys_created_on');\r\n var si = new CalculateDueDates();\r\n var response = si.findDueDate(priority, created);\r\n var gdt = new GlideDateTime();\r\n gdt.setDisplayValue(response);\r\n current.setValue('due_date', gdt);\r\n current.update();\r\n action.setRedirectURL(current);\r\n\r\n}\r\nduedate();" }, { "path": "Client-Side Components/UI Actions/Preview context record during approval/README.md", "content": "While approving any request it was very hard until now to preview the record for which the approval was required. This UI action created on sysapproval_approver table will enable previewing the record before approval so that the approver can make an easy informed decision.\n" }, { "path": "Client-Side Components/UI Actions/Preview context record during approval/TestScriptInclude.js", "content": "var TestScriptInclude = Class.create();\nTestScriptInclude.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n\n\tgetDocumentClass: function(){\n\t\tvar sysId = this.getParameter(\"sysparm_sys_id\");\n\t\tvar gr = new GlideRecord(\"sysapproval_approver\");\n\t\tif(gr.get(sysId)){\n\t\t\treturn JSON.stringify({\n\t\t\t\t\"table\": gr.source_table.toString(),\n\t\t\t\t\"document\": gr.document_id.toString(),\n\t\t\t\t\"title\": gr.document_id.getDisplayValue()\n\t\t\t});\n\t\t}\n\t},\n\n type: 'TestScriptInclude'\n});" }, { "path": "Client-Side Components/UI Actions/Preview context record during approval/UI_Action.js", "content": "/*\nThis script should be placed in the UI action on the table sysapproval_approver.\nThis UI action should be marked as client callable script include.\nUse openContextRecord() function in the Onclick field.\n*/\n\nfunction openContextRecord() {\n var rec = g_form.getDisplayValue(\"document_id\");\n var gaSi = new GlideAjax(\"TestScriptInclude\");\n gaSi.addParam(\"sysparm_name\", \"getDocumentClass\");\n gaSi.addParam(\"sysparm_sys_id\", g_form.getUniqueValue());\n gaSi.getXMLAnswer(function(response) {\n var answer = JSON.parse(response);\n var gp = new GlideModalForm(answer.title, answer.table, function(){});\n gp.addParm('sys_id', answer.document);\n gp.render();\n });\n}" }, { "path": "Client-Side Components/UI Actions/Printer Friendly Version/README.md", "content": "## Overview\n\n\nThis code snippet UI Action will allow you to have a printer friendly version of whatever record you might are trying to print. \nThis UI action uses the GlideNavigation API which you can find here [GlideNavigation API](https://developer.servicenow.com/dev.do#!/reference/api/zurich/client/c_GlideNavigationV3API#r_GNV3-openPopup_S_S_S_B)\n" }, { "path": "Client-Side Components/UI Actions/Printer Friendly Version/printer_friendly_verison.js", "content": "printView()\n\nfunction printView() {\n\n var table = g_form.getTableName();\n var recordID = g_form.getUniqueValue();\n var view = {{Insert the view you want to print here}}; //You can pass in an empty string and it will still work\n var windowName = {{Insert the name you want your window to display}}; //You can pass in an empty string and it will still work\n var features = 'resizeable,scrollbar'; //You can pass in an empty string and it will still work\n var urlString = '/' + table + \".do?sys_id=\" + recordID + \"&sysparm_view=\" + view + \"&sysparm_media=print\";\n var noStack = true; //Flag that indicates whether to append sysparm_stack=no to the URL\n\n g_navigation.openPopup(urlString, windowName, features, noStack);\n\n}\n" }, { "path": "Client-Side Components/UI Actions/Publish a Retired Knowledge Article again/README.md", "content": "**UI Action**: \nPublish a Retired Knowledge Article again after it is already retired.\n\n**How it works:**\n1. The code finds existing articles in the Knowledge base that share the same Article ID but are not the current article and are 'retired'.\n2. It updates the workflow state of these found articles to 'outdated'.\n3. For the current article, it sets the workflow_state to 'pubblished', records the current date and updates the 'published' field with the date.\n4. It also removes the pre-existing 'retired' date from the 'retired' field.\n5. It redirects the user to the updated current record.\n" }, { "path": "Client-Side Components/UI Actions/Publish a Retired Knowledge Article again/publishretiredkb.js", "content": "var kbArticle = new GlideRecord('kb_knowledge');\nkbArticle.setWorkflow(false);\nkbArticle.addQuery('article_id', current.article_id);\nkbArticle.addQuery('sys_id', \"!=\", current.sys_id); //articles that are not the current one\nkbArticle.addQuery('workflow_state', 'retired');\nkbArticle.query();\nwhile (kbArticle.next()) {\n kbArticle.workflow_state = 'outdated'; //setting the articles as outdated\n kbArticle.update();\n}\ncurrent.workflow_state = 'published'; //publishing retired kb article again\ncurrent.published = new GlideDate();\ncurrent.retired = \"\"; //clearing retired field value\ncurrent.update();\naction.setRedirectURL(current);\n" }, { "path": "Client-Side Components/UI Actions/Select Random User From Group/README.md", "content": "# Random User Assignment\n\nThis function allows you to select a random user from a specified group. Use case could be on all task-like records that need to be worked on by someone and you want to select the person randomly.\n\n\n\n" }, { "path": "Client-Side Components/UI Actions/Select Random User From Group/script.js", "content": "/**\n * Get a random user from a specific user group\n *\n * @param {string} group - The sys_id of the group to select a user from\n * @returns {string|null} - The sys_id of a randomly selected user from the specified group or null if no user is found\n */\n\nfunction getRandomUserFromGroup(group) {\n\n var users = [];\n\n var grMember = new GlideRecord(\"sys_user_grmember\");\n grMember.addNotNullQuery(\"user\");\n grMember.addQuery(\"group\", group);\n grMember.query();\n\n while (grMember.next()) {\n users.push(grMember.getValue(\"user\"));\n }\n\n if (users.length > 0) {\n // Select a random user from the \"users\" array\n return users[Math.floor(Math.random() * users.length)];\n } else {\n // Return null if no user is found in the specified group\n return null;\n }\n}\n" }, { "path": "Client-Side Components/UI Actions/Send notification if the incident remains unassigned/README.md", "content": "This is a UI Action script that adds a button to the Incident form. When clicked, it will check if the incident has been unassigned for more than 5 days. \nIf this condition is met, the button will trigger a notification to the manager of the incident's assignment group, informing them that the incident is still unassigned.\n\nBelow are the conditions when UI action will be created:\nTable: Incident\nShow Insert: False\nShow Update: True\nForm Button: Checked (to add the button on the form)\nCondition: current.assigned_to.nil() && current.assignment_group\n\nThe code contains below vaidations:\n- The script checks if the incident has been unassigned for more than 5 days by comparing the current date with the sys_created_on date using gs.daysAgo().\n- It verifies that the incident has an assignment group. If it does not, it displays an error message.\n- Queries the sys_user_group table to get the assignment group’s manager. If a manager is found, it sets up a notification to send an email directly to the manager.\n- Provides feedback to the user if the notification was sent or if there were issues (like missing assignment group or manager).\n- Redirects the user back to the current incident form after the UI Action runs.\n" }, { "path": "Client-Side Components/UI Actions/Send notification if the incident remains unassigned/script.js", "content": "// Check if the incident has been unassigned for more than 5 days\nvar unassignedDuration = gs.daysAgo(current.sys_created_on);\nif (unassignedDuration < 5) {\n gs.addErrorMessage(\"The incident has been unassigned for less than 5 days.\");\n action.setRedirectURL(current);\n return;\n}\n\n// Check if the incident has an assignment group\nif (current.assignment_group.nil()) {\n gs.addErrorMessage(\"No assignment group is set for this incident.\");\n action.setRedirectURL(current);\n return;\n}\n\n// Get the assignment group's manager\nvar assignmentGroup = new GlideRecord('sys_user_group');\nif (assignmentGroup.get(current.assignment_group)) {\n var manager = assignmentGroup.getValue('manager');\n\n if (manager) {\n // Create a notification\n var notification = new GlideEmailOutbound();\n notification.setFrom('no-reply@xyz.com');\n notification.setSubject(\"Alert! Incident \" + current.number + \" is still unassigned\");\n notification.setBody(\"The incident \" + current.number + \" has been unassigned for more than 5 days. Please assign it promptly.\");\n notification.setTo(manager);\n\n // Send the email\n notification.send();\n\n gs.addInfoMessage(\"Notification sent to the assignment group's manager.\");\n } else {\n gs.addErrorMessage(\"The assignment group has no manager defined.\");\n }\n} else {\n gs.addErrorMessage(\"Could not find the assignment group.\");\n}\n\naction.setRedirectURL(current);\n" }, { "path": "Client-Side Components/UI Actions/Send notification to the assigned user/README.md", "content": "Please note - Users should endeavor to use Flow, Notifications, etc., but UI Action option is also available.\n-------------------------------------------------------------------------------------------------------------------------------------------\nA UI Action in ServiceNow is a script that defines an action or button within the platform's user interface. It enables users to perform specific operations on forms and lists, such as creating, updating, or deleting records, or executing custom scripts. UI Actions enhance the user experience by providing functional buttons, links, or context menus.\n\nIn this case, the UI Action contains a server-side script that creates a record in the sys_email table, including the email body, subject, and recipient details.\nWhen the button on the incident form is clicked, an email notification will be sent to the user to whom the incident is assigned.\n\n-> If the incident is not assigned to any user, a message will be shown, and no email will be sent.\n-> If the assigned user's email address is missing, the email will not be sent, and an appropriate message will be displayed.\n-> However, if the incident is assigned to a user with a valid email address, the UI Action will successfully send the email to the assigned user.\n" }, { "path": "Client-Side Components/UI Actions/Send notification to the assigned user/script.js", "content": "//Servver Side Script to send notification to the assigned to user\nvar assignedToEmail = current.getValue('assigned_to'); // Fetches the sys_id of the assigned_to field\nif (assignedToEmail) {\n var userGR = new GlideRecord('sys_user'); // Access the sys_user table\n var txt_email = \"\";\n if (userGR.get(assignedToEmail)) {\n txt_email = userGR.getValue('email'); // Retrieves the email field from the sys_user record\n }\n if (txt_email) {\n var gr_sys_email = new GlideRecord('sys_email');\n gr_sys_email.initialize();\n gr_sys_email.setValue('type', 'send-ready');\n gr_sys_email.setValue('subject', 'UI Action Notification from Incident ' + current.number);\n gr_sys_email.setValue('recipients', txt_email);\n gr_sys_email.setValue('body', 'As the incident ' + current.number + ' is assigned to you, this UI Action Notification has been sent. Please review the incident.');\n gr_sys_email.insert();\n }\n\telse\n\t{\n\t\t\tgs.addInfoMessage(\"The email address for the user \" + userGR.getValue('name') + \" is missing. As a result, the email could not be sent.\");\n\t}\n}\nelse\n{\n\tgs.addInfoMessage(\"The incident \" + current.number + \" has not been assigned to any user. Therefore, the email could not be sent.\");\n}\n" }, { "path": "Client-Side Components/UI Actions/Set Incident Priority Critical/README.md", "content": "Set Incident Priority Critical\n\nThis UI Action sets current incident record as priority as Critical.\n\nWhen clicked\nBelow Conformation message will be displayed to the user as below\n\"Are you sure you want to set priority as Critical?\"\n\nIf user selects cancel nothing will happen.\n\nIf user selects confirm then\na) It sets the Priority of the current Record as 1-Critical by setting Urgency and Impact as 1-High.\nb) It also sets 'assigned_to' field as 'logedin user'.\nc) It also upends the description as \"Priority is set to Critical by 'logedin User'\".\n\n** Please note that it changes field values only on the form that is client side. \nUnless you submit or update the record, field values will not be updated in the database table records.\n\nYou can use this as reference to set other field values as well.\n" }, { "path": "Client-Side Components/UI Actions/Set Incident Priority Critical/script.js", "content": "// Call this function from OnClick field of UI Action form\nfunction ClientSideScript() {\n var answer = confirm(\"Are you sure you want to set priority as Critical?\");\n if (answer == true) {\n g_form.setValue('assigned_to', g_user.userID);\n g_form.setValue('impact', 1);\n g_form.setValue('urgency', 1);\n g_form.setValue('description', g_form.getValue('description') + \"\\nPriority is set to Critical by \" + g_user.getFullName());\n }\n" }, { "path": "Client-Side Components/UI Actions/Show Today Emails Logs/README.md", "content": "# Show Today Emails Logs\n\nThe UI Action simplifies the debugging of ServiceNow notifications by redirecting you from the notification definition to the email log list view with the predefined filter.\n\nSetting:\n- Name: Show Today Emails Logs\n- Table: sysevent_email_action\n- Show insert: false\n- Show update: true\n- Client: true\n- Form link: true\n- Onclick: openEmailLogList()\n- Condition: new GlideRecord('sys_email_log').canRead()" }, { "path": "Client-Side Components/UI Actions/Show Today Emails Logs/script.js", "content": "function openEmailLogList() {\n\tvar query = '';\n\tquery += 'sys_created_onONToday@javascript:gs.beginningOfToday()@javascript:gs.endOfToday()';\n\tquery += '^notification=' + g_form.getUniqueValue();\n\tquery += '^ORDERBYDESCsys_created_on';\n\t\n\tvar url = new GlideURL('sys_email_log_list.do');\n\turl.addParam('sysparm_query' , query);\n\tg_navigation.open(url.getURL(), '_blank');\n}" }, { "path": "Client-Side Components/UI Actions/Smart Assign to available member/README.md", "content": "**Use-case:**\nThe primary goal of this UI Action is load-balancing.\nIt assigns tasks based on the fewest currently Active tasks assigned to a member in a group.\n\n**Example Scenario**:\nAn assignment group has 10 members. Instead of assigning a new task to the whole group or any random member, the user/agent clicks on\n\"Smart Assign\" to find the member with the fewest currently Active tasks in the same group and assign the task to them.\n\n**UI Action Name:**\nSmart Assign\n\n**Condition**: !current.assignment_group.nil() && current.assigned_to.nil()\n\n**How it works:**\n1. The code queries the Group members table to find every single user associated with the currently selected assignment group.\n If someone removes a previous assignement group and then clicks on Smart Assign button, they are shown an error message to choose an Assignment group.\n2. There is a loop on the task table. This loop uses GlideAggregate to count how many active records are assigned to a specific user.\n3. It tracks the user that has the lowest count of tasks assigned to them and assigns the current task to them.\n" }, { "path": "Client-Side Components/UI Actions/Smart Assign to available member/smartAssigntoAvailablemember.js", "content": "var assignedToId = '';\nvar minOpenTasks = 77777;\nvar targetGroup = current.assignment_group;\n\nif (!targetGroup) {\n gs.addErrorMessage('Please select an Assignment Group first.');\n action.setRedirectURL(current);\n}\n\n//Finding all active members in the target group\nvar member = new GlideRecord('sys_user_grmember');\nmember.addQuery('group', targetGroup);\nmember.query();\n\nwhile (member.next()) {\n var userId = member.user.toString();\n\n //CountIng the number of active tasks currently assigned to the member\n var taskCountGR = new GlideAggregate('task');\n taskCountGR.addQuery('assigned_to', userId);\n taskCountGR.addQuery('active', true);\n taskCountGR.addAggregate('COUNT');\n taskCountGR.query();\n\n var openTasks = 0;\n if (taskCountGR.next()) {\n openTasks = taskCountGR.getAggregate('COUNT');\n }\n\n //Checking if this member has fewer tasks than the current minimum\n if (openTasks < minOpenTasks) {\n minOpenTasks = openTasks;\n assignedToId = userId;\n }\n}\n\n//Assigning the current record to the chosen user\nif (assignedToId) {\n current.assigned_to = assignedToId;\n current.work_notes = 'Assigned via Smart Assign to the user with the fewest active tasks (' + minOpenTasks + ' open tasks).';\n current.update();\n gs.addInfoMessage('Incident assigned to ' + current.assigned_to.getDisplayValue() + '.');\n} else {\n gs.addErrorMessage('Could not find an active member in the group to assign the task.');\n}\n\naction.setRedirectURL(current);\n" }, { "path": "Client-Side Components/UI Actions/Test and Debug Scheduled Scripts/README.md", "content": "

Test and Debug Scheduled Scripts using the Script Debugger

\n\nThis UI Action will run the script in the current session, so that it can be run and debugged in the script debugger.\n\n

Steps to Add:

\n1. Create a new UI Action in Global scope.
\n2. Name = Test and Debug (Modify this as per your preference).
\n3. Table = \"Scheduled Script Execution [sysauto_script]\"
\n4. Form Button = selected
\n5. Add the given script.
\n6. New UI Action will be available on Scheduled Scripts in Studio.
\n7. Use break points in script to debug.\n\n

WARNING

\nThis will run the script. So use it wisely.\n" }, { "path": "Client-Side Components/UI Actions/Test and Debug Scheduled Scripts/script.js", "content": "try{\n\t\t\n\tvar evaluator = new GlideScopedEvaluator(); \n\tevaluator.evaluateScript(current, 'script');\n\taction.setRedirectURL(current);\n\t\n}\t\ncatch(e){\n\tgs.addInfoMessage(e);\n}\n" }, { "path": "Client-Side Components/UI Actions/Try Catalog item in Portal view/README.md", "content": " UI action code which will help developers to test the same catalog item in serviceportal view by Clicking on the action .\n OOB we have try it which will preview the catalog item in ITIl view but some time we may miss few configurations which needs to bes tested in service portal. \n While doping testng its take to test the each item in serviceportal uisng this UI action we can test in portal itself.\n Its always recommended way to test and experience end user view way while performing testing.\n \n Note : Please update the \"portal \" value as per your request.\n\n Open any catalog item --> \n Click on Try It Sp Ui action -->\n Catalog item redirect to sp view in seperate tab.\n\nCreate UI action :\n==================\nOpen System defination --> UI action --> Create new\n\nName : Try it in SP\n\nTable : Catalog Item [sc_cat_item]\n\nOrder : 100\n\nAction name : try_it_in_sp\n\nClient : true\n\nForm button : true\n\nOnclick : tryitinsp()\n\nCondition : current.active == true && current.canWrite()&&new CatalogItemTypeProcessor().canTryIt(current.getRecordClassName()) && !(current.getRecordClassName() == \"sc_cat_item_content\" && current.content_type == \"external\") \n\nScript : copy and paste the code from TryItInSp.js file\n" }, { "path": "Client-Side Components/UI Actions/Try Catalog item in Portal view/TryItInSP.js", "content": "\ntryitinsp();\nfunction tryitinsp() {\n var portal = \"sp\"; //the portal you want to use for testing\t\n\tvar page = g_form.getTableName();\n var gUrl = new GlideURL(portal); \n gUrl.addParam(\"id\", page); \n\tgUrl.addParam(\"sys_id\", g_form.getUniqueValue()); //add the sys_id of this Catalog Item to render\n\n //and then display the Catalog Item in a new tab/window\n g_navigation.open (gUrl.getURL(), \"_blank\");\n}\n" }, { "path": "Client-Side Components/UI Actions/UI Action to Mark Incident as Escalated/README.md", "content": "Description: This UI Action allows users to mark an incident as escalated, indicating that it requires immediate attention. \nBy changing the incident's state to \"Escalated,\" the action not only helps prioritize the incident but also notifies the relevant support group to take prompt action. \nThis functionality is essential in incident management, ensuring that critical issues are addressed without delay.\n\nKey Features:\nImmediate Priority Update: Changes the incident's state to \"Escalated\" to reflect its urgent status.\nNotification: Sends an alert to the relevant support team, ensuring they are aware of the escalation.\nUser-Friendly: Provides an easy way for users to escalate incidents directly from the incident form.\n" }, { "path": "Client-Side Components/UI Actions/UI Action to Mark Incident as Escalated/Script.js", "content": "// UI Action: Mark as Escalated\n// Table: incident\n// Condition: current.state != 7 // Not Closed\n// Client: false\n\n(function executeAction(current) {\n current.state = 3; // Set to Escalated (assuming 3 represents Escalated state)\n current.update(); // Update the record\n\n // Optionally notify the support group\n var notification = new GlideRecord('sysevent_email');\n notification.initialize();\n notification.recipients = 'support_group_email@example.com';\n notification.subject = 'Incident ' + current.number + ' has been escalated';\n notification.body = 'The incident has been marked as escalated. Please address it promptly.';\n notification.insert();\n\n gs.addInfoMessage('Incident ' + current.number + ' has been marked as escalated.');\n})(current);\n" }, { "path": "Client-Side Components/UI Actions/Variable Ownership/Readme.md", "content": "The Variable Ownerships UI Action is a lightweight admin utility designed to help manage request item (RITM) variables more effectively.\n\nWith just one click, it provides direct access to the variable values table, allowing administrators to quickly review, update, or remove sensitive data entered by mistake. This eliminates the need to navigate multiple related tables manually, saving time and reducing risk.\n\nKey Benefits:\n\n• Direct access to RITM variable values\n\n• Faster cleanup of sensitive information\n\n• Improves data hygiene and admin efficiency\n\n• Simple to implement and lightweight\n" }, { "path": "Client-Side Components/UI Actions/Variable Ownership/script.js", "content": "/*\nThis script should be placed in the UI action on the table sc_req_item form view.\nThis UI action should be marked as client.\nUse viewMtom() function in the Onclick field.\n*/\n\nfunction viewMtom() {\n\n var url = 'sc_item_option_mtom_list.do?sysparm_query=request_item=' + g_form.getUniqueValue();\n g_navigation.openPopup(url);\n\n}\n" }, { "path": "Client-Side Components/UI Actions/View in Portal Page/README.md", "content": "code-snippet used in UI Action SCript to view the current record in Service Portal Page using a redirect\n\nExample:\n//to view a KB article in the Service Portal:\n\nfunction goToPortal(){\n\tvar url = 'sp?id=kb_article_view&sys_kb_id=' + g_form.getUniqueValue();\n\tg_navigation.openPopup(url);\n\t//g_navigation.open(url);\n\treturn false;\n}\n" }, { "path": "Client-Side Components/UI Actions/View in Portal Page/View in Portal Page.js", "content": "function goToPortal(){\n\tvar url = '?=';\n\tg_navigation.openPopup(url);\n\treturn false;\n}\n" }, { "path": "Client-Side Components/UI Macros/Copy To Clipboard/README.md", "content": "# ServiceNow UI Macro: Copy Field to Clipboard\n\nThis ServiceNow UI Macro allows you to easily copy field values to your clipboard by clicking on the button next to the field. It supports both standard fields and reference fields.\n\n## Usage\n\n1. Install the UI Macro:\n - Navigate to **System UI** > **UI Macros**.\n - Create a new UI Macro.\n - Paste the XML code of the UI Macro into the script field.\n - Save the UI Macro.\n\n2. Add the UI Macro to a Form:\n - Navigate to the form where you want to add the copy functionality.\n - Right-Click on the field you want this UI macro to be attached to.\n - Add/Modify the following attribute 'ref_contributions='\n - (OPTIONAL) Use semicolon to separate UI macros in field attributes like this 'ref_contributions=;'.\n\n3. Copy Field Value:\n - When viewing a record with the UI Macro added, you'll see a \"Copy to Clipboard\" icon next to the field.\n - Click the \"Copy to Clipboard\" icon to copy the field value to Clipboard.\n\n## Supported Fields\n\n- **Standard Fields**: You can use this UI Macro to copy values from standard fields on the form.\n- **Reference Fields**: This UI Macro also supports copying sys_ids of reference fields.\n" }, { "path": "Client-Side Components/UI Macros/Copy To Clipboard/copy_field_to_clipboard.xml", "content": "\n\n\t\n\t\n\t\n\t\n\t\n\t\n\n" }, { "path": "Client-Side Components/UI Macros/FormBackground/form_background.xml", "content": "\n\n\t\n\n" }, { "path": "Client-Side Components/UI Macros/FormBackground/readme.md", "content": "# ServiceNow Form Background Macro\n\n> A lightweight UI Macro to style ServiceNow forms with a custom background and simple element theming (labels, buttons, sections). \n---\n\n## Features\n\n* Adds a full-cover background image to a form (supports cover, center positioning).\n* Makes table/form/section backgrounds transparent so the background shows through.\n* Easy to customize (image path, label styles, button styles, additional CSS selectors).\n\n## Requirements\n\n* ServiceNow instance with admin access.\n* An image to set as background\n \n> ⚠️ Note: This macro uses Jelly/CSS that may not work as expected in some Next Experience workspaces or future UI updates. Test in a non-production instance first.\n\n## Installation\n\n1. **Upload the background image**\n\n * Navigate to **System UI > Images** and upload your background image (e.g., `formbg.png`).\n\n2. **Create the UI Macro**\n\n * Go to **System UI > UI Macros** and create a new macro (e.g., `ui_form_background`).\n * Copy the example macro content below into the UI Macro.\n\n3. **Create a UI Formatter**\n\n * Go to **System UI > Formatters**. Create a new formatter for the target table (for example, `incident` table).\n * In the *Formatter* field, reference the macro name you created (e.g., `ui_form_background.xml`).\n\n4. **Add the Formatter to the Form Layout**\n\n * Open the form layout for the target table (Form Layout / Form Designer) and place the formatter region on the form.\n * Save and open a record to see the background applied.\n\n## Compatibility\n\n* Tested on ServiceNow classic forms (UI16). May require tweaks for Next Experience, Service Portal, or Workspace.\n* If your instance uses strict Content Security Policy (CSP) or image hosting constraints, host the image in a supported location or adapt the implementation.\n\n## Troubleshooting\n\n* If no background appears:\n\n * Confirm the image is uploaded and the filename matches.\n * Ensure the formatter is placed on the form layout and published.\n * Inspect (browser devtools) to confirm CSS selectors are applied.\n \n## Result\n\"image\"\n\n" }, { "path": "Client-Side Components/UI Macros/JSON Formatter and Viewer/README.md", "content": "This solution provides a significant User Experience (UX) enhancement for fields that store complex data in JSON format (e.g., integration payloads, configuration properties, or setup data). \n\nInstead of forcing users (developers, administrators) to read or edit raw, unformatted JSON in a plain text area, this macro adds a \"JSON Viewer\" button next to the field\n\nName\tjson_formatter_macro\t\nActive\ttrue\t\nType\tXML\n\nNavigate to **System UI > UI** Macros and create a new record named json_formatter_macro , Use XML Attached File as Script\n" }, { "path": "Client-Side Components/UI Macros/JSON Formatter and Viewer/json_formatter.xml", "content": "\n\n \n \n\n \n \n \n\n" }, { "path": "Client-Side Components/UI Macros/Purchase Order Approval Summarizer/README.md", "content": "With the [Procurement plugin](https://docs.servicenow.com/bundle/rome-it-asset-management/page/product/procurement/concept/c_Procurement.html) activated, Asset managers can track vendor purchase orders for hardware and software assets. This application does not have approvals built-in by default, but that is a common addition.\n\nWhen these approvers are also fulfillers, they will likely be approving from the platform rather than via the portal. The included XML is to be used in a UI Macro to show critical Purchase Order data elements so that the approver can approve directly from the approval record without clicking into the PO.\n\nIn order to use this script, create a new UI Macro named \"approval_summarizer_proc_po\" add the full script from the XML file into the XML field. The system will automatically know to now use this macro for Purchase Orders because of the naming convention.\n\nYou can also create summarizers for other tables in a similar fashion by creating UI Macros start with \"approval_summarizer_\" and ending with the database table name.\n\nBelow is an example of the Purchase Order details display on an approval recor. It is not the most beautiful, but follows the formatting from similar approval summarizers.\n\n![Purchase Order Approval](approval_summarizer_proc_po.png)\n" }, { "path": "Client-Side Components/UI Macros/Purchase Order Approval Summarizer/approval_summarizer_proc_po.xml", "content": "\n\n \n \n ${gs.getMessage('Summary of Purchase Order')}:\n \n \n \n \n \n \n \n \t\n \n \n \n \n \n \n \n\t\t\t\t \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n ${proc_po.number.sys_meta.label}:\n \n ${proc_po.number.getDisplayValue()}\n
\n \n ${proc_po.vendor.sys_meta.label}:\n \n ${proc_po.vendor.getDisplayValue()}\n
\n \n ${proc_po.ship_to.sys_meta.label}:\n \n ${proc_po.ship_to.getDisplayValue()}\n
\n \n ${proc_po.due_by.sys_meta.label}:\n \n ${proc_po.due_by.getDisplayValue()}\n
\n \n ${proc_po.requested_for.sys_meta.label}:\n \n ${proc_po.requested_for.getDisplayValue()}\n
\n \n ${proc_po.department.sys_meta.label}:\n \n ${proc_po.department.getDisplayValue()}\n
\n \n ${proc_po.short_description.sys_meta.label}:\n \n ${proc_po.short_description.getDisplayValue()}\n
\n \n ${proc_po.ship_rate.sys_meta.label}:\n \n \n
\n \n ${proc_po.total_cost.sys_meta.label}:\n \n \n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\t\t\t\t\t\n \n \n\t\t\t\t\t\t\n \n \n \n \n \n \n \n
\n ${proc_po_labels.number.sys_meta.label}\n \n ${proc_po_labels.model.cmdb_model_category.sys_meta.label}\n \n ${proc_po_labels.model.sys_meta.label}\n \n ${proc_po_labels.cost.sys_meta.label}\n \n ${proc_po_labels.ordered_quantity.sys_meta.label}\n \n ${proc_po_labels.total_cost.sys_meta.label}\n
\n \n \n \"${gs.getMessage('uppercase_view')}\"\n ${SP}${SP}${SP}\n \n ${proc_po_item.number}\n \n ${proc_po_item.model.cmdb_model_category.getDisplayValue()} ${proc_po_item.model.getDisplayValue()}\n \n ${proc_po_item.ordered_quantity}\n \n
\n \n \n\n" }, { "path": "Client-Side Components/UI Macros/Show Open Incident of Caller/Readme.md", "content": "Show Open Incident of caller\n\nScript Type: UI Macro\n\nGoal: In Form view caller can see what are the open incident of that particular caller.\n\nWalk through of code: So for this use case a new macro will be added to the caller field, when it is triggered it will open a new popup window where it will show the list of particular caller which are all open incident.So for this a new UImacro have been used in that a new list icon have been rendered from the db_image table and inside that a showopentckts() function this will get the current caller and then add the query to filter out the list of open incident and then open a popup to show the list of that particular caller which are all open(other than Closed and Cancelled).\n\nNote: To inherite the UI Macro in that particular field (Caller) we need to add the attribute in the Dictionary Entry = ref_contributions=caller_inc_lists [ref_contributions=\"name of the macro\"]\n\nUI Macro\n\"UIMacro\"\n\nDictonary Entry in Attribute section\n\"UIMacroDictionary\"\n\nUI Macro in Incident Form near the Caller Field\n\"From\n\nResult:\n\"UIMacro\n" }, { "path": "Client-Side Components/UI Macros/Show Open Incident of Caller/macro.js", "content": "\r\n\r\n\r\n\r\n\r\n\r\n\r\n" }, { "path": "Client-Side Components/UI Macros/Variable Copy Context Options/README.md", "content": "# Add \"Copy Variable Name\" to Context Menu\n\nAdds code to the element_context UI Macro, allowing for admins to be able to right click a variable name and choose \"Copy Variable Name\" to quickly get the column name to their clipboard\n\n## where to add\n\n1. In the sys_ui_macro (Macros) table, open the record `element_context`\n2. Replace the existing `` block with the block in element context.xml\n\n## full XML for element_context example\n\nThis code is from an out-of-box instance with the necessary code, you can replace the existing element_context xml with this:\n\n```xml\n\n\n \n\n```" }, { "path": "Client-Side Components/UI Macros/Variable Copy Context Options/element context.xml", "content": "\n // Custom \"Copy Field Name\"\n gcm.addLine();\n gcm.addHref(\"${JS:gs.getMessage('Copy Field Name')}\", \"copyToClipboard('${jvar_field_name}');\");\n gcm.addHref(\"${JS:gs.getMessage('Copy Field Value')}\", \"copyToClipboard(g_form.getValue('${jvar_field_name}'));\");\n gcm.addHref(\"${JS:gs.getMessage('Copy Field Display Value')}\", \"copyToClipboard(g_form.getDisplayBox('${jvar_field_name}').value);\");\n gcm.addLine();\n gcm.addHref(\"${JS:gs.getMessage('Show')}\" + \" - '\" + '${jvar_field_name}' + \"'\",\n \"showDictionary('\" + table + \"', '\" + id + \"');\");\n count = 1;\n" }, { "path": "Client-Side Components/UI Pages/Add Multiple Items to Order Guide/README.md", "content": "**Details**\n1. This code will add multiple items in an order guide in single click\n2. Order guide rule base creation will be automatic\n3. This code will also add variable set to selected catalog items automatically.\n\n**How to use**\n1. Go to \"sc_cat_item\" table and select the items to be added in list view.\n2. Look for \"Add to order guide\" in list actions.\n3. The list action will give you an option to select order guide and variable set to be added to catalog items\n\n**Components**\n1. UI Action\n2. UI Page\n3. Script Include\n\n\"image\"\n" }, { "path": "Client-Side Components/UI Pages/Add Multiple Items to Order Guide/Script Include.js", "content": "\nvar AddtoOG = Class.create();\nAddtoOG.prototype = Object.extendsObject(AbstractAjaxProcessor, {\n addToOrderGuide: function() {\n var msgArrNotAdded = []; // array to store not added catalog items.\n var msgArrAdded = []; // array to store added catalog items.\n var msg = '';\n var item = this.getParameter('sysparm_itemList').toString().split(',');\n var order_guide = this.getParameter('sysparm_og');\n var var_set = this.getParameter('sysparm_set');\n for (var i = 0; i < item.length; i++) {\n var itemName = new GlideRecord('sc_cat_item');\n itemName.get(item[i]); // get item name\n var itemBckName = itemName.name.toString().replace(/[^a-zA-Z0-9]/g, \"_\");\n // check if item is present in order guide\n var checkStatus = new GlideRecord('sc_cat_item_guide_items');\n checkStatus.addQuery('guide', order_guide);\n checkStatus.addQuery('item', item[i]);\n checkStatus.query();\n if (checkStatus.next()) {\n msgArrNotAdded.push(itemName.name);\n } else {\n // Add variable set to all catalog items selected\n var set = new GlideRecord('io_set_item');\n var orderVar = new GlideRecord('item_option_new');\n set.initialize();\n set.variable_set = var_set;\n set.sc_cat_item = item[i];\n set.order = '200'; // set order as per your requirement\n set.insert();\n\n // Add checkbox variable in order guide for each catalog item\n orderVar.initialize();\n orderVar.setValue('type', 7);\n orderVar.setValue('cat_item', order_guide);\n orderVar.setValue('question_text', itemName.name);\n orderVar.setValue('name', itemBckName);\n orderVar.setValue('order', 1200); // set order as per your requirement\n orderVar.insert();\n }\n\n // Add rule base to order guide\n var ruleBase = new GlideRecord('sc_cat_item_guide_items');\n ruleBase.initialize();\n ruleBase.setValue('item', item[i]);\n ruleBase.setValue('guide', order_guide);\n ruleBase.setValue('condition', 'IO:' + orderVar.sys_id + '=true^EQ');\n ruleBase.insert();\n msgArrAdded.push(itemName.name);\n }\n if (msgArrNotAdded.length > 0) {\n msg = \"Not added item are \" + msgArrNotAdded + ' Added Items are ' + msgArrAdded; // array of items which are not added\n } else\n msg = 'Added Items are ' + msgArrAdded; // array of added items\n return msg;\n },\n type: 'AddtoOG'\n});\n" }, { "path": "Client-Side Components/UI Pages/Add Multiple Items to Order Guide/UI Action.js", "content": "\n/*\nonClick function name : addToOrderGuide\nThe UI action will prompt UI page to select order guide and variable set. \n*/\nfunction addToOrderGuide() {\n var items = g_list.getChecked();\n var dialog = new GlideDialogWindow(\"add_to_og\"); // UI page name\n dialog.setTitle(\"Select Order Guide and Variable Set\"); // Prompt title.\n dialog.setPreference(\"items\", items);\n dialog.render();\n}\n" }, { "path": "Client-Side Components/UI Pages/Add Multiple Items to Order Guide/UI Page.js", "content": "\n\n \n
\n \n \n \n \n
\n \n
\n \n \n \n \n
\n \n \n\n\n//Client Script of UI page\n\nfunction addItems(catItems) {\n var og = document.getElementById(\"order_guide\").value;\n var varSet = document.getElementById(\"var_set\").value;\n\n var orderG = new GlideAjax('AddtoOG');\n orderG.addParam('sysparm_name', 'addToOrderGuide');\n orderG.addParam('sysparm_itemList', catItems);\n orderG.addParam('sysparm_og', og);\n orderG.addParam('sysparm_set', varSet);\n orderG.getXML(addOrderGuide);\n}\n\nfunction addOrderGuide(response) {\n var answer = response.responseXML.documentElement.getAttribute(\"answer\");\n alert(answer);\n GlideDialogWindow.get().destroy();\n}\n" }, { "path": "Client-Side Components/UI Pages/BulkUpdate Worknotes/Readme.md", "content": "\r\nBulk Update Worknotes\r\n\r\nScript Type: UI Action, Table: incident, List banner button: True, Client: True, Show update: True, OnClick: functionName()\r\n\r\nScript Type: UI Page Category: General\r\n\r\nGoal: To update the worknotes for multiple tickets in a single view \r\n\r\nWalk through of code: So in the incident List view we do have a list banner button called \"Bulk Updates\" so that was the UI Action configured with the script which has used the GlideModel API to call the UI page which is responsible to get the multiple tickets and worknotes value and then update to the respective ticket and store in the worknotes in journal entry. For this the HTML part in the UI page is configured with two fields, one for the multiple list of tickets, and then the worknotes field, and one submit button to save that into the table.\r\nAnd the Processing Script is used to get each ticket number and then check the valid tickets and query the respective table, and then update the worknotes of each respective ticket if it is valid. Otherwise, it won't update.\r\n" }, { "path": "Client-Side Components/UI Pages/BulkUpdate Worknotes/UI Action.js", "content": "// Table: incident, List banner button: True, Client: True, Show update: True, OnClick: bulkupdate()\r\n\r\nfunction bulkupdate() {\r\n var modalT = new GlideModal(\"BulkUpdate\", false, 1200);\r\n modalT.setTitle(\"Bulk Update Worknotes\");\r\n modalT.render();\r\n}" }, { "path": "Client-Side Components/UI Pages/BulkUpdate Worknotes/UI Page_ClientScript.js", "content": "function bulkupdate() {\r\n document.getElementById(\"spinner-btn\").style.display = \"block\";\r\n document.getElementById(\"submit-btn\").style.display = \"none\";\r\n\r\n}" }, { "path": "Client-Side Components/UI Pages/BulkUpdate Worknotes/UI Page_HTML.html", "content": "\r\n\r\n \r\n \r\n\r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n\r\n \r\n\r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n
\r\n\r\n
\r\n
\r\n Error - An error has occurred when trying to update Work Notes.\r\n
\r\n
\r\n Warning - Invalid list of Incident Tickets or Work Note field. Please try again.\r\n
\r\n
\r\n\r\n
\r\n\r\n \r\n
\r\n\r\n \r\n
\r\n \r\n \r\n
\r\n
\r\n \r\n \n \n
\n\n" }, { "path": "Client-Side Components/UI Pages/Edit Last WorkNotes/uipage_clientcode.js", "content": "fetchLastComment();\n\nfunction closeDialog() {\n GlideDialogWindow.get().destroy();\n return false;\n}\n\nfunction fetchLastComment() {\n var dialogWindow = GlideDialogWindow.get();\n var incidentSysId = dialogWindow.getPreference('incid');\n var glideAjax = new GlideAjax('UpdateINCworkNotes');\n glideAjax.addParam('sysparm_name', 'getIncLastWorknotes');\n glideAjax.addParam('sysparm_id', incidentSysId);\n glideAjax.getXMLAnswer(setCommentFieldValue);\n}\n\nfunction setCommentFieldValue(answer) {\n var commentField = document.getElementById('commenttext');\n if (commentField) {\n commentField.value = answer || '';\n }\n}\n\nfunction submitComment() {\n var dialogWindow = GlideDialogWindow.get();\n var incidentSysId = dialogWindow.getPreference('incid');\n var newCommentText = document.getElementById('commenttext').value;\n\n var glideAjax = new GlideAjax('UpdateINCworkNotes');\n glideAjax.addParam('sysparm_name', 'updateCommentsLatest');\n glideAjax.addParam('sysparm_id', incidentSysId);\n glideAjax.addParam('sysparm_newcomment', newCommentText);\n\n glideAjax.getXMLAnswer(handleSuccessfulSubmit);\n closeDialog();\n}\n\nfunction handleSuccessfulSubmit(answer) {\n window.location.reload();\n}\n" }, { "path": "Client-Side Components/UI Pages/Export UI pages to word docx/Export to word.js", "content": "********** HTML CODE ************\n\n \n \n
\n

Heading

\n

Heading 1

\n

Heading 2

\n \n
\n \n \n********* End of HTML *************\n\n********* Client Script ************\n function exportHTML() {\n var header = \"\" +\n \"Export HTML to Word Document with JavaScript\";\n var footer = \"\";\n var sourceHTML = header + document.getElementById(\"source-html\").innerHTML + footer;\n\n var source = 'data:application/vnd.ms-word;charset=utf-8,' + encodeURIComponent(sourceHTML);\n var fileDownload = document.createElement(\"a\");\n document.body.appendChild(fileDownload);\n fileDownload.href = source;\n fileDownload.download = 'document.doc';\n fileDownload.click();\n document.body.removeChild(fileDownload);\n }\n ********* End of Client Script ************\n" }, { "path": "Client-Side Components/UI Pages/Export UI pages to word docx/README.md", "content": "This code allows you to export the contents of a UI page into a word document\n\nSteps\n1. Create a body and contents in the html part of the UI Page\n2. Create a button and name it as 'Export to word' and call the function.\n3. Now, paste the js code in the client script section of the ui page.\n4. Click on try it and the contents of the html body will be exported as a word upon clicking on the 'export to word' button.\n" }, { "path": "Client-Side Components/UI Pages/Fetch Table(Incident) fields in UI Page/Fetch incident fields.js", "content": "********** UI Action Code **********\n //Client callable : true\n //OnClick : fetchHTML();\n //table : incident\n \n function fetchHTML() {\n\tvar dialog = new GlideDialogWindow(\"my_page\"); \n dialog.setTitle('Fetch table fields');\n\tdialog.setSize('600', '600');\n dialog.setPreference(\"sysparm_sys_id\", g_form.getUniqueValue());\n dialog.render();\n}\n\n********** End of UI Action code **********\n \n********** UI Page code **********\n// Name of ui page : my_page\n \n\n\n\n\n\nvar gr_inc = new GlideRecord('incident');\ngr_inc.addQuery('sys_id', jelly.jvar_sysId);\ngr_inc.query();\ngr_inc;\n\n
\n

Fetch Incident fields in UI Page

\t\n \n
\n

\t\n\t\t\t\t \n\t\t\t\t

\n\t

Caller

\n

The Caller is : ${gr_inc.caller_id.getDisplayValue()}

\n\t
\n\t\t\t\t\t
\n\t\t\t\t\t\t

Incident Short Description

\n\t\t\t\t

${gr_inc.short_description()}

\n\t\t\t\t\t
\n\t\t\t\t\t
\t\n\t\t\t\t\t\t

Incident Description

\n\t\t\t\t

${gr_inc.description()}

\n\t\t\t\t
\n\t\t\t\t \n\t\t\t\t \n \n\t\t\t

\n
\n \t\n
\n\n\n********** End of UI Page code **********\n" }, { "path": "Client-Side Components/UI Pages/Fetch Table(Incident) fields in UI Page/README.md", "content": "Fetch Incident fields(or any table fields) in a UI page via UI Action trigger\n\nSteps\n1) Create a UI action and create a function.\n2) Add the UI action script provided in the Script section.\n3) This code helps to render a pop up window of 600x600 dimentions for the UI page and passes the current sys id to UI page.\n4) Make sure to add the code in the UI Page : \n5) Create a UI Page and add the HTML Code provided.\n6) Trigger the UI Action from the Incident form and it should render the ui page with the incident fields data.\n7) Add additional static or dynamic data as per the requirement.\n" }, { "path": "Client-Side Components/UI Pages/Populate Glide List field/README.md", "content": "//The UI page includes a label prompting users to select an \"SN Company,\" and utilizes the lightweight_glide_list2 macro to generate a dropdown list populated with active companies from the core_company table. The form also features \"OK\" and \"Cancel\" buttons in the modal footer, which trigger the onSubmit() and onCancel() functions, respectively, when clicked. This setup facilitates user interaction by enabling the selection of a company, which can be crucial for various processes within the ServiceNow platform.\n\n\n

\n//This code creates a label for the company selection field, indicating that users should select a company from the list.\nCompany Selection Control:\n\n\n\n//This line invokes a macro called lightweight_glide_list2, which creates a dropdown or list control for selecting a company. The parameters specify that it should reference the core_company table, only show active companies (where u_active is true), and allow the user to write (make changes).\n\n
\n \n \n \n
\n//This section creates a footer for the modal dialog containing \"OK\" and \"Cancel\" buttons. The g:dialog_buttons_ok_cancel macro generates these buttons, calling the onSubmit() function to handle submission when the OK button is clicked and the onCancel() function to handle cancellation when the Cancel button is clicked.\n\n\n\n\nvar splitted = ['0c441abbc6112275000025157c651c89', '820351a1c0a8018b67c73d51c074097c'];\nvar displayText = ['3Com', 'Acer'];\n//Two arrays are defined: splitted contains unique identifiers (likely Sys IDs), and displayText contains the corresponding display names for each identifier. For example, the first identifier corresponds to \"3Com\" and the second to \"Acer.\"\nLoop Through the Arrays:\n\n\nfor (var z = 0; z < splitted.length; z++) {\n//A for loop is initiated to iterate through the elements of the splitted array. The loop runs as long as z is less than the length of the splitted array, ensuring that each item in both arrays is processed.\nGet the Dropdown Element:\n\nvar selEl = document.getElementById('select_0comCollector');\n//This line retrieves the HTML select element with the ID select_0comCollector. This element is where the new options will be added.\nCreate a New Option Element:\n\n\nvar optEl = document.createElement('option');\n//A new