@itentialopensource/adapter-db_sybase 0.3.0 → 0.3.1

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.
package/AUTH.md CHANGED
@@ -23,3 +23,4 @@ STEPS
23
23
  - Make sure you copied over the correct username and password.
24
24
  - Turn on debug level logs for the adapter in IAP Admin Essentials.
25
25
  - Investigate the logs
26
+ - 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.
package/CHANGELOG.md CHANGED
@@ -1,4 +1,12 @@
1
1
 
2
+ ## 0.3.1 [07-26-2024]
3
+
4
+ * manual updates
5
+
6
+ See merge request itentialopensource/adapters/persistence/adapter-db_sybase!4
7
+
8
+ ---
9
+
2
10
  ## 0.3.0 [01-06-2024]
3
11
 
4
12
  * Adapter Engine has been updated and the changes are being migrated to the adapter
package/SYSTEMINFO.md CHANGED
@@ -3,9 +3,23 @@
3
3
  Vendor: SAP
4
4
  Homepage: https://www.sap.com/index.html
5
5
 
6
- Product: Sybase - Adaptive Server Enterprise
7
- Product Page: https://www.sap.com/index.html
6
+ Product: Sybase
7
+ Product Page: https://www.sap.com/products/technology-platform/sybase-ase.html
8
8
 
9
9
  ## Introduction
10
+ We classify Sybase into the Data Storage domaina as Sybase is a database which provides the storage of information.
10
11
 
