Published at: 2025-10-30

Salesforce Connector Configuration Guide

1. Documentation Overview

This document outlines the procedures, steps, and assets for Salesforce integration/migration projects from pre-sales through delivery. It provides a set of best practices for system integration/migration using the Integration Platform and aims to help implementation teams improve delivery efficiency.

This document is intended for pre-sales industry specialists, Account executives, delivery technical consultants, and implementation consultants.

2. Pre-sales Phase

This phase emphasizes the value delivered to customers by integrating CRM with Salesforce via the Integration Platform and the advantages of using the Integration Platform for Salesforce integrations. Refer to the Training Assistant Videos for the Salesforce connector configuration and to set up a demo environment: https://www.fxiaoke.com/XV/UI/Home?noheader=0&ddtab=true#app/train/detail/=/id-132948/trainType-0. For pre-sales demos, you can also reference the Salesforce migration PPT demo video. The PPT is available at: Cloud Drive > Company Files > All Files > ❤️ Sales Essentials - Sales Toolkit > 04 Salesforce Replacement and Migration

image

3. Implementation Phase

When starting implementation, use the information collected during pre-sales discovery to get an initial understanding of the target system’s API interfaces, integration objects, and data flows. Next, use the implementation toolkit to perform a detailed survey and produce the customer business blueprint, integration flow diagrams for each system that needs to integrate with CRM, and a prioritized list of the customer’s original data (i.e., complete the implementation tool’s preliminary survey List, business blueprint, and flowchart tabs). After producing these deliverables, conduct an internal business solution review.

After solution confirmation, proceed to field-level mapping for each integration object to prepare concrete API examples for developer communication. Once field mapping is complete, coordinate a standards discussion between internal R&D and the customer’s developers. Notes:

  • For Salesforce system integrations, solution design is critical. Allocate sufficient time and attention for this step.
  • Although not mandatory, we recommend first configuring and validating customer business processes in a sandbox environment (CRM sandbox must connect to the customer’s SAP test instance). Only after successful joint validation should you finalize go-live arrangements. Important: If you must configure directly in the production environment, obtain the customer’s agreement to avoid disputes—ideally secure a signed or screenshot acknowledgement from the customer indemnifying the implementer.
  • The implementation tool exists to provide accurate, detailed integration materials. All fields in the tool must reflect actual findings from the implementation-level survey (list specific scenarios in the remarks and explain them during review). Any omissions that cause schedule delays are the responsibility of the person who completed the form.

3.1 Implementation Prerequisites

Implementation prerequisites:

  1. Implementation toolkit survey completed and solution review approved;
  2. CRM and Integration Platform Salesforce connector enabled;
  3. Customer-side SAP system APIs/packages completed and unit-tested.

After confirming prerequisites are met, proceed to System Management > Integration Platform Management to perform configuration.

3.2 Connector Configuration

3.2.1 Authorization Configuration

Open the Salesforce connector and enter authorization information. The connector supports two authorization methods: OAuth 2.0 (Authorization Code) and API Key. Configuration details follow:

  • If you choose the OAuth 2.0 Web Server Flow (OAuth 2.0 Web Server Flow for Web App Integration) — OAuth 2.0 (Authorization Code) authorization, fill parameters as follows:

    • Authorization method: OAuth 2.0 (Authorization Code)
    • Base URL: Salesforce system domain
    • Version URL: Optional; supports API versions 50.0 and above
    • client_id: Refer to the appendix “Salesforce Authorization Setup” for how to obtain
    • client_secret: Refer to the appendix “Salesforce Authorization Setup” for how to obtain
    • Redirect URI: Displayed during OAuth2.0 authorization and cannot be modified. You must add this address to Salesforce as a callback URL.

