Salesforce Commerce Cloud Export Integration

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Salesforce Commerce Cloud (SFCC) is an e-commerce solution for B2C (business to consumer) and B2B (business to business) customers. This connector helps to

• Synchronize customer profiles on TD Console to the Customer Lists on the SFCC platform.
• ​Assign customers to or remove customers from the static Customer Groups on the SFCC platform.

Prerequisites

• Basic Knowledge of Treasure Data
• Basic knowledge of Salesforce Commerce Cloud
• Basic knowledge of Open Commerce Cloud API
• Have an API Client created on the Commerce Cloud Account Manager System. Further details can be found here

Limitations

• The application secret should not contain the %  character. Due to an internal issue with the SFCC authentication server, any secret containing the % character is not able to authenticate.
• The connector will send the customer attributes as-is without validating them. Data validation is on the SFCC side.
• To synchronize customer profiles to the SFCC Customer List, the list must exist on SFCC before the job execution.
• A large volume of data may cause low performance.

Use the TD Console

Create a New Connection

You must create and configure the data connection on TD Console before running your query. As part of the data connection, you provide authentication to access the integration following the below steps

1. Open TD Console
2. Navigate to Integrations Hub > Catalog
3. Search for and select Salesforce Commerce Cloud
4. Select Create Authentication, and provide the credential information for the integration as described below
5. Select **Continue,**enter a name for the Authentication, and select Done.

Authentication Fields

Configure a Query Result for Export

The TD Console supports multiple ways to export data. Please follow the below steps to export data from the Data Workbench.

1. Navigate to Data Workbench > Queries.
2. Select New Query, and define your query.
3. Select Export Results to configure the data exporting.
4. Select an existing SFCC authentication or create a new one following the above section.
5. Configure the exporting parameters as described below, and select Done.

• Configuration Parameters

• Use Update mode to update some selected attributes of the existing customer profiles. If Skip empty/null fields is checked, empty or null attributes will not be exported, and the existing values on SFCC will stay unchanged.
• Use Upsert mode when you want to overwrite all attributes. This means that the existing customer profiles will be replaced by those included in the query result, and attributes that are not included will be emptied. Profiles that do not exist will be created anew. |

Define your query to synchronize customer profiles to the Customer Lists

• Your query must include the customer_no column to indicate which customer profiles are synchronized.
• If the query intention is to update multiple Customer Lists, a column named customer_list_id can be included to indicate the target lists
• For other customer attributes, please refer to the SFCC documentation. All attributes will be sent as-is without any validation

Define your Query to Assign/Remove Customers to Customer Groups

To assign (or remove) customers to (from) a Customer Group, the only required column in your query is the customer_no column.

(Optional) Schedule Query Export Jobs

You can use Scheduled Jobs with Result Export to periodically write the output result to a target destination that you specify.

Treasure Data's scheduler feature supports periodic query execution to achieve high availability.

When two specifications provide conflicting schedule specifications, the specification requesting to execute more often is followed while the other schedule specification is ignored.

For example, if the cron schedule is '0 0 1 * 1', then the 'day of month' specification and 'day of week' are discordant because the former specification requires it to run every first day of each month at midnight (00:00), while the latter specification requires it to run every Monday at midnight (00:00). The latter specification is followed.

Scheduling your Job Using TD Console

1. Navigate to Data Workbench > Queries

2. Create a new query or select an existing query.

3. Next to Schedule, select None.

4. In the drop-down, select one of the following schedule options:

   Drop-down Value	Description
   Custom cron...	Review Custom cron... details.
   @daily (midnight)	Run once a day at midnight (00:00 am) in the specified time zone.
   @hourly (:00)	Run every hour at 00 minutes.
   None	No schedule.

Custom cron... Details

 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
 |    |    |    +---------- month (1 - 12)
 |    |    +--------------- day of month (1 - 31)
 |    +-------------------- hour (0 - 23)
 +------------------------- min (0 - 59)

The following named entries can be used:

• Day of Week: sun, mon, tue, wed, thu, fri, sat.
• Month: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.

A single space is required between each field. The values for each field can be composed of:

1. (Optional) You can delay the start time of a query by enabling the Delay execution.

Execute the Query

Save the query with a name and run, or just run the query. Upon successful completion of the query, the query result is automatically exported to the specified destination.

(Optional) You can delay the start time of a query by enabling the Delay execution.

Activate a Segment in Audience Studio

You can also send segment data to the target platform by creating an activation in the Audience Studio.

1. Navigate to Audience Studio.
2. Select a parent segment.
3. Open the target segment, right-mouse click, and then select Create Activation.
4. In the Details panel, enter an Activation name and configure the activation according to the previous section on Configuration Parameters.
5. Customize the activation output in the Output Mapping panel.

• Attribute Columns
  • Select Export All Columns to export all columns without making any changes.
  • Select + Add Columns to add specific columns for the export. The Output Column Name pre-populates with the same Source column name. You can update the Output Column Name. Continue to select + Add Columnsto add new columns for your activation output.
• String Builder
  • + Add string to create strings for export. Select from the following values:
    • String: Choose any value; use text to create a custom value.
    • Timestamp: The date and time of the export.
    • Segment Id: The segment ID number.
    • Segment Name: The segment name.
    • Audience Id: The parent segment number.

