@itentialopensource/adapter-db_mssql 1.0.0 → 1.0.1

package/AUTH.md

@@ -0,0 +1,25 @@
+## Authenticating Microsoft SQL Adapter 
+
+This document will go through the steps for authenticating the Microsoft SQL adapter with. 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>. 
+
+### Database Library Authentication
+The Microsoft SQL adapter requires Database Library 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 Microsoft SQL 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": {
+  "dbAuth": true,
+  "domain": "",
+  "username": "sa",
+  "password": "Password"
+}
+```
+4. Restart the adapter. If your properties were set correctly, the adapter should go online. 
+
+### Troubleshooting
+- Make sure you copied over the correct username and password.
+- Turn on debug level logs for the adapter in IAP Admin Essentials.
+- Investigate the logs

package/CALLS.md

@@ -0,0 +1,40 @@
+## 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
+
+These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.
+
+<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">connect()</td>
+    <td style="padding:15px">This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">healthCheck(callback)</td>
+    <td style="padding:15px">This call ensures that the adapter can communicate with <%= metaInfo.title %>. 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>
+</table>
+<br>
+
+### Specific Adapter Calls
+
+Specific adapter calls are built based on the API of the <%= metaInfo.title %>. 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.
+
+<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">Path</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+</table>
+<br>

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 1.0.1 [01-05-2024]
+
+* more migration changes
+
+See merge request itentialopensource/adapters/persistence/adapter-db_mssql!6
+
+---
+
 ## 1.0.0 [01-05-2024]
 
 * Adapter Migration

package/SYSTEMINFO.md

@@ -0,0 +1,11 @@
+# Microsoft SQL
+
+Vendor: Microsoft
+Homepage: https://www.microsoft.com/en-us/
+
+Product: MSSQL
+Product Page: https://www.microsoft.com/en-us/
+
+## Introduction
+
+## Additional Product Documentation

package/changelogs/changelog.md

@@ -0,0 +1,40 @@
+
+## 1.0.0 [01-05-2024]
+
+* Adapter Migration
+
+See merge request itentialopensource/adapters/persistence/adapter-db_mssql!5
+
+---
+
+## 0.4.0 [07-16-2021]
+
+* added call that removes the record set from select returns
+
+See merge request itentialopensource/adapters/persistence/adapter-db_mssql!3
+
+---
+
+## 0.3.0 [03-26-2021]
+
+* add domain support for connecting
+
+See merge request itentialopensource/adapters/persistence/adapter-db_mssql!2
+
+---
+
+## 0.2.0 [08-04-2020]
+
+* add encrypt capability to the connextion
+
+See merge request itentialopensource/adapters/persistence/adapter-db_mssql!1
+
+---
+
+## 0.1.1 [05-20-2020]
+
+* Bug fixes and performance improvements
+
+See commit f5ac952
+
+---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-db_mssql",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Itential adapter to connect to mssql",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",

package/workflows/README.md

@@ -1,3 +0,0 @@
-# Adapter Workflows
-
-This directory contains workflows that support the adapter use cases. These workflows can be imported into IAP. If the adapter is installed using App-Artifact the workflows should be automatically imported.

package/workflows/test-sql-server.json

@@ -1,470 +0,0 @@
-{
-  "name": "test SQL Server",
-  "tasks": {
-    "1121": {
-      "name": "drop",
-      "canvasName": "drop",
-      "summary": "drop table from MicrosoftSQL server.",
-      "description": "drop table from MicrosoftSQL server.",
-      "location": "Adapter",
-      "locationType": "MicrosoftSQL",
-      "app": "MicrosoftSQL",
-      "type": "automatic",
-      "displayName": "MicrosoftSQL",
-      "variables": {
-        "incoming": {
-          "sql": "DROP TABLE test.dbo.test_table;",
-          "adapter_id": "test-sql-server"
-        },
-        "outgoing": {
-          "result": null
-        },
-        "error": ""
-      },
-      "deprecated": false,
-      "matched": [
-        {
-          "key": "displayName",
-          "highlightString": "Microsoft<span class='highlight-string'>SQL</span>"
-        },
-        {
-          "key": "summary",
-          "highlightString": "drop table from Microsoft<span class='highlight-string'>SQL</span> server."
-        },
-        {
-          "key": "description",
-          "highlightString": "drop table from Microsoft<span class='highlight-string'>SQL</span> server."
-        }
-      ],
-      "groups": [],
-      "actor": "Pronghorn",
-      "x": 1.809153713298791,
-      "y": 0.07195301027900147,
-      "scheduled": false
-    },
-    "8575": {
-      "name": "select",
-      "canvasName": "select",
-      "summary": "select item from MicrosoftSQL server",
-      "description": "select item from MicrosoftSQL server",
-      "location": "Adapter",
-      "locationType": "MicrosoftSQL",
-      "app": "MicrosoftSQL",
-      "type": "automatic",
-      "displayName": "MicrosoftSQL",
-      "variables": {
-        "incoming": {
-          "sql": "SELECT * FROM test.dbo.test_table;",
-          "adapter_id": "test-sql-server"
-        },
-        "outgoing": {
-          "result": null
-        },
-        "error": ""
-      },
-      "deprecated": false,
-      "matched": [
-        {
-          "key": "displayName",
-          "highlightString": "Microsoft<span class='highlight-string'>SQL</span>"
-        },
-        {
-          "key": "summary",
-          "highlightString": "select item from Microsoft<span class='highlight-string'>SQL</span> server"
-        },
-        {
-          "key": "description",
-          "highlightString": "select item from Microsoft<span class='highlight-string'>SQL</span> server"
-        }
-      ],
-      "groups": [],
-      "actor": "Pronghorn",
-      "x": 1.116580310880829,
-      "y": 0.06461086637298091,
-      "scheduled": false
-    },
-    "workflow_start": {
-      "name": "workflow_start",
-      "groups": [],
-      "x": -0.17184801381692574,
-      "y": 0.048458149779735685
-    },
-    "workflow_end": {
-      "name": "workflow_end",
-      "groups": [],
-      "x": 1.9663212435233162,
-      "y": 0.0763582966226138
-    },
-    "e61d": {
-      "name": "query",
-      "canvasName": "query",
-      "summary": "query the MicrosoftSQL server.",
-      "description": "query the MicrosoftSQL server.",
-      "location": "Adapter",
-      "locationType": "MicrosoftSQL",
-      "app": "MicrosoftSQL",
-      "type": "automatic",
-      "displayName": "MicrosoftSQL",
-      "variables": {
-        "incoming": {
-          "sql": "SELECT GETDATE()",
-          "adapter_id": "test-sql-server"
-        },
-        "outgoing": {
-          "result": null
-        },
-        "error": ""
-      },
-      "deprecated": false,
-      "matched": [
-        {
-          "key": "canvasName",
-          "highlightString": "<span class='highlight-string'>query</span>"
-        },
-        {
-          "key": "summary",
-          "highlightString": "<span class='highlight-string'>query</span> the MicrosoftSQL server."
-        },
-        {
-          "key": "description",
-          "highlightString": "<span class='highlight-string'>query</span> the MicrosoftSQL server."
-        }
-      ],
-      "groups": [],
-      "actor": "Pronghorn",
-      "x": -0.018134715025906734,
-      "y": 0.055800293685756244,
-      "scheduled": false
-    },
-    "2c40": {
-      "name": "create",
-      "canvasName": "create",
-      "summary": "create a table into MicrosoftSQL server.",
-      "description": "create a table into MicrosoftSQL server.",
-      "location": "Adapter",
-      "locationType": "MicrosoftSQL",
-      "app": "MicrosoftSQL",
-      "type": "automatic",
-      "displayName": "MicrosoftSQL",
-      "variables": {
-        "incoming": {
-          "sql": "CREATE TABLE test.dbo.test_table (\n    id INT PRIMARY KEY,\n    first_name VARCHAR(100) NOT NULL,\n    last_name VARCHAR(100) NOT NULL\n);",
-          "adapter_id": "test-sql-server"
-        },
-        "outgoing": {
-          "result": null
-        },
-        "error": ""
-      },
-      "deprecated": false,
-      "matched": [
-        {
-          "key": "displayName",
-          "highlightString": "Microsoft<span class='highlight-string'>SQL</span>"
-        },
-        {
-          "key": "summary",
-          "highlightString": "create a table into Microsoft<span class='highlight-string'>SQL</span> server."
-        },
-        {
-          "key": "description",
-          "highlightString": "create a table into Microsoft<span class='highlight-string'>SQL</span> server."
-        }
-      ],
-      "groups": [],
-      "actor": "Pronghorn",
-      "x": 0.20207253886010362,
-      "y": 0.05726872246696035,
-      "scheduled": false
-    },
-    "4a45": {
-      "name": "select",
-      "canvasName": "select",
-      "summary": "select item from MicrosoftSQL server",
-      "description": "select item from MicrosoftSQL server",
-      "location": "Adapter",
-      "locationType": "MicrosoftSQL",
-      "app": "MicrosoftSQL",
-      "type": "automatic",
-      "displayName": "MicrosoftSQL",
-      "variables": {
-        "incoming": {
-          "sql": "SELECT * FROM test.dbo.test_table;",
-          "adapter_id": "test-sql-server"
-        },
-        "outgoing": {
-          "result": null
-        },
-        "error": ""
-      },
-      "deprecated": false,
-      "matched": [
-        {
-          "key": "displayName",
-          "highlightString": "Microsoft<span class='highlight-string'>SQL</span>"
-        },
-        {
-          "key": "summary",
-          "highlightString": "select item from Microsoft<span class='highlight-string'>SQL</span> server"
-        },
-        {
-          "key": "description",
-          "highlightString": "select item from Microsoft<span class='highlight-string'>SQL</span> server"
-        }
-      ],
-      "groups": [],
-      "actor": "Pronghorn",
-      "x": 0.6744386873920553,
-      "y": 0.06167400881057269,
-      "scheduled": false
-    },
-    "b724": {
-      "name": "insert",
-      "canvasName": "insert",
-      "summary": "insert item into MicrosoftSQL server.",
-      "description": "insert item into MicrosoftSQL server.",
-      "location": "Adapter",
-      "locationType": "MicrosoftSQL",
-      "app": "MicrosoftSQL",
-      "type": "automatic",
-      "displayName": "MicrosoftSQL",
-      "variables": {
-        "incoming": {
-          "sql": "INSERT INTO test.dbo.test_table (id, first_name, last_name) VALUES (1, 'John', 'Smith');",
-          "adapter_id": "test-sql-server"
-        },
-        "outgoing": {
-          "result": null
-        },
-        "error": ""
-      },
-      "deprecated": false,
-      "matched": [
-        {
-          "key": "displayName",
-          "highlightString": "Microsoft<span class='highlight-string'>SQL</span>"
-        },
-        {
-          "key": "summary",
-          "highlightString": "insert item into Microsoft<span class='highlight-string'>SQL</span> server."
-        },
-        {
-          "key": "description",
-          "highlightString": "insert item into Microsoft<span class='highlight-string'>SQL</span> server."
-        }
-      ],
-      "groups": [],
-      "actor": "Pronghorn",
-      "x": 0.4430051813471503,
-      "y": 0.05433186490455213,
-      "scheduled": false
-    },
-    "1d9": {
-      "name": "update",
-      "canvasName": "update",
-      "summary": "update item into MicrosoftSQL server.",
-      "description": "update item into MicrosoftSQL server.",
-      "location": "Adapter",
-      "locationType": "MicrosoftSQL",
-      "app": "MicrosoftSQL",
-      "type": "automatic",
-      "displayName": "MicrosoftSQL",
-      "variables": {
-        "incoming": {
-          "sql": "UPDATE test.dbo.test_table SET first_name = 'Jane' WHERE first_name = 'John';",
-          "adapter_id": "test-sql-server"
-        },
-        "outgoing": {
-          "result": null
-        },
-        "error": ""
-      },
-      "deprecated": false,
-      "matched": [
-        {
-          "key": "displayName",
-          "highlightString": "Microsoft<span class='highlight-string'>SQL</span>"
-        },
-        {
-          "key": "summary",
-          "highlightString": "update item into Microsoft<span class='highlight-string'>SQL</span> server."
-        },
-        {
-          "key": "description",
-          "highlightString": "update item into Microsoft<span class='highlight-string'>SQL</span> server."
-        }
-      ],
-      "groups": [],
-      "actor": "Pronghorn",
-      "x": 0.8946459412780656,
-      "y": 0.07195301027900147,
-      "scheduled": false
-    },
-    "6eed": {
-      "name": "delete",
-      "canvasName": "delete",
-      "summary": "delete item from MicrosoftSQL server.",
-      "description": "delete item from MicrosoftSQL server.",
-      "location": "Adapter",
-      "locationType": "MicrosoftSQL",
-      "app": "MicrosoftSQL",
-      "type": "automatic",
-      "displayName": "MicrosoftSQL",
-      "variables": {
-        "incoming": {
-          "sql": "DELETE FROM test.dbo.test_table;",
-          "adapter_id": "test-sql-server"
-        },
-        "outgoing": {
-          "result": null
-        },
-        "error": ""
-      },
-      "deprecated": false,
-      "matched": [
-        {
-          "key": "displayName",
-          "highlightString": "Microsoft<span class='highlight-string'>SQL</span>"
-        },
-        {
-          "key": "summary",
-          "highlightString": "delete item from Microsoft<span class='highlight-string'>SQL</span> server."
-        },
-        {
-          "key": "description",
-          "highlightString": "delete item from Microsoft<span class='highlight-string'>SQL</span> server."
-        }
-      ],
-      "groups": [],
-      "actor": "Pronghorn",
-      "x": 1.3385146804835923,
-      "y": 0.06607929515418502,
-      "scheduled": false
-    },
-    "f2d9": {
-      "name": "select",
-      "canvasName": "select",
-      "summary": "select item from MicrosoftSQL server",
-      "description": "select item from MicrosoftSQL server",
-      "location": "Adapter",
-      "locationType": "MicrosoftSQL",
-      "app": "MicrosoftSQL",
-      "type": "automatic",
-      "displayName": "MicrosoftSQL",
-      "variables": {
-        "incoming": {
-          "sql": "SELECT * FROM test.dbo.test_table;",
-          "adapter_id": "test-sql-server"
-        },
-        "outgoing": {
-          "result": null
-        },
-        "error": ""
-      },
-      "deprecated": false,
-      "matched": [
-        {
-          "key": "displayName",
-          "highlightString": "Microsoft<span class='highlight-string'>SQL</span>"
-        },
-        {
-          "key": "summary",
-          "highlightString": "select item from Microsoft<span class='highlight-string'>SQL</span> server"
-        },
-        {
-          "key": "description",
-          "highlightString": "select item from Microsoft<span class='highlight-string'>SQL</span> server"
-        }
-      ],
-      "groups": [],
-      "actor": "Pronghorn",
-      "x": 1.579447322970639,
-      "y": 0.06901615271659324,
-      "scheduled": false
-    }
-  },
-  "transitions": {
-    "1121": {
-      "workflow_end": {
-        "type": "standard",
-        "state": "success"
-      }
-    },
-    "8575": {
-      "6eed": {
-        "type": "standard",
-        "state": "success"
-      }
-    },
-    "workflow_start": {
-      "e61d": {
-        "type": "standard",
-        "state": "success"
-      }
-    },
-    "workflow_end": {},
-    "e61d": {
-      "2c40": {
-        "type": "standard",
-        "state": "success"
-      }
-    },
-    "2c40": {
-      "b724": {
-        "type": "standard",
-        "state": "success"
-      }
-    },
-    "4a45": {
-      "1d9": {
-        "type": "standard",
-        "state": "success"
-      }
-    },
-    "b724": {
-      "4a45": {
-        "type": "standard",
-        "state": "success"
-      }
-    },
-    "1d9": {
-      "8575": {
-        "type": "standard",
-        "state": "success"
-      }
-    },
-    "6eed": {
-      "f2d9": {
-        "type": "standard",
-        "state": "success"
-      }
-    },
-    "f2d9": {
-      "1121": {
-        "type": "standard",
-        "state": "success"
-      }
-    }
-  },
-  "font_size": 12,
-  "created": "2020-04-23T18:21:28.989Z",
-  "created_by": {
-    "provenance": "Local AAA",
-    "username": "admin@pronghorn",
-    "firstname": "admin",
-    "inactive": false
-  },
-  "createdVersion": "5.5.9-2019.3.14.0",
-  "groups": [],
-  "last_updated": "2020-04-23T18:28:55.564Z",
-  "last_updated_by": {
-    "provenance": "Local AAA",
-    "username": "admin@pronghorn",
-    "firstname": "admin",
-    "inactive": false
-  },
-  "lastUpdatedVersion": "5.5.9-2019.3.14.0",
-  "type": "automation",
-  "description": null,
-  "tags": []
-}