Salesforce plugin setup¶

Creating a connected app in Salesforce¶

In order to use Salesforce with Campaign Studio, you must have a connected app in Salesforce. You may use an existing Salesforce user for the connection. However, Acquia recommends that you create a Salesforce user exclusively for connecting with Campaign Studio.

To create a connected app:

1. Access your Salesforce account.

2. Navigate to Setup > Apps > App Manager and click New Connected App.

   For more information, see Configure Basic Connected App Settings.

   

3. In the Basic Information section:

   

   1. In Connected App Name, specify a name for the connected app. For example, Campaign Studio.
   2. In API Name, set the value to Campaign_Studio. The system populates this field dynamically based on the value specified in Connected App Name.
   3. In Contact Email, specify the email address to which Salesforce can send an email, regarding the connected app.
   4. In Contact Phone, specify the phone number which Salesforce can contact regarding the connected app.
   5. In Logo Image URL, click Upload logo image to upload the image located in this location.
   6. In Info URL, specify the URL for this documentation page.
   7. In Description, specify the description for the connected app. For example, Integration with Campaign Studio.

4. Under the API (Enable OAuth Settings) section:

   

   1. Select the Enable OAuth Settings check box.

   2. In Callback URL, specify the Callback URL displayed in the plugin configuration modal in your Campaign Studio instance. The format is: https://subdomain.company.com/integration/Salesforce2/callback, where subdomain.company.com is replaced with your custom domain.

      

   3. Clear the Use digital signatures check box.

   4. In Selected OAuth Scopes, select the following scopes and move them to the Selected OAuth Scopes section on the right.

      • Manage user data via APIs (api)
      • Perform requests at any time (refresh_roken, offline_access)

5. Save the changes.

6. On the App Manager page, locate the row for your connected app.

7. Click the down arrow icon in the same row and then click View.

8. Locate Manage Consumer Details and copy the value for Consumer Key and Consumer Secret.

   You must specify these values in Campaign Studio while configuring the Salesforce plugin. For more information, see Configuring the plugin in Campaign Studio.

   

Configuring the plugin in Campaign Studio¶

To configure the plugin in Campaign Studio:

1. Sign in to your Campaign Studio account.

2. Click the Settings icon on the top right corner and select Plugins.

3. Click the Salesforce plugin. If you see two Salesforce options, select the second one (the first one is the legacy Salesforce plugin).

   

4. Under the Enabled/Auth section, perform the following steps:

   

   1. Leave the plugin unpublished until you’re fully ready to turn on the plugin and start syncing data.

      Note

      Whenever you make any configuration changes, such as field mapping changes, ensure that you unpublish and re-publish the plugin for all the changes to take effect.

   2. Specify the values for Consumer id and Consumer secret. You’ll get these values from Salesforce apps page. For more information, see Creating a connected app in Salesforce.

   3. Click Authorize App. A new window will open, where you can log in to Salesforce using the user credentials you’ve created for the plugin to use.

      Note

      If you try to authorize Campaign Studio immediately after creating the connected app in Salesforce, you might get an error. If so, wait for ~10 minutes and try again. The connected app and its credentials need time to propagate.

5. Under the Features section, perform the following steps:

   

   1. To enable sync between Salesforce and Campaign Studio, select the Sync objects between Campaign Studio and this integration check box. If this box is not selected, data doesn’t sync regularly. However, you’ll be able to use specific actions in campaigns, forms, and point triggers to push contacts from Campaign Studio to Salesforce. Once pushed, no data for those contacts will be updated in Campaign Studio if this check box is not selected.

   2. In Select the objects to sync with Campaign Studio, select the specific objects for which you want to get data synced between Salesforce and Campaign Studio. Available objects are Leads, Contacts, and Accounts.

   3. In Start synchronization from date, select the date from which data needs to be synced between Salesforce and Campaign Studio. Any records updated in Salesforce more recently than the selected date will be pulled into and synced with Campaign Studio. If you change this date after first publishing the plugin, you’ll need to unpublish and re-publish the plugin for the sync to start from the new date.

   4. (Optional) In Fetch only records for SF Lead that meet the following condition, select either Include or Exclude to include or exclude leads who have either a positive or negative value on a boolean field in Salesforce.

      Note

      If you don’t want to sync all leads, you may want to create a field in Salesforce for Sync to Campaign Studio and update that to a positive value using a Salesforce workflow, based on the criteria you determine.

   5. (Optional) In Push only records for Contacts that meet the following condition, select either Include or Exclude to include or exclude leads who have either a positive or negative value on a boolean field in Salesforce.

      Note

      If you do not want to sync all contacts, then create a field in Salesforce for Sync to Campaign Studio and update that to a positive value using a Salesforce workflow, based on the criteria you determine.

   6. (Optional) Repeat the above step for Company.

   7. (Optional) Repeat the above step for contact and account objects.

   8. To display a lead or contact’s Campaign Studio activity timeline on the record in Salesforce, set the Upload Campaign Studio activities toggle bar to Yes. For more information, see Timeline object.

   9. In Events to include in the activity sync, select the activity types that you’d like to display in Salesforce, if the Upload Campaign Studio activities toggle bar is set to Yes. For example, Email read, Form submitted, Point gained.

   10. If the Salesforce account that you’re connecting to is a sandbox for testing purposes, select the This is a Sandbox account check box.

       Note

       For sandbox, ensure that you select this check box as sandbox logins have different URLs, such as test.salesforce.com.

   11. In If your Salesforce account uses a namespace prefix, enter it here, specify your organization’s namespace prefix, if it is defined. Having a namespace prefix changes the API names for fields. Hence, if you have one, you must define it here.

