snow-flow 2.10.0 → 3.0.0

package/src/schemas/flow.schema.json

@@ -0,0 +1,79 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "ServiceNow Flow Configuration Schema",
+  "description": "Schema for validating ServiceNow Flow Designer flow configurations",
+  "type": "object",
+  "required": ["name", "description", "trigger_type"],
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100,
+      "description": "Flow name"
+    },
+    "description": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500,
+      "description": "Flow description"
+    },
+    "trigger_type": {
+      "type": "string",
+      "enum": ["record_created", "record_updated", "scheduled", "manual"],
+      "description": "Flow trigger type"
+    },
+    "table": {
+      "type": "string",
+      "description": "Target table for record-based triggers"
+    },
+    "condition": {
+      "type": "string",
+      "description": "Trigger condition (encoded query)"
+    },
+    "category": {
+      "type": "string",
+      "description": "Flow category (e.g., approval, automation)"
+    },
+    "active": {
+      "type": "boolean",
+      "default": true,
+      "description": "Whether the flow is active"
+    },
+    "flow_definition": {
+      "type": "string",
+      "description": "Flow Designer definition JSON"
+    },
+    "flow_type": {
+      "type": "string",
+      "enum": ["flow", "subflow", "action"],
+      "default": "flow",
+      "description": "Type of flow to create"
+    },
+    "validate_before_deploy": {
+      "type": "boolean",
+      "default": true,
+      "description": "Validate flow definition before deployment"
+    },
+    "sys_scope": {
+      "type": "string",
+      "description": "Application scope (global or application sys_id)"
+    },
+    "run_as": {
+      "type": "string",
+      "enum": ["system", "user"],
+      "default": "system",
+      "description": "Context for flow execution"
+    }
+  },
+  "additionalProperties": false,
+  "if": {
+    "properties": {
+      "trigger_type": {
+        "enum": ["record_created", "record_updated"]
+      }
+    }
+  },
+  "then": {
+    "required": ["table"]
+  }
+}

package/src/schemas/widget.schema.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "ServiceNow Widget Configuration Schema",
+  "description": "Schema for validating ServiceNow Service Portal widget configurations",
+  "type": "object",
+  "required": ["name", "title", "template"],
+  "properties": {
+    "name": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9_]*$",
+      "description": "Internal widget name (lowercase, underscores allowed)"
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100,
+      "description": "Display title for the widget"
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 500,
+      "description": "Widget description"
+    },
+    "category": {
+      "type": "string",
+      "default": "custom",
+      "description": "Widget category for organization"
+    },
+    "template": {
+      "type": "string",
+      "minLength": 1,
+      "description": "HTML template for the widget"
+    },
+    "css": {
+      "type": "string",
+      "description": "CSS styles for the widget"
+    },
+    "client_script": {
+      "type": "string",
+      "description": "Client-side JavaScript controller"
+    },
+    "server_script": {
+      "type": "string",
+      "description": "Server-side script for data processing"
+    },
+    "option_schema": {
+      "type": "string",
+      "default": "[]",
+      "description": "JSON schema for widget options"
+    },
+    "demo_data": {
+      "type": "string",
+      "default": "{}",
+      "description": "Demo data for widget preview"
+    },
+    "has_preview": {
+      "type": "boolean",
+      "default": true,
+      "description": "Whether widget supports preview mode"
+    },
+    "sys_scope": {
+      "type": "string",
+      "description": "Application scope (global or application sys_id)"
+    },
+    "active": {
+      "type": "boolean",
+      "default": true,
+      "description": "Whether the widget is active"
+    }
+  },
+  "additionalProperties": false
+}

package/src/templates/base/application.template.json

