Get Salesforce Lead
Overview
This processor is responsible for searching Salesforce for a Lead that matches the external identifier obtained in the earlier step. The processor can be configured so that if the Lead is converted then the converted Contact is used as the matching Salesforce object.
If the processor is not configured to retrieve the converted Contact and a converted Lead is found the processor will not match the converted Lead and the pipeline will move to the next step.
Note: If Leads do not need to be searched this processor can be commented out. |
Configuration
The configuration is done in the S4SAnalytics.config configuration file.
<!-- Processor to retrieve a Salesforce Lead that matches the external identifier. NOTE: If Leads do not need to be searched this processor can be commented out. If a lead is not found then processing will move to the next processor in the pipeline to enable searching of multiple object types. If a matching Salesforce object has already been found the processor will not run. --> <processor type="FuseIT.S4S.WebToSalesforce.Pipelines.ResolveXdbContactFromSalesforce.GetSalesforceLead, FuseIT.S4S.WebToSalesforce"> <!-- The field on the Salesforce Lead that contains the value of the external identifier to be matched against the value passed in the query string parameter. --> <SalesforceExternalIdentifierField>yourSalesforceExternalIdentifierField</SalesforceExternalIdentifierField> <!-- If set to true the converted Salesforce Contact will be set as the matched object if the Salesforce Lead that matches the external identifier is found to be converted. If set to false and the Lead is converted the processor will return and processing will continue with the next processor in the pipeline. --> <UseConvertedContact>true</UseConvertedContact> <!-- The list of fields to be returned with the matching Salesforce Lead. --> <Fields hint="list:AddField"> <Field>FirstName</Field> <Field>LastName</Field> <Field>Email</Field> </Fields> <!-- The list of fields to be returned with the matching converted Salesforce Contact. --> <ContactFields hint="list:AddContactField"> <Field>FirstName</Field> <Field>LastName</Field> <Field>Email</Field> </ContactFields> </processor>
Parameter | Description |
---|---|
SalesforceExternalIdentifierField | The name of the Salesforce field on the object that will be used to match against the external identifier obtained in the previous step. |
UseConvertedContact | Set to true to retrieve the converted Contact if the matching Lead is converted otherwise set to false. |
Fields | A list of fields to be brought back when a matching Lead is found. These fields need to include those needed to update the Sitecore facets and to be able to identify the xDB contact. |
ContactFields | A list of fields to be brought back if the converted Contact is retrieved. These fields need to include those needed to update the Sitecore facets and to be able to identify the xDB contact. |