# Oracle

This document outlines the integration with Oracle, enabling streamlined metadata management through features such as crawling, profiling, querying, data preview, and lineage building (both automatic and manual). Additionally, it ensures secure authentication via Credential Manager.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXf-5FGO6SOjRKvqvvmMC9TU9biypAp9Q-jjVS06ly5H0aFBBH_1bLjRLMBZ5Tc4bIdC0nm4dblmE5eiJ6kT6HPmum-B9fgPrrPlS-rNA6FbonFvIU-7rb_DUOB6U8SSLpfF0V796Q?key=lCyvcDwJo0t5rd6uGLd9y4KK" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

| Connector Category                                                               | RDBMS            |
| -------------------------------------------------------------------------------- | ---------------- |
| Connector Version                                                                | Release7.1       |
| Releases Supported (Available from)                                              | Legacy Connector |
| <p>Connectivity</p><p>\[How the connection is established with RDBMS System]</p> | JDBC driver      |
| Verified Oracle Version                                                          | 21c              |

{% hint style="info" %}
*The Oracle connector has been validated with the mentioned "Verified Oracle Versions" and is expected to be compatible with other supported Oracle versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.*
{% endhint %}

### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ❌      |
| Profiling                                    |       ✅      |
| Query Sheet                                  |       ✅      |
| Data Preview                                 |       ✅      |
| Auto Lineage                                 |       ✅      |
| Manual Lineage                               |       ✅      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |       ✅      |
| DAM (Data Access Management)                 |       ❌      |
| Bridge                                       |       ✅      |

### Metadata Mapping

The following objects are crawled from Oracle and mapped to the corresponding UI assets.

<table><thead><tr><th>Oracle Object</th><th width="191.703857421875">Oracle Property</th><th>OvalEdge Attribute</th><th>OvalEdge Category</th><th>OvalEdge Type</th></tr></thead><tbody><tr><td>Table</td><td>tablename</td><td>Table</td><td>Tables</td><td>table</td></tr><tr><td>Table</td><td>table_type</td><td>Table Type</td><td>Tables</td><td>table</td></tr><tr><td>Table</td><td>tablecomment</td><td>Source Description</td><td>Descriptions</td><td>Source Description</td></tr><tr><td>Columns</td><td>COLUMN_NAME</td><td>Column</td><td>Table Columns</td><td>            -</td></tr><tr><td>Columns</td><td>DATA_TYPE</td><td>Column Type</td><td>Table Columns</td><td>            -</td></tr><tr><td>Columns</td><td>COMMENTS</td><td>Source Description</td><td>Table Columns</td><td>            -</td></tr><tr><td>Columns</td><td>DATA_LENGTH</td><td>Data Type Size</td><td>Table Columns</td><td>            -</td></tr><tr><td>View</td><td>View Name</td><td>View</td><td>Tables</td><td>View</td></tr><tr><td>View</td><td>text</td><td>View Query</td><td>Views</td><td>View</td></tr><tr><td>Procedures</td><td>name</td><td>Name</td><td>Procedures</td><td>            -</td></tr><tr><td>Procedures</td><td>Text</td><td>Procedure Query</td><td>           -</td><td>            -</td></tr><tr><td>Synonyms</td><td>SYNONYM_NAME</td><td>Synonym</td><td>Synonyms</td><td>            -</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

#### **External Supporting Files**

