SalesAgreementSettings Metadata in SFDX

Architectural Overview#

SalesAgreementSettings configures org-level operational rules for Sales Agreements in Salesforce Manufacturing Cloud. In heavy manufacturing, industrial distribution, and automotive supply chains, commercial agreements span multi-year horizons detailing run-rate business: agreed quantities, negotiated price tiers, planned delivery intervals, and actual order drawdowns.

Using SalesAgreementSettings, Technical Architects declaratively govern the calculation engine that reconciles planned versus actual orders. Activating automated actuals calculation ensures that when ERP integration pipelines or Sales Cloud order management workflows insert or update orders, sales agreement product schedules automatically recalculate fulfillment percentages, volume compliance, and remaining revenue commitments in near real time.

Directory and File Conventions#

SalesAgreementSettings is a singleton settings metadata file located in the settings directory.

Key Metadata Fields#

The settings file exposes switches controlling sales agreement behavior and recalculation mechanisms.

Declarative XML and Package Manifest Examples#

The following sample enables automated actuals calculations derived directly from confirmed orders:

<?xml version="1.0" encoding="UTF-8"?>
<SalesAgreementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableSalesAgreements>true</enableSalesAgreements>
    <automaticallyCalculateMetrics>true</automaticallyCalculateMetrics>
    <enableMultipleSalesAgreementsPerOrder>true</enableMultipleSalesAgreementsPerOrder>
    <actualsCalculationMode>Orders</actualsCalculationMode>
</SalesAgreementSettings>

Package Manifest (package.xml)#

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

CLI Retrieval and Deployment Commands#

Manage SalesAgreementSettings using standard Salesforce CLI operations:

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

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

# Validate settings deployment in staging
sf project deploy validate --metadata "Settings:SalesAgreement"

Architect Best Practices and Gotchas#

• Feature License Requirements: Deploying SalesAgreementSettings into an environment lacking Manufacturing Cloud licenses or Sales Agreement permission sets will cause a deployment failure indicating the feature is not accessible.
• Large Volume Order Drawdowns: When automaticallyCalculateMetrics is enabled, bulk DML operations on Order or OrderItem records trigger background rollup jobs on related agreements. During massive ERP initial data loads, temporarily disable automated calculation to prevent row-lock errors and governor limit exhaustion.
• Scratch Org Definitions: Ensure your project-scratch-def.json has ManufacturingCloud or the appropriate license feature toggled on before deploying this settings file in continuous integration workflows.

Frequently asked questions

What does SalesAgreementSettings control in Salesforce?

It controls org-level configuration for Manufacturing Cloud Sales Agreements, such as automated actuals calculation frequencies and order schedule mappings.

Where is SalesAgreementSettings stored in the project structure?

It is stored in the settings folder under the file name SalesAgreement.settings-meta.xml.

What is the benefit of enabling automated metric calculation?

It automatically updates actual product quantities and revenues on sales agreement terms as orders and invoices are completed in the ERP or Salesforce.

Does SalesAgreementSettings require specific product licenses?

Yes, it strictly requires Manufacturing Cloud or Sales Agreements feature licenses to deploy and activate in target environments.