npm - @itentialopensource/adapter-salesforce_rest - Versions diffs - 0.1.1 → 0.1.3 - Mend

@itentialopensource/adapter-salesforce_rest 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/CHANGELOG.md +16 -1
package/TAB1.md +10 -0
package/TAB2.md +320 -0
package/package.json +2 -2
package/refs?service=git-upload-pack +0 -0

package/CHANGELOG.md CHANGED Viewed

@@ -1,4 +1,20 @@
+## 0.1.3 [10-15-2024]
+* Changes made at 2024.10.14_18:28PM
+See merge request itentialopensource/adapters/adapter-salesforce_rest!2
+---
+## 0.1.2 [10-14-2024]
+* Changes made at 2024.10.14_15:03PM
+See merge request itentialopensource/adapters/adapter-salesforce_rest!1
+---
 ## 0.1.1 [10-10-2024]
 * Bug fixes and performance improvements
@@ -6,4 +22,3 @@
 See commit 9a52913
 ---

package/TAB1.md ADDED Viewed

@@ -0,0 +1,10 @@
+# Overview
+This adapter is used to integrate the Itential Automation Platform (IAP) with the Salesforce_rest System. The API that was used to build the adapter for Salesforce_rest is usually available in the report directory of this adapter. The adapter utilizes the Salesforce_rest API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
+## Details
+The Salesforce REST adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Salesforce using REST API. With this adapter you have the ability to perform operations such as:
+- Create, Update, or Delete a Record
+For further technical details on how to install and use this adapter, please click the Technical Documentation tab.

package/TAB2.md ADDED Viewed

