Documentation Center

Connector for Salesforce CRM configuration properties

Implementing the Tridion Connector for Salesforce CRM requires a JSON configuration file, which defines your specific integration of Tridion with Connector for Salesforce CRM.

This topic describes the configuration properties that are needed specifically for the Connector for Salesforce CRM. For full details on the standard Connector configuration format, refer to the related topics.

clientId
API username to be used to authenticate over OAuth.
Use the consumer secret of the connector application you defined when setting up OAuth.
This property applies only to the REST API login flow.
clientSecret
API password to be used to authenticate over OAuth.
Use the consumer secret of the connector application you defined when setting up OAuth.
This property applies only to the REST API login flow.
username
API username defined in Salesforce CRM instance.
This property is required for both SOAP and REST login flows.
password
API password defined in Salesforce CRM instance consisting of a login password plus a security token, where the security token is a generated key from Salesforce CRM.
This property is required for both SOAP and REST login flows.
Example: With a user password of "mypassword" and a security token of "XXXXXXXXXX" the API password would be "mypasswordXXXXXXXXXX".
requestTimeout
Maximum time allowed for each request after the connection is established.
Specify the timeout in milliseconds.
entityTypes
A list of Salesforce CRM entity types (CRM data types) to be exposed through the Connector, such as a CRM contact.
When the Connector starts, it dynamically reads all schema details about the configured entity types.
If using the Content Delivery GraphQL endpoint, the configured CRM data types are exposed as GraphQL types.
pageSize
Default page size when doing search and list operations.
This property is optional. When no value is specified, the default page size is 100.
namespacePrefix
A Boolean value (true/false) that indicates whether the Salesforce CRM namespace prefix, if one has been associated to the package, should be removed from the custom field names.
When set to true, the Connector will remove any existing Salesforce CRM namespace prefix, as registered with the package in AppExchange (Apex).
exposeDataTypes
A Boolean value (true/false) that indicates whether data type information from Salesforce should be exposed to the form builder in the Tridion Sites Content Manager.
When set to true, Content Manager uses the data types to select data fields for the various form fields.

The following sample code illustrates the configuration file of a Connector for Salesforce CRM:

{
  "configuration": { 
     "SalesforceCRM": {
        "namespaces": {
            "salesforce"
                "configuration": {
                  "clientId": "K2347bZfZulVdeO5lMKuUbqzCme_3MGV9tzRQhEbJ_BtqvXm6M",
                  "clientSecret": "A129F7993688816A5159F9BBCFB8DE3EF1F541C”,
                  "username": "user1@mysalesforceinstance.com",
                  "password": "S3cret!",
                  "entityTypes": ["Account", "Contact", "Lead"],
                  "pageSize": 100
                }
            }
         }
     }
  },
  "sitesCm": {
    "isEnabled": true,
    "SalesforceCRM": { 
    	"displayName": "Salesforce",
    	"stubFolders": ["tcm:2-71-2"],
    	"configuration": {
           "exposeDataTypes": true
    	}
    }
  },
  "staging": {
    "isEnabled": true,
    "SalesforceCRM": { 
    	"configuration": {
           "pageSize": 200
    	}
    }
  }
}