Newer Version Available

This content describes an older version of this product. View Latest

PartyDataModelSettings

Represents an organization’s party data model settings, including options around the Individual object and consent enablement. 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 more details.

File Suffix and Directory Location

PartyDataModelSettings values are stored in the PartyDataModel.settings file in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

PartyDataModelSettings is available in API version 47.0 and later.

Fields

Field Name Field Type Description
enableAutoSelectIndividualOnMerge boolean Indicates whether the most recently modified data privacy record for the Individual is retained when merging lead, contact, and person accounts (true) or users must manually determine which data privacy record to retain during the merge process (false). This field has a default value of false.
enableConsentManagementEnabled boolean Indicates whether data protection details are available in records (true) or not (false). This has a default value of true.

Setting this field to false purges all data protection details, such as privacy preferences and stored consent forms.

Note

enableIndividualAutoCreate boolean Deprecated in API version 48.0 and removed in API version 49.0 and later.

Declarative Metadata Sample Definition

The following is an example of a PartyDataModelSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<PartyDataModelSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableAutoSelectIndividualOnMerge>true</enableAutoSelectIndividualOnMerge>
4    <enableConsentManagementEnabled>true</enableConsentManagementEnabled>
5</PartyDataModelSettings>

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>PartyDataModel</members>
5        <name>Settings</name>
6    </types>
7    <version>47.0</version>
8</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.