@@ -0,0 +1,45 @@
+{
+  "type": "application",
+  "name": "{{APPLICATION_NAME}}",
+  "description": "{{APPLICATION_DESCRIPTION}}",
+  "config": {
+    "name": "{{APPLICATION_NAME}}",
+    "scope": "{{SCOPE|x_custom}}",
+    "version": "{{VERSION|1.0.0}}",
+    "short_description": "{{SHORT_DESCRIPTION}}",
+    "description": "{{APPLICATION_DESCRIPTION}}",
+    "vendor": "{{VENDOR|Custom}}",
+    "vendor_prefix": "{{VENDOR_PREFIX|x}}",
+    "runtime_access_tracking": "{{RUNTIME_ACCESS_TRACKING|permissive}}",
+    "enforce_license": {{ENFORCE_LICENSE|none}},
+    "active": true,
+    "licensable": {{LICENSABLE|false}},
+    "installable": {{INSTALLABLE|true}},
+    "accessible_from": "{{ACCESSIBLE_FROM|All application scopes}}",
+    "application_access": "{{APPLICATION_ACCESS|Can read}}",
+    "tables": [],
+    "menu": {
+      "label": "{{MENU_LABEL|APPLICATION_NAME}}",
+      "hint": "{{MENU_HINT|Access APPLICATION_NAME}}",
+      "order": {{MENU_ORDER|100}}
+    }
+  },
+  "variables": {
+    "APPLICATION_NAME": "My Custom Application",
+    "APPLICATION_DESCRIPTION": "A custom ServiceNow application",
+    "SCOPE": "x_custom",
+    "VERSION": "1.0.0",
+    "SHORT_DESCRIPTION": "Custom application for ServiceNow",
+    "VENDOR": "Custom",
+    "VENDOR_PREFIX": "x",
+    "RUNTIME_ACCESS_TRACKING": "permissive",
+    "ENFORCE_LICENSE": "none",
+    "LICENSABLE": false,
+    "INSTALLABLE": true,
+    "ACCESSIBLE_FROM": "All application scopes",
+    "APPLICATION_ACCESS": "Can read",
+    "MENU_LABEL": "My Custom Application",
+    "MENU_HINT": "Access My Custom Application",
+    "MENU_ORDER": 100
+  }
+}

package/src/templates/base/business_rule.template.json

@@ -0,0 +1,33 @@
+{
+  "type": "business_rule",
+  "name": "{{BUSINESS_RULE_NAME}}",
+  "description": "{{BUSINESS_RULE_DESCRIPTION}}",
+  "config": {
+    "name": "{{BUSINESS_RULE_NAME}}",
+    "table": "{{TABLE|incident}}",
+    "when": "{{WHEN|before}}",
+    "condition": "{{CONDITION|}}",
+    "script": "// Business Rule: {{BUSINESS_RULE_NAME}}\n(function executeRule(current, previous /*null when async*/) {\n    // {{BUSINESS_RULE_DESCRIPTION}}\n    \n    {{BUSINESS_LOGIC|// Add your business logic here}}\n    \n})(current, previous);",
+    "active": true,
+    "order": {{ORDER|100}},
+    "advanced": true,
+    "collection": "{{TABLE|incident}}",
+    "action_insert": {{ACTION_INSERT|true}},
+    "action_update": {{ACTION_UPDATE|true}},
+    "action_delete": {{ACTION_DELETE|false}},
+    "action_query": {{ACTION_QUERY|false}}
+  },
+  "variables": {
+    "BUSINESS_RULE_NAME": "My Business Rule",
+    "BUSINESS_RULE_DESCRIPTION": "A custom business rule for ServiceNow",
+    "TABLE": "incident",
+    "WHEN": "before",
+    "CONDITION": "",
+    "ORDER": 100,
+    "ACTION_INSERT": true,
+    "ACTION_UPDATE": true,
+    "ACTION_DELETE": false,
+    "ACTION_QUERY": false,
+    "BUSINESS_LOGIC": "// Add your business logic here"
+  }
+}

package/src/templates/base/script_include.template.json

