S4S List Builder for Sitecore 9.3 and above

Owned by Ashan Wijayawardhane (Unlicensed)
Last updated: Nov 01, 2020 by Paul Carter (Unlicensed)
3 min read

Prerequisites

To use S4S List Builder with Sitecore 9.3 and above, you require the following:

  • Core S4S version 2.931.20224.1 or above.

  • S4S List Builder version FuseIT-S4SLB-2.93.20244.1 or above

Installation

S4S List Builder comes as a standard Sitecore Package. Users can install it from:

Sitecore Desktop » Start menu » Development Tools » Installation Wizard.

By default, S4S List Builder imports Email Address, First Name and Last Name from Salesforce to the Sitecore Contact. S4SLB 2.93.20244.1 supports additional Salesforce fields to be saved in the Sitecore Contact as custom facets - see the following steps:

  • You can define additional Salesforce fields that you need to import from following paths in the Sitecore tree.

    For Salesforce Contacts - /sitecore/system/Modules/S4S/S4SLB Facet Mapping/Contact

    For Salesforce Leads - /sitecore/system/Modules/S4S/S4SLB Facet Mapping/Lead

  • Right-click any of the items above (Depending on what Salesforce entity you need to add extra fields) and create a new item from the template called “Facet Mapping”. “Facet Mapping” template can be found in /sitecore/templates/S4S/S4SLB/Facet Mapping.

  •  After creating a new item using the “Facet Mapping” template, you can choose the facet field key and add the Salesforce field name. After you fill those fields, added Salesforce field value will save into the chosen facet field key in S4SInfo facet.

  • You can create multiple items as above if you need multiple Salesforce fields to be added to the Sitecore Contact as custom facets.

  • All the mapped Salesforce field values will be saved under the “S4SInfo” custom facet in Sitecore xDB when running S4S List Builder.

Constraints

S4S List Builder does not push Sitecore Email Experience analytics back to Salesforce so full "round trip" reporting is not possible. Our S4S EXM module is required for this.

Technical

S4S List Builder creates new Contact Lists in Sitecore. These are not real lists, but list id references in each Contact record that the contact belongs to.

When importing through S4S List Builder the process tries to find xDB contacts that match the configured identifier for the Salesforce object. If an xDB contact exists it is added to the list otherwise a new xDB contact is created, with the appropriate identifier, and added to the list.

Ideally an xDB contact that is linked to a Salesforce contact or lead should be the same one regardless of whether it is created through S4S List Builder or through the S4S form submit action. By default the identifiers in Sitecore are case sensitive but the S4S.Analytics.ConvertIdentifierValueToLowerCase setting in /App_Config/Modules/S4S/S4SAnalytics.config can be configured to save all identifiers as lower case so they are consistent across S4S. The identifier source and field containing the identifier need to be configured so that the xDB contacts can be matched.

Identifier Source

By default, S4SLB uses “S4S“ as the IdentifierSource. This value can be changed from the following config setting in /App_Config/Modules/S4S/S4SAnalytics.config. Keep in mind that changing this value will affect the S4S form submit action as well.

<!-- The source to use for identifiers --> <setting name="S4S.Analytics.IdentifierSource" value="S4S" />

Identifier

In /App_Config/Modules/S4S/S4SLB.config, there are two config settings to set the Salesforce fields to use as the identifier of the Sitecore contact. By default those config setting values are set to “Email“ so the Email field in the Salesforce contact or the lead will be used as the Sitecore xDB contact identifier.

<!--Salesforce contact field which use to identify Sitecore contact created by S4SLB--> <setting name="FuseIT.S4SLB.SFContact.IdentifierField" value="Email" /> <!--Salesforce lead field which use to identify Sitecore contact created by S4SLB--> <setting name="FuseIT.S4SLB.SFLead.IdentifierField" value="Email" />

Ideally, having the same Salesforce fields configured in the above settings and in “S4S.Analytics.Identifier“ setting in /App_Config/Modules/S4S/S4SAnalytics.config (Refer https://fuseit.atlassian.net/wiki/spaces/S4S/pages/319160564 for more details) will give more robust Sitecore contacts in the XDB. It will prevent redundant Sitecore Contacts being created for the same Salesforce entity when using the S4S submit action and S4S List Builder.

Next Step

Congratulations, you have finished installing this option.