Generic JDBC Connector

Used for OneTrust Data Discovery, the Generic Java Database Connectivity (JDBC) connector allows customers to utilize their own JDBC JAR and easily onboard a new data source that may not be present in the Data Discovery Gallery.

Data Sources

This connector type is also leveraged to conduct worker node scans on the following data sources:

  • Apache Kafka

  • IBM DB2

  • IBM AS/400

  • Jira

  • Neo4j

Overview

Pod Residency

rdbms-scanner

Connection Method

JDBC Connection URL

Supported Scan Actions

Scan Type

Description

Catalog

This scan type will only retrieve the metadata in the database like details of schema, table, or column.

Catalog & Scan

OneTrust scans both metadata and data under the tables and returns the appropriate labels.

Credential and System Permissions

OneTrust recommends to adhere to your organization's security and infrastructure policy and include system engineer resources or other qualified subject matter experts to set up credentials on data sources. For specific instructions for how to enable these credentials, refer to your data source's implementation documentation, knowledge base and/or support resources.

This connector requires a JDBC URL with username and password credentials.

Sample JSON Credentials

JSON 
{
    "auto_commit": "true",
    "connectionUrl": "jdbc:<your-connection-url>",
    "driver_class_name": "<your-driver-class-name>",
    "fetch_size": "<integer>",
    "jdbc_query_timeout": "PT10M",
    "password": "######",
    "user": "######"
}

Additional Required Fields

Field Name

Default Value

Required? (Y/N)

driver_class_name

N/A

Y

fetch_size

N/A

N

jdbc_query_timeout

N/A

N

auto_commit

true

N

isolation_level

N/A

N

network_timeout

N/A

N

table_size_metadata_sql

N/A

N

disable_extended_metadata_fetch_on_max_table_count

N/A

N

is_multi_db_supported

false

Note:

Set to true if the database follows the structure Database > Schema > Table (e.g. Snowflake, Microsoft SQL)

N

is_multi_connection_supported

false

Note:

Set to true if database follows the structure Schema > Table, where Schema Name is needed in the connection URL (e.g. Oracle)

N

JAR Uploading Process

  1. Download the installer file for the worker node that will be used to connect to this data source by clicking “Launch Install” in your environment, copy the curl command, paste in your deploy machine, and run the command.

  2. Once the installer.sh file is created, run the file and once the folder dependencies are created, navigate to extlib folder and add the JDBC JAR.

  3. Navigate within the k8s-deployment/onebox-deployment folder and and run the below command to sync the JAR to the deployment:

    CODE 
    ./deploy.sh sync-extlib
    Note:

    Once the sync is complete all scanner pods should be return to running state

  4. Optional: To verify whether JAR was uploaded successfully, complete the following:

    • Exec into the RDBMS Pod:

      CODE 
      kubectl exec -it rdbms-scanner-pod-name -n nameofnamespace -c rdbms-scanner -- /bin/bash

    • List out the contents of /home/ot-service/extlib folderls /home/ot-service/extlib

  5. Configure scan profile, credential and data source.

  6. Trigger scan(s).

Scan Profile Support

Note:

For additional details on scan profile configuration and management, see Setting Up Scan Profiles.

Scan profiles types supported for other RDBMS connectors are also available for the Generic JDBC connector. When creating the scan profile, you will have to select the most applicable Profile Pattern to the database being scanned. This selection will populate the necessary object limits and path patterns.

  • Database Table

  • Database/Schema Table

  • Schema Table



Limits:

  • Maximum Number of Databases

  • Maximum Number of Tables per Database

  • Maximum Number of Rows per Table

Include/Exclude Paths:

  • Database

  • Table

Collected Objects & Fields

Note:

Driver must be provided to collect the given objects and fields.

Objects

Fields

Databases

  • Name

Tables

  • Name

Columns

  • Name

  • Column Index (Order)

  • Comment

  • Nullable (T/F)

  • Size Estimate

  • Comment

Keys

  • Primary Key Name

  • Primary Key Columns

  • Foreign Key Name

  • Foreign Key Columns

Troubleshooting

No suitable driver found for [system]

CODE 
ode:[Connection Error] Source:[RDBMS Scanner] Message:[SQLException: No suitable driver found for [sapdb]. Please check the 'connectionUrl' property in credentials.] Arguments:[[Dialect: sapdb]] Date:[2024-10-07T13:36:16]

Resolution: Follow the steps in the section, JAR Uploading Process, to upload the correct JAR file(s) to the worker node. In the error example above, the SAP DB JAR file should be downloaded from official sources.