Salesforce DX Developer Guide

How Salesforce Developer Experience Changes the Way You Work
Project Setup
Authorization
Metadata Coverage
Scratch Orgs
Scratch Org Definition File
Scratch Org Definition Configuration Values
Create Scratch Orgs
Salesforce DX Project Structure and Source File Format
Push Source to the Scratch Org
Assign a Permission Set
Ways to Add Data to Your Scratch Org
Pull Source from the Scratch Org to Your Project
Scratch Org Users
Manage Scratch Orgs from Dev Hub
Development
Build and Release Your App
First-Generation Managed Packages
Unlocked Packages and Second-Generation Managed Packages
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Newer Version Available

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

Scratch Org Definition Configuration Values

Configuration values determine the shape of the scratch org.

Supported Editions

The Salesforce edition of the scratch org. Possible values are:

  • Developer
  • Enterprise
  • Group
  • Professional

Supported Features

You can enable these add-on features in a scratch org:

  • API
  • AuthorApex
  • Communities
  • ContactsToMultipleAccounts
  • ContractApprovals
  • CascadeDelete
  • CustomerSelfService
  • CustomApps
  • CustomTabs
  • DebugApex
  • DefaultWorkflowUser
  • ExpandedSourceTracking
  • ExternalSharing (not available in Group Edition)
  • ForceComPlatform
  • MultiCurrency
  • PersonAccounts
  • SalesWave
  • LightningSalesConsole
  • LightningServiceConsole
  • ServiceCloud
  • ServiceWave
  • SiteDotCom
  • Sites
  • StateAndCountryPicklist
You can specify multiple feature values in a comma-delimited list in the scratch org definition file.

For Group and Professional Edition orgs, the AuthorApex feature is disabled by default. Enabling the AuthorApex feature lets you edit and test your Apex classes.

Note

Expanded Source Tracking (Beta)

As a beta feature, Salesforce DX Expanded Source Tracking is a preview and isn’t part of the “Services” under your master subscription agreement with Salesforce. Use this feature at your sole discretion, and make your purchase decisions only on the basis of generally available products and features. Salesforce doesn’t guarantee general availability of this feature within any particular time frame or at all, and we can discontinue it at any time. This feature is for evaluation purposes only, not for production use. It’s offered as is and isn’t supported, and Salesforce has no liability for any harm or damage arising out of or in connection with it. All restrictions, Salesforce reservation of rights, obligations concerning the Services, and terms for related Non-Salesforce Applications and Content apply equally to your use of this feature. You can provide feedback and suggestions for Expanded Source Tracking in the Salesforce DX group in the Trailblazer Community.

Note

Right now, Salesforce DX source tracking supports some Metadata API types but not all, as documented in Metadata Coverage. The Expanded Source Tracking beta includes these additional metadata types:

  • AppMenu
  • CaseSubjectParticle
  • Certificate
  • DataCategoryGroup
  • DelegateGroup
  • EclairGeoData
  • EmailServicesFunction
  • EmbeddedServiceBranding
  • EmbeddedServiceConfig
  • EmbeddedServiceLiveAgent
  • GlobalValueSetTranslation
  • InstalledPackage
  • ManagedTopics
  • Package
  • PersonalJourneySettings
  • Portal
  • ProfilePasswordPolicy
  • ProfileSessionSetting
  • SearchSettings
  • SocialCustomerServiceSettings
  • StandardValueSetTranslation
  • SynonymDictionary
  • Territory2Settings
  • TopicsForObjects

Because there isn’t a direct correlation between a Setup page and each Metadata API type, source tracking doesn’t always work exactly as you expect. For instance, when you update or save something through a Setup page, some changes aren’t tracked via force:source:status or force:source:pull.

To enable Expanded Source Tracking:

This feature is enabled for any new scratch orgs you create but doesn’t affect scratch orgs already created.

Note

  1. Open your Dev Hub org.
  2. From Setup, enter Dev Hub in the Quick Find box, and select Dev Hub.
  3. Click Enable Expanded Source Tracking (Beta).
  4. Add the ExpandedSourceTracking feature to your scratch org definition file.

Supported Org Preferences

