--- name: ui-actions-policies-7c8da486571b description: Build ServiceNow UI Actions (form/list buttons, context menus) and UI Policies (conditional mandatory/visible/read-only) with server/client scripts and GlideAjax. Use snow_analyze_form before modifying forms. license: Apache-2.0 compatibility: Designed for Serac and ServiceNow development metadata: author: serac version: "1.0.0" category: servicenow tools: - snow_create_ui_action - snow_create_ui_policy - snow_artifact_manage - snow_analyze_form --- # UI Actions & UI Policies for ServiceNow UI Actions add buttons, links, and context menus. UI Policies control form field behavior dynamically. Before modifying an existing form, reach for `snow_analyze_form` — it returns every active UI policy, client script, data policy, record + field ACL, and UI action on the target table in one call. Use it to answer "why is this form behaving like this?" before guessing. ## UI Actions ### UI Action Types | Type | Location | Example | | --------------------- | ------------------ | ------------------ | | **Form Button** | Form header | "Resolve Incident" | | **Form Context Menu** | Right-click menu | "Copy Record" | | **Form Link** | Related links | "View CI" | | **List Button** | List header | "Export Selected" | | **List Context Menu** | Right-click on row | "Assign to Me" | | **List Choice** | Actions dropdown | "Update State" | | **List Link** | List header links | "New Record" | ### Form Button UI Action (ES5) ```javascript // Table: sys_ui_action // Name: Resolve Incident // Table: incident // Form button: true // Active: true // Condition: current.active == true && current.state != 6 // Script (Server-side - ES5 ONLY): ;(function executeAction() { // Validate before resolving if (!current.resolution_code) { gs.addErrorMessage("Please select a resolution code") action.setRedirectURL(current) return } if (!current.close_notes) { gs.addErrorMessage("Please provide resolution notes") action.setRedirectURL(current) return } // Set resolved state current.state = 6 // Resolved current.resolved_at = new GlideDateTime() current.resolved_by = gs.getUserID() current.update() gs.addInfoMessage("Incident " + current.number + " has been resolved") action.setRedirectURL(current) })() ``` ### Client-Side UI Action (ES5) ```javascript // Table: sys_ui_action // Name: Quick Assign // Client: true // Onclick: quickAssign() // Client script (ES5 ONLY): function quickAssign() { // Get current user var userId = g_user.userID var userName = g_user.getFullName() // Confirm action var confirmed = confirm("Assign this incident to yourself (" + userName + ")?") if (!confirmed) { return false } // Set the field value g_form.setValue("assigned_to", userId) g_form.setValue("assignment_group", g_user.getGroupID()) // Save the form gsftSubmit(null, g_form.getFormElement(), "save") return false } ``` ### List UI Action (ES5) ```javascript // Table: sys_ui_action // Name: Close Selected Incidents // Table: incident // List button: true // List choice: true // Condition: gs.hasRole('itil') // Script (Server-side - ES5 ONLY): ;(function executeAction() { // Get selected records var selectedRecords = RP.getParameterValue("sysparm_checked_items") if (!selectedRecords) { gs.addErrorMessage("No records selected") return } var sysIds = selectedRecords.split(",") var closedCount = 0 for (var i = 0; i < sysIds.length; i++) { var gr = new GlideRecord("incident") if (gr.get(sysIds[i])) { if (gr.state != 7) { // Not already closed gr.state = 7 // Closed gr.closed_at = new GlideDateTime() gr.closed_by = gs.getUserID() gr.update() closedCount++ } } } gs.addInfoMessage("Closed " + closedCount + " incident(s)") })() ``` ### UI Action with GlideAjax (ES5) ```javascript // Client-side UI Action calling server // Client: true // Onclick: checkAndEscalate() function checkAndEscalate() { var incidentId = g_form.getUniqueValue() // Check if escalation is allowed var ga = new GlideAjax("IncidentAjax") ga.addParam("sysparm_name", "canEscalate") ga.addParam("sysparm_incident_id", incidentId) ga.getXMLAnswer(function (answer) { var result = JSON.parse(answer) if (result.canEscalate) { // Proceed with escalation g_form.setValue("priority", 1) g_form.setValue("escalation", 1) gsftSubmit(null, g_form.getFormElement(), "escalate_incident") } else { alert("Cannot escalate: " + result.reason) } }) return false } ``` ## UI Policies ### UI Policy Structure | Field | Purpose | | --------------------- | ------------------------- | | **Short description** | Policy name | | **Table** | Target table | | **Conditions** | When to apply | | **Reverse if false** | Undo when condition false | | **On load** | Run when form loads | | **UI Policy Actions** | Field behaviors | ### Basic UI Policy (No Script) ```yaml # UI Policy: Make Resolution Required on Resolve Table: incident Short description: Require resolution fields when resolving Conditions: state = 6 (Resolved) On load: true Reverse if false: true # UI Policy Actions: - Field: resolution_code Mandatory: true Visible: true - Field: close_notes Mandatory: true Visible: true - Field: resolved_by Read only: true ``` ### UI Policy with Script (ES5) ```javascript // UI Policy Script - Execute if true // Runs when condition becomes true (ES5 ONLY!) function onCondition() { // Show/hide fields based on category var category = g_form.getValue("category") if (category === "hardware") { g_form.setDisplay("cmdb_ci", true) g_form.setMandatory("cmdb_ci", true) g_form.setDisplay("software", false) } else if (category === "software") { g_form.setDisplay("software", true) g_form.setMandatory("software", true) g_form.setDisplay("cmdb_ci", false) } } ``` ### Complex UI Policy Script (ES5) ```javascript // UI Policy: VIP Caller Handling // Condition: None (script handles logic) // On load: true // Run scripts: true // Script - Execute if true (ES5 ONLY!): function onCondition() { var callerId = g_form.getValue("caller_id") if (!callerId) { return } // Check if VIP via GlideAjax var ga = new GlideAjax("UserAjax") ga.addParam("sysparm_name", "isVIP") ga.addParam("sysparm_user_id", callerId) ga.getXMLAnswer(function (answer) { var isVIP = answer === "true" if (isVIP) { // Highlight form g_form.flash("caller_id", "#FFD700", 0) g_form.showFieldMsg("caller_id", "VIP Customer", "info") // Set default priority if (!g_form.getValue("priority")) { g_form.setValue("priority", 2) } // Make assignment group mandatory g_form.setMandatory("assignment_group", true) } }) } ``` ### Dynamic Field Visibility (ES5) ```javascript // UI Policy: Show fields based on incident type // Table: incident // On load: true function onCondition() { var incidentType = g_form.getValue("u_incident_type") // Reset all conditional fields var conditionalFields = ["u_network_details", "u_hardware_model", "u_software_name"] for (var i = 0; i < conditionalFields.length; i++) { g_form.setDisplay(conditionalFields[i], false) g_form.setMandatory(conditionalFields[i], false) } // Show relevant fields switch (incidentType) { case "network": g_form.setDisplay("u_network_details", true) g_form.setMandatory("u_network_details", true) break case "hardware": g_form.setDisplay("u_hardware_model", true) g_form.setMandatory("u_hardware_model", true) break case "software": g_form.setDisplay("u_software_name", true) g_form.setMandatory("u_software_name", true) break } } ``` ## Creating via Scripts (ES5) ### Create UI Action Programmatically ```javascript // Create UI Action via background script (ES5 ONLY!) var uiAction = new GlideRecord("sys_ui_action") uiAction.initialize() uiAction.setValue("name", "Escalate to Manager") uiAction.setValue("table", "incident") uiAction.setValue("active", true) uiAction.setValue("form_button", true) uiAction.setValue("form_style", "btn-warning") uiAction.setValue("hint", "Escalate this incident to the caller's manager") uiAction.setValue("condition", "current.active == true && current.priority > 2") uiAction.setValue( "script", "(function executeAction() {\n" + " current.priority = 2;\n" + " current.escalation = 1;\n" + ' current.work_notes = "Escalated by " + gs.getUserDisplayName();\n' + " current.update();\n" + ' gs.addInfoMessage("Incident escalated");\n' + " action.setRedirectURL(current);\n" + "})();", ) uiAction.insert() ``` ### Create UI Policy Programmatically ```javascript // Create UI Policy (ES5 ONLY!) var policy = new GlideRecord("sys_ui_policy") policy.initialize() policy.setValue("short_description", "Require Close Notes on Close") policy.setValue("table", "incident") policy.setValue("active", true) policy.setValue("on_load", true) policy.setValue("reverse_if_false", true) policy.setValue("conditions", "state=7") var policySysId = policy.insert() // Add UI Policy Action var action = new GlideRecord("sys_ui_policy_action") action.initialize() action.setValue("ui_policy", policySysId) action.setValue("field", "close_notes") action.setValue("mandatory", true) action.setValue("visible", true) action.setValue("disabled", false) action.insert() ``` ## MCP Tool Integration ### Available Tools | Tool | Purpose | | ------------------------------------- | ------------------------- | | `snow_create_ui_action` | Create UI Action | | `snow_create_ui_policy` | Create UI Policy | | `snow_artifact_manage` (action=find) | Find existing UI elements | | `snow_artifact_manage` (action=update) | Modify UI elements | ### Example Workflow ```javascript // 1. Create UI Action await snow_create_ui_action({ name: "Approve Change", table: "change_request", form_button: true, condition: 'current.state == "assess"', script: "/* approval script */", }) // 2. Create UI Policy await snow_create_ui_policy({ short_description: "Require justification for high priority", table: "change_request", conditions: "priority=1", actions: [{ field: "justification", mandatory: true }], }) ``` ## Best Practices 1. **Descriptive Names** - Clear purpose in name 2. **Conditions First** - Use conditions before scripts 3. **Minimal Scripts** - Keep scripts short 4. **Reverse If False** - Clean up field states 5. **Test Thoroughly** - Multiple scenarios 6. **Role Security** - Add role conditions 7. **ES5 Only** - No modern JavaScript syntax 8. **Form vs List** - Choose appropriate action type --- Source attribution: serac Original project: https://github.com/groeimetai/snow-flow/blob/af3ad2b3c01305526a44b2647415ba794237462c/packages/skills/ui-actions-policies/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2026 Serac Labs Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: serac Original project: https://github.com/groeimetai/snow-flow/blob/af3ad2b3c01305526a44b2647415ba794237462c/packages/skills/ui-actions-policies/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering, Product Management, Sales, Customer Support Roles: Backend Developer, Product Manager, Technical Product Manager, Customer Success Manager, Support Agent Specialties: Frontend, Design, Testing, Mobile, Backend Tools: Snow_Create_Ui_Action, Snow_Create_Ui_Policy, Snow_Find_Artifact, Snow_Edit_Artifact Country applicability: Country not specified Classification basis: Source category, role and specialization labels Instruction SHA-256: e2d5d0d41d430bda52b28f8c0fda07d2825feb4e1b6a666043d40c4aff26e41f