SFCC (Salesforce Commerce Cloud)

This document outlines the integration with SFCC (Salesforce Commerce Cloud), enabling streamlined metadata management through crawling and manual lineage building. It also ensures secure authentication via Credential Manager.

Overview

Connector Details

Connector Category

RDBMS

Connector Version

Release6.3.4.8

Releases Supported (Available from)

Release6.3.4.8

Connectivity

[How the connection is established with RDBMS System]

REST APIs

Verified API Version

23_2

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

SFCC Object

SFCC Property

OvalEdge Attribute

OvalEdge Category

OvalEdge Type

System Objects

object_type

Table

Tables

Table

System Objects

description

Source Description

Descriptions

System Objects

object_type

Table Title

Object Fields

Column Name

Columns

Object Fields

display_name

Column Title

Object Fields

value_type

Column Type

Object Fields

field_length

Data Type Size

Object Fields

description

Column Description

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 Commerce Cloud administrator, as users may not have the required access to assign them independently.

Operations

Endpoint

Permission

Get List System Objects

/system_object_definitions

Read

Get objects metadata

/system_object_definitions/{object_type}

Read

Get List Fields for Object

/system_object_definitions/{object_type}/attribute_definitions

Read

Get field metadata

/system_object_definitions/{object_type}/attribute_definitions/{id}

Read

The access permissions specified above are based on the source system, including SFCC and other external sources. These permissions may vary depending on specific requirements or environment settings.

Connection Configuration Steps

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

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

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.

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 the 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 the 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". It can be changed 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 configured in the security settings 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 the security settings 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 that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.

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.
The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl

To perform crawl operation, users must be assigned the Integration Admin role.

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

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

The Schedule checkbox allows automated crawling at defined intervals, from a minute to a year.

Click the Schedule checkbox to enable the Select Period drop-down.
Select a time period for the operation from the drop-down menu.
Click Schedule to initiate metadata collection from the connected source.
The system will automatically execute the Crawl operation 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.

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

Connectivity Troubleshooting

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

S.No.

Error Message(s)

Error Description & Resolution

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 the correct Host URL of the Salesforce Commerce Cloud instance is entered.
Verify that the URL is accessible and matches the appropriate environment (e.g., development, staging, production).

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:

The Client ID or Client Secret entered in the setup form is incorrect.
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.

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:

The API Version entered in the setup form is incorrect.
Make sure that the version matches a supported Salesforce Commerce Cloud API version (e.g., v1, v2).

PreviousRDBMS NextOracle

Last updated 1 month ago

Was this helpful?

Overview

Connector Details

Connector Features

Metadata Mapping

Set up a Connection

Prerequisites

Service Account User Permissions

Connection Configuration Steps

Manage Connector Operations

Crawl

Other Operations

Managing connectors includes:

Nine Dots Menu Options:

Connectivity Troubleshooting