Org preferences are settings that a user can configure in the org. For example, these preferences control which Chatter, Knowledge, and Opportunities settings are enabled, among many others. These settings are enabled (or disabled) in the orgPreferences section of the configuration file, in JSON format.

You can set the following org preferences in the configuration file. See the Metadata API Developer Guide for descriptions of the supported settings.

Exercise caution when using DisableParallelApexTesting. Your tests might run noticeably slower. Try these Testing Best Practices in the Apex Developer Guide so that you can run your Apex tests in parallel.

Important

General Settings

  • AnalyticsSharingEnable
  • AsyncSaveEnabled
  • ChatterEnabled
  • DisableParallelApexTesting
  • EnhancedEmailEnabled
  • EventLogWaveIntegEnabled
  • LoginForensicsEnabled
  • NetworksEnabled
  • NotesReservedPref01
  • OfflineDraftsEnabled
  • PathAssistantsEnabled
  • S1DesktopEnabled
  • S1EncryptedStoragePref2
  • S1OfflinePref
  • SelfSetPasswordInApi
  • SendThroughGmailPref
  • SocialProfilesEnable
  • Translation
  • VoiceEnabled

Account Settings

  • IsAccountTeamsEnabled
  • ShowViewHierarchyLink

Activities Settings

  • IsActivityRemindersEnabled
  • IsDragAndDropSchedulingEnabled
  • IsEmailTrackingEnabled
  • IsGroupTasksEnabled
  • IsMultidayEventsEnabled
  • IsRecurringEventsEnabled
  • IsRecurringTasksEnabled
  • IsSidebarCalendarShortcutEnabled
  • IsSimpleTaskCreateUIEnabled
  • ShowEventDetailsMultiUserCalendar
  • ShowHomePageHoverLinksForEvents
  • ShowMyTasksHoverLinks

Contract Settings

  • AutoCalculateEndDate
  • IsContractHistoryTrackingEnabled
  • NotifyOwnersOnContractExpiration

Entitlement Settings

  • AssetLookupLimitedToActiveEntitlementsOnAccount
  • AssetLookupLimitedToActiveEntitlementsOnContact
  • AssetLookupLimitedToSameAccount
  • AssetLookupLimitedToSameContact
  • IsEntitlementsEnabled
  • EntitlementLookupLimitedToActiveStatus
  • EntitlementLookupLimitedToSameAccount
  • EntitlementLookupLimitedToSameAsset
  • EntitlementLookupLimitedToSameContact

Forecasting Settings

  • IsForecastsEnabled

Ideas Settings

  • IsChatterProfileEnabled
  • IsIdeaThemesEnabled
  • IsIdeasEnabled
  • IsIdeasReputationEnabled

Knowledge Settings

  • IsCreateEditOnArticlesTabEnabled
  • IsExternalMediaContentEnabled
  • IsKnowledgeEnabled
  • ShowArticleSummariesCustomerPortal
  • ShowArticleSummariesInternalApp
  • ShowArticleSummariesPartnerPortal
  • ShowValidationStatusField

Live Agent Settings

  • IsLiveAgentEnabled

Marketing Action Settings

  • IsMarketingActionEnabled

Name Settings

  • IsMiddleNameEnabled
  • IsNameSuffixEnabled

Opportunity Settings

  • IsOpportunityTeamEnabled

Order Settings

  • IsNegativeQuantityEnabled
  • IsOrdersEnabled
  • IsReductionOrdersEnabled

Personal Journey Settings

  • IsExactTargetForSalesforceAppsEnabled

Product Settings

  • IsCascadeActivateToRelatedPricesEnabled
  • IsQuantityScheduleEnabled
  • IsRevenueScheduleEnabled

Quote Settings

  • IsQuoteEnabled

Search Settings

  • DocumentContentSearchEnabled
  • OptimizeSearchForCjkEnabled
  • RecentlyViewedUsersForBlankLookupEnabled
  • SidebarAutoCompleteEnabled
  • SidebarDropDownListEnabled
  • SidebarLimitToItemsIownCheckboxEnabled
  • SingleSearchResultShortcutEnabled
  • SpellCorrectKnowledgeSearchEnabled