Product DocsMenu

About the Default Salesforce Mapping File for the Legacy Connector

Deprecated

The Coveo legacy connector for Salesforce embeds an XML mapping file that is appropriate for many Salesforce setups. This default mapping file specifies to index the basic Salesforce database object types and the corresponding fields.

The Salesforce object types indexed with the default mapping file are:

  • Account

  • Contact

  • Lead

  • Opportunity

  • Case

  • Event

  • Task

  • Case Comment

  • Email Message

  • Document

  • Attachment

Managing Permissions

The permissions associated to Salesforce content are incorporated into the unified index. When a user makes a query for Salesforce content, the index knows which content this user has access to and only returns query results for content this specific user has access to.

Using the default mapping file

The default mapping file includes a security binding mapping (<AllowedUsers>) that grants access to all users that are members of the Salesforce Users CES custom security group. This mapping is in the <CommonMapping> section of the mapping file and therefore applies to all indexed Salesforce types of content.

Using a custom mapping file

You can customize the mapping file to implement more specific early-binding security mappings, like creating independent custom security groups for each Salesforce type of content (see Creating and Using a Custom Salesforce Mapping File for the Legacy Connector).

Example: You may want that only users from your Sales department can search the Opportunity type of Salesforce content and only users from your Customer Support department can search the Case type of Salesforce content.

Default Mapping File Content

The following XML code presents the content of the default mapping file.

<?xml version="1.0" encoding="Windows-1252" ?>
<SalesForce>
  <CommonMapping>
    <Fields>
      <ContentType>binarydata</ContentType>
      <syssfcreatedby>%[CreatedById.Name]</syssfcreatedby>
      <syssfcreatedbyid>%[CreatedById]</syssfcreatedbyid>
      <syssfcreateddate>%[CreatedDate]</syssfcreateddate>
      <sysauthor>%[LastModifiedById.Name]</sysauthor>
      <sysdate>%[SystemModstamp]</sysdate>
      <syssfid>%[Id]</syssfid>
      <syssfowner>%[OwnerId.Name]</syssfowner>
      <syssfownerid>%[OwnerId]</syssfownerid>
    </Fields>
    <AllowedUsers>
      <AllowedUser type="CustomGroup" allowed="true">
        <Name>Salesforce Users</Name>
        <Server></Server>
      </AllowedUser>
    </AllowedUsers>
  </CommonMapping>
  <Mapping type="Account">
    <Fields>
      <Title>%[Name]</Title>
      <Body>%[Name]
Owner: %[OwnerId.Name]
Type: %[Type]
Industry: %[Industry]
Description:
%[Description]
      </Body>
      <sysfiletype>SFAccount</sysfiletype>
      <syssfbillingstreet>%[BillingStreet]</syssfbillingstreet>
      <syssfbillingcity>%[BillingCity]</syssfbillingcity>
      <syssfbillingstate>%[BillingState]</syssfbillingstate>
      <syssfbillingcountry>%[BillingCountry]</syssfbillingcountry>
      <syssfbillingpostalcode>%[BillingPostalCode]</syssfbillingpostalcode>
      <syssfshippingstreet>%[ShippingStreet]</syssfshippingstreet>
      <syssfshippingcity>%[ShippingCity]</syssfshippingcity>
      <syssfshippingstate>%[ShippingState]</syssfshippingstate>
      <syssfshippingcountry>%[ShippingCountry]</syssfshippingcountry>
      <syssfshippingpostalcode>%[ShippingPostalCode]</syssfshippingpostalcode>
      <sysworkphone>%[Phone]</sysworkphone>
      <syssffax>%[Fax]</syssffax>
      <syssfwebsite>%[Website]</syssfwebsite>
      <syssfcurrency>%[CurrencyIsoCode]</syssfcurrency>
      <syssfdescription>%[Description]</syssfdescription>
      <syssfcountry>%[BillingCountry]</syssfcountry>
      <syssfindustry>%[Industry]</syssfindustry>
    </Fields>
  </Mapping>
  <Mapping type="Contact">
    <Fields>
      <Title>%[FirstName] %[LastName] (%[Title])</Title>
      <Body>%[FirstName] %[LastName]
%[AccountId.Name]
Title: %[Title]
Account: %[AccountId.Name]
Email: %[Email]
Phone: %[Phone]
Address:
%[MailingStreet]
%[MailingCity],%[MailingState]
%[MailingCountry]
      </Body>
      <sysfiletype>SFContact</sysfiletype>
      <syssffirstname>%[FirstName]</syssffirstname>
      <syssflastname>%[LastName]</syssflastname>
      <syssfstreet>%[MailingStreet]</syssfstreet>
      <syssfcity>%[MailingCity]</syssfcity>
      <syssfstate>%[MailingState]</syssfstate>
      <syssfcountry>%[MailingCountry]</syssfcountry>
      <syssfpostalcode>%[MailingPostalCode]</syssfpostalcode>
      <sysworkemail>%[Email]</sysworkemail>
      <sysworkphone>%[Phone]</sysworkphone>
      <syscompany>%[AccountId.Name]</syscompany>
      <syssfaccount>%[AccountId.Name]</syssfaccount>
      <syssfaccountid>%[AccountId]</syssfaccountid>
    </Fields>
  </Mapping>
  <Mapping type="Lead">
    <Fields>
      <Title>%[Company] (%[FirstName] %[LastName])</Title>
      <Body>%[FirstName] %[LastName]
Title: %[Title]
Company: %[Company]
Email: %[Email]
Phone: %[Phone]
Address:
%[Street]
%[City],%[State]
%[Country]
Status: %[Status]</Body>
      <sysfiletype>SFLead</sysfiletype>
      <syssffirstname>%[FirstName]</syssffirstname>
      <syssflastname>%[LastName]</syssflastname>
      <syscompany>%[Company]</syscompany>
      <syssfcity>%[City]</syssfcity>
      <sysworkemail>%[Email]</sysworkemail>
      <syssfindustry>%[Industry]</syssfindustry>
      <syssfleadsource>%[LeadSource]</syssfleadsource>
      <sysworkphone>%[Phone]</sysworkphone>
      <syssfcountry>%[Country]</syssfcountry>
      <syssfstate>%[State]</syssfstate>
      <syssfcity>%[City]</syssfcity>
      <syssfstreet>%[Street]</syssfstreet>
      <syssfpostalcode>%[PostalCode]</syssfpostalcode>
      <syssfleadstatus>%[Status]</syssfleadstatus>
    </Fields>
  </Mapping>
  <Mapping type="Opportunity">
    <CacheTables>
        <Table name="OpportunityLineItem">
            <IndexedField name="OpportunityId" />
        </Table>
        <Table name="PricebookEntry" />
        <Table name="Product2" />
    </CacheTables>
    <Fields>
      <Title>%[AccountId.Name] [%[Name]]</Title>
      <Body>%[Name]</Body>
      <sysfiletype>SFOpportunity</sysfiletype>
      <syssfaccount>%[AccountId.Name]</syssfaccount>
      <syssfaccountid>%[AccountId]</syssfaccountid>
      <syssfcountry>%[AccountId.BillingCountry]</syssfcountry>
      <syssfstagename>%[StageName]</syssfstagename>
      <syssfamount>%[Amount]</syssfamount>
      <syssfcurrency>%[CurrencyIsoCode]</syssfcurrency>
      <syssfopportunitytype>%[Type]</syssfopportunitytype>
      <syssfclosedate>%[CloseDate]</syssfclosedate>
      <syssfclosequarter>%[FiscalYear]-Q%[FiscalQuarter]</syssfclosequarter>
      <syssfleadsource>%[LeadSource]</syssfleadsource>
      <syssfname>%[Name]</syssfname>
    </Fields>
  </Mapping>
  <Mapping type="Case">
    <Fields>
      <ContentType>binarydata</ContentType>
      <Title>%[Subject] (%[CaseNumber])</Title>
      <Body>
        AssetId : %[AssetId]
        CaseNumber : %[CaseNumber]
        ClosedDate : %[ClosedDate]
        Contact : %[ContactId.Name]
        CurrencyIsoCode : %[CurrencyIsoCode]
        IsClosed : %[IsClosed]
        IsEscalated : %[IsEscalated]
        Origin : %[Origin]
        Priority : %[Priority]
        Reason : %[Reason]
        Status : %[Status]
        Subject : %[Subject]
        SuppliedCompany : %[SuppliedCompany]
        SuppliedEmail : %[SuppliedEmail]
        SuppliedName : %[SuppliedName]
        SuppliedPhone : %[SuppliedPhone]
        Type : %[Type]
        Description :
        %[Description]
      </Body>
      <sysfiletype>SFCase</sysfiletype>
    </Fields>
  </Mapping>
  <Mapping type="Event">
    <Fields>
      <Title>%[Subject]</Title>
      <Body>%[Description]</Body>
      <sysfiletype>SFEvent</sysfiletype>
      <syssfduration>%[DurationInMinutes]</syssfduration>
      <syssflocation>%[Location]</syssflocation>
    </Fields>
  </Mapping>
  <Mapping type="Task">
    <Fields>
      <Title>%[Subject]</Title>
      <Body>%[Description]</Body>
      <sysfiletype>SFTask</sysfiletype>
      <syssfstatus>%[Status]</syssfstatus>
      <syssfpriority>%[Priority]</syssfpriority>
    </Fields>
  </Mapping>
  <Mapping type="CaseComment">
    <Fields>
      <Body>%[CommentBody]</Body>
      <sysfiletype>SFCaseComment</sysfiletype>
      <syssfcaseid>%[ParentId]</syssfcaseid>
    </Fields>
  </Mapping>
  <Mapping type="EmailMessage">
    <Fields>
      <Title>%[Subject]</Title>
      <Body>%[TextBody]</Body>
      <sysfiletype>SFEmailMessage</sysfiletype>
      <syssfcaseid>%[ParentId]</syssfcaseid>
      <sysdate>%[MessageDate]</sysdate>
      <sysrecipients>%[ToAddress]</sysrecipients>
      <sysfrom>%[FromAddress]</sysfrom>
      <syscc>%[CcAddress]</syscc>
      <sysbcc>%[BccAddress]</sysbcc>
      <sysconversationsubjectid>%[ParentId]</sysconversationsubjectid>
      <sysmailbox>Salesforce.com</sysmailbox>
    </Fields>
  </Mapping>
  <Mapping type="Document">
    <Fields>
      <clickableuri>https://na4.salesforce.com/servlet/servlet.FileDownload?file=%[Id]</clickableuri>
      <filename>%[Name]</filename>
      <body>%[Body]</body>
      <Title>%[Name]</Title>
    </Fields>
  </Mapping>
  <Mapping type="Attachment">
    <Fields>
      <clickableuri>https://na4.salesforce.com/servlet/servlet.FileDownload?file=%[Id]</clickableuri>
      <filename>%[Name]</filename>
      <body>%[Body]</body>
      <Title>%[Name]</Title>
    </Fields>
  </Mapping>
</SalesForce>
People who viewed this topic also viewed