Architectural Overview
HighVelocitySalesSettings manages the feature configuration for Salesforce Sales Engagement (formerly High Velocity Sales). This platform enables inside sales and business development teams to run structured outreach workflows known as Sales Cadences. Cadences guide sales representatives through phone calls, emails, LinkedIn InMail, and custom tasks.
In automated DevOps and scratch org workflows, deploying HighVelocitySalesSettings is a mandatory prerequisite before deploying ActionCadence definitions, cadence-related Flows, or custom Work Queue lightning page configurations.
Directory and File Conventions
HighVelocitySalesSettings is stored under settings/:
| Property | Value |
|---|---|
| Metadata Type Name | Settings (member: HighVelocitySales) |
| SFDX Directory | force-app/main/default/settings/ |
| File Name | HighVelocitySales.settings-meta.xml |
| Scratch Org Key | highVelocitySalesSettings |
Key Metadata Fields
The XML schema exposes toggles that activate Sales Engagement features:
| Field Name | Type | Required | Description |
|---|---|---|---|
enableHighVelocitySales |
boolean |
No | Master activation toggle for Sales Engagement and Action Cadence capabilities. |
enableSalesCadenceAutomations |
boolean |
No | Enables automated branching and rules within sales cadences. |
enableWorkQueue |
boolean |
No | Activates the Work Queue utility bar component for sales reps. |
Note
Enabling Sales Engagement requires appropriate licenses (such as Sales Engagement or CRM Analytics) in production orgs. Scratch orgs require the "SalesEngagement" or "HighVelocitySales" feature flag.
Declarative XML and Package Manifest Examples
Below is a production HighVelocitySales.settings-meta.xml configuration:
<?xml version="1.0" encoding="UTF-8"?>
<HighVelocitySalesSettings xmlns="http://soap.sforce.com/2006/04/metadata">
<enableHighVelocitySales>true</enableHighVelocitySales>
</HighVelocitySalesSettings>Scratch Org Definition (config/project-scratch-def.json)
{
"orgName": "Sales Engagement Testing Org",
"edition": "Enterprise",
"features": ["SalesEngagement"],
"settings": {
"highVelocitySalesSettings": {
"enableHighVelocitySales": true
}
}
}Package Manifest (package.xml)
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>HighVelocitySales</members>
<name>Settings</name>
</types>
<version>68.0</version>
</Package>Retrieval and Deployment via SF CLI
Retrieve and deploy the settings using SF CLI:
# Retrieve HighVelocitySales settings
sf project retrieve start --metadata "Settings:HighVelocitySales"
# Deploy settings to an integration org
sf project deploy start --metadata "Settings:HighVelocitySales" --target-org int-orgTip
Ensure user permission sets granting the SalesEngagementUser or SalesEngagementCadenceCreator permissions are deployed alongside the settings.
Senior Architect Best Practices and Gotchas
- Pipeline Sequencing: Always deploy
HighVelocitySalesSettingsin an initial foundation deployment step before attempting to deployActionCadencemetadata. - License Limitations: Scratch orgs must explicitly define the feature in
project-scratch-def.json; otherwise, deployingHighVelocitySalesSettingswill throw an invalid feature error. - Telemetry and Activity Capture: Sales Engagement relies heavily on Einstein Activity Capture for automatic email response tracking and cadence advancement.
Frequently asked questions
What product is configured by HighVelocitySalesSettings?
It configures Salesforce Sales Engagement, formerly known as High Velocity Sales (HVS).
What happens when enableHighVelocitySales is set to true?
It activates the Sales Engagement engine, provisioning sales cadences, the Work Queue component, and engagement tracking.
Can cadences be deployed if HighVelocitySalesSettings is disabled?
No. Deployments containing ActionCadence metadata will fail if Sales Engagement is not enabled in the target org.
Where is HighVelocitySalesSettings located in source code?
It is stored in force-app/main/default/settings/HighVelocitySales.settings-meta.xml.
Comments
Questions, corrections and tips are welcome. Comments are GitHub Discussions, so you sign in with GitHub.