Sybase ASE (Adaptive Server Enterprise) is a relational database management system (RDBMS) designed for managing and storing structured data in enterprise-level applications.
OvalEdge enables connectivity to Sybase ASE using the jTDS driver, allowing for tasks such as crawling database objects, profiling sample data, executing queries, building relationships, and lineage.
Connector Capabilities
The connector capabilities are shown below:
Crawling
Feature |
Supported Objects |
Remarks |
---|---|---|
Crawling |
Tables |
|
Table Columns |
||
Views |
||
Stored Procedures |
||
Functions |
||
Triggers |
Profiling
Feature |
Supported Objects |
Remarks |
---|---|---|
Table Profiling |
Row Count, Columns Count, View Sample data |
- |
View Profiling |
Row Count, Columns Count, View sample data |
View is treated as a table for profiling purposes. |
Column Profiling |
Min, Max, Null Count, Distinct, Top 50 values |
Supported Data Types: bit, tinyint, bigint, unsigned, char, nchar, numeric, decimal, int, smallint, double, float, varchar, nvarchar, datetime, xml, text, ntext, mediumtext, longtext |
Full Profiling |
Supported |
- |
Sample Profiling |
Supported |
- |
Lineage Building
Lineage entities |
Details |
---|---|
Table Lineage |
Supported |
Column Lineage |
Supported |
Lineage Sources |
Stored Procedures, Functions, Triggers, Views, SQL queries (from Query Sheet) |
Querying
Operation |
Details |
---|---|
Select |
Supported |
Insert |
By default not supported |
Update |
By default not supported |
Delete |
By default not supported |
Joins within database |
Supported |
Joins outside database |
Not supported |
Aggregations |
Supported |
Group By |
Supported |
Order By |
Supported |
Union |
Supported |
By default, the service account provided for the connector will be used for any query operations. If the service account has write privileges, then Insert / Update / Delete queries can be executed.
Prerequisites
The following are prerequisites for connecting to the Sybase ASE:
Drivers
The APIs/drivers used by the connector are given below:
Sl.No |
Driver/API |
Version |
Details |
---|---|---|---|
1 |
Driver |
jtds-1.3.1 |
https://mvnrepository.com/artifact/net.sourceforge.jtds/jtds/1.3.1 |
Configuring Environment Variables
Configuring environment names enables you to select the appropriate environment from the drop-down list when adding a connector. This allows for consistent crawling of schemas across different environments, such as production (PROD), staging (STG), or temporary environments. It also facilitates schema comparisons and assists in application upgrades by providing a temporary environment that can be later deleted if needed.
Before establishing a connection, it is important to configure the environment names for the specific connector. If your environments have been configured, skip this step.
Steps to Configure the Environment
- Log into the OvalEdge application.
- Navigate to Administration > System Settings.
- Select the Connector tab.
- Find the key name “connector.environment”.
- Enter the desired environment values (PROD, STG) in the Value column.
- Click ✔ to Save.
Service Account Permissions
An admin/service account for crawling and building lineage. The minimum privileges required are:
Operation |
Access Permission |
---|---|
Connection validate |
Read |
Crawl objects |
Read |
Profiling |
Read |
Query Execution |
Select |
Lineage Building |
Read Permission for Views, Procedures, Functions |
Establish a Connection
To connect to the Sybase ASE using the OvalEdge application, complete the following steps:
- Log in to the OvalEdge application.
- Navigate to Administration > Connectors.
- Click on the + (New Connector) icon, and the Add Connection with Search Connector pop-up window is displayed.
- Add Connector pop-up window is displayed where you can search for the Sybase connector.
- The Add Connector with Connector Type specific details pop-up window is displayed. Enter the relevant information to configure the Sybase connection.
Note: The asterisk (*) denotes mandatory fields required for establishing a connection.
Field Name
Description
Connector Type
It allows you to select the connector from the drop-down list. By default, 'Sybase ASE' is displayed as the selected connector type.
Connector Settings
Credential Manager*
Select the option from the drop-down list to save your credentials.
OE Credential Manager: When OvalEdge establishes a connection to the IMPALA database, the connection is configured with the service account's basic username and password in real-time.
- HashiCorp: The credentials are stored in the HashiCorp database server and fetched from HashiCorp to OvalEdge.
- AWS Secrets Manager: The credentials are stored in the AWS Secrets Manager database server and fetched from the AWS Secrets Manager to OvalEdge.
- Azure Key Vault: The credentials are stored in the Azure Key Vault database server and fetched from the Azure Key Vault to OvalEdge.
For more information on Azure Key Vault, refer to Azure Key Vault Connector Integration.
For more information on Credential Manager, refer to Credential Manager
License Add Ons
All the connectors will have a Base Connector License by default, which allows you to crawl and profile to obtain metadata and statistical information from a data source.
OvalEdge supports various License Add-Ons based on the connector’s functionality requirements.
- Auto Lineage: Select the Auto Lineage Add-On license that enables the automatic construction of the Lineage of data objects for a connector with the Lineage feature.
Connector Name*
Provide a connector name for the Sybase ASE database in OvalEdge. This name will serve as a reference to identify the specific Sybase ASE database connection. Example: "SybaseASE_Connection_test"
Connector Environment
The Connector Environment drop-down list allows you to select the environment configured for the connector from the drop-down list.
For example, PROD, or STG (based on the configured items in the OvalEdge configuration for the connector.environment).
The purpose of the environment field is to help you identify which connector is connecting what type of system environment (Production, STG, or QA).
Note: The steps to set up environment variables are explained in the Configuring Environment Variables section.
Server*
Specify the name of the Sybase database instance server IP/URL, which is accessible by the OvalEdge application.
Example :
IP: 190.x1.x3.xx90
Server: ovalsybaserdbms.com
Port*
By default, port number 5000, which is related to the Sybase database, is displayed. If needed a new port number can be provided.
Database*
Enter the source database name for crawling.
Driver*
A JDBC driver is a Java library file with the extension .jar that connects to a database. The driver details associated with the Sybase database will be auto-populated by default.
Username*
Enter the Service Account Username of the Sybase ASE Server.
Password*
Enter the password of the Sybase server name.
Connection String
Set the Connection string toggle button to automatic to get the details automatically from the credentials provided. Alternatively, you can manually enter the string.
Format: jdbc:jtds:sybase://{server}:5000/{sid}
Example:
jdbc:jtds:sybase://190.x1.x3.xx90:5000/ovaledgedb
Plugin Server
Specify the server name if the data source library runs as a web server, similar to bridge-lite.
Plugin Port
Enter the port number associated with the plugin server.
Default Governance Roles
Steward*
Select the Steward from the drop-down list options.
Custodian*
Select the Custodian from the drop-down list options.
Owner*
Select the Owner from the drop-down list options.
Governance Roles 4, 5, 6*
Select the respective user from the drop-down options.
Note: The drop-down list displays all the configurable roles (for a single user or a team) according to the configurations made in the OvalEdge Security > Governance Roles section.
Admin Roles
Integration Admins*
To add Integration Admin Roles, search for or select one or more roles from the Integration Admin options and then click on the Apply button.
The responsibility of the Integration Admin includes configuring crawling and profiling settings for the connector, as well as deleting connectors, schemas, or data objects.Security and Governance Admins*
To add Security and Governance Admin roles, search for or select one or more roles from the list and then click on the Apply button.
The security and Governance Admin is responsible for:- Configure role permissions for the connector and its associated data objects.
- Add admins to set permissions for the connector's roles and associated data objects.
- Update governance roles.
- Create custom fields.
- Develop Service Request templates for the connector.
- Create Approval workflows for the templates.
No. of Archive Objects*
The number of archive objects indicates the number of recent metadata modifications made to a dataset at a remote/source location. By default, the archive objects feature is deactivated. However, users may enable it by clicking the Archive toggle button and specifying the number of objects they wish to archive.
Select Bridge*
With the OvalEdge Bridge component, any cloud-hosted server can connect with any on-premise or public cloud data sources without modifying firewall rules. A bridge provides real-time control that makes managing data movement between any source and destination easy. For more information, refer to Bridge Overview.
For more information, refer to Bridge Overview.
- After entering all the connection details, select the appropriate button based on your preferences.
- Validate: Click on the Validate button to verify the connection details. This ensures that the provided information is accurate and enables successful connection establishment.
- Save: Click on the Save button to store the connection details. Once saved, the connection will be added to the Connectors home page for easy access.
- Save & Configure: For certain Connectors that require additional configuration settings. Click on the Save & Configure button. This will open the Connection Settings pop-up window, allowing you to configure the necessary settings before saving the connection.
- Once the connection is validated and saved, it will be displayed on the Connectors home page.
Note: You can either save the connection details first or validate the connection first and then save it.
Connection Validation Details
S.No |
Error Message(s) |
Description |
1 |
Failed to establish a connection, please check the credentials. |
In case of an invalid username and password. |
2. |
Connection Timeout |
Please check the port is opened to the OvalEdge server |
Note: If you have any issues creating a connection, please contact your assigned OvalEdge Customer Success Management (CSM) team.
Connector Settings
Once the connection is established successfully, various settings are provided to fetch and analyze the information from the data source. The connection settings include Crawler, Profiler, Data Access, Query Policies, Access Instruction, Business Glossary Settings, and Others.
To view the Connector Settings page,
- Go to the Connectors page.
- From the 9- dots, select the Settings option.
- Connector Settings page is displayed where you can view all the connector setting options.
- Click on Save Changes. All the settings will be applied to the metadata.
- The following is aThe connectorconnection settings along w,ith their corresponding descriptions:
Connection Settings
Description
Crawler
Crawler settings are configured to connect to a data source and collect and catalog all the data elements in the form of metadata.
Profiler
The process of gathering statistics and informative summaries about the connected data source(s). Statistics can help assess the quality of data sources before using them for analysis. Profiling is always optional; crawling can be run without profiling.
Query Policies
It restricts the use of the selected query types based on your role.
Access Instruction
Access Instruction allows the data owner to instruct others on using the objects in the application.
Business Glossary Settings
The Business Glossary Setting provides flexibility and control over how they view and manage term association within the context of a business glossary at the connector level.
Anomaly Detection Settings
Anomaly Detection Settings enable users to configure anomaly detection preferences at the connector level. By default, the configuration aligns with the global settings in System Settings and cannot be modified.
Users can activate or deactivate anomaly detection for a specific connector in custom settings. They can also switch between the default Deviation or IQR algorithm and adjust associated parameters.
Others
The Enable/Disable Metadata Change Notifications option sets the change notification about metadata changes of the data objects.
- You can use the toggle button to set the Default Governance Roles (Steward, Owner Custodian, etc.)
- Using the Roles and Teams, you can select the role and team to receive the notification of metadata changes.
Note: For more information, refer to the Connector Settings.
Crawling of Schema(s)
A Crawl/Profile option allows you to select the specific schemas for the following operations: Crawl, Crawl & Profile, Profile, or Profile Unprofiled. For any scheduled crawlers and profilers, the defined run date and time are displayed to set.
- Navigate to the Connectors page, and click on the Crawl/Profile button.
Select Schema For Crawling and Profiling pop-up window is displayed. - The below list of actions is displayed.
- Crawl: It allows the crawling of the metadata of the selected schemas.
- Crawl & Profile: It allows crawling the metadata of the selected schemas and profiles the sample data.
- Profile: It allows the collection of table column statistics.
- Profile Unprofiled: It allows data that has not been profiled to be profiled.
Schedule: Connectors can also be scheduled in advance to run crawling and/or profiling at prescribed times and selected intervals.
Note: For more information on Scheduling, refer to Scheduling Connector.
Copyright © 2024, OvalEdge LLC, Peachtree Corners, GA USA