image

  • If you choose the OAuth 2.0 Client Credentials Flow for Server-to-Server Integration — API Key authorization, fill parameters as follows:

    • Authorization method: OAuth 2.0 (Authorization Code)
    • Base URL: Salesforce system domain
    • Version URL: Optional; supports API versions 50.0 and above
    • client_id: Refer to the appendix “Salesforce Authorization Setup” for how to obtain
    • client_secret: Refer to the appendix “Salesforce Authorization Setup” for how to obtain

image

Appendix: Salesforce Authorization Setup

  • OAuth 2.0 Web Server Flow (OAuth 2.0 Web Server Flow for Web App Integration) — default. Maps to platform OAuth2.0 type.
  • (Recommended) OAuth 2.0 Client Credentials Flow for Server-to-Server Integration — non-default. Maps to platform API Key type.
  • Metadata management API: obtain object list, obtain Sub-object list (related objects), obtain object field information.
  • Query records changed since a timestamp; query records by ID.
  • Single-object record create and update.
  • Primary Object and Sub-object record create.
  • Primary Object and Sub-object record update; detail record deletion is not supported.

Configuration elements: Configuring a Salesforce External Client App includes the following steps:

  • Create a new External Client App
  • Configure OAuth
  • Configure Policies
  • Retrieve keys
    • Enable OAuth 2.0 Client Credentials Flow for Server-to-Server Integration [optional, recommended]

· Create a New External Client App

Log in to Salesforce → Setup → Apps → External Client App Manager → New External Client App

image

image

image

· Enable OAuth Settings

External Client App Manager → [Your app] → Enable OAuth → Configure OAuth

picture coming soon:

image

image

Copy the Redirect URI

image

Set redirect URIs and API scope

image

Uncheck PKCE

image

· Configure Policies

image

· View Keys

Enter the app

picture coming soon:

image

image

image

Fill in authorization information

· Enable OAuth 2.0 Client Credentials Flow

image

Edit app configuration

image

Enable

3.2.2 Retrieve Connection Objects

After authorization succeeds, the Salesforce connector can use metadata management APIs to retrieve object categories, Sub-object lists, and field details. Note: Modern Salesforce versions typically do not maintain strict master-detail relationships; the Sub-object list will return all related objects. Select related objects according to business needs.

image

After retrieving a Primary Object, you can select the converted Sub-objects below according to business requirements.

3.2.3 Configure Object Mapping

After retrieving objects, configure object mappings in the object list. Click Edit Mapping to open the mapping page. You can map to an existing CRM object or create a new object for mapping.

image

After object configuration, map object fields. When you select to create a custom object, the system can automatically create the custom object and its fields in CRM based on the Salesforce object, enabling rapid object and field migration.

3.2.4 Attachment Migration

Attachments for Salesforce business objects can be migrated using a preset field (field API name: fake_salesforce_data_file). In the connection object field viewer, a preset fake_salesforce_data_file field is available.

image

If object records require attachment migration, in Migration Tool > Edit Mapping, map the connector’s fake_salesforce_data_file field to the CRM attachment-type field as shown:

image

When you create an integration flow in section 3.3, the system will automatically map the corresponding attachment-type field on the integration flow. After enabling it, the integration flow will automatically retrieve and migrate Salesforce record attachments.

3.3 Create Integration Flows

In the migration list, select the mapped objects and field records, then click More > Create Integration Flow to quickly create an integration flow based on the configured mappings:

picture coming soon:

Open the integration flow, review and edit field mappings, then enable the integration flow. Perform a small data sync to validate the configuration. If no issues are found, use the historical data sync function to bulk migrate Salesforce business data.

Reference Documents

salesforce official: About CRM software and cloud solutions: https://www.salesforce.com/cn/?ir=1

salesforce Developer Portal: https://developer.salesforce.com/

salesforce REST API documentation: About REST API | REST API Developer Guide | Salesforce Developers https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_what_is_rest_api.htm

salesforce OAuth 2.0 authorization docs: OAuth Authorization Flows (salesforce.com) https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_flows.htm&type=5

Submit Feedback