OvalEdge uses REST APIs to connect to the data source, which allows users to crawl system objects and object fields.
Overview
Connector Details
Connector Category |
RDBMS System |
OvalEdge Release Current Connector Version |
6.3.x |
Connectivity [How OvalEdge connects to Salesforce Commerce Cloud] |
REST APIs |
OvalEdge Releases Supported (Available from) |
Release6.3.x Onwards |
Connector Features
✅ | |
Delta Crawl |
❌ |
Profiling |
❌ |
Query Sheet |
❌ |
Data Preview |
❌ |
Auto Lineage |
❌ |
Manual Lineage |
✅ |
Authentication via Credential Manager |
✅ |
Data Quality |
❌ |
DAM (Data Access Management) |
❌ |
Bridge |
❌ |
Getting Ready to Establish a Connection
Prerequisites
The following are the prerequisites required for establishing a connection:
Service Account User Permissions
Important: We recommend having a separate service account to establish a connection from OvalEdge to the data source with minimal permissions.
Operations | Endpoints | Permissions |
Get List System Objects |
/system_object_definitions |
read |
Get objects metadata |
/system_object_definitions/{object_type} |
read |
Get List Fileds for Object |
/system_object_definitions/{object_type}/attribute_definitions |
read |
Get field metadata |
/system_object_definitions/{object_type}/attribute_definitions/{id} |
read |
Important: The documented permissions above are based on source documentation and may not be fully inclusive. Metadata crawling requirements may necessitate additional permissions.
Setup a Connection
Important: You must have the Connector Creator role to set up a connection in OvalEdge.
- Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Salesforce Commerce Cloud, and complete the specific parameters.
Note: Fields marked with an asterisk (*) are mandatory for establishing a connection.
Field Name
Description
Connector Type
By default, "Salesforce Commerce Cloud" is displayed as the selected connector type.
Connector Settings
Credential Manager*
Select the desired credentials manager from the dropdown list. Relevant parameters will be displayed based on your selection.
Supported Credential Managers:
- OE Credential Manager
- HashiCorp Vault
- AWS Secrets Manager
- Azure Key Vault
License Add Ons
OvalEdge connectors have a default license add-on for data crawling and profiling.
Auto Lineage
Not Supported
Data Quality
Not Supported
Data Access
Not Supported
Connector Name*
Enter a unique name for the Salesforce Commerce Cloud connection.
(Example: "SalesforceCC_Prod").
Connector Environment
Select the environment (Example: PROD, STG) configured for the connector.
Server*
The base endpoint of your Salesforce Commerce Cloud instance.
Client Id*
The "Client ID" is a unique identifier assigned to your application when registering it with Salesforce Commerce Cloud.
Client secret*
The "Client Secret" is a confidential key associated with your Client ID. It acts as a password to authenticate your application during API requests.
API version*
Specifies the version of the Salesforce Commerce Cloud API.
Schema Name*
By default, the schema name is set to “SF_COMMERCE_CLOUD.” However, users can change it to their preferred name while creating a connection.
Important: Schema Name cannot be editable once a connection is validated & saved.
Default Governance Roles
Default Governance Roles*
Select the appropriate users or teams for each governance role from the dropdown list. All users and teams configured in OvalEdge Security are displayed for selection.
Admin Roles
Admin Roles*
Select one or more users from the dropdown list for Integration Admin and Security and Governance Admin. All users configured in OvalEdge Security are available for selection.
Bridge
Select Bridge*
If applicable, select the bridge from the drop-down list.
The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.
- After entering all connection details, you can perform the following actions:
- Click Validate to verify the connection.
- Click Save to store the connection for future use.
- Click Save & Configure to apply additional settings before saving.
- The saved connection will appear on the Connectors home page.
Connectivity Troubleshooting
If incorrect parameters are provided, you may encounter error messages. To resolve these issues, ensure all input is correct. If problems persist, contact your assigned OvalEdge support team.
S.No. |
Error Description |
Resolution |
01 |
Error while getting the salesforce commerce cloud toke: 401 Unauthorized: " {"error_description":"Client authentication failed","error": "invalid_client"}" |
Provide the valid client ID & client secret. |
Manage Connector Operations
Crawl/Profile
Important: You must have the Integration Admin role in OvalEdge for crawl/profile operations.
Crawl and Profile operations enable you to select one or more schemas from a list of all available schemas within a specific database. This allows you to customize the selection of crawling and profiling operations according to your requirements. Furthermore, it provides the option to schedule crawling and profiling and enable anomaly detection to identify any irregularities in the data objects.
Other Operations
The Connectors page in OvalEdge provides a centralized view of all configured connectors, including their health status. You can view, edit, validate, build lineage, and delete connectors using the Nine Dots menu.
Managing connectors includes:
- Connectors Health: Displays performance with a green (active) or red (inactive) icon, helping monitor data flow and address issues early.
- Viewing: Shows connector details (e.g., Databases, Tables, Table Columns, and Codes) via the View icon.
Nine Dots Menu Options:
- Edit Connector: Update and revalidate the data source.
- Validate Connector: Check the connection's integrity.
- Settings: Modify connector settings.
- Crawler: Configure data that needs to be extracted.
- Access Instructions: Specify how data can be accessed as a note.
- Business Glossary Settings: Manage term associations at the connector level.
- Others: Configure notification recipients for metadata changes.
- Delete Connector: Remove connectors or schemas with confirmation.
Metadata Mapping
Source Object |
Source Attribute |
OvalEdge Attribute |
OvaEdge Category |
OvalEdge Type |
System Objects |
object_type |
Table |
Tables |
Table |
description |
Source Description |
Tables |
Description |
|
object_type |
Table Title |
Tables |
- | |
Object Fileds |
id |
Column Name |
Columns |
Column |
display_name |
Column Title |
Columns |
- | |
value_type |
Column Type |
Columns |
- | |
field_length |
Data Type Size |
Columns |
- |
Important: The display_name from the source is displayed as the table/column "Title" in OvalEdge. If the title is manually altered or inherited from a term via the copy-to-title functionality, the title will be updated and the original display_name erased.
Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA