Salesforce Commerce Cloud Connection¶

Introduction¶

A Salesforce Commerce Cloud connection, created using the Salesforce Commerce Cloud connector, establishes access to Salesforce Commerce Cloud. Once a connection is configured, you can create instances of Salesforce Commerce Cloud activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or Edit a Salesforce Commerce Cloud Connection¶

A new Salesforce Commerce Cloud connection is created using the Salesforce Commerce Cloud connector from one of these locations:

• The design component palette's Connections tab (see Design Component Palette).
• The Global Connections page (see Create a Global Connection in Global Connections).

An existing Salesforce Commerce Cloud connection can be edited from these locations:

• The design component palette's Connections tab (see Design Component Palette).
• The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
• The Global Connections page (see Edit a Global Connection in Global Connections).

Configure a Salesforce Commerce Cloud Connection¶

Each user interface element of the Salesforce Commerce Cloud connection configuration screen is described below.

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each Salesforce Commerce Cloud connection and must not contain forward slashes / or colons :. This name is also used to identify the Salesforce Commerce Cloud endpoint, which refers to both a specific connection and its activities.

• Tenant ID: Enter the tenant ID. A tenant ID begins with a four-character realm ID, followed by an underscore (_) and an instance ID.

• Organization ID: Enter the organization ID. You can look up the organization ID for an instance through Business Manager.

• Short Code: Enter the short code. The short code is in the same place as the organization ID.

• Client ID: Enter the client ID, depending on whether your API client is for an Admin API or a Shopper API.

• Client Secret: Enter the client secret, depending on whether your API client is for an Admin API or a Shopper API.

• Use Proxy Settings (Private Agent Only): When using a Private Agent, this setting can be selected to use Private Agent proxy settings.

• Test: Click to verify the connection using the provided configuration. When the connection is tested, the following occurs:

  • The connection is validated against two resources: oauth2/access_token and a GET call to the /product resource. The minimum required authorization scope is sfcc.products.rw.

  • The latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Next Steps¶

After a Salesforce Commerce Cloud connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions Menus in Connector Basics.

These activity types are available:

• Search: Based on a specified custom query, retrieves a limited set of Customer, Pricing, or Product object data from Salesforce Commerce Cloud, and is intended to be used as a source in an operation.

• Read: Based on a specified set of criteria, retrieves all Checkout, Customer, or Product object data from Salesforce Commerce Cloud, and is intended to be used as a source in an operation.

• Get: Based on specified IDs, retrieves all Checkout, Customer, Pricing, or Product object data from Salesforce Commerce Cloud and is intended to be used as a source in an operation.

• Create: Creates Customer, Pricing, or Product object data in Salesforce Commerce Cloud and is intended to be used as a target in an operation.

• Update: Updates Customer, Pricing, or Product object data in Salesforce Commerce Cloud and is intended to be used as a target in an operation.

• Delete: Deletes or cancels Customer, Pricing, or Product object data in Salesforce Commerce Cloud and is intended to be used as a target in an operation.