@itentialopensource/adapter-servicenow 2.8.8 → 2.9.0

package/BROKER.md

@@ -22,18 +22,25 @@ Below is an example of how you may set up the properties for this call.
   {
     "path": "/{org}/get/devices",
     "method": "GET",
+    "pagination": {
+      "offsetVar": "",
+      "limitVar": "",
+      "incrementBy": "limit",
+      "requestLocation": "query"
+    },
     "query": {},
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
       "org": "555"
     },
     "responseFields": {
-      "name": "host",
-      "ostype": "os",
+      "name": "{hostField}",
+      "ostype": "{osField}",
       "ostypePrefix": "system-",
-      "ipaddress": "attributes.ipaddr",
+      "ipaddress": "{attributes.ipaddr}",
       "port": "443"
     }
   },
@@ -44,16 +51,17 @@ Below is an example of how you may set up the properties for this call.
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
       "org": "777"
     },
     "responseFields": {
-      "name": "host",
-      "ostype": "os",
+      "name": "{hostField}",
+      "ostype": "{osField}",
       "ostypePrefix": "system-",
-      "ipaddress": "attributes.ipaddr",
+      "ipaddress": "{attributes.ipaddr}",
       "port": "443",
-      "myorg": "org"
+      "myorg": "{orgField}"
     }
   }
 ]
@@ -88,12 +96,13 @@ Below is an example of how you may set up the properties for this call.
     "headers": {},
     "handleFailure": "ignore",
     "statusValue": "online",
+    "responseDataKey": "",
     "requestFields": {
-      "org": "myorg",
-      "id": "name"
+      "org": "{myorg}",
+      "id": "{name}"
     },
     "responseFields": {
-      "status": "status"
+      "status": "{status}"
     }
   }
 ]
@@ -129,9 +138,10 @@ Below is an example of how you may set up the properties for this call.
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
-      "org": "myorg",
-      "id": "name"
+      "org": "{myorg}",
+      "id": "{name}"
     }
     "responseFields": {}
   },
@@ -142,8 +152,9 @@ Below is an example of how you may set up the properties for this call.
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
-      "org": "myorg"
+      "org": "{myorg}"
     }
     "responseFields": {}
   }
@@ -178,17 +189,18 @@ Below is an example of how you may set up the properties for this call.
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
-      "org": "myorg",
-      "id": "name"
+      "org": "{myorg}",
+      "id": "{name}"
     },
     "responseFields": {
-      "name": "host",
-      "ostype": "os",
+      "name": "{hostField}",
+      "ostype": "{osField}",
       "ostypePrefix": "system-",
-      "ipaddress": "attributes.ipaddr",
+      "ipaddress": "{attributes.ipaddr}",
       "port": "443",
-      "myorg": "org"
+      "myorg": "{orgField}"
     }
   }
 ]

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 2.9.0 [07-15-2024]
+
+* Minor/2024 auto migration
+
+See merge request itentialopensource/adapters/itsm-testing/adapter-servicenow!35
+
+---
+
 ## 2.8.8 [06-05-2024]
 
 * Changes made at 2024.03.27_14:10PM

package/PROPERTIES.md

