Walkthrough: Creating a custom contact facet

In Visual Studio, create the following project:

Add references to the following NuGet packages:

To create a contact facet to store the Salesforce contact account name, add the following class to the project:

using Sitecore.XConnect;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Examples.Connect.Salesforce
{
    [FacetKey(DefaultFacetKey)]
    [Serializable]
    public class SalesforceAccountInformationFacet : Facet
    {
        public const string DefaultFacetKey = "SalesforceAccount";
        public string AccountName { get; set; }
        public SalesforceAccountInformationFacet()
        {
        }
    }
}

To create an xConnect collection model that defines which contact facets are available, add the following class to the project:

using Sitecore.DataExchange.Tools.SalesforceConnect.Models;
using Sitecore.XConnect;
using Sitecore.XConnect.Schema;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Examples.Connect.Salesforce
{
    public class SalesforceConnectCollectionModelEx
    {
        public SalesforceConnectCollectionModelEx()
        {
        }
        static SalesforceConnectCollectionModelEx()
        {
            _model = BuildModel();
        }
        private static XdbModel _model = null;
        public static XdbModel Model { get { return _model; } }
        private static XdbModel BuildModel()
        {
            var builder = new XdbModelBuilder(typeof(SalesforceConnectCollectionModelEx).FullName, new XdbModelVersion(1, 0));
            builder.DefineFacet<Contact, SalesforceAccountInformationFacet>(SalesforceAccountInformationFacet.DefaultFacetKey);
            builder.ReferenceModel(SalesforceConnectCollectionModel.Model);
            return builder.BuildModel();
        }
    }
}

To deploy the assembly on your Sitecore server, build the Visual Studio project, and copy the resulting Examples.Connect.Salesforce.dll file to your Sitecore server.

In Sitecore, open the Content Editor and navigate to Sitecore/System/Settings/Data Exchange/Providers/xConnect/Collection Models.

Add the following item:

In the new Custom Models item, add the following item:

Select the new Custom Collection Model for Salesforce item. In the right-hand pane, on the Content tab, in the Settings section, set the following field value:

Save the item.

To deploy the model to xConnect, navigate to the custom collection model. On the ribbon, on the Data Exchange tab, click Convert Model to Items. Then click Convert Model to JSON.

Save the model file, and deploy the model to the following servers:

To configure the xConnect Client Endpoint to use the collection model, in the Content Editor, navigate to Sitecore/System/Data Exchange/<your Salesforce tenant>/Endpoints/Providers/xConnect/xConnect Client Endpoint.

In the right-hand pane, on the Content tab, in the Collection Service section, set the following field value:

Save the item.

To test the configuration, on the ribbon, on the Data Exchange tab, click Run Troubleshooter.

A message informs you a connection to the xConnect collection service was established:

To add the value accessor for the account on the contact, in the Content Editor, navigate to <your Salesforce tenant>/Data Access/Value Accessor Sets/Providers/Salesforce/Salesforce Contact Fields. Add the following item:

Select the new Account on Salesforce Contact item. In the right-hand pane, on the Content tab, in the Field section, set the following field values:

Save the item.

To create the value accessor to access the account name , in the Content Editor, navigate to <your Salesforce tenant>/Data Access/Value Accessor Sets/Providers/Salesforce. Add the following item:

In the new Salesforce Account Fields item, add the following item:

In the new Name on Salesforce Account item, in the right-hand pane, on the Content tab, in the Field section, set the following field value:

Save the item.

To create the value reader, in the Content Editor, navigate to <your Salesforce tenant>/Data Access/Value Readers/Providers/Salesforce. Add the following item:

In the new Value Reader for Account Name Value Accessor item, in the right-hand pane, on the Content tab, in the Settings section, set the following field value:

Save the item.

In the Content Editor, navigate to <your Salesforce tenant>/Data Access/Value Accessor Sets/Providers/xConnect.

Add the following item:

In the new xConnect Contact Salesforce Account Information Facet item, add the following item:

In the new Account Name on Salesforce Account Information Facet on xConnect Contactitem, in the right-hand pane, on the Content tab, in the Settings section, set the following field value:

Save the item.

In the Content Editor, navigate to <your Salesforce tenant>/Value Mapping Sets/Salesforce to xConnect Contact Mappings.

Add the following item:

In the new Salesforce Contact to xConnect Contact Salesforce Account Information Facet item, add the following item:

In the new Account Name  item, in the right-hand pane, on the Content tab, set the following field values:

Save the item.

In the Content Editor, navigate to <your Salesforce tenant>/Data Access/Value Accessor Sets/Providers/xConnect/xConnect Contact.

Add the following item:

In the new Salesforce Account Information Facet on xConnect Contact item, in the right-hand pane, on the Content tab, in the Settings section, set the following field values:

Save the item.

Select your tenant.

Navigate to <your Salesforce tenant>/Value Mapping Sets/Salesforce to xConnect Contact Mappings/Salesforce Contact to Contact Model.

Add the following item:

In the new Salesforce Account Information Facet item, in the right-hand pane, on the Content tab, set the following values:

Save the item.

To add the fields for the facets to the pipeline step, in the Content Editor, navigate to <your Salesforce tenant>/Pipelines/Salesforce Contacts to xConnect Sync Pipelines/Read Contacts from Salesforce Pipeline/Read Contacts from Salesforce.

In the right-hand pane, on the Content tab, in the Object Settings sections, in the Fields to Read field, add Salesforce Account Fields to the Selected column. Save the pipeline step.

To add the facet to the Process Single Contact from Salesforce pipeline step, in the Content Editor, navigate to <your Salesforce tenant>/Pipelines/Salesforce Contacts to xConnect Sync Pipelines/Process Single Contact from Salesforce Pipeline/Resolve Contact Model by Id from xConnect.

In the right-hand pane, on the Content tab, in the xConnect Settings sections, in the Facets to Read field, locate Collection Models/Custom Models/Custom Collection Model for Salesforce/Facets/Contact/SalesforceAccount. Add it to the Selected column.

Save the pipeline step.