@@ -0,0 +1,18 @@
+{
+  "type": "script_include",
+  "name": "{{CLASS_NAME}}",
+  "description": "{{DESCRIPTION}}",
+  "config": {
+    "api_name": "{{API_NAME|CLASS_NAME}}",
+    "access": "{{ACCESS|public}}",
+    "active": true,
+    "script": "var {{CLASS_NAME}} = Class.create();\n{{CLASS_NAME}}.prototype = {\n    initialize: function() {\n        // Constructor\n    },\n    \n    // Add your methods here\n    {{METHOD_NAME|exampleMethod}}: function() {\n        // Method implementation\n        return true;\n    },\n    \n    type: '{{CLASS_NAME}}'\n};"
+  },
+  "variables": {
+    "CLASS_NAME": "MyUtilityClass",
+    "DESCRIPTION": "Utility functions for ServiceNow",
+    "API_NAME": "MyUtilityClass",
+    "ACCESS": "public",
+    "METHOD_NAME": "exampleMethod"
+  }
+}

package/src/templates/base/table.template.json

@@ -0,0 +1,64 @@
+{
+  "type": "table",
+  "name": "{{TABLE_NAME}}",
+  "description": "{{TABLE_DESCRIPTION}}",
+  "config": {
+    "name": "{{TABLE_NAME}}",
+    "label": "{{LABEL}}",
+    "plural": "{{PLURAL}}",
+    "extends_table": "{{EXTENDS_TABLE|task}}",
+    "number_ref": {
+      "table": "{{TABLE_NAME}}",
+      "prefix": "{{PREFIX|CUSTOM}}"
+    },
+    "access": "{{ACCESS|public}}",
+    "create_access_controls": {{CREATE_ACCESS_CONTROLS|true}},
+    "live_feed_enabled": {{LIVE_FEED_ENABLED|false}},
+    "is_extendable": {{IS_EXTENDABLE|true}},
+    "create_module": {{CREATE_MODULE|true}},
+    "icon": "{{ICON|}}",
+    "user_role": "{{USER_ROLE|}}",
+    "fields": [
+      {
+        "column_name": "{{FIELD1_NAME|description}}",
+        "column_label": "{{FIELD1_LABEL|Description}}",
+        "type": "{{FIELD1_TYPE|string}}",
+        "max_length": {{FIELD1_LENGTH|255}},
+        "mandatory": {{FIELD1_MANDATORY|false}},
+        "display": {{FIELD1_DISPLAY|true}},
+        "active": true
+      }
+    ],
+    "acls": {
+      "create": "{{ACL_CREATE|true}}",
+      "read": "{{ACL_READ|true}}",
+      "write": "{{ACL_WRITE|true}}",
+      "delete": "{{ACL_DELETE|admin}}"
+    }
+  },
+  "variables": {
+    "TABLE_NAME": "u_custom_table",
+    "TABLE_DESCRIPTION": "A custom ServiceNow table",
+    "LABEL": "Custom Table",
+    "PLURAL": "Custom Tables",
+    "EXTENDS_TABLE": "task",
+    "PREFIX": "CUSTOM",
+    "ACCESS": "public",
+    "CREATE_ACCESS_CONTROLS": true,
+    "LIVE_FEED_ENABLED": false,
+    "IS_EXTENDABLE": true,
+    "CREATE_MODULE": true,
+    "ICON": "",
+    "USER_ROLE": "",
+    "FIELD1_NAME": "description",
+    "FIELD1_LABEL": "Description",
+    "FIELD1_TYPE": "string",
+    "FIELD1_LENGTH": 255,
+    "FIELD1_MANDATORY": false,
+    "FIELD1_DISPLAY": true,
+    "ACL_CREATE": "true",
+    "ACL_READ": "true",
+    "ACL_WRITE": "true",
+    "ACL_DELETE": "admin"
+  }
+}

package/src/templates/base/widget.template.json

