@itentialopensource/adapter-db_sybase 0.2.1 → 0.3.0

package/.eslintignore

@@ -2,3 +2,4 @@
 backup/*
 coverage/*
 out/*
+adapter_modifications/*

package/.eslintrc.js

@@ -1,18 +1,18 @@
 module.exports = {
-  'env': {
-    'browser': true,
-    'es6': true,
-    'node': true,
+  env: {
+    browser: true,
+    es6: true,
+    node: true
   },
-  'extends': 'airbnb-base',
-  "plugins": [
-    "json"
+  extends: 'airbnb-base',
+  plugins: [
+    'json'
   ],
-  'parserOptions': {
-    'sourceType': 'module',
+  parserOptions: {
+    sourceType: 'module'
   },
   rules: {
     'max-len': 'warn',
-    'comma-dangle': ['error', 'never'],
-  },
-};
+    'comma-dangle': ['error', 'never']
+  }
+};

package/AUTH.md

@@ -0,0 +1,25 @@
+## Authenticating Sybase SQL Adapter 
+
+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>. 
+
+### Database Library Authentication
+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.
+
+STEPS  
+1. Ensure you have access to a Sybase 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 @@
 
+## 0.3.0 [01-06-2024]
+
+* Adapter Engine has been updated and the changes are being migrated to the adapter
+
+See merge request itentialopensource/adapters/persistence/adapter-db_sybase!1
+
+---
+
 ## 0.2.1 [04-05-2021]
 
 * Bug fixes and performance improvements
@@ -6,4 +14,3 @@
 See commit 1be9196
 
 ---
-

package/CODE_OF_CONDUCT.md

@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 
@@ -34,15 +34,10 @@ This Code of Conduct applies both within project spaces and in public spaces whe
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [support@itential.com](mailto:support@itential.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@itential.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
-
-_return to [README](../README.md)_
+This Code of Conduct is adapted from the <a href="http://contributor-covenant.org" target="_blank">Contributor Covenant</a>, version 1.4, available at <a href="http://contributor-covenant.org/version/1/4/" target="_blank">version</a>

package/CONTRIBUTING.md

@@ -1,158 +1,13 @@
 # Contributing
 
-:+1: :tada: First off, thanks for taking the time to contribute! :tada: :+1:
+First off, thanks for taking the time to contribute!
 
 The following is a set of rules for contributing.
 
-## Table Of Contents
-
-[Code of Conduct](#code-of-conduct)
-
-[How Can I Contribute?](#how-can-i-contribute)
-
-* [Reporting Bugs](#reporting-bugs)
-* [Your First Code Contribution](#your-first-code-contribution)
-* [Merge Requests](#merge-requests)
-
-[Styleguides](#styleguides)
-
-* [Git Commit Messages](#git-commit-messages)
-* [JavaScript Styleguide](#javascript-styleguide)
-* [Tests Styleguide](#tests-styleguide)
-* [Documentation Styleguide](#documentation-styleguide)
-
 ## Code of Conduct
 
-This project and everyone participating in it is governed by the [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [support@itential.com](mailto:support@itential.com).
+This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itential.com.
 
 ## 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 [this list](#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](#how-do-i-submit-a-good-bug-report). 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](mailto:support@itential.com).
-
-#### Before Submitting A Bug Report
-
-* **Check the [User Guide](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 [Itential Knowledge Base](https://itential.atlassian.net/servicedesk/customer/kb/view/286883841?applicationId=605994d2-2cb2-3174-af59-ed5b23ff5fd5&spaceKey=PKB&src=1187380921) 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 [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows. Use [this tool](https://github.com/colinkeenan/silentcast) or [program](https://github.com/rhcarvalho/byzanz-guiz) 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 [User Guide](README.md). The [User Guide](README.md)provides 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.
-
-| Files | Changes |
-| ------- | ------- |
-| .codeclimate.yml, .eslintignore, .eslintrc.js, .gitignore, .gitlab-ci.yml, .jshintrc, .npmignore | 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.|
-| CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE, README.md | 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.|
-| utils/*, adapterBase.js | Changes to these files will rarely be accepted. These are process files that need to be changed through the builder process and migration.|
-| adapter.js | 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.|
-| error.json, propertiesSchema.json | 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.|
-| pacakge.json, package-lock.json | 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.|
-| pronghorn.json | 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.|
-| entities/* | 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.|
-| test/* | 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.|
-
-> **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-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](#styleguides).
-* 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.
-
-_return to [README](./README.md)_
+Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]

package/ENHANCE.md

@@ -0,0 +1,28 @@
+## Enhancements
+
+### Adding a Second Instance of an Adapter
+
+You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
+
+### Adding Adapter Properties
+
+While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
+
+```text
+Files to update
+* propertiesSchema.json: add the new property and how it is defined
+* sampleProperties: add the new property with a default value
+* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
+* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
+```
+
+### Enhancing Adapter Integration Tests
+
+The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.
+
+```text
+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://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.

package/PROPERTIES.md

@@ -0,0 +1,111 @@
+## Configuration
+
+This section defines **all** the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the sampleProperties.
+
+```json
+  {
+    "id": "ALL ADAPTER PROPERTIES!!!",
+    "properties": {
+      "database": "test",
+      "host": "system.access.resolved",
+      "port": 443,
+      "encrypt": false,
+      "authentication": {
+        "dbAuth": true,
+        "username": "username",
+        "password": "password",
+        "domain": "domain"
+      },
+      "ssl": {
+        "enabled": false,
+        "accept_invalid_cert": false,
+        "ca_file": ""
+      }
+    },
+    "type": "YOUR ADAPTER CLASS"
+  }
+```
+
+### Connection Properties
+
+These base properties are used to connect to MicrosoftSQL upon the adapter initially coming up. It is important to set these properties appropriately.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">database</td>
+    <td style="padding:15px">Required. The name of the database.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">host</td>
+    <td style="padding:15px">Required. A fully qualified domain name or IP address.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">port</td>
+    <td style="padding:15px">Required. Used to connect to the server.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">encrypt</td>
+    <td style="padding:15px">Optional. Used to tell the adapter to encrypt the data. The default behavior is to encrypt.</td>
+  </tr>
+</table>
+<br>
+
+A connectivity check tells IAP the adapter has loaded successfully.
+
+### Authentication Properties
+
+The following properties are used to define the authentication process to MicrosoftSQL.
+
+>**Note**: Depending on the method that is used to authenticate with MicrosoftSQL, you may not need to set all of the authentication properties.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">dbAuth</td>
+    <td style="padding:15px">Optional. Used to tell the adapter to authenticate. The default behavior is unauthenticated.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">username</td>
+    <td style="padding:15px">Used to authenticate with MicrosoftSQL 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 MicrosoftSQL on every request or when pulling a token that will be used in subsequent requests.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">domain</td>
+    <td style="padding:15px">Domain of the user used when authentication is enabled.</td>
+  </tr>
+</table>
+<br>
+
+### SSL Properties
+
+The SSL section defines the properties utilized for ssl authentication with MicrosoftSQL. 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>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">enabled</td>
+    <td style="padding:15px">If SSL is required, set to true.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">accept_invalid_certs</td>
+    <td style="padding:15px">Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">ca_file</td>
+    <td style="padding:15px">Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.</td>
+  </tr>
+</table>
+<br>

package/SUMMARY.md

@@ -0,0 +1,9 @@
+## Overview
+
+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.
+
+>**Note**: It is possible that some integrations will be supported through the Sybase adapter while other integrations will not. If you need additional API calls, you can use the Update capabilities provided by the Adapter Builder or request Itential to add them if the Adapter is an Itential opensourced adapter.
+
+Itential provides information on all of its product adapters in the Customer Knowledge Base. Information in the <a href="https://itential.atlassian.net/servicedesk/customer/portals" target="_blank">Customer Knowledge Base</a> is consistently maintained and goes through documentation reviews. As a result, it should be the first place to go for information.
+
+For opensourced and custom built adapters, the ReadMe is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into IAP.

package/SYSTEMINFO.md

@@ -0,0 +1,11 @@
+# Sybase SQL
+
+Vendor: SAP
+Homepage: https://www.sap.com/index.html
+
+Product: Sybase - Adaptive Server Enterprise
+Product Page: https://www.sap.com/index.html
+
+## Introduction
+
+## Additional Product Documentation

package/TROUBLESHOOT.md

@@ -0,0 +1,28 @@
+## Troubleshoot
+
+### Connectivity Issues
+
+1. Verify the adapter properties are set up correctly.
+
+```text
+Go into the Itential Platform GUI and verify/update the properties
+```
+
+2. Verify there is connectivity between the Itential Platform Server and MicrosoftSQL Server.
+
+```text
+ping the ip address of MicrosoftSQL server
+try telnet to the ip address port of MicrosoftSQL
+execute a curl command to the other system
+```
+
+3. Verify the credentials provided for MicrosoftSQL.
+
+```text
+login to MicrosoftSQL using the provided credentials
+```
+
+
+### Functional Issues
+
+Adapter logs are located in `/var/log/pronghorn`. In older releases of the Itential Platform, there is a `pronghorn.log` file which contains logs for all of the Itential Platform. In newer versions, adapters can be configured to log into their own files.

package/changelogs/changelog.md

@@ -0,0 +1,9 @@
+
+## 0.2.1 [04-05-2021]
+
+* Bug fixes and performance improvements
+
+See commit 1be9196
+
+---
+

package/error.json

@@ -96,6 +96,12 @@
       "displayString": "Invalid properties: $VARIABLE$",
       "recommendation": "Verify the properties for the adapter"
     },
+    {
+      "key": "Missing Properties",
+      "icode": "AD.306",
+      "displayString": "Property $VARIABLE$ is required",
+      "recommendation": "Please provide the required property"
+    },
     {
       "key": "Query Not Translated",
       "icode": "AD.310",
@@ -168,6 +174,12 @@
       "displayString": "Failure response received for $VARIABLE$",
       "recommendation": "Check the reason for failure in the stack trace"
     },
+    {
+      "key": "Suspended Adapter",
+      "icode": "AD.600",
+      "displayString": "Adapter is suspended",
+      "recommendation": "Check if external system is functional and unsuspend if appropriate"
+    },
     {
       "key": "Caught Exception",
       "icode": "AD.900",

package/metadata.json

@@ -0,0 +1,49 @@
+{
+  "name": "adapter-db_sybase",
+  "webName": "Adapter for Integration to Sybase Database",
+  "vendor": "SAP",
+  "product": "Sybase",
+  "osVersion": [],
+  "apiVersions": [],
+  "iapVersions": [
+    "2021.1.x",
+    "2021.2.x",
+    "2022.1.x",
+    "2023.1.x"
+  ],
+  "method": "Library",
+  "type": "Adapter",
+  "domains": [
+    "Data Storage"
+  ],
+  "tags": [],
+  "useCases": [],
+  "deprecated": {
+    "isDeprecated": false
+  },
+  "brokerSince": "",
+  "documentation": {
+    "storeLink": "",
+    "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-db_sybase",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/persistence/adapter-db_sybase",
+    "docLink": "",
+    "demoLinks": [],
+    "trainingLinks": [],
+    "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
+    "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
+    "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
+    "webLink": "https://www.itential.com/adapters/sybase/",
+    "vendorLink": "",
+    "productLink": "",
+    "apiLinks": []
+  },
+  "assets": [],
+  "relatedItems": {
+    "adapters": [],
+    "integrations": [],
+    "ecosystemApplications": [],
+    "workflowProjects": [],
+    "transformationProjects": [],
+    "exampleProjects": []
+  }
+}