Sybase IQ

Sybase IQ is a column-based, petabyte scale, relational database software system used for business intelligence, data warehousing, and data marts.

OvalEdge enables connectivity to Sybase IQ using the jConnect (jconn4) 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

Profiling

Lineage Building

Querying 

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 IQ:

Drivers

The APIs/drivers used by the connector are given below:

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 later be deleted if needed.

Before establishing a connection, it is important to configure the environment names for the specific connector. If your environments have already been configured, skip this step. 

Steps to Configure the Environment

1. Log in to the OvalEdge application.
2. Navigate to Administration >  System Settings.
3. Select the Connector tab.
4. Find the key name “connector.environment”.
   
5. Enter the desired environment values (PROD, STG) in the Value column.
6. Click ✔ to Save.

Service Account Permissions

An admin/service account is necessary for crawling and building lineage. The minimum privileges required are:

Establish a Connection

To connect to Sybase IQ using the OvalEdge application, complete the following steps:

1. Log in to the OvalEdge application.
2. Navigate to Administration >  Connectors.
3. Click on the + (New Connector) icon.
   
4. The Add Connector pop-up window is displayed, and you can search for the Sybase IQ connector.
   
5. The Add Connector with connector type-specific details pop-up window is displayed. Enter the relevant information to configure the Sybase IQ connection. Informational fields and their descriptions are listed below.
   Note: An asterisk (*) denotes a mandatory field required for establishing a connection.      
   

   Field		Description
   Connector Type		This field allows you to select the connector from the drop-down list provided. By default, 'Sybase IQ' is displayed as the selected connector type.
   Connector Settings
   Credential Manager*		Select the option from the drop-down list indicating where you want to save your credentials: OE Credential Manager: When OvalEdge establishes a connection, the connection is configured with the service account's basic Username and Password in real-time. Users must manually add the credentials if the OE Credential Manager option is selected. 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; OvalEdge fetches the credentials from the AWS Secrets Manager.  Azure Key Vault: Azure Key Vault allows for secure storage and strict access mechanisms of sensitive information such as tokens, passwords, certificates, API keys, and other confidential data.  For more information on Azure Key Vault, refer to Azure Key Vault. 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 to automatically construct the Lineage of data objects for a connector with the Lineage feature.
   Connector Name*		Provide a connector name for the Sybase IQ database in OvalEdge. This name will serve as a reference to identify the specific Sybase IQ database connection.  Example: "SybaseIQ_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, you can select 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 IQ database instance server IP/URL, which is accessible via the OvalEdge application. Example:  IP: 190.x1.x3.xx90 Server: ovalsybiqrdbms.com
   Port*		Port number 2638, related to the Sybase IQ database, is displayed by default. A new port number can be provided if needed.
   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. By default, the driver details associated with the SybaseIQ database will be auto-populated.
   Username*		Enter the Service Account Username of the Sybase IQ database.
   Password*		Enter the password of the Sybase IQ database.
   Connection String		Set the Connection String toggle button to automatically to get the details from the credentials provided. Alternatively, you can manually enter the string. Format: jdbc:sybase:Tds:{server}:2638?ServiceName={sid} Example: jdbc:sybase:Tds:192.22.64.xx:2638?ServiceName=sybasedb
   Plugin Server		Enter the server name if you are running this as a plugin.
   Plugin Port		Enter the port number of the plugin that is running.
   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 (single user or a team) as per the configurations made in the OvalEdge application: Administration > 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, then click the Apply button. The Integration Admin's responsibilities include configuring the connector's crawling and profiling settings and 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, then click the Apply button. The Security and Governance Admin is responsible for: Configuring role permissions for the connector and its associated data objects. Adding admins to set permissions for the connector's roles and associated data objects. Updating governance roles. Creating custom fields. Developing Service Request templates for the connector. Creating Service Request 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.

6. After entering all the required connection details, select the appropriate option based on your preferences: 
   1. Validate: Click on the Validate button to verify the connection details. This ensures that the provided information is accurate and enables successful connection establishment.
   2. 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.
   3. 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.
7. 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

 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 successfully established, 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, Anomaly Detection Settings, and Others.

To view the Connector Settings page,

1. Go to the Connectors page.
2. From the 9- dots select the Settings option.
   
3. This will display the Connector Settings page, where you can view all the connector settings.
   
4. When you have finished making your desired changes, click on Save Changes. All setting changes will be applied to the metadata.
5. The following is a list of connection settings along with their corresponding descriptions:

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.

1. Navigate to the Connectors page and click the Crawl/Profile button.
   Select Schema For Crawling and Profiling pop-up window is displayed below:
   
2. Select the required Schema(s).
3. The list of actions below is displayed in the Action section.
   1. Crawl: This allows the selected schema(s) metadata to be crawled.
   2. Crawl & Profile: This allows crawling of the metadata of the selected schema(s) and profiles of the sample data.
   3. Profile: This allows the collection of table column statistics.
   4. Profile Unprofiled: This allows data that has not been profiled to be profiled.
   5. 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.
4. Click on the Run button. This gathers all metadata from the connected source and puts it into the OvalEdge Data Catalog.
   
   
   

   ---

   Copyright © 2024, OvalEdge LLC, Peachtree Corners, GA, USA.