6. Set a Schedule.

• Select the values to define your schedule and optionally include email notifications.

7. Select Create.

(Optional) Export Integration Using the CLI

The TD Toolbelt can trigger the Query Result exporting from a CLI. You need to specify the parameters for the exporting job as the --result option of the td query command. For more information, please refer to this article.

The format of the option is JSON and the general structure is as follows.

• Case: data_target is customer_list

{"type": "salesforce_commerce_cloud",    "client_id": "client_id",    "client_secret": "client_secret",    "base_url": "https://your link.commercecloud.salesforce.com",    "data_target": "customer_list",    "operation_mode": "create,update,delete,upsert",    "customer_list_id": "customer_list_id",    "skip_empty_fields": true,    "thread_count": 2}Case: data_target is customer_group{    "type": "salesforce_commerce_cloud",    "client_id": "client_id",    "client_secret": "client_secret",    "base_url": "https://your link.commercecloud.salesforce.com",    "data_target": "customer_list",    "customer_group_operation_mode": "add,remove,replace",    "site_id": "your site id",    "customer_group_id": "your customer group id",    "customer_group_name": "your customer group name",    "thread_count": 2}

CLI Parameters

Example usage

• Create the new customer

td --database luan_db --wait "SELECT customer_list_id,first_name,last_name,birthday,company_name,email,fax,gender,job_title,phone_business,phone_home,phone_mobile,second_name,credentials FROM (VALUES ('site_1','fname_201','lname_1','1990-05-12','Test Company','test201@test.com','84111111201',1,'Sr Software','84111111201','84111111201','84111111201','Ryan','{\"enabled\":true,\"locked\":false,\"login\":\"login_url_1_100001.csv\"}')) tbl(customer_list_id,first_name,last_name,birthday,company_name,email,fax,gender,job_title,phone_business,phone_home,phone_mobile,second_name,credentials)" \--type presto \--result '{"type":"salesforce_commerce_cloud","td_authentication_id": 2837,"base_url":"https://zzvt-003.dx.commercecloud.salesforce.com","operation_mode":"create","customer_list_id":"static_g_1","skip_invalid_record":true,"thread_count":2}'

• Update the existing customer

td --database luan_db --wait "SELECT customer_list_id,customer_no,first_name,last_name,credentials FROM (VALUES ('site_1','00000001','fname_1_updated','','{\"enabled\":true,\"locked\":false,\"login\":\"login_url_1_100001.csv\"}')) tbl(customer_list_id,customer_no,first_name,last_name,credentials)" \--type presto \--result '{"type":"salesforce_commerce_cloud","data_target": "customer_list","td_authentication_id": 2837,"base_url":"https://zzvt-003.dx.commercecloud.salesforce.com","operation_mode":"update","customer_list_id":"static_g_1","skip_invalid_record":true,"thread_count":2}'

• Assign customer to a specific customer group

td --database luan_db --wait "SELECT customer_no FROM (VALUES ('00000001')) tbl(customer_no)" \--type presto \--result '{"type":"salesforce_commerce_cloud","data_target": "customer_group","td_authentication_id": 2837,"base_url":"https://zzvt-003.dx.commercecloud.salesforce.com","customer_group_operation_mode":"add","site_id":"site_1", "customer_group_id": "static_customer_group_1","thread_count":2}'

(Reference) Create and configure an API Client

This section explains at a high level how to obtain credentials and configure necessary permissions (if any) to use the SFCC API. The detailed steps might be changed by Salesforce without any in-advance notice.

Create an API Client on the SFCC Account Manager System

1. Navigate and log in to the SFCC Account Manager
2. Select API Client

1. Select Add API Client

1. Type values for Display Name, Password, Confirm Password, and select Access Control to enable it
2. In the Organizations area, select your organization
3. In the Roles area, select Add
4. Select the appropriate roles, and select Add
5. Scroll to the Token Endpoint Auth Method section
6. Select the Auth method and the token format like the one below, and select Save

7. Note down the API Client ID and Password to create a new Authentication for the SFCC integration on the TD Console

Configure the API Client to access your SFCC instance

These steps allow the created API Client to modify data on your SFCC instance using the Open Commerce API features

1. Open Business Manager (https://{YOUR_INSTANCE_URL}.commercecloud.salesforce.com/on/demandware.store/Sites-Site/default/ViewApplication-DisplayWelcomePage)
2. Select Administration >> Open Commerce API Settings

3. Select Data in the Select Type drop-down list

4. On the configuration string of the Data API, make sure the WRITE permission is set: "write_attributes": "(**)"
5. Select  Global (organization-wide) in the Select Context drop-down list
6. Select Save, and the permission of the API Client will be applied in a few minutes

Your API Client is ready to be used in the Salesforce Commerce Cloud integration

Related articles

• The Result Export can be scheduled to upload data to a target destination periodically

• All import and export integrations can be added to a TD Workflow. The td data operator can be used to export a query result to a specified connector. For more information, see Reference for Treasure Data Operators

• Open Commerce Cloud API