@@ -97,6 +97,7 @@ This section defines **all** the properties that are available for the adapter,
         }
       },
       "devicebroker": {
+        "enabled": false,
         "getDevice": [
           {
             "path": "/call/to/get/device/details",
@@ -580,6 +581,10 @@ The device broker section defines the properties used integrate Servicenow to th
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
   </tr>
+  <tr>
+    <td style="padding:15px">enabled</td>
+    <td style="padding:15px">Whether or not the device broker calls have been mapped.</td>
+  </tr>
   <tr>
     <td style="padding:15px">getDevice</td>
     <td style="padding:15px">The array of calls used to get device details for the broker</td>

package/README.md

@@ -4,29 +4,49 @@
 
 Some of the page links in this document and links to other GitLab files do not work in Confluence however, the information is available in other sections of the Confluence material.
 
-- [Overview](./SUMMARY.md)
-- [Versioning](#versioning)
-- [Supported IAP Versions](#supported-iap-versions)
-- [Getting Started](#getting-started)
-  - [Helpful Background Information](#helpful-background-information)
-  - [Prerequisites](#prerequisites)
-  - [How to Install](#how-to-install)
-  - [Testing](#testing)
-- [Configuration](./PROPERTIES.md)
-- [Using this Adapter](./CALLS.md)
+- [Specific to this Adapter](#specific-to-this-adapter)
   - [Authentication](./AUTH.md)
-- [Additional Information](#additional-information)
-  - [Enhancements](./ENHANCE.md)
-  - [Contributing](./CONTRIBUTING.md)
-  - [Helpful Links](#helpful-links)
-  - [Node Scripts](#node-scripts)
-- [Troubleshoot](./TROUBLESHOOT.md)
-- [License and Maintainers](#license-and-maintainers)
-- [Product License](#product-license)
+  - [Sample Properties](./sampleProperties.json)
+  - [Available Calls](./CALLS.md)
+  - [Swagger](./report/adapter-openapi.json)
+- [Generic Adapter Information](#generic-adapter-information)
+  - [Overview](./SUMMARY.md)
+  - [Versioning](#versioning)
+  - [Supported IAP Versions](#supported-iap-versions)
+  - [Getting Started](#getting-started)
+    - [Helpful Background Information](#helpful-background-information)
+    - [Prerequisites](#prerequisites)
+    - [How to Install](#how-to-install)
+    - [Testing](#testing)
+  - [Configuration](./PROPERTIES.md)
+  - [Additional Information](#additional-information)
+    - [Enhancements](./ENHANCE.md)
+    - [Contributing](./CONTRIBUTING.md)
+    - [Helpful Links](#helpful-links)
+    - [Node Scripts](#node-scripts)
+  - [Troubleshoot](./TROUBLESHOOT.md)
+  - [License and Maintainers](#license-and-maintainers)
+  - [Product License](#product-license)
+
+
+## Specific to this Adapter
 
-## [Overview](./SUMMARY.md)
+### [Authentication](./AUTH.md)
+
+### [Sample Properties](./sampleProperties.json)
+
+<a href="./sampleProperties.json" target="_blank">Sample Properties</a> can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
+
+### [Available Calls](./CALLS.md)
+
+### [Swagger](./report/adapter-openapi.json)
+
+
+## Generic Adapter Information
+
+### [Overview](./SUMMARY.md)
 
-## Versioning
+### Versioning
 
 Itential Product and opensource adapters utilize SemVer for versioning. The current version of the adapter can be found in the `package.json` file or viewed in the IAP GUI on the System page. All Itential opensource adapters can be found in the <a href="https://gitlab.com/itentialopensource/adapters" target="_blank">Itential OpenSource Repository</a>.
 
@@ -34,7 +54,7 @@ Any release prior to 1.0.0 is a pre-release. Initial builds of adapters are gene
 
 Release notes can be viewed in CHANGELOG.md.
 
-## Supported IAP Versions
+### Supported IAP Versions
 
 Itential Product adapters are built for particular versions of IAP and packaged with the versions they work with. 
 
@@ -42,11 +62,11 @@ Itential opensource adapter as well as custom adapters built with the Itential A
 
 Many of the scripts that come with all adapters built using the Itential Adapter Builder do have some dependencies on IAP or the IAP database schema and so it is possible these scripts could stop working in different versions of IAP. If you notify Itential of any issues, the Adapter Team will attempt to fix the scripts for newer releases of IAP.
 
-## Getting Started
+### Getting Started
 
 These instructions will help you get a copy of the project on your local machine for development and testing. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and properties.
 
-### Helpful Background Information
+#### Helpful Background Information
 
 There is <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter documentation available on the Itential Documentation Site</a>. This documentation includes information and examples that are helpful for:
 
@@ -67,7 +87,7 @@ Troubleshooting an Adapter
 Others will be added over time.
 Want to build a new adapter? Use the <a href="https://adapters.itential.io" target="_blank">Itential Adapter Builder</a>
 
-### Prerequisites
+#### Prerequisites
 
 The following is a list of required packages for installation on the system the adapter will run on:
 
@@ -154,16 +174,8 @@ eslint-plugin-json
 testdouble
 ```
 
-### How to Install
+#### How to Install
 
-Installing an Adapter into your instance of Itential varies for Itential Cloud and On Prem IAP customers.
-
-#### Cloud
-1. Create an instance of the adapter in IAP Admin Essentials GUI
-
-2. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
-
-#### On Prem IAP
 1. Set up the name space location in your IAP node_modules.
 
 ```bash
@@ -175,8 +187,8 @@ if the @itentialopensource directory does not exist, create it:
 2. Clone/unzip/tar the adapter into your IAP environment.
 
 ```bash
-cd \@itentialopensource
-git clone git@gitlab.com:\@itentialopensource/adapters/adapter-servicenow
+cd @itentialopensource
+git clone git@gitlab.com:@itentialopensource/adapters/adapter-servicenow
 or
 unzip adapter-servicenow.zip
 or
@@ -204,30 +216,11 @@ systemctl restart pronghorn
 
 7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
-
-For an easier install of the adapter use npm run adapter:install, it will install the adapter in IAP. Please note that it can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If using this, you can replace step 3-5 above with these:
-
-3. Install adapter dependencies and check the adapter.
-
-```bash
-cd adapter-servicenow
-npm run adapter:install
-```
-
-4. Restart IAP
-
-```bash
-systemctl restart pronghorn
-```
-
-5. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
-
-
-### Testing
+#### Testing
 
 Mocha is generally used to test all Itential Opensource Adapters. There are unit tests as well as integration tests performed. Integration tests can generally be run as standalone using mock data and running the adapter in stub mode, or as integrated. When running integrated, every effort is made to prevent environmental failures, however there is still a possibility.
 
-#### Unit Testing
+##### Unit Testing
 
 Unit Testing includes testing basic adapter functionality as well as error conditions that are triggered in the adapter prior to any integration. There are two ways to run unit tests. The prefered method is to use the testRunner script; however, both methods are provided here.
 
@@ -240,7 +233,7 @@ npm run test:baseunit
 
 To add new unit tests, edit the `test/unit/adapterTestUnit.js` file. The tests that are already in this file should provide guidance for adding additional tests.
 
-#### Integration Testing - Standalone
+##### Integration Testing - Standalone
 
 Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from Servicenow. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.
 
@@ -255,7 +248,7 @@ npm run test:integration
 
 To add new integration tests, edit the `test/integration/adapterTestIntegration.js` file. The tests that are already in this file should provide guidance for adding additional tests.
 
-#### Integration Testing
+##### Integration Testing
 
 Integration Testing requires connectivity to Servicenow. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.
 
@@ -271,23 +264,19 @@ Test should also be written to clean up after themselves. However, it is importa
 
 > **Reminder**: Do not check in code with actual credentials to systems.
 
-## [Configuration](./PROPERTIES.md)
-
-## [Using this Adapter](./CALLS.md)
-
-### [Authentication](./AUTH.md)
+### [Configuration](./PROPERTIES.md)
 
-## Additional Information
+### Additional Information
 
-### [Enhancements](./ENHANCE.md)
+#### [Enhancements](./ENHANCE.md)
 
-### [Contributing](./CONTRIBUTING.md)
+#### [Contributing](./CONTRIBUTING.md)
 
-### Helpful Links
+#### Helpful Links
 
 <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a>
 
-### Node Scripts
+#### Node Scripts
 
 There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of IAP as they have dependencies on IAP and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.
 
@@ -339,9 +328,9 @@ There are several node scripts that now accompany the adapter. These scripts are
 </table>
 <br>
 
-## [Troubleshoot](./TROUBLESHOOT.md)
+### [Troubleshoot](./TROUBLESHOOT.md)
 
-## License and Maintainers
+### License and Maintainers
 
 ```text
 Itential Product Adapters are maintained by the Itential Product Team.
@@ -349,6 +338,6 @@ Itential OpenSource Adapters are maintained by the Itential Adapter Team and the
 Custom Adapters are maintained by other sources.
 ```
 
-## Product License
+### Product License
 
 [Apache 2.0](./LICENSE)