Salesforce
Integration type: User-defined
A User-defined integration meaning you can select variables at run time and create a personalised output based on specific requirements.
Supported functionality
Upload
Upload - You can upload a list to schedule then send using the ESP's own functionality
Upload & Broadcast - You can upload a list to the ESP to broadcast immediately
Broadcast
Email - You can create an email broadcast in Orbit and PeopleStage
Documentation
Click the link to download the Salesforce Integration Guide
Click the link to download the Salesforce Broadcaster Setup Pages
Channel configuration in Orbit
Note: Values shown may be for example only, the options will differ for each broadcaster.
Basic Details
| Name | Description |
|---|---|
| Channel Name | Enter a name for the channel |
| Broadcaster | Select Salesforce from the drop-down |
| Broadcaster Username | Enter your broadcaster API username, Available from Salesforce |
| Broadcaster Password | Enter your broadcaster API password, Available from Salesforce |
| Update Password | This button displays once a password has been set you can use this to change the password if required |
| Test Login | Use the Test Login button to confirm the above details are correct. A "Test login successful" message will display to if the credentials are correct |
| Email Variable | Select Email Address from the drop-down |
| Advanced Email Variable Settings | The Email Variable drop down enables the check-box option to "Select email variable during campaign creation". This is for use with PeopleStage. Do not use this channel option in Orbit |
| Email Variable Description Override | Optional - Enter the description, for example, “Email Address” Note: This must correspond to the e-mail field within Salesforce |
| Reply Email Address | The email address that will receive notifications when the channel is used, this is NOT the reply email address that will be used for the email send |
| Broadcaster Action | The default is Upload and Broadcast, select Upload Only to upload the list only without initiating a broadcast |
Broadcast Parameters
| Parameter Name | Parameter Value |
|---|---|
| Email Content | Options are Classic, Builder or Both. Content Builder replaced Classic Builder, new email content will use Content Builder but you can still send using existing Classic emails. Select Both if you have existing Classic emails |
| API Version | All new accounts with Salesforce will be on v2, you can check if your existing API Package is a Legacy API v1 from Setup – Apps > Installed Packages |
| Authentication Base URI | e.g. *https:// msem8vt6-nevvshs2m4rgf24jlw7.auth.marketingcloudapis.com/ |
| Base URI | e.g. *https://msem8vt6-nevvshs2m4rgf24jlw7.rest.marketingcloudapis.com/ |
| Client ID | e.g. *g2yTgel9ighz118ps6cWnq3j |
| Client Secret | 8ps6cWnq3j9ighz11g2yTgel |
| API Timeout | Api Timeout for the RESTful Api in seconds (the default value is 300 seconds) |
| Business Unit | Optional |
| URL | Soap Base URI e.g. *https://msem8vt6-nevvshs2m4rgf24jlw7.soap.marketingcloudapis.com/ |
| Triggered Send Definition | |
| Use Triggered Sends | |
| Sendable | Setting this to false will put the data extension into non sendable mode, useful for if you only want to report on the data. The default option is true. |
| Publication List | |
| Triggered Send Data Extension | |
| Use URN as Subscriber Key | Choose whether to use the URN as the subscriber key, the default is 'false'. |
| Subscriber Key Name | |
| The Salesforce Send Classification | e.g. Default Commercial |
| File Transfer Location | Recommended "ExactTargetEnhanced FTP Found in the ESP's Admin panel under Data Management, "ExactTargetEnhancedFTP"" |
| The *Sender Profile Code/s to associate with a broadcast in FastStats or PeopleStage (). | Mouse over the Sender Profile Initials to see the globally unique identifier (GUID) at the bottom of the window, change to uppercase *24C54B21-3708-F123-A4E8-973AF123381B |
| Business Unit | Enter the Business Unit name for the account you wish to use for this broadcast. |
| Data Extension Retention Period | |
| Owner Member ID | Enter your owner member ID |
| Owner Member Name | |
| URL | The API URL e.g. https://webservice.exacttarget.com/Service.asmx Check with Salesforce |
| Upload and Broadcast Folder | These can be absolute paths to the folder, or you can use the following parameters e.g. Root\%LISTNAME%\%MESSAGENAME% |
| Upload Only Folder | The message Upload Folder under the Data Extensions tree and the Upload Only Folder to organize your broadcasts |
| Account Id/FTP Username | e.g. *12345678 used as the FTP Username and forms the first part of the FTP URL |
| FTP Password | |
| FTP URL e.g. ftp1.exacttarget.com | The FTP endpoint can vary between accounts see: Developer.Salesforce |
| Throttle Start Time | |
| Throttle End Time | |
| Throttle Limit | |
| Encoding |
Common Parameters
| Parameter Name | Parameter Value |
|---|---|
| SFTP Private Key Path | If secure ftp is used above and requires a private key, this should refer to the path and filename of that key. |
| Use Dated List | Setting this to false will remove the date and time stamp at the end of the file name. The default option is 'true'. |
| Dated List Format | Enter the date format string for the date and time stamp if created. The default value is yyyyMMdd-HHmmss. |
| FTP Protocol | Enter the date format string for the date and time stamp if created. The default value is yyyyMMdd-HHmmss. |
Output Settings
| Name | Value |
|---|---|
| Allow in Transactional Output | This is a setting specific to PeopleStage and Transactional Campaigning. (Note: if you select Yes, it means you can send multiple emails to the same email address) |
| Append to List | Optional |
| Number of Retries | The number of times to retry on failure of the channel. It is recommended (for Broadcast Channels) to leave this at 0. The Delivery Agent also has a retry value, so setting this to > 0 can result in multiple retries and may cause undesirable results |
| Response File Key Type | This is a specific setting to channels where Response Gathering has been set up in FastStats.The key field to match responses to sends. Varies from broadcaster to broadcaster due to the fields they return in the response file. Should be set to Communication Key for Salesforce. |
| Message Content Type | For email broadcasts this will always be Template (using the Broadcaster Template) |
| Retrieve Existing List Names | Optional, not supported in Orbit at the moment |
File Settings
| Name | Value |
|---|---|
| Zip File | Default is deselected, select this optional setting to compress the file if required |
| Output File Format | Default is Comma Separated Values (CSV) |
| Output Header | Default is Descriptions, will use the title of the variable in the header |
| Delimiter | Default is Tab |
| Alpha Encloser | Default is None |
| Numeric Encloser | Default is None |
| Extras | This field is empty by default, it can reference the name of Extras XML file, this area is reserved for advanced use |
| Encoding | Default is UTF-8 |
Ordinarily, you would use the default settings on this page unless the broadcaster requires a different option explicitly.
Additional Variables
Common variables used in this section are Forename, Surname, etc. The purpose here is to map any additional FastStats variables to the broadcaster's variables. For example the Forename variable in FastStats may be named FirstName in the broadcaster. This ensures any broadcaster templates that use one of the additional variables are populated correctly.
-
Click the +Add Variable button to select a variable.
-
Click in the Search data box.
-
Select the variable to add from the system.
See the variable options below
| Name | Value |
|---|---|
| Variable | Click to search the FastStats system for the additional variable |
| Variable Description Override | Optional, use this field to override the variable header description to match the name in the broadcaster, e.g Forename - FirstName |
| Formatting | Default is Unformatted, you have the option to apply a naming convention to the variable, either UPPERCASE, lowercase or TitleCase |
| Append Additional Variables Directly | Deselected by default, select this option to change how the additional variables are added to the list, either at the End or Beginning. When not set the variables will append to the end of the list. |
| Selector and Multi-Response | Additional options are available for these types of variables |
| Chose Output | Selects what to output, either the Description or the Code from the system design, the default is description. |
| Handle "Unclassified" as | Select how to handle unclassified selector data, use the setting as specified in the system From Design or send no content Empty |