Prerequisites

Before establishing a connection, the following prerequisites are required:

• Driver Details

• Whitelisting IP address and Port

• Service Account User Permissions

• Environmental Variables

• Credential Manager

Driver Details

Drivers are required to enable communication between the data source and the application. The type of driver depends on the data source and can include SDKs, JDBC drivers, or other proprietary formats.

Location: Drivers are packaged and deployed within the application artifacts.

Whitelisting IP Address and Port

To ensure a secure and uninterrupted connection between the application and the data source, whitelist the application's IP address and port in the data source's firewall or network configuration. This prevents connection issues, secures the connection, and protects data from unauthorized access.

Service Account User Permissions

Service account user permissions are used to connect to the data source with defined permissions to crawl metadata, profile data, and build the lineage.

Permission requirements may differ based on the connector. Specific instructions will be provided in the documentation for each connector.

Connector Environment

Each environment has a specific purpose (For reference only):

• Development (DEV): For building and testing new features.

• Quality Assurance (QA): For testing by QA teams.

• Staging (STG): For pre-production testing.

• Production (PROD): Live environment.

• Temporary: For short-term use, like schema comparison or upgrade checks.

Steps to Configure the Environment:

1. Go to Administration > System Settings.

2. Select the Connector tab.

3. Find the key connector.environment.

   
4. Add values like PROD, STG, QA, etc., in the Value column.

5. Click the Save button.

Saved environments will now appear in the environment drop-down on the Add Connector page.

Credential Manager

Credential managers store and manage authentication details for data connectors. Four types are supported, each designed to securely hold sensitive information such as passwords, tokens, certificates, and API keys. Credentials are fetched in real time during connection attempts to ensure enhanced security and compliance.

Supported Credential Managers

• Database

  • Stores credentials such as username/password, tokens, API keys, and certificates.

  • Saves credential details in an encrypted format within the application database.

  • Used when credentials are managed directly inside the installed platform environment.

  • Suitable for storing credentials for websites, applications, or networks.

• AWS Secrets Manager

  • Centralized credential storage with built-in encryption and secret rotation.

  • Uses encryption keys to generate and manage secrets.

  • Supports automatic rotation of credentials.

  • Credentials stored here are used to access data sources securely.

• HashiCorp Vault

  • Identity-based secret management and encryption system.

  • Protects tokens, passwords, certificates, and encryption keys.

  • Uses a key-value store to manage secrets.

  • Offers strong access control and data protection mechanisms.

• Azure Key Vault

  • Provides secure storage for sensitive data, including passwords, API keys, certificates, and tokens.

  • Ensures strict access control with permission-based retrieval.

  • Designed for high security and regulatory compliance.

To use a credential manager for a specific connection, an active integration must be configured within the application. This enables the platform to fetch and manage credentials securely through the selected service.

---

Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA