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 ensures secure authentication via Credential Manager.

Overview

Connector Details

Connector Category	Application
Connector Version	Release6.3.x
Releases Supported (Available from)	Legacy connector
Connectivity [How the connection is established with RDBMS System]	REST APIs

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 Salesforce and mapped to the corresponding UI assets.

Salesforce Object	Salesforce Attribute	OvalEdge Attribute	OvalEdge Category	OvalEdge Type
Objects (System & Custom)	Object Name	Table Name	Tables	Table
Objects (System & Custom)	Object Description	Table Comment	Tables	Table
Object Fields	Field Name	Column Name	Table Columns	Columns
Object Fields	Field Type	Data Type	Table Columns	Columns
Object Fields	Field Length	Data Type Size	Table Columns	Columns
Object Fields	Field Description	Source Description	Table Columns	Description
Object Fields	Field Name	Title	Table Columns	Columns
Indexes	Index Name	Index	Indexes	Index
Indexes	If Unique	Yes/No	Indexes	Index

Salesforce does not provide a native schema concept. A default schema named "Salesforce" is created to act as a logical container for organizing and managing all Salesforce-related objects and attributes.

Set up a Connection

Prerequisites

The following are the prerequisites to establish a connection:

Service Account User Permissions

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.

👨‍💻Who can provide these permissions? These permissions are typically granted by the Salesforce administrator, as users may not have the required access to assign them independently.

Objects	Sys Tables	Permission
Schema	Salesforce	N/A
Tables	Objects	Read
Columns	Object fields	Read
Indexes	Indexed Fields	Read

For the Tables operation, the user must have API Enabled permission and read access to the objects to be crawled. These objects will appear as tables in the Application after crawling.

For the Columns & Indexes operation, the user must have read access to the object fields to be crawled. These fields will appear as table columns in the Application after crawling.

Connection Configuration Steps

Users are required to have the Connector Creator role in order to configure a new connection.

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

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.
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)

Token Based

Field Name	Description
Connector Name*	Enter a unique name for the Salesforce connection (Example: "Salesforce_Prod").
Connector Description	Enter a description to identify the purpose of the connector.
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., [email protected]).
Password*	Enter the password for the Salesforce user account used for API access.
Consumer Key*	It is generated when a Connected App is created in Salesforce and is used to identify the client making the API request.
Consumer Secret*	It is generated with the Connected App in Salesforce and is used along with the Customer Key to connect and authenticate the application securely.
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. This can be obtained by 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.
Sandbox Environment*	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.
Proxy Enabled*	Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.

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.

1. 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.

2. The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl/Profile

To perform crawl and profile operations, users must be assigned the Integration Admin role.

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