Represents an organization’s custom
field mappings for lead conversion. Custom fields can be mapped from Leads to Accounts,
Contacts, and Opportunities. Options for creating opportunities during lead conversion
can also be specified.
This type extends the
Metadata metadata type and inherits its
fullName field.
In the package manifest, all organization settings
metadata types are accessed using the Settings name. See Settings for details.
File Suffix and Directory Location
LeadConvertSettings components have the suffix LeadConvertSetting and are
stored in the LeadConvertSettings folder.
Version
LeadConvertSettings is available in API versions 39.0 and later.
Fields
| allowOwnerChange |
- Field Type
- boolean
- Description
- Indicates whether to include the Record
Owner field in the Convert
Lead dialog box (true) or not (false).
|
| objectMapping |
- Field Type
- ObjectMapping[]
- Description
- A set of custom field mappings between objects. Up to
three objectMapping types can be
declared—one each for account, contact, and
opportunity.
|
| opportunityCreationOptions |
- Field Type
- VisibleOrRequired (enumeration of type string)
- Description
- This field determines whether the
Opportunity field is visible
or required in the Convert Lead
dialog box.
Values are:
-
VisibleOptional—The
Opportunity field is
included in the dialog box but not required. A new
opportunity is created if the user enters an
opportunity name. This is the default value.
-
VisibleRequired—The
Opportunity field is
included in the dialog box and is required. A new
opportunity is created based on the name the user
enters.
-
NotVisible—The
Opportunity field is not
included in the dialog box. No opportunity is
created.
|
ObjectMapping
Represents a custom field mapping between two objects.
| inputObject |
- Field Type
- string
- Description
-
Required.
The name of the object type containing
the source fields for mapping. The value is always
Lead.
|
| mappingFields |
- Field Type
- ObjectMappingField[]
- Description
- A set of input and output field names of the custom
fields to be mapped.
|
| outputObject |
- Field Type
- string
- Description
-
Required.
The object type receiving data during
lead conversion.
- Account
- Contact
- Opportunity
|
ObjectMappingField
Represents custom field names to be mapped between objects.
| inputField |
- Field Type
- string
- Description
-
Required.
The name of a custom lead field
supplying source data during lead conversion.
|
| outputField |
- Field Type
- string
- Description
-
Required.
The name of a custom account, contact,
or opportunity field that will receive data from source
field named in the accompanying
inputField entry.
|
Declarative Metadata Sample Definition
The following is an example of the LeadConvertSettings type:
Wildcard Support in the Manifest File
The wildcard character * (asterisk) in the
package.xml manifest file doesn’t apply to metadata types for feature
settings. The wildcard applies only when retrieving all settings, not for an individual
setting. For details, see Settings. For information about using the manifest file, see
Deploying and Retrieving Metadata with the Zip File.
j