@itentialopensource/adapter-att_mobility 0.1.2 → 0.2.0

package/.eslintignore

@@ -1,4 +1,3 @@
-
 .nyc_output/*
 backup/*
 coverage/*

package/.jshintrc

@@ -0,0 +1,3 @@
+{
+  "esversion": 6
+}

package/AUTH.md

@@ -1,31 +1,27 @@
-## Authenticating Attmobility Adapter 
+## Authenticating ATT Mobility Adapter 
 
-This document will go through the steps for authenticating the Attmobility adapter with Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>. 
+This document will go through the steps for authenticating the ATT Mobility adapter with the authentication methods we have worked with in the past. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>.
+
+Companies periodically change authentication methods to provide better security. As this happens this section should be updated and contributed/merge back into the adapter repository.
 
 ### Basic Authentication
-The Attmobility adapter requires Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
+The ATT Mobility adapter authenticates with a basic authentication.
 
 STEPS  
-1. Ensure you have access to a Attmobility server and that it is running
+1. Ensure you have access to a ATT Mobility server and that it is running
 2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
 3. Use the properties below for the ```properties.authentication``` field
 ```json
 "authentication": {
   "auth_method": "basic user_password",
-  "username": "<username>",
-  "password": "<password>",
-  "token": "",
-  "token_timeout": 1800000,
-  "token_cache": "local",
-  "invalid_token_error": 401,
+  "username": "<your username>",
+  "password": "<your password>",
   "auth_field": "header.headers.Authorization",
   "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
-  "auth_logging": false,
-  "client_id": "",
-  "client_secret": "",
-  "grant_type": ""
+  "auth_logging": false
 }
 ```
+you can leave all of the other properties in the authentication section, they will not be used when the auth_method is basic user_password.
 4. Restart the adapter. If your properties were set correctly, the adapter should go online. 
 
 ### Troubleshooting
@@ -36,4 +32,5 @@ STEPS
   - The FULL REQUEST log to make sure the proper headers are being sent with the request.
   - The FULL BODY log to make sure the payload is accurate.
   - The CALL RETURN log to see what the other system is telling us.
+- Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
 - Remember when you are done to turn auth_logging off as you do not want to log credentials.

package/BROKER.md

@@ -1,9 +1,9 @@
-## Integrating Attmobility Adapter with IAP Device Broker
+## Integrating AttMobility Adapter with IAP Device Broker
 
-This document will go through the steps for integrating the Attmobility adapter with IAP's Device Broker. IAP Device Broker integration allows for easier interation into several of IAPs applications (e.g. Configuration Manager). Properly configuring the properties for the adapter in IAP is critical for getting the device broker integration to work. Their is additional information in the configuration section of the adapter readme. This document will go through each of the calls that are utilized by the Device Broker.
+This document will go through the steps for integrating the AttMobility adapter with IAP's Device Broker. IAP Device Broker integration allows for easier interation into several of IAPs applications (e.g. Configuration Manager). Properly configuring the properties for the adapter in IAP is critical for getting the device broker integration to work. Their is additional information in the configuration section of the adapter readme. This document will go through each of the calls that are utilized by the Device Broker.
 
 ### getDevicesFiltered
-getDevicesFiltered(options, callback) → This call returns all of the devices within Attmobility that match the provided filter.
+getDevicesFiltered(options, callback) → This call returns all of the devices within AttMobility that match the provided filter.
 
 #### input
 

package/CALLS.md

@@ -19,7 +19,7 @@ These are adapter methods that IAP or you might use. There are some other method
   </tr>
   <tr>
     <td style="padding:15px">healthCheck(callback)</td>
-    <td style="padding:15px">This call ensures that the adapter can communicate with Attmobility. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
+    <td style="padding:15px">This call ensures that the adapter can communicate with Adapter for AT&T Mobility. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
     <td style="padding:15px">No</td>
   </tr>
   <tr>
@@ -29,7 +29,7 @@ These are adapter methods that IAP or you might use. There are some other method
   </tr>
   <tr>
     <td style="padding:15px">encryptProperty(property, technique, callback)</td>
-    <td style="padding:15px">This 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 Attmobility.</td>
+    <td style="padding:15px">This 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 Adapter for AT&T Mobility.</td>
     <td style="padding:15px">No</td>
   </tr>
   <tr>
@@ -37,11 +37,6 @@ These are adapter methods that IAP or you might use. There are some other method
     <td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
     <td style="padding:15px">Yes</td>
   </tr>
-  <tr>
-    <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
-    <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
-    <td style="padding:15px">Yes</td>
-  </tr>
   <tr>
     <td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
     <td style="padding:15px">This 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.</td>
@@ -57,12 +52,16 @@ These are adapter methods that IAP or you might use. There are some other method
     <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
+    <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
   <tr>
     <td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
     <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
     <td style="padding:15px">Yes</td>
   </tr>
-
   <tr>
     <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
     <td style="padding:15px">This call will return the results of a healthcheck.</td>
@@ -83,6 +82,21 @@ These are adapter methods that IAP or you might use. There are some other method
     <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
+    <td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapActivateTasks(tasks, callback)</td>
+    <td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
+    <td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
   <tr>
     <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
     <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
@@ -94,19 +108,42 @@ These are adapter methods that IAP or you might use. There are some other method
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">iapHasAdapterEntity(entityType, entityId, callback)</td>
-    <td style="padding:15px">This call verifies the adapter has the specific entity.</td>
-    <td style="padding:15px">No</td>
+    <td style="padding:15px">iapRunAdapterLint(callback)</td>
+    <td style="padding:15px">Runs lint on the addapter and provides the information back.</td>
+    <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">iapVerifyAdapterCapability(entityType, actionType, entityId, callback)</td>
-    <td style="padding:15px">This call verifies the adapter can perform the provided action on the specific entity.</td>
-    <td style="padding:15px">No</td>
+    <td style="padding:15px">iapRunAdapterTests(callback)</td>
+    <td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
+    <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">iapUpdateAdapterEntityCache()</td>
-    <td style="padding:15px">This call will update the entity cache.</td>
-    <td style="padding:15px">No</td>
+    <td style="padding:15px">iapGetAdapterInventory(callback)</td>
+    <td style="padding:15px">This call provides some inventory related information about the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>
+  
+### Adapter Cache Calls
+
+These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td>
+    <td style="padding:15px">This call populates the adapter cache.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
+    <td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
+    <td style="padding:15px">Yes</td>
   </tr>
 </table>
 <br>
@@ -129,32 +166,31 @@ These are adapter methods that are used to integrate to IAP Brokers. This adapte
   <tr>
     <td style="padding:15px">getDevice(deviceName, callback)</td>
     <td style="padding:15px">This call returns the details of the requested device.</td>
-    <td style="padding:15px">Yes</td>
+    <td style="padding:15px">No</td>
   </tr>
   <tr>
     <td style="padding:15px">getDevicesFiltered(options, callback)</td>
     <td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
-    <td style="padding:15px">Yes</td>
+    <td style="padding:15px">No</td>
   </tr>
   <tr>
     <td style="padding:15px">isAlive(deviceName, callback)</td>
     <td style="padding:15px">This call returns whether the device status is active</td>
-    <td style="padding:15px">Yes</td>
+    <td style="padding:15px">No</td>
   </tr>
   <tr>
     <td style="padding:15px">getConfig(deviceName, format, callback)</td>
     <td style="padding:15px">This call returns the configuration for the selected device.</td>
-    <td style="padding:15px">Yes</td>
+    <td style="padding:15px">No</td>
   </tr>
   <tr>
     <td style="padding:15px">iapGetDeviceCount(callback)</td>
     <td style="padding:15px">This call returns the count of devices.</td>
-    <td style="padding:15px">Yes</td>
+    <td style="padding:15px">No</td>
   </tr>
 </table>
 <br>
 
-
 ### Specific Adapter Calls
 
 Specific adapter calls are built based on the API of the Attmobility. 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.

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.2.0 [09-26-2023]
+
+* Adapter Engine has been updated and the changes are being migrated to the adapter
+
+See merge request itentialopensource/adapters/inventory/adapter-att_mobility!3
+
+---
+
 ## 0.1.2 [11-09-2022]
 
 * QOS-109

package/CONTRIBUTING.md

@@ -10,163 +10,4 @@ This project and everyone participating in it is governed by the Code of Conduct
 
 ## How to Contribute
 
-### Reporting Bugs
-
-This section guides you through submitting a bug report. Following these guidelines helps maintainers understand your report :pencil:, reproduce the behavior :computer: :left_right_arrow: :computer:, and find related reports :mag_right:.
-
-Before creating bug reports, please check before-submitting-a-bug-report, as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. If you have an Itential support contract, please create an Itential Service Desk ticket. If you don't have an Itential support contract, please send an email of the issue to support@itential.com.
-
-#### Before Submitting A Bug Report
-
-* **Check the README.md.** You might be able to find the cause of the problem and fix things yourself. Most importantly, check if you can reproduce the problem __in the latest version__.
-* **Work through the troubleshooting process.** Troubleshooting will include changing the log level of Itential Automation Platform (IAP) and adapters and checking the logs to see what the issues are. These logs should be included in any ticket you open for this issue.
-* **Check for resolutions to the issue.** Check the <a href="https://itential.atlassian.net/servicedesk/customer/kb/view/286883841?applicationId=605994d2-2cb2-3174-af59-ed5b23ff5fd5&spaceKey=PKB&src=1187380921" target="_blank">Itential Knowledge Base</a> to see if there is a known resolution for the issue you are having.
-* **Ask around in chat if you are an Itential employee** to see if others are experiencing the same issue.
-
-#### How to Submit a (Good) Bug Report
-
-Bugs are tracked through the Itential Service Desk. Explain the problem and include additional details to help maintainers reproduce the problem:
-
-- **Use a clear and descriptive title** for the issue to identify the problem.
-- **Describe the exact steps which reproduce the problem** in as much detail as possible. For example, start by explaining how you configured the adapter (e.g., which properties you used and how they were set) or how you are using an artifact.
-- **Provide specific examples to demonstrate the steps**. Include logs, or copy/paste snippets, in your examples.
-- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
-- **Explain which behavior you expected to see instead and why.**
-- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. You can use <a href="https://www.cockos.com/licecap/" target="_blank">this tool</a> to record GIFs on macOS and Windows. Use <a href="https://github.com/colinkeenan/silentcast" target="_blank">this tool</a> or <a href="https://github.com/rhcarvalho/byzanz-guiz" target="_blank">program</a> on Linux.
-- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
-
-Provide more context by answering these questions:
-
-- **Did the problem start happening recently** (e.g. after updating to a new version/tag) or was this always a problem?
-- If the problem started happening recently, **can you reproduce the problem in an older version/tag?** What's the most recent version in which the problem does not happen?
-- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
-
-Include details about your configuration and environment:
-
-- **Which version of the adapter/artifact are you using?** You can get the exact version by checking the project version in the package.json file.
-- **What's the name and version of the OS you're using**?
-- **Are you running or using IAP in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and guest?
-- **Are there firewalls between IAP and any other system you are integrating with?** If so, have you tried running curl from the system IAP is on to the other system to verify you have connectivity between the systems?
-
-### Your First Code Contribution
-
-#### Local development
-
-This project can be developed locally on all operating systems. For instructions on how to do this, follow the steps highlighted in the README.md. The README.mdprovides many more details on cloning the repository for local development, how to lint and test your changes. 
-
-#### Development Process
-
-The following provides a local copy of the repository along with dependencies.
-
-```json
-go to the repository you are interested in working on
-click on the Clone button to get the link(s) you can use to clone the repository
-git clone <link to clone the project>
-npm install
-```
-
-Prior to making changes you should create a branch to work in. The branch should be named with the type of change (major, minor or patch) and then a Jira issue number or a description of the issue.
-
-```json
-git checkout -b <name_of_your_new_branch>
-```
-
-Make all of the desired changes.
-
-> **Note:** All code changes should be accompanied by additional Unit and Integration tests to minimize the likelihood that any changes will negatively impact the adapter/artifact as well as to ensure the desired functionality is achieved.
-
-
-<table border="1" class="bordered-table">
-  <tr>
-    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Files</span></th>
-    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Changes</span></th>
-  </tr>
-  <tr>
-    <td style="padding:15px">.codeclimate.yml, .eslintignore, .eslintrc.js, .gitignore, .gitlab-ci.yml, .jshintrc, .npmignore</td>
-    <td style="padding:15px">These are foundational files that are used in linting and building of the adapter. Changes to these files are heavily scrutinized and may be implemented in a different manner so that the changes can be implemented across all adapters.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE, README.md</td>
-    <td style="padding:15px">These are license and process files for the repository. Changes to these files may require legal review and may also be implemented in a different manner so that the changes can be implemented across all adapters.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">utils/*, adapterBase.js</td>
-    <td style="padding:15px">Changes to these files will rarely be accepted. These are process files that need to be changed through the builder process and migration.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">adapter.js</td>
-    <td style="padding:15px">Changes to this file are code changes. They should be accompanied by the appropriate unit and integration tests. If new methods are added, they should also be added to the pronghorn.json file, otherwise integration tests are likely to fail.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">error.json, propertiesSchema.json</td>
-    <td style="padding:15px">These files are utilized by the Itential Runtime libraries. You can make changes to these files, but the changes should be appending of new errors or properties. Removal of errors and properties can result in rejection of the changes.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">pacakge.json, package-lock.json</td>
-    <td style="padding:15px">The package-lock.json is automatically generated and should only be updated when the dependencies inside of the package.json are modified. You can make changes to the package.json to add additional scripts, add new dependencies, modify names, etc. However, changing the scripts or dependencies that are Itential specific will be overriden during the acceptance process.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">pronghorn.json</td>
-    <td style="padding:15px">Changes to this file are made for integration into IAP. The most common change here is adding new methods that shoud be exposed to the IAP Workflow.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">entities/*</td>
-    <td style="padding:15px">Changes to these files include adding new capabilities, updating existing capabilities, or removing deprecated capabilities in the adapter. Translation configuration can also be modified here.</td>
-  </tr>
-  <tr>
-    <td style="padding:15px">test/*</td>
-    <td style="padding:15px">Changes to these files include adding, updating, or removing unit and integration tests in the adapter. Tests should never be removed unless the methods that are being tested are removed also. Both the unit and integration test file should have a marker that identifies where modification can take place. Modifications above that marker are likely to be rejected or implemented in a different manner.</td>
-  </tr>
-</table>
-<br>
-
-> **Note:** It is a best practice to lint and test your code prior to committing changes into the repository. You can lint your code by running **npm run lint** and test it by running **node utils/testRunner.sh**. However, there are pre-commit hooks that will run these scripts when you commit your changes.
-
-Commit the changes to the repository.
-
-```json
-git commit -a -m "<descriptive message>" 
-```
-
-> **Note:** There are pre-commit hooks in place. If the pre-commit hooks fail, you will need to address those issues before moving forward.
-
-Push the changes into the repository. This should only be done after the commit has successfully completed.
-
-```json
-git push origin <name_of_your_new_branch>
-```
-
-Create a Merge Request.
-
-### Merge Requests
-
-- Fill out the provided merge request template.
-- Reference related issues and merge requests liberally.
-- Include screenshots and animated GIFs in your merge request whenever possible.
-- Follow the project Styleguide.
-- End all files with a newline.
-
-## Styleguide
-
-### Git Commit Messages
-
-- Use the present tense ("Add feature" not "Added feature")
-- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
-- Consider starting the commit message with an applicable emoji _(not required)_:
-  - :art: `:art:` When improving the format/structure of the code.
-  - :racehorse: `:racehorse:` When improving performance
-  - :non-potable_water: `:non-potable_water:` When plugging memory leaks.
-  - :memo: `:memo:` When writing documentation.
-  - :penguin: `:penguin:` When fixing something on Linux.
-  - :apple: `:apple:` When fixing something on macOS.
-  - :checkered_flag: `:checkered_flag:` When fixing something on Windows.
-  - :bug: `:bug:` When fixing a bug.
-  - :fire: `:fire:` When removing code or files.
-  - :green_heart: `:green_heart:` When fixing the CI build.
-  - :white_check_mark: `:white_check_mark:` When adding tests,
-  - :lock: `:lock:` When dealing with security.
-  - :arrow_up: `:arrow_up:` When upgrading dependencies.
-  - :arrow_down: `:arrow_down:` When downgrading dependencies.
-  - :shirt: `:shirt:` When removing linter warnings.
-
-__Avoid installing unnecessary packages.__ Do not install packages just because they might be "nice to have". Itential Opensource projects are supposed to be minimal, specific, and compact by design.
+Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]

package/ENHANCE.md

@@ -11,14 +11,14 @@ 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 simply put it in the adapter directory and execute `npm run adapter:update`.
 
 ```bash
-mv updatePackage.zip adapter-attmobility
-cd adapter-attmobility
+mv updatePackage.zip adapter-att_mobility
+cd adapter-att_mobility
 npm run adapter:update
 ```
 
 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 <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/" target="_blank">Adapter Technical Resources</a> on Dev Site.
+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 <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.
 
 ```text
 Files to update
@@ -66,4 +66,4 @@ Files to update
 * test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.
 ```
 
-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 <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/" target="_blank">Adapter Technical Resources</a> on Dev Site.
+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 <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.

package/PROPERTIES.md

@@ -164,7 +164,7 @@ This section defines **all** the properties that are available for the adapter,
 
 ### Connection Properties
 
-These base properties are used to connect to Attmobility upon the adapter initially coming up. It is important to set these properties appropriately.
+These base properties are used to connect to AttMobility upon the adapter initially coming up. It is important to set these properties appropriately.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -205,7 +205,7 @@ These base properties are used to connect to Attmobility upon the adapter initia
   </tr>
   <tr>
     <td style="padding:15px">stub</td>
-    <td style="padding:15px">Optional. Indicates whether the stub should run instead of making calls to Attmobility (very useful during basic testing). Default is false (which means connect to Attmobility).</td>
+    <td style="padding:15px">Optional. Indicates whether the stub should run instead of making calls to AttMobility (very useful during basic testing). Default is false (which means connect to AttMobility).</td>
   </tr>
   <tr>
     <td style="padding:15px">protocol</td>
@@ -218,9 +218,9 @@ A connectivity check tells IAP the adapter has loaded successfully.
 
 ### Authentication Properties
 
-The following properties are used to define the authentication process to Attmobility.
+The following properties are used to define the authentication process to AttMobility.
 
->**Note**: Depending on the method that is used to authenticate with Attmobility, you may not need to set all of the authentication properties.
+>**Note**: Depending on the method that is used to authenticate with AttMobility, you may not need to set all of the authentication properties.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -233,11 +233,11 @@ The following properties are used to define the authentication process to Attmob
   </tr>
   <tr>
     <td style="padding:15px">username</td>
-    <td style="padding:15px">Used to authenticate with Attmobility on every request or when pulling a token that will be used in subsequent requests.</td>
+    <td style="padding:15px">Used to authenticate with AttMobility on every request or when pulling a token that will be used in subsequent requests.</td>
   </tr>
   <tr>
     <td style="padding:15px">password</td>
-    <td style="padding:15px">Used to authenticate with Attmobility on every request or when pulling a token that will be used in subsequent requests.</td>
+    <td style="padding:15px">Used to authenticate with AttMobility on every request or when pulling a token that will be used in subsequent requests.</td>
   </tr>
   <tr>
     <td style="padding:15px">token</td>
@@ -249,7 +249,7 @@ The following properties are used to define the authentication process to Attmob
   </tr>
   <tr>
     <td style="padding:15px">token_timeout</td>
-    <td style="padding:15px">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 Attmobility. 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.</td>
+    <td style="padding:15px">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 AttMobility. 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.</td>
   </tr>
   <tr>
     <td style="padding:15px">token_cache</td>
@@ -293,11 +293,11 @@ The following properties are used to define the authentication process to Attmob
 
 ### Healthcheck Properties
 
-The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach Attmobility. There are currently three types of healthchecks.
+The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach AttMobility. 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 Attmobility.
+- None - Not recommended. Adapter will not run a healthcheck. Consequently, unable to determine before making a request if the adapter can reach AttMobility.
 - Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
-- Intermittent - Adapter will check connectivity to Attmobility at a frequency defined in the `frequency` property.
+- Intermittent - Adapter will check connectivity to AttMobility at a frequency defined in the `frequency` property.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -346,7 +346,7 @@ The request section defines properties to help handle requests.
   </tr>
   <tr>
     <td style="padding:15px">attempt_timeout</td>
-    <td style="padding:15px">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 Attmobility, and then will re-attempt the request that aborted. Default is 5000 milliseconds.</td>
+    <td style="padding:15px">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 AttMobility, and then will re-attempt the request that aborted. Default is 5000 milliseconds.</td>
   </tr>
   <tr>
     <td style="padding:15px">global_request</td>
@@ -378,7 +378,7 @@ The request section defines properties to help handle requests.
   </tr>
   <tr>
     <td style="padding:15px">archiving</td>
-    <td style="padding:15px">Optional flag. Default is false. It archives the request, the results and the various times (wait time, Attmobility 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.</td>
+    <td style="padding:15px">Optional flag. Default is false. It archives the request, the results and the various times (wait time, AttMobility 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.</td>
   </tr>
   <tr>
     <td style="padding:15px">return_request</td>
@@ -389,7 +389,7 @@ The request section defines properties to help handle requests.
 
 ### SSL Properties
 
-The SSL section defines the properties utilized for ssl authentication with Attmobility. SSL can work two different ways: set the `accept\_invalid\_certs` flag to true (only recommended for lab environments), or provide a `ca\_file`.
+The SSL section defines the properties utilized for ssl authentication with AttMobility. SSL can work two different ways: set the `accept\_invalid\_certs` flag to true (only recommended for lab environments), or provide a `ca\_file`.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -433,7 +433,7 @@ The SSL section defines the properties utilized for ssl authentication with Attm
 
 ### Throttle Properties
 
-The throttle section is used when requests to Attmobility must be queued (throttled). All of the properties in this section are optional.
+The throttle section is used when requests to AttMobility must be queued (throttled). All of the properties in this section are optional.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -458,7 +458,7 @@ The throttle section is used when requests to Attmobility must be queued (thrott
   </tr>
   <tr>
     <td style="padding:15px">concurrent_max</td>
-    <td style="padding:15px">Defines the number of requests the adapter can send to Attmobility at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to Attmobility in a serial manner.</td>
+    <td style="padding:15px">Defines the number of requests the adapter can send to AttMobility at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to AttMobility in a serial manner.</td>
   </tr>
   <tr>
     <td style="padding:15px">expire_timeout</td>
@@ -466,7 +466,7 @@ The throttle section is used when requests to Attmobility must be queued (thrott
   </tr>
   <tr>
     <td style="padding:15px">average_runtime</td>
-    <td style="padding:15px">Represents the approximate average of how long it takes Attmobility 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 Attmobility performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently.</td>
+    <td style="padding:15px">Represents the approximate average of how long it takes AttMobility 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 AttMobility performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently.</td>
   </tr>
   <tr>
     <td style="padding:15px">priorities</td>
@@ -477,7 +477,7 @@ The throttle section is used when requests to Attmobility must be queued (thrott
 
 ### Proxy Properties
 
-The proxy section defines the properties to utilize when Attmobility is behind a proxy server.
+The proxy section defines the properties to utilize when AttMobility is behind a proxy server.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -486,7 +486,7 @@ The proxy section defines the properties to utilize when Attmobility is behind a
   </tr>
   <tr>
     <td style="padding:15px">enabled</td>
-    <td style="padding:15px">Required. Default is false. If Attmobility is behind a proxy server, set enabled flag to true.</td>
+    <td style="padding:15px">Required. Default is false. If AttMobility is behind a proxy server, set enabled flag to true.</td>
   </tr>
   <tr>
     <td style="padding:15px">host</td>
@@ -573,7 +573,7 @@ The mongo section defines the properties used to connect to a Mongo database. Mo
 
 ### Device Broker Properties
 
-The device broker section defines the properties used integrate Attmobility to the device broker. Each broker call is represented and has an array of calls that can be used to build the response. This describes the calls and then the fields which are available in the calls.
+The device broker section defines the properties used integrate AttMobility to the device broker. Each broker call is represented and has an array of calls that can be used to build the response. This describes the calls and then the fields which are available in the calls.
 
 <table border="1" class="bordered-table">
   <tr>