Salesforce Commerce Cloud

This document outlines OvalEdge's integration with Salesforce Commerce Cloud, enabling efficient metadata management through crawling and manual lineage building. It also ensures secure authentication via Credential Manager.

Overview

Connector Details

 

Connector Features

Getting Ready to Establish a Connection

Prerequisites

The following are the prerequisites to establish a connection between Salesforce Commerce Cloud and OvalEdge:

Service Account User Permissions

Setup a Connection

1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Salesforce Commerce Cloud, 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 Commerce Cloud" 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 your selection. Supported Credential Managers: OE Credential Manager AWS Secrets Manager HashiCorp Vault Azure Key Vault
   Connector Name*	Enter a unique name for the Salesforce Commerce Cloud connection (Example: "Salesforce Commerce Cloud_Prod").
   Connector Environment	Select the environment (Example: PROD, STG) configured for the connector.
   Server*	Enter the Host URL of your Salesforce Commerce Cloud instance to establish a connection. This is the primary endpoint where API requests are directed (Example: https://xxxx-xxxxxx.xxx.com).
   Client ID*	Enter the unique Client ID assigned to your application in Salesforce Commerce Cloud.
   Client Secret*	Enter the Client Secret, a confidential key used with the Client ID for secure authentication.
   API Version*	Enter the API version to ensure compatibility with Salesforce Commerce Cloud (Example: v1, v2).
   Schema Name*	By default, the schema name is set to "SF_COMMERCE_CLOUD". You can change it if required.

    

   Default Governance Roles
   Default Governance Roles*	Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are available for selection.
   Admin Roles
   Admin Roles*	Select one or more users from the drop-down list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security are available for selection.
   No of Archive Objects
   No Of Archive Objects*	This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive. Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.
   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 modifying firewall rules.

2. After entering all connection details, you can perform the following actions:
   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.

Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are correct to resolve these issues. If issues persist, contact your assigned OvalEdge support team.

S.No.	Error Message(s)	Error Description & Resolution
1	Error while validating connection: Error validating the Salesforce Commerce Cloud connector; Error : I/O error while fetching API response: www.xxx.xxxxxx.com: Name or service not known	Error Description: The provided Server (Host URL) is invalid. Resolution: Ensure that you have entered the correct Host URL of your Salesforce Commerce Cloud instance. Verify that the URL is accessible and corresponds to the correct environment (e.g., development, staging, production).
2	Error while validating connection: Error validating the Salesforce Commerce Cloud connector; Error : Error occurred while fetching a valid Salesforce access token: Error while getting the salesforce commerce cloud toke: 401 Unauthorized: "{"error_description":"Client authentication failed","error":"invalid_client"}"	Error Description: Invalid Client ID or Client Secret. Resolution: You provided an incorrect Client ID or Client Secret in the setup form. Make sure that both values are correctly entered as registered in Salesforce Commerce Cloud. Verify that the credentials have the required permissions and are not expired or revoked.
3	Error while validating connection: Error validating the Salesforce Commerce Cloud connector; Error : Error while fetching GET API response: Error while fetching response status: 400	Error Description: Invalid API Version. Resolution: You provided an incorrect API Version in the setup form. Make sure that the version matches a supported Salesforce Commerce Cloud API version (e.g., v1, v2).

Manage Connector Operations

Crawl

The Crawl/Profile button allows you to select one or more schemas for crawling.

1. Navigate to the Connectors page and click Crawl/Profile.
2. Select the schemas you want to crawl.
3. The Crawl option is selected by default.
4. Click Run to collect metadata from the connected source and load it into the OvalEdge Data Catalog.
5. After a successful crawl, the information appears in the Data Catalog > Databases tab.

The Schedule checkbox allows automated crawling for a selected timeframe, 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 Crawl operation at the scheduled time.

Other Operations

The Connectors page in OvalEdge provides a centralized view of all configured connectors and their health status.

Managing connectors includes:

• Connector Health: Displays performance using a green icon for active connections and a red icon for inactive connections, helping to monitor the connection between OvalEdge and 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:

You can view, edit, validate, modify connector settings and delete connectors using 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.
  • 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.
  

Metadata Mapping

Source Object	Source Attribute	OvalEdge Attribute	OvalEdge Category	OvalEdge Type
System Objects	object_type	Table	Tables	Table
	description	Source Description	Descriptions	-
	object_type	Table Title	-	-
Object Fields	Id	Column Name	Columns	-
	display_name	Column Title	-	-
	value_type	Column Type	-	-
	field_length	Data Type Size	-	-
	description	Column Description	-	-

---

Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA