FieldMappingConfig

Represents the configuration for fields mapped between a source object and one or more destination objects and fields.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type 

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location 

FieldMappingConfig components have the suffix .fieldMappingConfig and are stored in the fieldMappingConfigs folder.

Version 

FieldMappingConfig components are available in API version 63.0 and later.

Special Access Rules 

This metadata type is available only if the Fundraising Access license is enabled for the org.

Fields 

description 

  • Type: string
  • Description: The description of the field mapping configuration.

fieldMappingConfigItems 

  • Type: FieldMappingConfigItem[]
  • Description: The field mappings in the configuration. Each item maps a field on the source object to a field on a destination object.

masterLabel 

  • Type: string
  • Description: Required. The label for the field mapping configuration.

processType 

  • Type: FieldMappingConfigProcessType (enumeration of type string)

  • Description: Specifies the type of process that the field mapping configuration supports.

  • Possible values:

    • Case
    • ChangeRequest
    • GiftEntry
    • Incident
    • MessagingSubscriber
    • Problem
  • Default value: GiftEntry

sourceObjectId 

  • Type: string

  • Description: Required. The API name of the source object for all of the fields mapped in the configuration.

  • Possible values:

    • Case
    • ChangeRequest
    • GiftEntry
    • Incident
    • MessagingSubscriber
    • Problem

FieldMappingConfigItem 

Represents a mapping between a field on the source object and a field on a destination object.

destinationFieldId 

  • Type: string
  • Description: Required. The API name of the destination field.

destinationObjectId 

  • Type: string
  • Description: Required. The API name of the destination object.

isActive 

  • Type: boolean
  • Description: Indicates whether the field mapping is active (true) or not (false). Inactive field mappings are ignored during sync. Available in API version 68.0 and later.

isOverriddenByNull 

  • Type: boolean
  • Description: Indicates whether a null value in the source field overwrites the value in the destination field during sync (true) or null source values are skipped (false). Available in API version 68.0 and later.

sequence 

  • Type: int
  • Description: Required. The order number of the field relative to other fields, which determines the sequence in which fields are displayed in a custom user interface.

sourceFieldId 

  • Type: string
  • Description: Required. The API name of the source field.

syncBehaviour 

  • Type: FieldMappingSyncBehaviour (enumeration of type string)

  • Description: Specifies which record’s value is kept when a conflict occurs during a bidirectional sync. Available in API version 68.0 and later.

  • Possible values:

    • CRM—The CRM record’s value is kept.
    • MessagingSubscriber—The messaging subscriber record’s value is kept.
    • MostRecent—The value from the most recently modified record is kept.

Declarative Metadata Sample Definition 

The following is an example of a FieldMappingConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<FieldMappingConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>Maps custom gift entry fields to gift transaction fields.</description>
4    <fieldMappingConfigItems>
5        <destinationFieldId>Tribute_Name__c</destinationFieldId>
6        <destinationObjectId>GiftTransaction</destinationObjectId>
7        <sequence>1</sequence>
8        <sourceFieldId>Tribute_Name__c</sourceFieldId>
9    </fieldMappingConfigItems>
10    <fieldMappingConfigItems>
11        <destinationFieldId>Appeal_Code__c</destinationFieldId>
12        <destinationObjectId>GiftTransaction</destinationObjectId>
13        <sequence>2</sequence>
14        <sourceFieldId>Appeal_Code__c</sourceFieldId>
15    </fieldMappingConfigItems>
16    <masterLabel>Gift Entry Custom Fields</masterLabel>
17    <processType>GiftEntry</processType>
18    <sourceObjectId>GiftEntry</sourceObjectId>
19</FieldMappingConfig>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>FieldMappingConfig</name>
6    </types>
7    <version>68.0</version>
8</Package>

Wildcard Support in the Manifest File 

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.