RetailExecutionSettings Metadata in SFDX

Architectural Overview#

RetailExecutionSettings represents the org-level configuration file that enables and controls Consumer Goods Cloud (CGC) Retail Execution. Consumer goods enterprises manage expansive retail field forces tasked with store visits, merchandising audits, promotional compliance, planogram checks, and van delivery logistics.

Through RetailExecutionSettings, architects declaratively activate core retail execution features across sandbox and production tiers. This includes governing whether field sales reps can generate replenishment orders directly during store visits, activating inventory tracking modules, and configuring automated scheduling behaviors. Packaging this configuration as metadata guarantees that scratch orgs and multi-tier deployment pipelines automatically instantiate properly configured retail environments.

Directory and File Conventions#

RetailExecutionSettings is a singleton settings metadata file residing in the settings directory.

Key Metadata Fields#

The settings file exposes boolean switches governing retail execution features.

Declarative XML and Package Manifest Examples#

The following sample configures an active Retail Execution environment with order generation and inventory tracking enabled:

<?xml version="1.0" encoding="UTF-8"?>
<RetailExecutionSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableRetailExecution>true</enableRetailExecution>
    <enableOrderGeneration>true</enableOrderGeneration>
    <enableInventoryTracking>true</enableInventoryTracking>
    <enableVisitScheduling>true</enableVisitScheduling>
</RetailExecutionSettings>

Package Manifest (package.xml)#

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

CLI Retrieval and Deployment Commands#

Manage RetailExecutionSettings using the Salesforce CLI:

# Retrieve RetailExecution settings
sf project retrieve start --metadata "Settings:RetailExecution"

# Deploy settings to target org
sf project deploy start --source-dir force-app/main/default/settings/RetailExecution.settings-meta.xml

# Validate settings deployment in CI pipeline
sf project deploy validate --metadata "Settings:RetailExecution"

Architect Best Practices and Gotchas#

• Industry License Prerequisite: Deploying RetailExecutionSettings into an org lacking active Consumer Goods Cloud or Lightning Retail Execution licenses results in immediate deployment failure (Feature not enabled).
• Scratch Org Provisioning: When utilizing scratch orgs for CGC development, declare the ConsumerGoodsCloud feature in project-scratch-def.json before deploying this settings file.
• Mobile Offline Dependency: Toggling enableOrderGeneration or enableInventoryTracking impacts mobile synchronization schemas. Field reps running the offline app must perform a full synchronization cycle after changes to prevent local schema mismatches.

Frequently asked questions

What does RetailExecutionSettings govern in Salesforce?

It governs org-wide settings for Consumer Goods Cloud Retail Execution, including store visit management, mobile synchronization, and task automation.

Where is RetailExecutionSettings located in source format?

It is located in the settings directory with the file name RetailExecution.settings-meta.xml.

Can RetailExecutionSettings be deployed to any Salesforce edition?

No, RetailExecutionSettings requires an active Consumer Goods Cloud license in the destination environment or deployment will fail.

What mobile application interacts with these settings?

The Consumer Goods Cloud mobile offline app relies on these settings to guide field representatives through in-store audit and promotion compliance tasks.