{% hint style="info" %}
*The supporting file is required to enable connectivity with Oracle databases using the ojdbc8 driver. Use this file according to the installation environment. The supporting files are available for download. Extract the ZIP file and select the required files to proceed. To download the ZIP file, click* [*here*](https://docs.ovaledge.com/connectors/connector-supporting-files)*.*
{% endhint %}

<table><thead><tr><th width="188.75">File Name</th><th>Description</th></tr></thead><tbody><tr><td>ojdbc8-19.3.0.0.jar</td><td>Use this file when connecting to Oracle databases using the ojdbc8 driver. Place the file in the Third Party Jars folder.</td></tr></tbody></table>

### **Whitelisting Ports**

Make sure that inbound port “1521” is whitelisted to enable successful connectivity with the Oracle database.

{% hint style="warning" %}
*The default port number for Oracle data source is 1521. If a different port is used, ensure that the updated port number is specified during connection setup, the port is whitelisted, and communication between the system and Oracle data source is properly established.*
{% endhint %}

### **Service Account User Permissions**

{% hint style="warning" %}
*It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.*
{% endhint %}

{% hint style="info" %}
👨‍💻 **Who can provide these permissions?** These permissions are typically granted by the Oracle administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Objects           | System Tables / Objects               | Access Permission |
| ----------------- | ------------------------------------- | ----------------- |
| Schemas           | sys.dba\_users                        | SELECT            |
| Schemas           | all\_users                            | SELECT            |
| Tables            | all\_tab\_comments                    | SELECT            |
| Tables            | SYS.ALL\_MVIEWS                       | SELECT            |
| Tables            | dba\_tab\_comments                    | SELECT            |
| Table Columns     | ALL\_TAB\_COLUMNS, ALL\_COL\_COMMENTS | SELECT            |
| Table Columns     | all\_constraints, all\_cons\_columns  | SELECT            |
| Views             | ALL\_VIEWS                            | SELECT            |
| Functions         | DBA\_SOURCE, ALL\_SOURCE              | SELECT            |
| Stored Procedures | DBA\_SOURCE, ALL\_SOURCE              | SELECT            |
| Synonyms          | all\_synonyms                         | SELECT            |
| Indexes           | ALL\_INDEXES, ALL\_IND\_COLUMNS       | SELECT            |
| Relationships     | all\_cons\_columns, all\_constraints  | SELECT            |

### Connection Configuration Steps

{% hint style="warning" %}
*Users are required to have the Connector Creator role in order to configure a new connection.*
{% endhint %}

1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for **Oracle**, and complete the required parameters.

{% hint style="info" %}
*Fields marked with an asterisk (\*) are mandatory for establishing a connection.*
{% endhint %}

<table><thead><tr><th width="220">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "Oracle" is displayed as the selected connector type.</td></tr></tbody></table>

**Connector Settings**

<table><thead><tr><th width="220.25">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><ul><li>Select the checkbox for Auto Lineage Add-On to build data lineage automatically.</li><li>Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.</li></ul></td></tr><tr><td>Connector Name*</td><td>Enter a unique name for the Oracle connection.</td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Connector Description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Server*</td><td>Enter the Oracle database server name or IP address (Example: xxxx-xxxxxxx.xxxx4ijtzasl.xx-south-1.rds.xxxxxx.com or 1xx.xxx.1.xx).</td></tr><tr><td>Port*</td><td>By default, the port number for Oracle, 1521, is auto-populated. If required, the port number can be modified as per custom port number that is configured for the Oracle database.</td></tr><tr><td>Database*</td><td>Enter the database name to which the service account user has access within the Oracle database.</td></tr><tr><td>Database Type</td><td><p>Select SID or Service Name from the Database type drop-down.</p><p>An SID uniquely identifies a specific database within an environment, whereas a Service Name can represent one or more SIDs.</p></td></tr><tr><td>Driver*</td><td>By default, the Oracle driver details are auto-populated.</td></tr><tr><td>Username*</td><td>Enter the service account username configured to access the Oracle database (example: "oesauser").</td></tr><tr><td>Password*</td><td>Enter the password associated with the service account user.</td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the Oracle database:</p><ul><li>Automatic mode: The system generates a connection string based on the provided credentials.</li><li>Manual mode: Enter a valid connection string manually.</li></ul><p>Replace placeholders with actual database details.</p><p>{sid} refers to the database name.</p></td></tr></tbody></table>

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="220.25"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="220.25"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the drop-down list for Integration Admin and Security &#x26; Governance Admin. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**No Of Archive Objects**

<table data-header-hidden><thead><tr><th width="221.5"></th><th></th></tr></thead><tbody><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="220.25"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.</p></td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl/Profile

{% hint style="warning" %}
*To perform crawl and profile operations, users must be assigned the Integration Admin role.*
{% endhint %}

The **Crawl/Profile** button allows users to select one or more schemas for crawling and profiling.

1. Navigate to the **Connectors** page and click **Crawl/Profile**.
2. Select the schemas to crawl.
3. The **Crawl** option is selected by default. To perform both operations, select the **Crawl & Profile** radio button.
4. Click **Run** to collect metadata from the connected source and load it into the **Data Catalog**.
5. After a successful crawl, the information appears in the **Data Catalog > Databases** tab.

The **Schedule** checkbox allows automated crawling and profiling at defined intervals, from a minute to a year.

1. Click the Schedule checkbox to enable the **Select Period** drop-down.
2. Select a time period for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the selected operation (**Crawl** or **Crawl & Profile**) at the scheduled time.

### Other Operations

The Connectors page provides a centralized view of all configured connectors, along with their health status.

#### **Managing connectors includes:**

* **Connector Health:** Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.
* **Viewing:** Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and codes.

#### **Nine Dots Menu Options:**

To view, edit, validate, build lineage, configure, or delete connectors, click on the **Nine Dots** menu.

* **Edit Connector:** Update and revalidate the data source.
* **Validate Connector:** Check the connection's integrity.
* **Settings:** Modify connector settings.
  * **Crawler:** Configure data extraction.
  * **Profiler:** Customize data profiling rules and methods.
  * **Query Policies:** Define query execution rules based on roles.
  * **Access Instructions:** Add notes on how data can be accessed.
  * **Business Glossary Settings:** Manage term associations at the connector level.
  * **Anomaly Detection Settings:** Configure anomaly detection preferences at the connector level.
  * **Others:** Configure notification recipients for metadata changes.
* **Build Lineage:** Automatically build data lineage using source code parsing.
* **Delete Connector:** Remove a connector with confirmation.

## Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="62.3333740234375">S. No</th><th width="301.1666259765625">Error Message(s)</th><th>Description/Resolution</th></tr></thead><tbody><tr><td>1</td><td>Error while validating connection: Error while validating Oracle Connection: Failed to obtain JDBC Connection; nested exception is xxx.sql.SQLxxxxx: ORA-xxxxx: invalid username/password; logon denied</td><td><p><strong>Description</strong>:</p><p>Either username and password might be wrong.</p><p><strong>Resolution</strong>:</p><ul><li>The username or password entered in the setup form is incorrect.</li><li>The authorizing user has the necessary permissions to establish a connection with the database.</li></ul></td></tr><tr><td>2</td><td>Error while validating connection: Error while validating Oracle Connection: Failed to obtain JDBC Connection; nested exception is xxxx.sql.SQLxxxx: Listener refused the connection with the following error: ORA-xxxxx, TNS:listener does not currently know of SID given in connect descriptor.</td><td><p><strong>Description</strong>:</p><p>The database name provided is invalid.</p><p><strong>Resolution</strong>:</p><ul><li>The database name entered in the setup form's Database Name field is incorrect.</li><li>Ensure that the database name is correctly spelled and exists in the target system.</li></ul></td></tr></tbody></table>

***

Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA