@itentialopensource/adapter-servicenow 2.4.4 → 2.4.5

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 2.4.5 [08-03-2023]
+
+* More metadata changes
+
+See merge request itentialopensource/adapters/itsm-testing/adapter-servicenow!21
+
+---
+
 ## 2.4.4 [07-12-2023]
 
 * fix meta comma

package/metadata.json

@@ -2,7 +2,7 @@
   "name": "adapter-servicenow",
   "vendor": "ServiceNow",
   "product": "IT Service Management",
-  "os_versions": [
+  "osVersions": [
     "Istanbul",
     "Jakarta",
     "Kingston",
@@ -17,7 +17,11 @@
     "Tokyo",
     "Utah"
   ],
-  "iap_versions": [
+  "apiVersions": [
+    "Istanbul",
+    "Jakarta"
+  ],
+  "iapVersions": [
     "2021.1.x",
     "2021.2.x",
     "2022.1.x",
@@ -25,82 +29,183 @@
   ],
   "method": "REST API",
   "type": "Adapter",
-  "example": "getChangeRequests -> Returns the changes from the provided ServiceNow instance.",
+  "example": {
+    "name": "getStandardChangeRequestById",
+    "overview": "Get a particular Servicenow change request by its id",
+    "exampleInput": "{\n  \"name\": \"sysparmQuery\",\n  \"type\": \"object\",\n  \"info\": \"Encoded query used to filter the result set. e.g. { change: 'CHG123456' }\",\n  \"required\": false,\n  \"schema\": {\n    \"title\": \"sysparmQuery\",\n    \"type\": \"object\"\n  }\n},\n{\n  \"name\": \"changeId\",\n  \"type\": \"string\",\n  \"info\": \"Unique identifier of the standard change request to retrieve from the [change_request] table.\",\n  \"required\": true,\n  \"schema\": {\n    \"title\": \"changeId\",\n    \"type\": \"string\"\n  }\n}\n",
+    "exampleOutput": "{ \n  \"result\": { \n    \"sys_id\": {\n      \"display_value\": \"c45e54b0db400010a704fe1b68961985\",\n      \"value\": \"c45e54b0db400010a704fe1b68961985\"\n    },\n    \"reason\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"parent\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"watch_list\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"upon_reject\": {\n      \"display_value\": \"Cancel all future Tasks\",\n      \"value\": \"cancel\"\n    },\n    \"sys_updated_on\": {\n      \"display_value\": \"2019-09-19 14:06:29\",\n      \"value\": \"2019-09-19 21:06:29\",\n      \"display_value_internal\": \"2019-09-19 14:06:29\"\n    },\n    \"type\": {\n      \"display_value\": \"Standard\",\n      \"value\": \"standard\"\n    },\n    \"approval_history\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"test_plan\": {\n      \"display_value\": \"Explain what testing you have done or will do prior to implementation that gives you confidence this change will be successful.\\r\\n\\r\\nDescribe the tests that will be carried out after implementation to confirm.\\r\\n\\t\\t\\tthat the change has been successful.\",\n      \"value\": \"Explain what testing you have done or will do prior to implementation that gives you confidence this change will be successful.\\r\\n\\r\\nDescribe the tests that will be carried out after implementation to confirm.\\r\\n\\t\\t\\tthat the change has been successful.\"\n    },\n    \"number\": {\n      \"display_value\": \"CHG0030004\",\n      \"value\": \"CHG0030004\"\n    },\n    \"cab_delegate\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"requested_by_date\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"state\": {\n      \"display_value\": \"New\",\n      \"value\": -5\n    },\n    \"sys_created_by\": {\n      \"display_value\": \"admin\",\n      \"value\": \"admin\"\n    },\n    \"knowledge\": {\n      \"display_value\": \"false\",\n      \"value\": false\n    },\n    \"order\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"phase\": {\n      \"display_value\": \"Requested\",\n      \"value\": \"requested\"\n    },\n    \"cmdb_ci\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"delivery_plan\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"impact\": {\n      \"display_value\": \"3 - Low\",\n      \"value\": 3\n    },\n    \"active\": {\n      \"display_value\": \"true\",\n      \"value\": true\n    },\n    \"work_notes_list\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"priority\": {\n      \"display_value\": \"4 - Low\",\n      \"value\": 4\n    },\n    \"sys_domain_path\": {\n      \"display_value\": \"/\",\n      \"value\": \"/\"\n    },\n    \"production_system\": {\n      \"display_value\": \"false\",\n      \"value\": false\n    },\n    \"cab_recommendation\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"rejection_goto\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"review_date\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"requested_by\": {\n      \"display_value\": \"System Administrator\",\n      \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n    },\n    \"business_duration\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"group_list\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"change_plan\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"approval_set\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"wf_activity\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"implementation_plan\": {\n      \"display_value\": \"List the steps in order of completion that will be worked through when implementing this change.\\r\\n\\r\\nNote who will perform each step and whether there are dependencies\\r\\n\\t\\t\\tbetween steps.\",\n      \"value\": \"List the steps in order of completion that will be worked through when implementing this change.\\r\\n\\r\\nNote who will perform each step and whether there are dependencies\\r\\n\\t\\t\\tbetween steps.\"\n    },\n    \"end_date\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"short_description\": {\n      \"display_value\": \"Include a title for your change no greater than 100 characters\",\n      \"value\": \"Include a title for your change no greater than 100 characters\"\n    },\n    \"correlation_display\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"delivery_task\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"work_start\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"outside_maintenance_schedule\": {\n      \"display_value\": \"false\",\n      \"value\": false\n    },\n    \"additional_assignee_list\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"std_change_producer_version\": {\n      \"display_value\": \"Replace printer toner - 1\",\n      \"value\": \"5b7399bc53231300e321ddeeff7b1206\"\n    },\n    \"sys_class_name\": {\n      \"display_value\": \"Change Request\",\n      \"value\": \"change_request\"\n    },\n    \"closed_by\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"follow_up\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"review_status\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"reassignment_count\": {\n      \"display_value\": \"0\",\n      \"value\": 0\n    },\n    \"start_date\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"assigned_to\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"variables\": {\n      \"display_value\": \"variable_pool\",\n      \"value\": \"variable_pool\"\n    },\n    \"sla_due\": {\n      \"display_value\": \"UNKNOWN\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"comments_and_work_notes\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"escalation\": {\n      \"display_value\": \"Normal\",\n      \"value\": 0\n    },\n    \"upon_approval\": {\n      \"display_value\": \"Proceed to Next Task\",\n      \"value\": \"proceed\"\n    },\n    \"correlation_id\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"made_sla\": {\n      \"display_value\": \"true\",\n      \"value\": true\n    },\n    \"backout_plan\": {\n      \"display_value\": \"Describe the steps you will take to revert the change to its pre-implementation state.\\r\\n\\r\\nAt what point during the implementation will you take the decision to\\r\\n\\t\\t\\tbackout your change?\\r\\n\\r\\n\\t\\t\\tDoes your change window include time to backout if you need\\r\\n\\t\\t\\tto?\",\n      \"value\": \"Describe the steps you will take to revert the change to its pre-implementation state.\\r\\n\\r\\nAt what point during the implementation will you take the decision to\\r\\n\\t\\t\\tbackout your change?\\r\\n\\r\\n\\t\\t\\tDoes your change window include time to backout if you need\\r\\n\\t\\t\\tto?\"\n    },\n    \"conflict_status\": {\n      \"display_value\": \"Not Run\",\n      \"value\": \"Not Run\"\n    },\n    \"sys_updated_by\": {\n      \"display_value\": \"admin\",\n      \"value\": \"admin\"\n    },\n    \"opened_by\": {\n      \"display_value\": \"System Administrator\",\n      \"value\": \"6816f79cc0a8016401c5a33be04be441\"\n    },\n    \"user_input\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"sys_created_on\": {\n      \"display_value\": \"2019-09-19 14:06:29\",\n      \"value\": \"2019-09-19 21:06:29\",\n      \"display_value_internal\": \"2019-09-19 14:06:29\"\n    },\n    \"on_hold_task\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"sys_domain\": {\n      \"display_value\": \"global\",\n      \"value\": \"global\"\n    },\n    \"closed_at\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"review_comments\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"business_service\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"time_worked\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"expected_start\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"opened_at\": {\n      \"display_value\": \"2019-09-19 14:06:20\",\n      \"value\": \"2019-09-19 21:06:20\",\n      \"display_value_internal\": \"2019-09-19 14:06:20\"\n    },\n    \"work_end\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"phase_state\": {\n      \"display_value\": \"Open\",\n      \"value\": \"open\"\n    },\n    \"cab_date\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"work_notes\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"close_code\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"assignment_group\": {\n      \"display_value\": \"Help Desk\",\n      \"value\": \"679434f053231300e321ddeeff7b12d8\"\n    },\n    \"description\": {\n      \"display_value\": \"Describe what you plan to do\",\n      \"value\": \"Describe what you plan to do\"\n    },\n    \"on_hold_reason\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"calendar_duration\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"close_notes\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"contact_type\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"cab_required\": {\n      \"display_value\": \"false\",\n      \"value\": false\n    },\n    \"urgency\": {\n      \"display_value\": \"3 - Low\",\n      \"value\": 3\n    },\n    \"scope\": {\n      \"display_value\": \"Medium\",\n      \"value\": 3\n    },\n    \"company\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"justification\": {\n      \"display_value\": \"To improve color standards.\",\n      \"value\": \"To improve color standards.\"\n    },\n    \"activity_due\": {\n      \"display_value\": \"UNKNOWN\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"comments\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"approval\": {\n      \"display_value\": \"Approved\",\n      \"value\": \"approved\"\n    },\n    \"due_date\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"on_hold\": {\n      \"display_value\": \"false\",\n      \"value\": false\n    },\n    \"sys_tags\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"conflict_last_run\": {\n      \"display_value\": \"\",\n      \"value\": \"\",\n      \"display_value_internal\": \"\"\n    },\n    \"risk\": {\n      \"display_value\": \"Moderate\",\n      \"value\": 3\n    },\n    \"location\": {\n      \"display_value\": \"\",\n      \"value\": \"\"\n    },\n    \"category\": {\n      \"display_value\": \"Other\",\n      \"value\": \"Other\"\n    },\n    \"risk_impact_analysis\": {\n      \"display_value\": \"Low\",\n      \"value\": \"Low\"\n    }\n  }\n}"
+  },
   "domains": [
     "Inventory",
     "Discovery",
     "ITSM"
   ],
+  "tags": [
+    "Change Management",
+    "ITSM",
+    "Incidents",
+    "Request"
+  ],
+  "deprecated": {
+    "isDeprecated": false,
+    "deprecatedOn": "<date>",
+    "endOfLife": "<date>",
+    "replacedBy": {
+      "name": "adapter-servicenow  JUST EXAMPLE!!!!",
+      "overview": "1 sentence about this thing",
+      "repoLink": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-servicenow",
+      "docLink": "https://docs.itential.com/opensource/docs/servicenow",
+      "webLink": "<TBD>"
+    }
+  },
   "documentation": {
-    "storelink": "",
-    "repolink": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-servicenow",
-    "npmlink": "https://www.npmjs.com/package/@itentialopensource/adapter-servicenow",
-    "doclink": "https://docs.itential.com/opensource/docs/servicenow",
-    "marketlink": "<TBD>"
+    "storeLink": "",
+    "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-servicenow",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-servicenow",
+    "docLink": "https://docs.itential.com/opensource/docs/servicenow",
+    "faqLink": "https://docs.itential.com/opensource/docs/servicenow",
+    "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
+    "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
+    "webLink": "https://www.itential.com/adapters/servicenow/",
+    "vendorLink": "https://www.servicenow.com/",
+    "productLink": "https://www.servicenow.comhttps://www.servicenow.com/products/itsm.html",
+    "apiLinks": [
+      "https://developer.servicenow.com/dev.do#!/learn/learning-plans/tokyo/new_to_servicenow/app_store_learnv2_scripting_tokyo_servicenow_apis"
+    ]
   },
   "relatedItems": {
     "adapters": [
       {
         "name": "adapter-servicenow  JUST EXAMPLE!!!!",
-        "repolink": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-servicenow",
-        "doclink": "https://docs.itential.com/opensource/docs/servicenow",
-        "marketLink": "<TBD>"
+        "overview": "1 sentence about this thing",
+        "versions": [
+          "^0.9.0"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-servicenow",
+        "docLink": "https://docs.itential.com/opensource/docs/servicenow",
+        "webLink": "<TBD>"
+      }
+    ],
+    "integrations": [
+      {
+        "name": "adapter-servicenow  JUST EXAMPLE!!!!",
+        "overview": "1 sentence about this thing",
+        "versions": [
+          "^0.9.0"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-servicenow",
+        "docLink": "https://docs.itential.com/opensource/docs/servicenow",
+        "webLink": "<TBD>"
       }
     ],
     "ecosystemApplications": [
       {
         "name": "Itential ServiceNow App",
-        "storelink": "https://store.servicenow.com/sn_appstore_store.do#!/store/application/f2ba728813da041032813092e144b01f",
-        "doclink": "https://docs.itential.com/opensource/docs/servicenow-application",
-        "marketLink": "<TBD>"
+        "overview": "1 sentence about this thing",
+        "versions": [
+          "^0.9.0"
+        ],
+        "storeLink": "https://store.servicenow.com/sn_appstore_store.do#!/store/application/f2ba728813da041032813092e144b01f",
+        "docLink": "https://docs.itential.com/opensource/docs/servicenow-application",
+        "webLink": "<TBD>"
       }
     ],
     "automations": [
       {
         "name": "ServiceNow Create Change Request",
-        "repolink": "https://gitlab.com/itentialopensource/pre-built-automations/servicenow-create-change-request",
+        "overview": "1 sentence about this thing",
+        "versions": [
+          "^0.9.0"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/servicenow-create-change-request",
         "docLink": "<TBD>",
-        "marketLink": "<TBD>"
+        "webLink": "<TBD>"
       },
       {
         "name": "ServiceNow Schedule Automation Using Change Request",
-        "repolink": "https://gitlab.com/itentialopensource/pre-built-automations/servicenow-schedule-automation-using-change-request",
+        "overview": "1 sentence about this thing",
+        "versions": [
+          "^0.9.0"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/servicenow-schedule-automation-using-change-request",
         "docLink": "<TBD>",
-        "marketLink": "<TBD>"
+        "webLink": "<TBD>"
       },
       {
         "name": "ServiceNow Incident Creation",
-        "repolink": "https://gitlab.com/itentialopensource/pre-built-automations/servicenow-incident-creation",
+        "overview": "1 sentence about this thing",
+        "versions": [
+          "^0.9.0"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/servicenow-incident-creation",
         "docLink": "<TBD>",
-        "marketLink": "<TBD>"
+        "webLink": "<TBD>"
       },
       {
         "name": "ServiceNow Create RITM",
-        "repolink": "https://gitlab.com/itentialopensource/pre-built-automations/servicenow-create-ritm",
+        "overview": "1 sentence about this thing",
+        "versions": [
+          "^0.9.0"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/servicenow-create-ritm",
+        "docLink": "<TBD>",
+        "webLink": "<TBD>"
+      }
+    ],
+    "transformations": [
+      {
+        "name": "Blah",
+        "overview": "1 sentence about this thing",
+        "versions": [
+          "^0.9.0"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/servicenow-create-change-request",
         "docLink": "<TBD>",
-        "marketLink": "<TBD>"
+        "webLink": "<TBD>"
       }
     ],
-    "usecases": [
+    "useCases": [
+      {
+        "name": "Create, update and complete change management requests",
+        "overview": "1 sentence about this thing",
+        "webLink": "<TBD>",
+        "exampleInput": "",
+        "exampleOutput": ""
+      },
       {
         "name": "Create, update and complete change management requests",
-        "marketLink": "<TBD>"
+        "overview": "1 sentence about this thing",
+        "webLink": "<TBD>",
+        "exampleInput": "",
+        "exampleOutput": ""
       },
       {
         "name": "Create tickets/issues when problems arise during automations",
-        "marketLink": "<TBD>"
+        "overview": "1 sentence about this thing",
+        "webLink": "<TBD>",
+        "exampleInput": "",
+        "exampleOutput": ""
       },
       {
         "name": "Close tickets/issues when problems are fixed by automations",
-        "marketLink": "<TBD>"
+        "overview": "1 sentence about this thing",
+        "webLink": "<TBD>",
+        "exampleInput": "",
+        "exampleOutput": ""
       },
       {
         "name": "Add items into CMDB systems and set them up to be discovered",
-        "marketLink": "<TBD>"
+        "overview": "1 sentence about this thing",
+        "webLink": "<TBD>",
+        "exampleInput": "",
+        "exampleOutput": ""
       },
       {
         "name": "Remove items from CMDB",
-        "marketLink": "<TBD>"
+        "overview": "1 sentence about this thing",
+        "webLink": "<TBD>",
+        "exampleInput": "",
+        "exampleOutput": ""
       }
     ]
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-servicenow",
-  "version": "2.4.4",
+  "version": "2.4.5",
   "description": "This adapter integrates with system described as: servicenowMadrid.",
   "main": "adapter.js",
   "systemName": "ServiceNow",

package/report/adapterInfo.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.4.2",
+  "version": "2.4.3",
   "configLines": 7662,
   "scriptLines": 1707,
   "codeLines": 13423,