@itentialopensource/adapter-efficientip_solidserver 0.1.1 → 0.3.0

package/README.md

@@ -1,48 +1,75 @@
-# Adapter for Efficientip_solidserver
+# Adapter for Efficientip_solidserver 
+
+## Table of Contents
+
+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)
+  - [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)
+
+## [Overview](./SUMMARY.md)
 
-This adapter is used to integrate the Itential Automation Platform (IAP) with the Efficientip_solidserver System. The API for Efficientip_solidserver is available at [undefined API URL]. The adapter utilizes the Efficientip_solidserver API to provide the integrations that are deemed pertinent to IAP. This ReadMe file is intended to provide information on this adapter.
-
->**Note**: It is possible that some integrations will be supported through the Efficientip_solidserver adapter while other integrations will not.
+## Versioning
 
-Itential provides information on all of its product adapters in the Customer Knowledge Base. Information in the [Customer Knowledge Base](https://itential.atlassian.net/servicedesk/customer/portals) is consistently maintained and goes through documentation reviews. As a result, it should be the first place to go for information.
+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>.
 
-For custom built adapters, it is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into IAP.
+Any release prior to 1.0.0 is a pre-release. Initial builds of adapters are generally set up as pre-releases as there is often work that needs to be done to configure the adapter and make sure the authentication process to Efficientip_solidserver works appropriately.
 
-## Versioning
+Release notes can be viewed in CHANGELOG.md.
 
-Itential Product 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. For Open Source Adapters, the versions available can be found in the [Itential OpenSource Repository](https://www.npmjs.com/search?q=itentialopensource%2Fadapter).
+## Supported IAP Versions
 
-## Release History
+Itential Product adapters are built for particular versions of IAP and packaged with the versions they work with. 
 
-Any release prior to 1.0.0 is a pre-release. Initial builds of adapters are generally set up as pre-releases as there is often work that needs to be done to configure the adapter and make sure the authentication process to Efficientip_solidserver works appropriately.
+Itential opensource adapter as well as custom adapters built with the Itential Adapter Builder work acoss many releases of IAP. As a result, it is not often necessary to modify an adapter when upgrading IAP. If IAP has changes that impact the pronghorn.json, like adding a new required section, this will most likely require changes to all adapters when upgrading IAP.
 
-Release notes can be viewed in CHANGELOG.md or in the [Customer Knowledge Base](https://itential.atlassian.net/servicedesk/customer/portals) for Itential adapters.
+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
 
 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.
 
-### Adapter Technical Resources
+### Helpful Background Information
 
-There is adapter documentation available on the Itential Developer Site [HERE](https://developer.itential.io/adapters-resources/). This documentation includes information and examples that are helpful for:
+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:
 
 ```text
 Authentication
-Properties
+IAP Service Instance Configuration
 Code Files
-Action Files
-Schema Files
-Mock Data Files
+Endpoint Configuration (Action & Schema)
+Mock Data
+Adapter Generic Methods
+Headers
+Security
 Linting and Testing
-Troubleshooting
+Build an Adapter
+Troubleshooting an Adapter
 ```
 
 Others will be added over time.
-Want to build a new adapter? Use the Adapter Builder [HERE](https://adapters.itential.io)
+Want to build a new adapter? Use the <a href="https://adapters.itential.io" target="_blank">Itential Adapter Builder</a>
 
-### Environment Prerequisites
+### Prerequisites
 
-The following is a list of required packages for an adapter.
+The following is a list of required packages for installation on the system the adapter will run on:
 
 ```text
 Node.js
@@ -50,26 +77,73 @@ npm
 Git
 ```
 
-### Adapter Prerequisites
-
-The following list of packages are required for Itential product adapters or custom adapters that have been built utilizing the Itential Adapter Builder.
-
-| Package | Description |
-| ------- | ------- |
-| @itentialopensource/adapter-utils | Runtime library classes for all adapters;  includes request handling, connection, throttling, and translation. |
-| ajv | Required for validation of adapter properties to integrate with Efficientip_solidserver. |
-| axios | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
-| commander | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
-| fs-extra | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
-| network-diagnostics | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
-| readline-sync | Utilized by the node script that comes with the adapter;  helps to test unit and integration functionality. |
-| semver | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
-
-Some of the adapter node scripts run testing scripts which require the dev dependencies listed below.
-
-### Additional Prerequisites for Development and Testing
-
-If you are developing and testing a custom adapter, or have testing capabilities on an Itential product adapter, you will need to install these packages as well.
+The following list of packages are required for Itential opensource adapters or custom adapters that have been built utilizing the Itential Adapter Builder. You can install these packages by running npm install inside the adapter directory.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Package</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">@itentialopensource/adapter-utils</td>
+    <td style="padding:15px">Runtime library classes for all adapters;  includes request handling, connection, authentication throttling, and translation.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">ajv</td>
+    <td style="padding:15px">Required for validation of adapter properties to integrate with Efficientip_solidserver.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">axios</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">commander</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">dns-lookup-promise</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">fs-extra</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">mocha</td>
+    <td style="padding:15px">Testing library that is utilized by some of the node scripts that are included with the adapter.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">mocha-param</td>
+    <td style="padding:15px">Testing library that is utilized by some of the node scripts that are included with the adapter.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">mongodb</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">nyc</td>
+    <td style="padding:15px">Testing coverage library that is utilized by some of the node scripts that are included with the adapter.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">ping</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">readline-sync</td>
+    <td style="padding:15px">Utilized by the node script that comes with the adapter;  helps to test unit and integration functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">semver</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">winston</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+</table>
+<br>
+
+If you are developing and testing a custom adapter, or have testing capabilities on an Itential opensource adapter, you will need to install these packages as well.
 
 ```text
 chai
@@ -77,355 +151,37 @@ eslint
 eslint-config-airbnb-base
 eslint-plugin-import
 eslint-plugin-json
-mocha
-mocha-param
-nyc
-package-json-validator
 testdouble
-winston
-```
-
-### Creating a Workspace
-
-The following provides a local copy of the repository along with adapter dependencies.
-
-```bash
-git clone git@gitlab.com:\@itentialopensource/adapters/adapter-efficientip_solidserver
-npm install
-```
-
-## Adapter Properties and Descriptions
-
-This section defines **all** the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the **Installation** section.
-
-```json
-  {
-    "id": "ALL ADAPTER PROPERTIES!!!",
-    "properties": {
-      "host": "system.access.resolved",
-      "port": 443,
-      "base_path": "/",
-      "version": "v1",
-      "cache_location": "local",
-      "encode_pathvars": true,
-      "save_metric": true,
-      "stub": false,
-      "protocol": "https",
-      "authentication": {
-        "auth_method": "basic user_password",
-        "username": "username",
-        "password": "password",
-        "token": "token",
-        "invalid_token_error": 401,
-        "token_timeout": 0,
-        "token_cache": "local",
-        "auth_field": "header.headers.X-AUTH-TOKEN",
-        "auth_field_format": "{token}",
-        "auth_logging": false
-      },
-      "healthcheck": {
-        "type": "startup",
-        "frequency": 300000,
-        "query_object": {}
-      },
-      "request": {
-        "number_redirects": 0,
-        "number_retries": 3,
-        "limit_retry_error": [401],
-        "failover_codes": [404, 405],
-        "attempt_timeout": 5000,
-        "global_request": {
-          "payload": {},
-          "uriOptions": {},
-          "addlHeaders": {},
-          "authData": {}
-        },
-        "healthcheck_on_timeout": false,
-        "return_raw": false,
-        "archiving": false,
-        "return_request": false
-      },
-      "ssl": {
-        "ecdhCurve": "",
-        "enabled": false,
-        "accept_invalid_cert": false,
-        "ca_file": "",
-        "key_file": "",
-        "cert_file": "",
-        "secure_protocol": "",
-        "ciphers": ""
-      },
-      "throttle": {
-        "throttle_enabled": false,
-        "number_pronghorns": 1,
-        "sync_async": "sync",
-        "max_in_queue": 1000,
-        "concurrent_max": 1,
-        "expire_timeout": 0,
-        "avg_runtime": 200,
-        "priorities": []
-      },
-      "proxy": {
-        "enabled": false,
-        "host": "localhost",
-        "port": 9999,
-        "protocol": "http",
-        "username": "",
-        "password": "",
-      },
-      "mongo": {
-        "host": "",
-        "port": 0,
-        "database": "",
-        "username": "",
-        "password": "",
-        "replSet": "",
-        "db_ssl": {
-          "enabled": false,
-          "accept_invalid_cert": false,
-          "ca_file": "",
-          "key_file": "",
-          "cert_file": ""
-        }
-      }
-    },
-    "type": "YOUR ADAPTER CLASS"
-  }
-```
-
-### Connection Properties
-
-These base properties are used to connect to Efficientip_solidserver upon the adapter initially coming up. It is important to set these properties appropriately.
-
-| Property | Description |
-| ------- | ------- |
-| host | Required. A fully qualified domain name or IP address.|
-| port | Required. Used to connect to the server.|
-| base_path | Optional. Used to define part of a path that is consistent for all or most endpoints. It makes the URIs easier to use and maintain but can be overridden on individual calls. An example **base_path** might be `/rest/api`. Default is ``.|
-| version | Optional. Used to set a global version for action endpoints. This makes it faster to update the adapter when endpoints change. As with the base-path, version can be overridden on individual endpoints. Default is ``.|
-| cache\_location | Optional. Used to define where the adapter cache is located. The cache is used to maintain an entity list to improve performance. Storage locally is lost when the adapter is restarted. Storage in Redis is preserved upon adapter restart. Default is none which means no caching of the entity list.|
-| encode\_pathvars | Optional. Used to tell the adapter to encode path variables or not. The default behavior is to encode them so this property can b e used to stop that behavior.|
-| save\_metric | Optional. Used to tell the adapter to save metric information (this does not impact metrics returned on calls). This allows the adapter to gather metrics over time. Metric data can be stored in a database or on the file system.|
-| stub | Optional. Indicates whether the stub should run instead of making calls to Efficientip_solidserver (very useful during basic testing). Default is false (which means connect to Efficientip_solidserver).|
-| protocol | Optional. Notifies the adapter whether to use HTTP or HTTPS. Default is HTTP.|
-
-A connectivity check tells IAP the adapter has loaded successfully.
-
-### Authentication Properties
-
-The following properties are used to define the authentication process to Efficientip_solidserver.
-
->**Note**: Depending on the method that is used to authenticate with Efficientip_solidserver, you may not need to set all of the authentication properties.
-
-| Property | Description |
-| ------- | ------- |
-| auth\_method | Required. Used to define the type of authentication currently supported. Authentication methods currently supported are: `basic user_password`, `static_token`, `request_token`, and `no_authentication`.|
-| username | Used to authenticate with Efficientip_solidserver on every request or when pulling a token that will be used in subsequent requests.|
-| password | Used to authenticate with Efficientip_solidserver on every request or when pulling a token that will be used in subsequent requests.|
-| token | Defines a static token that can be used on all requests. Only used with `static_token` as an authentication method (auth\_method).|
-| invalid\_token\_error | Defines the HTTP error that is received when the token is invalid. Notifies the adapter to pull a new token and retry the request. Default is 401.|
-| token\_timeout | Defines how long a token is valid. Measured in milliseconds. Once a dynamic token is no longer valid, the adapter has to pull a new token. If the token\_timeout is set to -1, the adapter will pull a token on every request to Efficientip_solidserver. If the timeout\_token is 0, the adapter will use the expiration from the token response to determine when the token is no longer valid.|
-| token\_cache | Used to determine where the token should be stored (local memory or in Redis).|
-| auth\_field | Defines the request field the authentication (e.g., token are basic auth credentials) needs to be placed in order for the calls to work.|
-| auth\_field\_format | Defines the format of the auth\_field. See examples below. Items enclosed in {} inform the adapter to perofrm an action prior to sending the data. It may be to replace the item with a value or it may be to encode the item. |
-| auth\_logging | Setting this true will add some additional logs but this should only be done when trying to debug an issue as certain credential information may be logged out when this is true. |
-
-#### Examples of authentication field format
-
-```json
-"{token}"
-"Token {token}"
-"{username}:{password}"
-"Basic {b64}{username}:{password}{/b64}"
 ```
 
-### Healthcheck Properties
-
-The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach Efficientip_solidserver. There are currently three types of healthchecks.
-
-- None - Not recommended. Adapter will not run a healthcheck. Consequently, unable to determine before making a request if the adapter can reach Efficientip_solidserver.
-- Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
-- Intermittent - Adapter will check connectivity to Efficientip_solidserver at a frequency defined in the `frequency` property.
-
-| Property | Description |
-| ------- | ------- |
-| type | Required. The type of health check to run. |
-| frequency | Required if intermittent. Defines how often the health check should run. Measured in milliseconds. Default is 300000.|
-| query_object | Query parameters to be added to the adapter healthcheck call.|
-
-### Request Properties
-
-The request section defines properties to help handle requests.
-
-| Property | Description |
-| ------- | ------- |
-| number\_redirects | Optional. Tells the adapter that the request may be redirected and gives it a maximum number of redirects to allow before returning an error. Default is 0 - no redirects.|
-| number\_retries | Tells the adapter how many times to retry a request that has either aborted or reached a limit error before giving up and returning an error.|
-| limit\_retry\_error | Optional. Can be either an integer or an array. Indicates the http error status number to define that no capacity was available and, after waiting a short interval, the adapter can retry the request. If an array is provvided, the array can contain integers or strings. Strings in the array are used to define ranges (e.g. "502-506"). Default is [0].|
-| failover\_codes | An array of error codes for which the adapter will send back a failover flag to IAP so that the Platform can attempt the action in another adapter.|
-| attempt\_timeout | Optional. Tells how long the adapter should wait before aborting the attempt. On abort, the adapter will do one of two things: 1) return the error; or 2) if **healthcheck\_on\_timeout** is set to true, it will abort the request and run a Healthcheck until it re-establishes connectivity to Efficientip_solidserver, and then will re-attempt the request that aborted. Default is 5000 milliseconds.|
-| global\_request | Optional. This is information that the adapter can include in all requests to the other system. This is easier to define and maintain than adding this information in either the code (adapter.js) or the action files.|
-| global\_request -> payload | Optional. Defines any information that should be included on all requests sent to the other system that have a payload/body.|
-| global\_request -> uriOptions | Optional. Defines any information that should be sent as untranslated  query options (e.g. page, size) on all requests to the other system.|
-| global\_request -> addlHeaders | Optioonal. Defines any headers that should be sent on all requests to the other system.|
-| global\_request -> authData | Optional. Defines any additional authentication data used to authentice with the other system. This authData needs to be consistent on every request.|
-| healthcheck\_on\_timeout | Required. Defines if the adapter should run a health check on timeout. If set to true, the adapter will abort the request and run a health check until it re-establishes connectivity and then it will re-attempt the request.|
-| return\_raw | Optional. Tells the adapter whether the raw response should be returned as well as the IAP response. This is helpful when running integration tests to save mock data. It does add overhead to the response object so it is not ideal from production.|
-| archiving | Optional flag. Default is false. It archives the request, the results and the various times (wait time, Efficientip_solidserver time and overall time) in the `adapterid_results` collection in MongoDB. Although archiving might be desirable, be sure to develop a strategy before enabling this capability. Consider how much to archive and what strategy to use for cleaning up the collection in the database so that it does not become too large, especially if the responses are large.|
-| return\_request | Optional flag. Default is false. Will return the actual request that is made including headers. This should only be used during debugging issues as there could be credentials in the actual request.|
-
-### SSL Properties
-
-The SSL section defines the properties utilized for ssl authentication with Efficientip_solidserver. SSL can work two different ways: set the `accept\_invalid\_certs` flag to true (only recommended for lab environments), or provide a `ca\_file`.
-
-| Property | Description |
-| ------- | ------- |
-| enabled | If SSL is required, set to true. |
-| accept\_invalid\_certs | Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.|
-| ca\_file | Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.|
-| key\_file | Defines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL.|
-| cert\_file | Defines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL.|
-| secure\_protocol | Defines the protocol (e.g., SSLv3_method) to use on the SSL request.|
-| ciphers | Required if SSL enabled. Specifies a list of SSL ciphers to use.|
-| ecdhCurve | During testing on some Node 8 environments, you need to set `ecdhCurve` to auto. If you do not, you will receive PROTO errors when attempting the calls. This is the only usage of this property and to our knowledge it only impacts Node 8 and 9. |
-
-### Throttle Properties
-
-The throttle section is used when requests to Efficientip_solidserver must be queued (throttled). All of the properties in this section are optional.
-
-| Property | Description |
-| ------- | ------- |
-| throttle\_enabled | Default is false. Defines if the adapter should use throttling o rnot. |
-| number\_pronghorns | Default is 1. Defines if throttling is done in a single Itential instance or whether requests are being throttled across multiple Itential instances (minimum = 1, maximum = 20). Throttling in a single Itential instance uses an in-memory queue so there is less overhead. Throttling across multiple Itential instances requires placing the request and queue information into a shared resource (e.g. database) so that each instance can determine what is running and what is next to run. Throttling across multiple instances requires additional I/O overhead.|
-| sync-async | This property is not used at the current time (it is for future expansion of the throttling engine).|
-| max\_in\_queue | Represents the maximum number of requests the adapter should allow into the queue before rejecting requests (minimum = 1, maximum = 5000). This is not a limit on what the adapter can handle but more about timely responses to requests. The default is currently 1000.|
-| concurrent\_max | Defines the number of requests the adapter can send to Efficientip_solidserver at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to Efficientip_solidserver in a serial manner. |
-| expire\_timeout | Default is 0. Defines a graceful timeout of the request session. After a request has completed, the adapter will wait additional time prior to sending the next request. Measured in milliseconds (minimum = 0, maximum = 60000).|
-| average\_runtime | Represents the approximate average of how long it takes Efficientip_solidserver to handle each request. Measured in milliseconds (minimum = 50, maximum = 60000). Default is 200. This metric has performance implications. If the runtime number is set too low, it puts extra burden on the CPU and memory as the requests will continually try to run. If the runtime number is set too high, requests may wait longer than they need to before running. The number does not need to be exact but your throttling strategy depends heavily on this number being within reason. If averages range from 50 to 250 milliseconds you might pick an average run-time somewhere in the middle so that when Efficientip_solidserver performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently.|
-| priorities | An array of priorities and how to handle them in relation to the throttle queue. Array of objects that include priority value and percent of queue to put the item ex { value: 1, percent: 10 }|
-
-### Proxy Properties
-
-The proxy section defines the properties to utilize when Efficientip_solidserver is behind a proxy server.
-
-| Property | Description |
-| ------- | ------- |
-| enabled | Required. Default is false. If Efficientip_solidserver is behind a proxy server, set enabled flag to true. |
-| host | Host information for the proxy server. Required if `enabled` is true.|
-| port | Port information for the proxy server. Required if `enabled` is true.|
-| protocol | The protocol (i.e., http, https, etc.) used to connect to the proxy. Default is http.|
-| username | If there is authentication for the proxy, provide the username here.|
-| password | If there is authentication for the proxy, provide the password here.|
-
-### Mongo Properties
-
-The mongo section defines the properties used to connect to a Mongo database. Mongo can be used for throttling as well as to persist metric data. If not provided, metrics will be stored in the file system.
-
-| Property | Description |
-| ------- | ------- |
-| host | Optional. Host information for the mongo server.|
-| port | Optional. Port information for the mongo server.|
-| database | Optional. The database for the adapter to use for its data.|
-| username | Optional. If credentials are required to access mongo, this is the user to login as.|
-| password | Optional. If credentials are required to access mongo, this is the password to login with.|
-| replSet | Optional. If the database is set up to use replica sets, define it here so it can be added to the database connection.|
-| db\_ssl | Optional. Contains information for SSL connectivity to the database.|
-| db\_ssl -> enabled | If SSL is required, set to true.|
-| db\_ssl -> accept_invalid_cert | Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.|
-| db\_ssl -> ca_file | Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.|
-| db\_ssl -> key_file | Defines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL.|
-| db\_ssl -> cert_file | Defines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL.|
-
-## Testing an Itential Product Adapter
-
-Mocha is generally used to test all Itential Product 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 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.
-
-
-```bash
-node utils/testRunner --unit
-
-npm run test:unit
-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
-
-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 Efficientip_solidserver. 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.
-
-Similar to unit testing, there are two ways to run integration tests. Using the testRunner script is better because it prevents you from having to edit the test script; it will also resets information after testing is complete so that credentials are not saved in the file.
-
-```bash
-node utils/testRunner
-  answer no at the first prompt
-
-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 requires connectivity to Efficientip_solidserver. 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.
-
-> **Note**: These tests have been written as a best effort to make them work in most environments. However, the Adapter Builder often does not have the necessary information that is required to set up valid integration tests. For example, the order of the requests can be very important and data is often required for `creates` and `updates`. Hence, integration tests may have to be enhanced before they will work (integrate) with Efficientip_solidserver. Even after tests have been set up properly, it is possible there are environmental constraints that could result in test failures. Some examples of possible environmental issues are customizations that have been made within Efficientip_solidserver which change order dependencies or required data.
-
-```bash
-node utils/testRunner
-answer yes at the first prompt
-answer all other questions on connectivity and credentials
-```
-
-Test should also be written to clean up after themselves. However, it is important to understand that in some cases this may not be possible. In addition, whenever exceptions occur, test execution may be stopped, which will prevent cleanup actions from running. It is recommended that tests be utilized in dev and test labs only.
-
-> **Reminder**: Do not check in code with actual credentials to systems.
-
-## Adapter Node Scripts
-
-There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Each of these scripts are described below.
-
-| Run | Description |
-| ------- | ------- |
-| npm run adapter:install | Provides an easier way to install the adapter.|
-| npm run adapter:checkMigrate | Checks whether your adapter can and should be migrated to the latest foundation.|
-| npm run adapter:findPath | Can be used to see if the adapter supports a particular API call.|
-| npm run adapter:migrate | Provides an easier way to migrate your adapter after you download the migration zip from Itential DevSite|
-| npm run adapter:update | Provides an easier way to update your adapter after you download the migration zip from Itential DevSite|
-| npm run adapter:revert | Allows you to revert after a migration or update if it resulted in issues.|
-| npm run troubleshoot | Provides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get.|
-| npm run connectivity | Provides a connectivity check to the Efficientip_solidserver system.|
-| npm run healthcheck | Checks whether the configured healthcheck call works to Efficientip_solidserver.|
-| npm run basicget | Checks whether the basic get calls works to Efficientip_solidserver.|
-
-## Installing an Itential Product Adapter
-
-If you have App-Artifact installed in IAP, you can follow the instruction for that application to install the adapter into IAP. If not, follow these instructions.
+### How to Install
 
 1. Set up the name space location in your IAP node_modules.
 
 ```bash
-cd /opt/pronghorn/current/node_modules
+cd /opt/pronghorn/current/node_modules (* could be in a different place)
 if the @itentialopensource directory does not exist, create it:
-   mkdir @itentialopensource
+    mkdir @itentialopensource
 ```
 
-2. Clone the adapter into your IAP environment.
+2. Clone/unzip/tar the adapter into your IAP environment.
 
 ```bash
 cd \@itentialopensource
 git clone git@gitlab.com:\@itentialopensource/adapters/adapter-efficientip_solidserver
+or
+unzip adapter-efficientip_solidserver.zip
+or
+tar -xvf adapter-efficientip_solidserver.tar
 ```
 
 3. Run the adapter install script.
 
 ```bash
 cd adapter-efficientip_solidserver
-npm run adapter:install
+npm install
+npm run lint:errors
+npm run test
 ```
 
 4. Restart IAP
@@ -434,254 +190,157 @@ npm run adapter:install
 systemctl restart pronghorn
 ```
 
-## Installing a Custom Adapter
-
-If you built this as a custom adapter through the Adapter Builder, it is recommended you go through setting up a development environment and testing the adapter before installing it. There is often configuration and authentication work that is required before the adapter will work in IAP.
-
-1. Move the adapter into the IAP `node_modules` directory.
-
-```text
-Depending on where your code is located, this process is different.
-    Could be a tar, move, untar
-    Could be a git clone of a repository
-    Could also be a cp -R from a coding directory
-Adapter should be placed into: /opt/pronghorn/current/node_modules/\@itentialopensource
-```
-
-2. Follow Steps 3-4 (above) to install an Itential adapter to load your properties, dependencies and restart IAP.
-
-## Using this Adapter
-
-The `adapter.js` file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.
-
-### Generic Adapter Calls
+5. Create an adapter service instance configuration in IAP Admin Essentials GUI
 
-The `connect` call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.
-```js
-connect()
-```
+6. Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
 
-The `healthCheck` call ensures that the adapter can communicate with Efficientip_solidserver. The actual call that is used is defined in the adapter properties.
-```js
-healthCheck(callback)
-```
+7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
-The `refreshProperties` call provides the adapter the ability to accept property changes without having to restart the adapter.
-```js
-refreshProperties(properties)
-```
 
-The `encryptProperty` call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Efficientip_solidserver.
-```js
-encryptProperty(property, technique, callback)
-```
+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:
 
-The `addEntityCache` call will take the entities and add the list to the entity cache to expedite performance.
-```js
-addEntityCache(entityType, entities, key, callback)
-```
-
-The `capabilityResults` call will take the results from a verifyCompatibility and put them in the format to be passed back to the Itential Platform.
-```js
-capabilityResults(results, callback)
-```
-
-The `hasEntity` call verifies the adapter has the specific entity.
-```js
-hasEntity(entityType, entityId, callback)
-```
-
-The `verifyCapability` call verifies the adapter can perform the provided action on the specific entity.
-```js
-verifyCapability(entityType, actionType, entityId, callback)
-```
-
-The `updateEntityCache` call will update the entity cache.
-```js
-updateEntityCache()
-```
-
-The `updateAdapterConfiguration` call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.
-```js
-updateAdapterConfiguration(configFile, changes, entity, type, action, callback)
-```
-
-The `suspend` call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.
-```js
-suspend(mode, callback)
-```
-
-The `unsuspend` call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.
-```js
-unsuspend(callback)
-```
-
-The `findPath` call provides the ability to see if a particular API path is supported by the adapter.
-```js
-findPath(apiPath, callback)
-```
-
-The `troubleshoot` call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.
-```js
-troubleshoot(props, persistFlag, adapter, callback)
-```
-
-The `runHealthcheck` call will return the results of a healthcheck.
-```js
-runHealthcheck(adapter, callback)
-```
-
-The `runConnectivity` call will return the results of a connectivity check.
-```js
-runConnectivity(callback)
-```
-
-The `runBasicGet` call will return the results of running basic get API calls.
-```js
-runBasicGet(callback)
-```
-
-The `getQueue` call will return the requests that are waiting in the queue if throttling is enabled.
-```js
-getQueue(callback)
-```
-
-### Specific Adapter Calls
-
-Specific adapter calls are built based on the API of the Efficientip_solidserver. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.
-
-
-## Extending/Enhancing the Adapter
-
-### Adding a Second Instance of an Adapter
-
-You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances of the other system. For example, they should be configured to talk to different hosts.
-
-### Adding Adapter Calls
-
-There are multiple ways to add calls to an existing adapter.
-
-The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file simple put it in the adapter direcctory and execute `npm run adapter:update`.
+3. Install adapter dependencies and check the adapter.
 
 ```bash
-mv updatePackage.zip adapter-efficientip_solidserver
 cd adapter-efficientip_solidserver
-npm run adapter:update
+npm run adapter:install
 ```
 
-If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.
-
-If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the Adapter Technical Resources on Dev Site [HERE](https://developer.itential.io/adapters-resources/)
+4. Restart IAP
 
-```text
-Files to update
-* entities/<entity>/action.json: add an action
-* entities/<entity>/schema.json (or the schema defined on the action): add action to the enum for ph_request_type
-* adapter.js: add the new method and make sure it calls the proper entity and action
-* pronghorn.json: add the new method
-* test/unit/adapterTestUnit.js (optional but best practice): add unit test(s) - function is there, any required parameters error when not passed in
-* test/integration/adapterTestIntegration.js (optional but best practice): add integration test
+```bash
+systemctl restart pronghorn
 ```
 
-### Adding Adapter Properties
+5. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
-While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
 
-```text
-Files to update
-* propertiesSchema.json: add the new property and how it is defined
-* sampleProperties: add the new property with a default value
-* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
-* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
-```
-
-### Changing Adapter Authentication
+### Testing
 
-Often an adapter is built before knowing the authentication and authentication process can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.
+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.
 
-```text
-Files to update
-* entities/<entity>/action.json: change the getToken action as needed
-* entities/<entity>/schemaTokenReq.json: add input parameters (external name is name in other system)
-* entities/<entity>/schemaTokenResp.json: add response parameters (external name is name in other system)
-* propertiesSchema.json: add any new property and how it is defined
-* sampleProperties: add any new property with a default value
-* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
-* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
-```
+#### Unit Testing
 
-### Enhancing Adapter Integration Tests
+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.
 
-The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.
+```bash
+node utils/testRunner --unit
 
-```text
-Files to update
-* test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.
+npm run test:unit
+npm run test:baseunit
 ```
 
-As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the Adapter Technical Resources on Dev Site [HERE](https://developer.itential.io/adapters-resources/)
-
-## Troubleshooting the Adapter
-
-Run `npm run troubleshoot` to start the interactive troubleshooting process. The command allows user to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.
-
-User also have the option to run individual command to perform specific test
+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.
 
-- `npm run healthcheck` will perform a healthcheck request of with current setting.
-- `npm run basicget` will perform some non-parameter GET request with current setting.
-- `npm run connectivity` will perform networking diagnostics of the adatper endpoint.
+#### Integration Testing - Standalone
 
-### Connectivity Issues
+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 Efficientip_solidserver. 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.
 
-1. You can run the adapter troubleshooting script which will check connectivity, run the healthcheck and run basic get calls.
+Similar to unit testing, there are two ways to run integration tests. Using the testRunner script is better because it prevents you from having to edit the test script; it will also resets information after testing is complete so that credentials are not saved in the file.
 
 ```bash
-npm run troubleshoot
-```
-
-2. Verify the adapter properties are set up correctly.
+node utils/testRunner
+  answer no at the first prompt
 
-```text
-Go into the Itential Platform GUI and verify/update the properties
+npm run test:integration
 ```
 
-3. Verify there is connectivity between the Itential Platform Server and Efficientip_solidserver Server.
-
-```text
-ping the ip address of Efficientip_solidserver server
-try telnet to the ip address port of Efficientip_solidserver
-```
+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.
 
-4. Verify the credentials provided for Efficientip_solidserver.
+#### Integration Testing
 
-```text
-login to Efficientip_solidserver using the provided credentials
-```
+Integration Testing requires connectivity to Efficientip_solidserver. 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.
 
-5. Verify the API of the call utilized for Efficientip_solidserver Healthcheck.
+> **Note**: These tests have been written as a best effort to make them work in most environments. However, the Adapter Builder often does not have the necessary information that is required to set up valid integration tests. For example, the order of the requests can be very important and data is often required for `creates` and `updates`. Hence, integration tests may have to be enhanced before they will work (integrate) with Efficientip_solidserver. Even after tests have been set up properly, it is possible there are environmental constraints that could result in test failures. Some examples of possible environmental issues are customizations that have been made within Efficientip_solidserver which change order dependencies or required data.
 
-```text
-Go into the Itential Platform GUI and verify/update the properties
+```bash
+node utils/testRunner
+answer yes at the first prompt
+answer all other questions on connectivity and credentials
 ```
 
-### Functional Issues
-
-Adapter logs are located in `/var/log/pronghorn`. In older releases of the Itential Platform, there is a `pronghorn.log` file which contains logs for all of the Itential Platform. In newer versions, adapters are logging into their own files.
-
-## Contributing to Efficientip_solidserver
-
-Please check out the [Contributing Guidelines](./CONTRIBUTING.md).
+Test should also be written to clean up after themselves. However, it is important to understand that in some cases this may not be possible. In addition, whenever exceptions occur, test execution may be stopped, which will prevent cleanup actions from running. It is recommended that tests be utilized in dev and test labs only.
 
-## License & Maintainers
+> **Reminder**: Do not check in code with actual credentials to systems.
 
-### Maintained By
+## [Configuration](./PROPERTIES.md)
+
+## [Using this Adapter](./CALLS.md)
+
+### [Authentication](./AUTH.md)
+
+## Additional Information
+
+### [Enhancements](./ENHANCE.md)
+
+### [Contributing](./CONTRIBUTING.md)
+
+### Helpful Links
+
+<a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a>
+
+### 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.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Run</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run adapter:install</td>
+    <td style="padding:15px">Provides an easier way to install the adapter.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run adapter:checkMigrate</td>
+    <td style="padding:15px">Checks whether your adapter can and should be migrated to the latest foundation.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run adapter:findPath</td>
+    <td style="padding:15px">Can be used to see if the adapter supports a particular API call.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run adapter:migrate</td>
+    <td style="padding:15px">Provides an easier way to update your adapter after you download the migration zip from Itential DevSite.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run adapter:update</td>
+    <td style="padding:15px">Provides an easier way to update your adapter after you download the update zip from Itential DevSite.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run adapter:revert</td>
+    <td style="padding:15px">Allows you to revert after a migration or update if it resulted in issues.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run troubleshoot</td>
+    <td style="padding:15px">Provides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run connectivity</td>
+    <td style="padding:15px">Provides a connectivity check to the Efficientip_solidserver system.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run healthcheck</td>
+    <td style="padding:15px">Checks whether the configured healthcheck call works to Efficientip_solidserver.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run basicget</td>
+    <td style="padding:15px">Checks whether the basic get calls works to Efficientip_solidserver.</td>
+  </tr>
+</table>
+<br>
+
+## [Troubleshoot](./TROUBLESHOOT.md)
+
+## License and Maintainers
 
 ```text
-Itential Product Adapters are maintained by the Itential Adapter Team.
-Itential OpenSource Adapters are maintained by the community at large.
+Itential Product Adapters are maintained by the Itential Product Team.
+Itential OpenSource Adapters are maintained by the Itential Adapter Team and the community at large.
 Custom Adapters are maintained by other sources.
 ```
 
-### Product License
+## Product License
 
 [Apache 2.0](./LICENSE)