NameSettings

Enables or disables the formal name, middle name, and suffix attributes for these person objects: Contact, Lead, Person Account, and User. 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

NameSettings values are stored in a single file named Name.settings in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

NameSettings components are available in API version 31.0 and later.

Fields

Field Name Field Type Description
enableInformalName boolean Reserved for internal use. Available in API version 48.0 and later.
enableMiddleName boolean Indicates whether middle names are enabled (true) or disabled (false) for person objects.
enableNameSuffix boolean Indicates whether suffixes are enabled (true) or disabled (false) for person objects.

Declarative Metadata Sample Definition

This example shows a NameSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<NameSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableMiddleName>true</enableMiddleName>
    <enableNameSuffix>false</enableNameSuffix>
</NameSettings>

This example package.xml manifest references the NameSettings definitions.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Name</members>
        <name>Settings</name>
    </types>
    <version>31.0</version>
</Package>

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.