6. Under the Lead Field Mapping section, perform the following steps:

   

   1. Map the specific Campaign Studio lead to a Salesforce field. Campaign Studio automatically identifies the Salesforce fields for each of the lead objects. The fields for each object are listed alphabetically. However, you can find a specific Salesforce field by using the Filter integration fields… search bar.

   2. From the following available options, select the direction you’d like the data to flow. To ensure that the data gets synced properly, see Field mapping validation.

      • Sync only to Campaign Studio: If Salesforce is your source of truth and data shouldn’t be updated in Salesforce by Campaign Studio.
      • Sync only to the integration: If you don’t want data to be updated in Campaign Studio by Salesforce.
      • Sync both ways: if you want to always match the fields using the latest updated data, no matter which system the data was last updated in.

      Important

      • If a synced record is updated in both systems within the same window between syncs, the system with the more recently changed data pushes data to the other system. The sync is expected to take place approximately every five minutes.
      • If a field is not writable in Salesforce, the system displays only the Sync only to Campaign Studio option for the direction of the sync.
      • For leads, you must map Company Name, Email address, and Last Name. Records that don’t have values in any required fields don’t sync.

7. Repeat the above step for the Contact Field Mapping and Account Field Mapping sections. For contacts, you must map Email and Last Name. For accounts, you must map Account Name.

8. Under the Enabled/Auth section, set the Plugin must be enabled and authorized for this field to work toggle bar to Yes (published).

9. Click Apply or Save & Close.

Setting up timelines¶

As a Salesforce user, you might want to view a lead or contact’s engagements with marketing activities. The following two ways enable you to view activities and interactions from Campaign Studio, as a Campaign Studio user would normally see on a contact record:

• Timeline object
• Timeline link

Segment filters¶

Once the plugin is authorized and published, you can view three Salesforce specific segment filters:

• Is a Salesforce Contact
• Is a Salesforce Lead
• Salesforce Campaign

The Salesforce filters for lead and contact have operators of including/excluding with values of yes/no.

For example,

• To create a segment of any Campaign Studio records that are synced to Salesforce contacts, select Is a Salesforce Contact, Including, and Yes.
• To create a segment of all records which aren’t synced with a Salesforce contact, select Is a Salesforce Contact and Excluding/Yes or Including/No.

For Salesforce campaign filters, the operators are equals/not equal/empty/not empty. Once you’ve selected the appropriate operator, type the name of the Salesforce campaign that you want to use in the filter. Campaign Studio displays a list of Salesforce campaigns with matching names, and the available statuses. To include multiple campaigns and/or statuses, add multiple segment filters with the OR filters.

Form, Campaign, and Point Trigger Actions¶

Campaign Studio has multiple Salesforce specific actions related to forms, campaigns, and point triggers. These actions can modify the way a record is synced with Salesforce:

• Create Salesforce task
• Push contact to Salesforce
• Remove from Salesforce campaign

All of the above actions are available as standalone form actions, campaign actions, and as point triggers. However, these actions are not available for campaign forms.

Points¶

Based on the status of a Salesforce campaign, Campaign Studio can add or remove points from a record.

To allocate points for Salesforce records:

1. Sign in to your Campaign Studio account.

2. Go to Points > Manage Actions and click New.

   

3. In Name, indicate a name for the point action that appears in your point action list.

4. In Description, add more detail on the campaign status and the value in adding or removing points based on that status.

5. In Change points (+/-), set the number of points you’d like to add (positive number) or subtract (negative number) based on the campaign status.

6. In When a contact, select Salesforce campaign member change for the Salesforce-specific point action. For more information, see points.

7. In Select Salesforce Campaign, select the campaign that you want to use as the basis for changing points. The system populates this field with all the active campaigns in Salesforce.

8. In Select Salesforce Campaign Status, select the status that triggers the point addition or subtraction to the record. The system populates this field with the available statuses for the selected campaign.

9. Save the changes.

Once a record has the selected status on the selected campaign in Salesforce, the point action adds or subtracts the designated number of points.