@@ -0,0 +1,25 @@
+{
+  "type": "widget",
+  "name": "{{WIDGET_NAME}}",
+  "description": "{{WIDGET_DESCRIPTION}}",
+  "config": {
+    "id": "{{WIDGET_ID}}",
+    "title": "{{WIDGET_TITLE}}",
+    "category": "{{CATEGORY|custom}}",
+    "template": "<div class=\"{{WIDGET_CLASS}}\">\n  <!-- Widget HTML here -->\n</div>",
+    "css": ".{{WIDGET_CLASS}} {\n  /* Widget styles here */\n}",
+    "client_script": "function() {\n  var c = this;\n  \n  // Client controller logic here\n  c.data = c.data || {};\n}",
+    "server_script": "(function() {\n  // Server script logic here\n  data = data || {};\n  \n  // Fetch data from ServiceNow\n  \n})()",
+    "option_schema": "[]",
+    "demo_data": "{}",
+    "has_preview": true
+  },
+  "variables": {
+    "WIDGET_NAME": "My Widget",
+    "WIDGET_DESCRIPTION": "A custom ServiceNow widget",
+    "WIDGET_ID": "my_widget",
+    "WIDGET_TITLE": "My Widget",
+    "WIDGET_CLASS": "my-widget",
+    "CATEGORY": "custom"
+  }
+}

package/src/templates/patterns/composite.incident-management.template.json