@@ -0,0 +1,320 @@
+# Adapter for Salesforce REST
+## Table of Contents
+  - [Specific Adapter Information](#specific-adapter-information)
+    - [Authentication](#authentication)
+    - [Sample Properties](#sample-properties)
+    - [Swagger](#swagger)
+  - [Generic Adapter Information](#generic-adapter-information)
+## Specific Adapter Information
+### Authentication
+This document will go through the steps for authenticating the Salesforce REST adapter with OAuth 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://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>.
+#### OAuth Authentication
+The Salesforce REST adapter requires OAuth Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
+STEPS
+1. Ensure you have access to a Salesforce 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": "request_token",
+  "username": "username",
+  "password": "passwordsecretToken",
+  "token_timeout": 1800000,
+  "token_cache": "local",
+  "invalid_token_error": 401,
+  "auth_field": "header.headers.Authorization",
+  "auth_field_format": "Bearer {token}",
+  "client_id": "client_id",
+  "client_secret": "client_secret",
+  "grant_type": "password"
+}
+```
+4. Restart the adapter. If your properties were set correctly, the adapter should go online.
+#### Troubleshooting
+- Make sure you copied over the correct credentials.
+- Turn on debug level logs for the adapter in IAP Admin Essentials.
+- Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
+- Investigate the logs - in particular:
+  - 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 token.
+- Remember when you are done to turn auth_logging off as you do not want to log credentials.
+### Sample Properties
+Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
+```json
+  "properties": {
+    "host": "localhost",
+    "port": 443,
+    "choosepath": "",
+    "base_path": "/services",
+    "version": "",
+    "cache_location": "none",
+    "encode_pathvars": true,
+    "encode_queryvars": true,
+    "save_metric": false,
+    "stub": true,
+    "protocol": "https",
+    "authentication": {
+      "auth_method": "request_token",
+      "username": "username",
+      "password": "password",
+      "token": "token",
+      "token_timeout": 1800000,
+      "token_cache": "local",
+      "invalid_token_error": 401,
+      "auth_field": "header.headers.Authorization",
+      "auth_field_format": "Bearer {token}",
+      "auth_logging": false,
+      "client_id": "client_id",
+      "client_secret": "client_secret",
+      "grant_type": "password",
+      "sensitive": [],
+      "sso": {
+        "protocol": "",
+        "host": "",
+        "port": 0
+      },
+      "multiStepAuthCalls": [
+        {
+          "name": "",
+          "requestFields": {},
+          "responseFields": {},
+          "successfullResponseCode": 200
+        }
+      ]
+    },
+    "healthcheck": {
+      "type": "startup",
+      "frequency": 300000,
+      "query_object": {},
+      "addlHeaders": {}
+    },
+    "throttle": {
+      "throttle_enabled": false,
+      "number_pronghorns": 1,
+      "sync_async": "sync",
+      "max_in_queue": 1000,
+      "concurrent_max": 1,
+      "expire_timeout": 0,
+      "avg_runtime": 200,
+      "priorities": [
+        {
+          "value": 0,
+          "percent": 100
+        }
+      ]
+    },
+    "request": {
+      "number_redirects": 0,
+      "number_retries": 3,
+      "limit_retry_error": [
+        0
+      ],
+      "failover_codes": [],
+      "attempt_timeout": 5000,
+      "global_request": {
+        "payload": {},
+        "uriOptions": {},
+        "addlHeaders": {},
+        "authData": {}
+      },
+      "healthcheck_on_timeout": false,
+      "return_raw": false,
+      "archiving": false,
+      "return_request": false
+    },
+    "proxy": {
+      "enabled": false,
+      "host": "",
+      "port": 1,
+      "protocol": "http",
+      "username": "",
+      "password": ""
+    },
+    "ssl": {
+      "ecdhCurve": "",
+      "enabled": false,
+      "accept_invalid_cert": true,
+      "ca_file": "",
+      "key_file": "",
+      "cert_file": "",
+      "secure_protocol": "",
+      "ciphers": ""
+    },
+    "mongo": {
+      "host": "",
+      "port": 0,
+      "database": "",
+      "username": "",
+      "password": "",
+      "replSet": "",
+      "db_ssl": {
+        "enabled": false,
+        "accept_invalid_cert": false,
+        "ca_file": "",
+        "key_file": "",
+        "cert_file": ""
+      }
+    },
+    "devicebroker": {
+      "enabled": false,
+      "getDevice": [
+        {
+          "path": "/not/mapped",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "insample": "{port}"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial": "{serial}"
+          }
+        }
+      ],
+      "getDevicesFiltered": [
+        {
+          "path": "/not/mapped",
+          "method": "GET",
+          "pagination": {
+            "offsetVar": "",
+            "limitVar": "",
+            "incrementBy": "limit",
+            "requestLocation": "query"
+          },
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial": "{serial}",
+            "id": "{myid}"
+          }
+        }
+      ],
+      "isAlive": [
+        {
+          "path": "/not/mapped/{devID}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "devID": "{id}"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "status": "return2xx",
+            "statusValue": "AD.200"
+          }
+        }
+      ],
+      "getConfig": [
+        {
+          "path": "/not/mapped/{devID}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "devID": "{id}"
+          },
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ],
+      "getCount": [
+        {
+          "path": "/not/mapped",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ]
+    },
+    "cache": {
+      "enabled": false,
+      "entities": [
+        {
+          "entityType": "device",
+          "frequency": 3600,
+          "flushOnFail": false,
+          "limit": 10000,
+          "retryAttempts": 5,
+          "sort": true,
+          "populate": [
+            {
+              "path": "/not/mapped",
+              "method": "GET",
+              "pagination": {
+                "offsetVar": "",
+                "limitVar": "",
+                "incrementBy": "limit",
+                "requestLocation": "query"
+              },
+              "query": {},
+              "body": {},
+              "headers": {},
+              "handleFailure": "ignore",
+              "requestFields": {},
+              "responseDatakey": "",
+              "responseFields": {
+                "name": "{this}{||}{that}",
+                "ostype": "{osfield}",
+                "ostypePrefix": "meraki-",
+                "port": "{port}",
+                "ipaddress": "{ip_addr}",
+                "serial": "{serial}",
+                "id": "{myid}"
+              }
+            }
+          ],
+          "cachedTasks": [
+            {
+              "name": "",
+              "filterField": "",
+              "filterLoc": ""
+            }
+          ]
+        }
+      ]
+    }
+  }
+```
+### [Swagger](https://gitlab.com/itentialopensource/adapters/adapter-salesforce_rest/-/blob/master/report/adapter-openapi.json)
+## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/adapter-salesforce_rest/-/blob/master/README.md)

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-salesforce_rest",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "This adapter integrates with system described as: Salesforce REST.",
   "main": "adapter.js",
   "systemName": "Salesforce_rest",
@@ -52,7 +52,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-salesforce_rest#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.9.0",
+    "@itentialopensource/adapter-utils": "^5.9.4",
     "acorn": "^8.12.1",
     "ajv": "^8.17.1",
     "axios": "^1.7.4",

package/refs?service=git-upload-pack CHANGED Viewed

Binary file