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
  • ContractApprovals
  • CustomerSelfService
  • CustomApps
  • CustomTabs
  • ForceComPlatform
  • MultiCurrency
  • PersonAccounts
  • SalesWave
  • SControls
  • ServiceCloud
  • ServiceWave
  • Sites

You can specify multiple feature values in a semi-colon delimited list.

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

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.

1"OrgPreferences": {
2    "enabled": ["S1DesktopEnabled", "ChatterEnabled", "IsOpportunityTeamEnabled"],
3    "disabled": ["IsOrdersEnabled"]
4}

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

General Settings

  • AnalyticsSharingEnable
  • AsyncSaveEnabled
  • ChatterEnabled
  • EnhancedEmailEnabled
  • EventLogWaveIntegEnabled
  • LoginForensicsEnabled
  • NetworksEnabled
  • 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
  • ShowRequestedMeetingsOnHomePage

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

  • IsOrdersEnabled

Personal Journey Settings

  • IsExactTargetForSalesforceAppsEnabled

Product Settings

  • IsCascadeActivateToRelatedPricesEnabled
  • IsQuantityScheduleEnabled
  • IsRevenueScheduleEnabled

Quote Settings

  • IsQuoteEnabled

Search Settings

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