@@ -0,0 +1,140 @@
+{
+  "type": "composite",
+  "name": "Incident Management System Template",
+  "description": "Complete incident management system with dashboard, workflows, and automation",
+  "category": "patterns/composite",
+  "artifacts": [
+    {
+      "type": "widget",
+      "template": "patterns/widget.dashboard",
+      "variables": {
+        "WIDGET_NAME": "incident_dashboard",
+        "WIDGET_TITLE": "Incident Management Dashboard",
+        "WIDGET_DESCRIPTION": "Real-time incident tracking and analytics",
+        "TABLE_NAME": "incident"
+      }
+    },
+    {
+      "type": "widget",
+      "template": "patterns/widget.datatable",
+      "variables": {
+        "WIDGET_NAME": "incident_list",
+        "WIDGET_TITLE": "Active Incidents",
+        "WIDGET_DESCRIPTION": "Interactive list of active incidents",
+        "TABLE_NAME": "incident",
+        "ENABLE_INLINE_EDIT": "true"
+      }
+    },
+    {
+      "type": "flow",
+      "template": "patterns/flow.approval",
+      "variables": {
+        "FLOW_NAME": "incident_escalation",
+        "FLOW_DESCRIPTION": "Automatic incident escalation based on priority and age",
+        "TABLE_NAME": "incident",
+        "TRIGGER_TYPE": "scheduled",
+        "TRIGGER_CONDITION": "priority IN (1,2) AND state != 'resolved'"
+      }
+    },
+    {
+      "type": "business_rule",
+      "template": "base/business_rule",
+      "variables": {
+        "NAME": "incident_auto_assignment",
+        "DESCRIPTION": "Automatically assign incidents based on category",
+        "TABLE": "incident",
+        "WHEN": "before",
+        "CONDITION": "current.assigned_to.nil() && !current.category.nil()",
+        "SCRIPT": "// Auto-assignment logic\nvar category = current.getValue('category');\nvar assignmentGroup = '';\n\nswitch(category) {\n  case 'hardware':\n    assignmentGroup = 'hardware_support';\n    break;\n  case 'software':\n    assignmentGroup = 'software_support';\n    break;\n  case 'network':\n    assignmentGroup = 'network_support';\n    break;\n  default:\n    assignmentGroup = 'service_desk';\n}\n\ncurrent.assignment_group = assignmentGroup;"
+      }
+    },
+    {
+      "type": "script_include",
+      "template": "base/script_include",
+      "variables": {
+        "CLASS_NAME": "IncidentAnalytics",
+        "DESCRIPTION": "Utility functions for incident analytics and reporting",
+        "SCRIPT": "var IncidentAnalytics = Class.create();\nIncidentAnalytics.prototype = {\n  initialize: function() {},\n  \n  getMetrics: function() {\n    var metrics = {};\n    \n    // Total incidents\n    var gr = new GlideRecord('incident');\n    gr.addActiveQuery();\n    gr.query();\n    metrics.total = gr.getRowCount();\n    \n    // By priority\n    var priorities = {};\n    gr = new GlideRecord('incident');\n    gr.addActiveQuery();\n    gr.query();\n    while (gr.next()) {\n      var priority = gr.getValue('priority') || 'undefined';\n      priorities[priority] = (priorities[priority] || 0) + 1;\n    }\n    metrics.byPriority = priorities;\n    \n    // Average resolution time\n    gr = new GlideRecord('incident');\n    gr.addQuery('state', 'resolved');\n    gr.orderByDesc('sys_updated_on');\n    gr.setLimit(100);\n    gr.query();\n    \n    var totalTime = 0;\n    var count = 0;\n    while (gr.next()) {\n      var created = new GlideDateTime(gr.sys_created_on);\n      var resolved = new GlideDateTime(gr.resolved_at);\n      if (resolved.getNumericValue() > created.getNumericValue()) {\n        totalTime += resolved.getNumericValue() - created.getNumericValue();\n        count++;\n      }\n    }\n    \n    if (count > 0) {\n      metrics.avgResolutionTime = Math.round(totalTime / count / 1000 / 60); // minutes\n    }\n    \n    return metrics;\n  },\n  \n  type: 'IncidentAnalytics'\n};"
+      }
+    },
+    {
+      "type": "table",
+      "template": "base/table",
+      "variables": {
+        "NAME": "u_incident_metrics",
+        "LABEL": "Incident Metrics",
+        "EXTENDS": "sys_metadata",
+        "FIELDS": [
+          {
+            "name": "metric_date",
+            "label": "Metric Date",
+            "type": "glide_date",
+            "mandatory": true
+          },
+          {
+            "name": "total_incidents",
+            "label": "Total Incidents",
+            "type": "integer",
+            "default": "0"
+          },
+          {
+            "name": "high_priority",
+            "label": "High Priority",
+            "type": "integer",
+            "default": "0"
+          },
+          {
+            "name": "avg_resolution_time",
+            "label": "Avg Resolution Time (min)",
+            "type": "decimal",
+            "default": "0"
+          },
+          {
+            "name": "sla_breaches",
+            "label": "SLA Breaches",
+            "type": "integer",
+            "default": "0"
+          }
+        ]
+      }
+    }
+  ],
+  "dependencies": [
+    {
+      "from": "widget.incident_dashboard",
+      "to": "script_include.IncidentAnalytics",
+      "type": "uses"
+    },
+    {
+      "from": "flow.incident_escalation",
+      "to": "table.incident",
+      "type": "updates"
+    },
+    {
+      "from": "business_rule.incident_auto_assignment",
+      "to": "table.incident",
+      "type": "triggers_on"
+    },
+    {
+      "from": "script_include.IncidentAnalytics",
+      "to": "table.u_incident_metrics",
+      "type": "writes_to"
+    }
+  ],
+  "deployment_order": [
+    "table.u_incident_metrics",
+    "script_include.IncidentAnalytics",
+    "business_rule.incident_auto_assignment",
+    "flow.incident_escalation",
+    "widget.incident_list",
+    "widget.incident_dashboard"
+  ],
+  "variables": {
+    "SYSTEM_NAME": "Incident Management",
+    "SYSTEM_PREFIX": "inc_mgmt",
+    "PRIMARY_TABLE": "incident",
+    "NOTIFICATION_GROUP": "incident_managers",
+    "SLA_WARNING_THRESHOLD": "80",
+    "ESCALATION_TIMEOUT": "3600"
+  }
+}