11
- ## Additional Product Documentation
12
+ "Deploy on premises and on an infrastructure as a service (IaaS)"
13
+ "Deliver high performance and availability to process mission-critical transactions"
14
+ "Provide a proven, flexible SQL database system to reduce risk and increase agility"
15
+ "Lower operational costs with a resource-efficient relational database server"
16
+
17
+ ## Why Integrate
18
+ The Sybase adapter from Itential is used to integrate the Itential Automation Platform (IAP) with SAP Sybase (Adaptive Server Enterprise - ASE). With this adapter you have the ability to perform operations with Sybase on items such as:
19
+
20
+ - Storage of Information
21
+ - Retrieval of Information
22
+
23
+ ## Additional Product Documentation
24
+ The [Sybase SQL Reference](https://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.sqlanywhere.12.0.1/dbusage/sqlqueries-sqlug.html)
25
+ The [Sybase Node Library Documentation](https://www.npmjs.com/package/sybase)
package/TAB1.md ADDED
@@ -0,0 +1,11 @@
1
+ # Overview
2
+
3
+ This adapter is used to integrate the Itential Automation Platform (IAP) with the Sybase System. The API that was used to build the adapter for Sybase is usually available in the report directory of this adapter. The adapter utilizes the Sybase 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.
4
+
5
+ ## Details
6
+ The Sybase adapter from Itential is used to integrate the Itential Automation Platform (IAP) with SAP Sybase (Adaptive Server Enterprise - ASE). With this adapter you have the ability to perform operations with Sybase on items such as:
7
+
8
+ - Storage of Information
9
+ - Retrieval of Information
10
+
11
+ For further technical details on how to install and use this adapter, please click the Technical Documentation tab.
package/TAB2.md ADDED
@@ -0,0 +1,63 @@
1
+ # Sybase SQL
2
+
3
+ ## Table of Contents
4
+
5
+ - [Specific Adapter Information](#specific-adapter-information)
6
+ - [Authentication](#authentication)
7
+ - [Sample Properties](#sample-properties)
8
+ - [Swagger](#swagger)
9
+ - [Generic Adapter Information](#generic-adapter-information)
10
+
11
+ ## Specific Adapter Information
12
+ ### Authentication
13
+
14
+ This document will go through the steps for authenticating the Sybase 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>.
15
+
16
+ #### Database Library Authentication
17
+ The Sybase 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.
18
+
19
+ STEPS
20
+ 1. Ensure you have access to a Sybase SQL server and that it is running
21
+ 2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
22
+ 3. Use the properties below for the ```properties.authentication``` field
23
+ ```json
24
+ "authentication": {
25
+ "dbAuth": true,
26
+ "domain": "",
27
+ "username": "sa",
28
+ "password": "Password"
29
+ }
30
+ ```
31
+ 4. Restart the adapter. If your properties were set correctly, the adapter should go online.
32
+
33
+ #### Troubleshooting
34
+ - Make sure you copied over the correct username and password.
35
+ - Turn on debug level logs for the adapter in IAP Admin Essentials.
36
+ - Investigate the logs
37
+ - 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.
38
+ ### Sample Properties
39
+
40
+ 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.
41
+
42
+ ```json
43
+ "properties": {
44
+ "database": "test",
45
+ "host": "localhost",
46
+ "port": 1433,
47
+ "encrypt": true,
48
+ "authentication": {
49
+ "username": "sa",
50
+ "password": "Password"
51
+ },
52
+ "ssl": {
53
+ "enabled": false,
54
+ "accept_invalid_cert": false,
55
+ "ca_file": ""
56
+ }
57
+ }
58
+ ```
59
+ ### Swagger
60
+
61
+ Note: The content for this section may be missing as its corresponding .json file is unavailable. This sections will be updated once adapter-openapi.json file is added.
62
+ ## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/persistence/adapter-db_sybase/-/blob/master/README.md)
63
+
@@ -0,0 +1,9 @@
1
+ {
2
+ "ComplianceEntries": [
3
+ {
4
+ "name": "Compliance Summary",
5
+ "numInvalidProjects": 0,
6
+ "numValidProjects": 0
7
+ }
8
+ ]
9
+ }
@@ -0,0 +1,5 @@
1
+ ---------------------------------------------------------------------------------------------
2
+ **** Project Compliance Summary ****
3
+ 0 project(s) are not valid
4
+ 0 project(s) are valid
5
+ ---------------------------------------------------------------------------------------------
package/metadata.json CHANGED
@@ -16,26 +16,54 @@
16
16
  "domains": [
17
17
  "Data Storage"
18
18
  ],
19
- "tags": [],
20
- "useCases": [],
19
+ "tags": [
20
+ "Database & Repository Operations"
21
+ ],
22
+ "useCases": [
23
+ "CRUD Operations",
24
+ "Persist Data"
25
+ ],
21
26
  "deprecated": {
22
27
  "isDeprecated": false
23
28
  },
24
29
  "brokerSince": "",
30
+ "authMethods": [
31
+ {
32
+ "type": "Database Auth",
33
+ "subtypes": [],
34
+ "primary": true
35
+ }
36
+ ],
25
37
  "documentation": {
26
38
  "storeLink": "",
27
39
  "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-db_sybase",
28
- "repoLink": "https://gitlab.com/itentialopensource/adapters/persistence/adapter-db_sybase",
40
+ "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-db_sybase",
29
41
  "docLink": "",
30
42
  "demoLinks": [],
31
- "trainingLinks": [],
43
+ "trainingLinks": [
44
+ {
45
+ "title": "Itential Academy",
46
+ "link": "https://www.itential.com/itential-academy/"
47
+ }
48
+ ],
32
49
  "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
33
50
  "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
34
51
  "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
35
52
  "webLink": "https://www.itential.com/adapters/sybase/",
36
- "vendorLink": "",
37
- "productLink": "",
38
- "apiLinks": []
53
+ "vendorLink": "https://www.sap.com/index.html",
54
+ "productLink": "https://www.sap.com/products/technology-platform/sybase-ase.html",
55
+ "apiLinks": [
56
+ {
57
+ "title": "Sybase SQL Reference",
58
+ "link": "https://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.help.sqlanywhere.12.0.1/dbusage/sqlqueries-sqlug.html",
59
+ "public": true
60
+ },
61
+ {
62
+ "title": "Sybase Node Library Documentation",
63
+ "link": "https://www.npmjs.com/package/sybase",
64
+ "public": true
65
+ }
66
+ ]
39
67
  },
40
68
  "assets": [],
41
69
  "relatedItems": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@itentialopensource/adapter-db_sybase",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "Itential adapter to connect to Sybase",
5
5
  "main": "adapter.js",
6
6
  "wizardVersion": "2.44.7",
@@ -14,7 +14,6 @@
14
14
  "lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
15
15
  "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
16
16
  "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
17
- "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
18
17
  "test": "npm run test:unit && npm run test:integration",
19
18
  "deploy": "npm publish --registry=https://registry.npmjs.org --access=public",
20
19
  "build": "npm run deploy"
@@ -32,14 +31,15 @@
32
31
  ],
33
32
  "license": "Apache-2.0",
34
33
  "engines": {
35
- "node": ">= 0.12.7"
34
+ "node": ">=14.0.0",
35
+ "npm": ">=6.0.0"
36
36
  },
37
37
  "repository": {
38
38
  "type": "git",
39
- "url": "git@gitlab.com:itentialopensource/adapters/persistence/adapter-db_sybase.git"
39
+ "url": "git@gitlab.com:itentialopensource/adapters/adapter-db_sybase.git"
40
40
  },
41
41
  "author": "Itential",
42
- "homepage": "https://gitlab.com/itentialopensource/adapters/persistence/adapter-db_sybase#readme",
42
+ "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-db_sybase#readme",
43
43
  "dependencies": {
44
44
  "ajv": "^8.12.0",
45
45
  "fs-extra": "^11.1.1",
@@ -53,10 +53,9 @@
53
53
  "eslint-config-airbnb-base": "^15.0.0",
54
54
  "eslint-plugin-import": "^2.27.5",
55
55
  "eslint-plugin-json": "^3.1.0",
56
- "mocha": "^9.2.2",
57
- "nyc": "^15.1.0",
56
+ "mocha": "^10.7.0",
58
57
  "testdouble": "^3.18.0",
59
- "winston": "^3.8.1"
58
+ "winston": "^3.13.1"
60
59
  },
61
60
  "private": false
62
61
  }
Binary file
@@ -12,7 +12,7 @@
12
12
  },
13
13
  "ssl": {
14
14
  "enabled": false,
15
- "accept_invalid_cert": true,
15
+ "accept_invalid_cert": false,
16
16
  "ca_file": ""
17
17
  }
18
18
  },