Salesforce

This document outlines the integration with the Salesforce connector, enabling streamlined metadata management through features such as crawling, profiling, data preview, querying, and manual lineage building. It also supports impact analysis and ensures secure authentication via Credential Manager.

Overview

Connector Capabilities

Metadata Mapping

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

Set up a Connection

Prerequisites

The following are the prerequisites to establish a connection:

Service Account User Permissions

Connection Configuration Steps

1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Salesforce, and complete the required parameters.
   Note: Fields marked with an asterisk (*) are mandatory for establishing a connection.
   

   Field Name	Description
   Connector Type	By default, "Salesforce" is displayed as the selected connector type.
   Connector Settings
   Credential Manager*	Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection. Supported Credential Managers: OE Credential Manager AWS Secrets Manager HashiCorp Vault Azure Key Vault
   Authentication Type	The following two types of authentication are supported for Salesforce: Token Based JSON Web Token (JWT)
   Connector Name*	Enter a unique name for the Salesforce connection (Example: "Salesforce_Prod").
   Connector Environment	Select the environment (Example: PROD, STG) configured for the connector.
   Username*	Enter the Salesforce username for the user account used for API access. It is usually in the format of an email (e.g., apiuser@xxxx.com).
   Password*	Enter the password for the Salesforce user account used for API access.
   Customer Key*	Also known as the Consumer Key. It is generated when a Connected App is created in Salesforce and is used to identify the client making the API request.
   Customer Secret	Also known as the Consumer Secret. It is generated with the Connected App in Salesforce and is used along with the Customer Key to securely connect and authenticate the application.
   Security token	A unique token generated by Salesforce for API access. Required when logging in from untrusted IP addresses. It must be appended to the password during login if the IP address is not whitelisted. Can be obtained using the "Reset My Security Token" option in Salesforce.
   API version*	Enter the version of the Salesforce REST or SOAP API to be used (e.g., v59.0). This determines the available endpoints and features.
   IS SANDBOX?*	Select Yes if the Salesforce environment is a sandbox (test environment), or No if it is a production environment. Sandbox environments usually have URLs like test.salesforce.com.
   Keystore password*	Enter the password used to access the keystore file. This password protects the keystore and ensures secure access to the stored certificates and keys. Note: This field appears only when the Authentication Type is set to JSON Web Token (JWT).
   Alias name*	Enter the alias name used to identify the specific key entry within the keystore. Each key entry in the keystore is associated with a unique alias. Note: This field appears only when the Authentication Type is set to JSON Web Token (JWT).
   Keystore file path*	Provide the full path and file name of the Java Keystore (.jks) file. This file contains the security certificates and keys  required for establishing a secure SSL/TLS connection. Note: This field appears only when the Authentication Type is set to JSON Web Token (JWT).

   Default Governance Roles
   Default Governance Roles*	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.
   Admin Roles
   Admin Roles*	Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in the security settings are available for selection.
   Bridge
   Select Bridge*	Select the bridge from the drop-down list. 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.

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

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 be crawled.
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.
  • Others: Configure notification recipients for metadata changes.
• Delete Connector: Remove a connector with confirmation.

Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA