@itentialopensource/adapter-db_oracle 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.3.0 [07-09-2024]
+
+* Add routes
+
+See merge request itentialopensource/adapters/persistence/adapter-db_oracle!7
+
+---
+
+## 0.2.1 [05-15-2024]
+
+* Patch/adapt 3377
+
+See merge request itentialopensource/adapters/persistence/adapter-db_oracle!6
+
+---
+
 ## 0.2.0 [01-06-2024]
 
 * Adapter Engine has been updated and the changes are being migrated to the adapter

package/TAB1.md

@@ -0,0 +1,5 @@
+# Overview 
+
+This adapter is used to integrate the Itential Automation Platform (IAP) with the Oracle System. The API that was used to build the adapter for Oracle is usually available in the report directory of this adapter. The adapter utilizes the Oracle 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.
+
+For further technical details on how to install and use this adapter, please click the Technical Documentation tab. 

package/TAB2.md

@@ -0,0 +1,57 @@
+# Oracle SQL
+
+## 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 Oracle 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 Oracle 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 Oracle 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
+
+### 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": {
+    "database": "your database name",
+    "host": "localhost",
+    "port": 3306,
+    "authentication": {
+      "username": "your username",
+      "password": "your password"
+    }
+  }
+```
+### Swagger
+
+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.
+## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/persistence/adapter-db_oracle/-/blob/master/README.md) 
+

package/adapter.js

@@ -138,7 +138,13 @@ class Oracle extends EventEmitter {
 
     // Get connection
     oracle.getConnection(connAttrs, (error, gotConn) => {
-      if (error) {
+      // Emit online if on stub mode
+      if (this.props && this.props.stub === true) {
+        this.emit('ONLINE', {
+          id: this.id
+        });
+        log.info('EMITTED ONLINE ON STUB MODE');
+      } else if (error) {
         log.error(`error connecting to Oracle: ${error}`);
         // emit failure
         this.alive = false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-db_oracle",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Itential adapter to connect to oracle",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",

package/pronghorn.json

@@ -29,6 +29,10 @@
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/query"
+      },
       "task": true
     },
     {
@@ -51,6 +55,10 @@
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/create"
+      },
       "task": true
     },
     {
@@ -73,6 +81,10 @@
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/select"
+      },
       "task": true
     },
     {
@@ -95,6 +107,10 @@
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/insert"
+      },
       "task": true
     },
     {
@@ -117,6 +133,10 @@
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/update"
+      },
       "task": true
     },
     {
@@ -139,6 +159,10 @@
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/delete"
+      },
       "task": true
     },
     {
@@ -161,6 +185,10 @@
       "roles": [
         "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/drop"
+      },
       "task": true
     }
   ]