PartyDataModelSettings in SFDX

Architectural Overview#

The PartyDataModelSettings metadata type activates and configures the unified Party Data Model across the Salesforce platform. In modern enterprise architectures spanning multiple clouds (Sales, Service, Marketing Cloud, and Salesforce Data Cloud), customer identity is fragmented across Account, Contact, Lead, User, and third-party systems.

The Party Data Model introduces standardized entities—such as Party, PartyRole, PartyConsent, and Individual—that decouple human and organizational identity from transactional CRM roles. Activating PartyDataModelSettings enables unified identity resolution, multi-party consent management for GDPR/CCPA compliance, and clean integration into Data Cloud identity graphs.

Directory and File Conventions#

In SFDX source format, PartyDataModelSettings is stored in the settings/ directory and referenced as Settings:PartyDataModel.

Key Metadata Fields#

The PartyDataModelSettings metadata schema controls party entity provisioning and automatic creation triggers:

Declarative XML and Package Manifest Examples#

Below is an enterprise configuration for enabling the unified party schema:

<?xml version="1.0" encoding="UTF-8"?>
<PartyDataModelSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableAutoCreateParty>true</enableAutoCreateParty>
    <enableConsentDataModel>true</enableConsentDataModel>
    <enablePartyDataModel>true</enablePartyDataModel>
    <enablePartyRole>true</enablePartyRole>
</PartyDataModelSettings>

Scratch Org Definition Configuration#

When testing Data Cloud ingestion pipelines in scratch orgs:

{
  "orgName": "Party Data Model Scratch Org",
  "edition": "Enterprise",
  "features": ["DataCloud", "PrivacyManagement"],
  "settings": {
    "partyDataModelSettings": {
      "enablePartyDataModel": true,
      "enableAutoCreateParty": true,
      "enableConsentDataModel": true,
      "enablePartyRole": true
    }
  }
}

Package Manifest (package.xml)#

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

CLI Retrieval and Deployment Commands#

Manage PartyDataModelSettings via the Salesforce CLI (sf):

# Retrieve PartyDataModelSettings from target org
sf project retrieve start --metadata Settings:PartyDataModel

# Deploy PartyDataModelSettings to remote org
sf project deploy start --metadata Settings:PartyDataModel

# Validate deployment without saving changes
sf project deploy validate --metadata Settings:PartyDataModel

Architect Best Practices and Gotchas#

• Schema Pre-requisite for Data Cloud: Deploy PartyDataModel.settings-meta.xml before establishing Data Cloud data streams pointing to CRM Account and Contact objects. This guarantees that party mapping fields exist.
• Bulk Ingestion Performance: When running initial data migrations with millions of rows, consider setting enableAutoCreateParty to false during data ingestion, backfilling party tables in batch Apex, and then deploying enableAutoCreateParty: true for ongoing operational sync.
• Privacy Enforcement: Combine the party data model with Individual object sharing rules to ensure privacy preferences (e.g., Do Not Call, Do Not Track) propagate cleanly across all child party roles.

Frequently asked questions

What does PartyDataModelSettings do in Salesforce?

It activates the unified Party Data Model, enabling standard entities like PartyConsent, PartyRole, and Individual for cross-system identity mapping.

Where is PartyDataModelSettings saved in an SFDX directory?

It is stored under force-app/main/default/settings/ as PartyDataModel.settings-meta.xml and retrieved as Settings:PartyDataModel.

Why is the Party Data Model critical for Data Cloud and Privacy regulations?

It unifies individual identities across leads, contacts, and external keys while centrally managing GDPR and CCPA privacy consents.

Can PartyDataModelSettings be automated in scratch org definitions?

Yes. Adding partyDataModelSettings to the project scratch org definition file ensures test orgs instantiate the required party relationship tables.