Scratch Org Definition Configuration Values
The scratch org definition file contains the configuration values that determine the
shape of the scratch org.
Supported Editions
The Salesforce edition of the scratch org. Possible values are:
- Developer
- Enterprise
- Group
- Professional
Partners can create partner edition scratch orgs: Partner Developer, Partner
Enterprise, Partner Group, and Partner Professional. This feature is available only
if creating scratch orgs from a Dev Hub in a partner business org. See Supported Scratch Org Editions for
Partners in the ISVforce Guide for details.
Supported Features
You can enable these add-on features in a scratch org. Features aren’t
case-sensitive. You can indicate them as all-caps, or as we define them here for
readability. If a feature is followed by <value>, you must specify a value as an
incremental allocation or limit.
You can specify multiple feature values in a comma-delimited list in the scratch org
definition
file.
AddCustomApps:<value>
Increases the maximum number of custom apps allowed in an org. Indicate a value from
1–30.
- Supported Quantities
- 1–30, Multiplier: 1
AddCustomObjects:<value>
Increases the maximum number of custom objects allowed in the org. Indicate a value from
1–30.
- Supported Quantities
- 1–30, Multiplier: 1
AddCustomRelationships:<value>
Increases the maximum number of custom relationships allowed on an object. Indicate a
value from 1–10.
- Supported Quantities
- 1–10, Multiplier: 5
AddCustomTabs:<value>
Increases the maximum number of custom tabs allowed in an org. Indicate a value from
1–30.
- Supported Quantities
- 1–30, Multiplier: 1
AddDataComCRMRecordCredit:<value>
Increases record import credits assigned to a user in your scratch org. Indicate a value
from 1–30.
- Supported Quantities
- 1–30, Multiplier: 1
AddInsightsQueryLimit:<value>
Increases the size of your Einstein Analytics query results. Indicate a value from
1–30 (multiplier is 10). Setting the quantity to 6
increases the query results to 60.
- Supported Quantities
- 1–30, Multiplier: 10
AdditionalFieldHistory:<value>
Increases the number of fields you can track history for beyond the default, which is 20
fields. Indicate a value between 1–40.
- Supported Quantities
- 1–40, Multiplier: 1
- More Information
-
Previous name: AddHistoryFieldsPerEntity.
AnalyticsAdminPerms
Enables all permissions required to administer the Analytics platform, including
permissions to enable creating Analytics templated apps and
Analytics Apps.
API
Enables access to the Salesforce APIs (REST, SOAP, Bulk, Bulk 2.0) even in scratch orgs where the edition normally doesn't have API access.
AuthorApex
Enables you to access and modify Apex code in a scratch org. Enabled by default in
Enterprise and Developer Editions.
- More Information
-
For Group and Professional Edition orgs, this feature is disabled by default. Enabling the AuthorApex feature lets you edit and test your Apex classes.
BigObjectsBulkAPI
Enables the scratch org to use BigObjects in the Bulk API.
CacheOnlyKeys
Enables the cache-only keys service. This feature allows you to store your key material
outside of Salesforce, and have the Cache-Only Key Service fetch your key on demand from a key
service that you control.
CalloutSizeMB:<value>
Increases the maximum size of an Apex callout. Indicate a value between
3–12.
- Supported Quantities
- 3–12, Multiplier: 1
CascadeDelete
Provides lookup relationships with the same cascading delete functionality previously
only available to master-detail relationships. To prevent records from being accidentally
deleted, cascade-delete is disabled by default.
CaseClassification
Enables Einstein Case Classification. Case Classification offers recommendations to your agents so they can select the best value. You can also automatically save the best recommendation and route the case to the right agent.
ChangeDataCapture
Enables Change Data Capture, if the scratch org edition doesn't automatically enable it.
Chatbot
Enables deployment of Bot metadata into a scratch org, and allows you to create and edit bots.
- More Information
-
To use this feature, turn on Enable Einstein Features in the Dev Hub org
to accept the Terms of Service.
See Einstein Bots in
Salesforce Help for more information.
CMSMaxContType
Limits the number of distinct content types you can create within Salesforce CMS to 21.
CMSMaxNodesPerContType
Limits the maximum number of child nodes (fields) you can create for a particular content type to 15.
CMSUnlimitedUse
Enables unlimited content records, content types, and bandwidth usage in Salesforce CMS.
Communities
Allows the org to create a customer community. To use Communities, you must also include
communitiesSettings > enableNetworksEnabled in the settings section
of your scratch org definition file.
- More Information
-
Available in Enterprise and Developer scratch orgs.
ConAppPluginExecuteAsUser
Enables the pluginExecutionUser field in the ConnectedApp Metadata API object.
ConcStreamingClients:<value>
Increases the maximum number of concurrent clients (subscribers) across all channels and
for all event types for API version 36.0 and earlier.
Indicate a value between 20–4,000.
- Supported Quantities
- 20–4,000, Multiplier: 1
ConsolePersistenceInterval:<value>
Increases how often console data is saved, in minutes. Indicate a value between
0–500. To disable auto save, set the value to
0.
- Supported Quantities
- 0–500, Multiplier: 1
ContractApprovals
Enables contract approvals, which allow you to track contracts through an approval process.
CPQ
Enables the licensed features required to install the Salesforce CPQ managed package.
Doesn't install the package automatically.
CustomNotificationType
Allows the org to create custom notification types, which are used to send custom desktop
and mobile notifications.
DataComDnbAccounts
Provides a license to Data.com account features.
DataComFullClean
Provides a license to Data.com cleaning features, and allows users to turn on auto
fill clean settings for jobs.
DataMaskUser
Provides 30 Data Mask permission set licenses. This permission set enables access to an installed Salesforce Data Mask package.
DebugApex
Enables Apex Interactive Debugger. You can use it to debug Apex code by setting breakpoints and checkpoints, and inspecting your code to find bugs.
DefaultWorkflowUser
Sets the scratch org admin as the default workflow user.
DeferSharingCalc
Allows admins to suspend group membership and sharing rule calculations and to resume
them later.
- More Information
-
Requires configuration using the Setup menu in the scratch org. See Defer Sharing
Calculations in Salesforce Help.
DevelopmentWave
Enables Einstein Analytics development in a scratch org. It assigns five platform
licenses and five EA platform licenses to the org, along with assigning the permission set
license to the admin user. It also enables the Analytics Templates and Einstein Discovery
features.
DeviceTrackingEnabled
Enables Device Tracking.
DisableManageIdConfAPI
Limits access to the LoginIP and ClientBrowser API objects to allow view or delete only.
Division
Turns on the Manage Divisions feature under Company Settings. Divisions let you segment your organization's data into logical sections, making searches, reports, and list views more meaningful to users. Divisions are useful for organizations with extremely large amounts of data.
DocumentChecklist
Enables Document Tracking and Approval features, and adds the Document Checklist permission set. Document tracking features let you define documents to upload and approve, which supports processes like loan applications or action plans.
DurableClassicStreamingAPI
Enables Durable PushTopic Streaming API for API version 37.0 and later.
- More Information
-
Available in Enterprise and Developer Edition scratch orgs.
DurableGenericStreamingAPI
Enables Durable Generic Streaming API for API version 37.0 and later.
- More Information
-
Available in Enterprise and Developer Edition
scratch orgs.
DynamicClientCreationLimit
Allows the org to register up to 100 OAuth 2.0 connected apps through the dynamic client
registration endpoint.
EinsteinAnalyticsPlus
Provides one Einstein Analytics Plus license.
EinsteinArticleRecommendations
Provides licenses for Einstein Article Recommendations. Einstein Article Recommendations uses data from past cases to identify Knowledge articles that are most likely to help your customer service agents address customer inquiries.
- More Information
-
Available in Enterprise Edition scratch orgs.
Requires configuration using the Setup menu in
the scratch org.
See Set Up Einstein Article
Recommendations in Salesforce Help for more
information.
EinsteinBuilderFree
Provides a license that allows admins to create one enabled prediction
with Einstein Prediction Builder. Einstein Prediction Builder is
custom AI for admins
EmbeddedLoginForIE
Provides JavaScript files that support Embedded Login in IE11.
EmpPublishRateLimit:<value>
Increases the maximum number of standard-volume platform event notifications published
per hour. Indicate a value between
1,000–10,000.
- Supported Quantities
- 1,000–10,000, Multiplier: 1
EnablePRM
Enables the partner relationship management permissions for the org.
EnableManageIdConfUI
Enables access to the LoginIP and ClientBrowser API objects to verify a user's identity in the UI.
EncryptionStatisticsInterval:<value>
Defines the interval (in seconds) between encryption statistics gathering processes. The
maximum value is 604,800 seconds (7 days). The default is once per 86,400 seconds (24
hours).
- Supported Quantities
- 0–60,4800, Multiplier: 1
EncryptionSyncInterval:<value>
Defines how frequently (in seconds) the org can synchronize data with the active key
material. The default and maximum value is 604,800 seconds (7 days). To synchronize data more
frequently, indicate a value, in seconds, equal to or larger than 0.
- Supported Quantities
- 0–604,800, Multiplier: 1
Entitlements
Enables entitlements. Entitlements are units of customer support in Salesforce, such as
phone support or web support that represent terms in service agreements.
EventLogFile
Enables API access to your org's event log files. The event log files contain information
about your org’s operational events that you can use to analyze usage trends and user
behavior.
ExternalIdentityLogin
Allows the scratch org to use External Identity features associated with your license.
FieldAuditTrail
Enables Field Audit Trail for the org and allows a total 60 tracked fields. By default,
20 fields are tracked for all orgs, and 40 more are tracked with
Field Audit Trail.
- More Information
-
Previous name: RetainFieldHistory
FieldService
Provides the Field Service license.
- More Information
-
Available in Enterprise Edition. Enabled by default in Developer Edition. See Enable Field Service
Lightning in Salesforce Help for more
information.
FinancialServicesUser:<value>
Adds the Financial Services Cloud Standard permission set license. This permission set
enables access to Lightning components and the standard version of
Financial Services Cloud. Also provides access to the standard
Salesforce objects and custom Financial Services Cloud objects. Indicate
a value between 1–10.
- Supported Quantities
- 1–10, Multiplier: 1
FlowSites
Enables the use of flows in Salesforce Sites and customer portals.
GenericStreaming
Enables Generic Streaming API for API version 36.0 and earlier.
- More Information
-
Available in Enterprise and Developer Edition scratch orgs.
GenStreamingEventsPerDay:<value>
Increases the maximum number of delivered event notifications within a 24-hour period,
shared by all CometD clients, with generic streaming for API
version 36.0 and earlier. Indicate a value between
10,000–50,000.
- Supported Quantities
- 10,000–50,000, Multiplier: 1
HealthCloudUser
Adds one user license to access Health Cloud features.
HighVelocitySales
Provides High Velocity Sales licenses. High Velocity Sales optimizes the inside sales
process with a high-productivity workspace. Sales managers can create custom sales processes
that guide reps through handling different types of prospects. And sales reps can rapidly
handle prospects with a prioritized list and other productivity-boosting features. The High
Velocity Sales feature can be deployed in scratch orgs, but the settings for the feature
can’t be updated through the scratch org definition file. Instead, configure settings
directly in the High Velocity Sales app.
HoursBetweenCoverageJob:<value>
The frequency in hours when the sharing inheritance coverage report can be run for an
object. Indicate a value between 1–24.
- Supported Quantities
- 1–24, Multiplier: 1
IdentityProvisioningFeatures
Enables use of Salesforce Identity User Provisioning.
IndustriesActionPlan
Provides a license for Action Plans. Action Plans allow you to define the tasks or document checklist items for completing a business process.
- More Information
-
Previous name: ActionPlan.
For more information and configuration steps,
see Enable Actions Plans
in Salesforce Help.
IndustriesManufacturing
Enables Sales Agreements. With Sales Agreements, you can negotiate purchase and sale of
products over a continued period. You can also get insights into
products, prices, discounts, and quantities. And you can track your
planned and actual quantities and revenues with real-time updates
from orders and contracts.
IndustriesManufacturingCmty
Provides the Manufacturing Sales Agreement for the Community permission set license,
which is intended for the usage of partner community users. It also
provides access to the Manufacturing community template for admins
users to create communities.
IndustriesMfgAccountForecast
Enables Account Forecast. With Account Forecast, you can generate forecasts for your
accounts based on orders, opportunities, and sales agreements. You
can also create formulas to calculate your forecasts per the
requirements of your company.
Interaction
Enables flows. A flow is the part of Lightning Flow that collects data and performs
actions in your Salesforce org or an external system. Lightning Flow
provides two types of flows: screen flows and autolaunched
flows.
- More Information
-
Requires configuration in the Setup menu of the scratch org.
IoT
Enables IoT so the scratch org can consume platform events to perform business and
service workflows using orchestrations and contexts.
- More Information
-
Requires configuration in the Setup menu of the scratch org.
JigsawUser
Provides one license to Jigsaw features.
Knowledge
Enables Salesforce Knowledge and gives your website visitors, clients, partners, and
service agents the ultimate support tool. Create and manage a
knowledge base with your company information, and securely share it
when and where it's needed. Build a knowledge base of articles that
can include information on process, like how to reset your product
to its defaults, or frequently asked questions.
LegacyLiveAgentRouting
Enables legacy Live Agent routing for Chat. Use Live Agent routing to chat in Salesforce Classic. Chats in Lightning Experience must be routed using Omni-Channel.
LightningSalesConsole
Adds one Lighting Sales Console user license.
LightningScheduler
Enables Lightning Scheduler. Lightning Scheduler gives you tools to simplify appointment scheduling in Salesforce. Create a personalized experience by scheduling customer appointments—in person, by phone, or by video—with the right person at the right place and time.
LightningServiceConsole
Assigns the Lightning Service Console License to your scratch org so you
can use the Lightning Service Console and access features that help
manage cases faster.
LiveAgent
Enables Chat for Service Cloud. Use web-based chat to quickly connect customers to agents for real-time support.
LiveMessage
Enables Messaging for Service Cloud. Use Messaging to quickly support customers using apps such as SMS text messaging and Facebook Messenger.
Macros
Enables macros in your scratch org. After enabling macros, add the macro browser to the Lightning Console so you can configure predefined instructions for commonly used actions and apply them to multiple posts at the same time.
MarketingUser
Provides access to the Campaigns object. Without this setting, Campaigns are
read-only.
MaxApexCodeSize:<value>
Limits the non-test, unmanaged Apex code size (in MB). To use a value greater than the
default value of 10, contact Salesforce Customer Support.
MaxAudTypeCriterionPerAud
Limits the number of audience type criteria available per audience. The default value is 10.
MaxCustomLabels:<value>
Limits the number of custom labels (measured in thousands). Setting the limit to 10
enables the scratch org to have 10,000 custom labels. Indicate a
value between 1–15.
- Supported Quantities
- 1–15, Multiplier: 1,000
MaxFavoritesAllowed:<value>
Increases the number of Favorites allowed. Favorites allow users to create a shortcut to
a Salesforce Page. Users can view their Favorites by clicking
the Favorites list dropdown in the header. Indicate a value
between 0–200.
- Supported Quantities
- 0–200, Multiplier: 1
MaxNoOfLexThemesAllowed:<value>
Increases the number of Themes allowed. Themes allow users to configure colors, fonts,
images, sizes, and more. Access the list of Themes in Setup,
under Themes and Branding. Indicate a value between
0–300.
- Supported Quantities
- 0–300, Multiplier: 1
MaxStreamingTopics:<value>
Increases the maximum number of delivered PushTopic event notifications within a 24-hour
period, shared by all CometD clients. Indicate a value between
40–100.
- Supported Quantities
- 40–100, Multiplier: 1
MaxUserNavItemsAllowed:<value>
Increases the number of navigation items a user can add to the navigation bar. Indicate a
value between 0–500.
- Supported Quantities
- 0–500, Multiplier: 1
MaxUserStreamingChannels:<value>
Increases the maximum number of user-defined channels for generic streaming. Indicate a
value between 20–1,000.
- Supported Quantities
- 20–1,000, Multiplier: 1
MedVisDescriptorLimit:<value>
Increases the number of sharing definitions allowed per record for sharing inheritance to
be applied to an object. Indicate a value between
150–1,600.
- Supported Quantities
- 150–1,600, Multiplier: 1
MinKeyRotationInterval
Sets the encryption key material rotation interval at once per 60 seconds. If this
feature isn't specified, the rotation interval defaults to once per 604,800 seconds (7 days) for
Search Index key material, and once per 86,400 seconds (24 hours) for all other key
material.
MobileExtMaxFileSizeMB:<value>
Increases the file size (in megabytes) for Field Service Lightning Mobile extensions.
Indicate a value between 1–2,000.
- Supported Quantities
- 1–2,000, Multiplier: 1
MobileSecurity
Enables Enhanced Mobile Security. With Enhanced Mobile Security, you can control a range
of policies to create a security solution tailored to your org’s needs. You can limit user
access based on operating system versions, app versions, and device and network security.
You can also specify the severity of a violation.
MultiCurrency
Enables the scratch org to set up and use multiple currencies in opportunities,
forecasts, quotes, reports, and other data.
MultiLevelMasterDetail
Allows the creation a special type of parent-child relationship between one object, the
child, or detail, and another object, the parent, or master.
MutualAuthentication
Requires client certificates to verify inbound requests for mutual authentication.
NonprofitCloudCaseManagementUser
Provides the permission set license required to use and configure the Salesforce.org
Nonprofit Cloud Case Management managed package. You can then install the package in the scratch
org.
ObjectLinking
Create rules to quickly link channel interactions to objects such as contacts, leads, or person accounts for customers (Beta).
OutboundMessageHTTPSession
Enables using HTTP endpoint URLs in outbound message definitions that have the Send
Session ID option selected.
PardotScFeaturesCampaignInfluence
Enables additional campaign influence models, first touch, last touch, and even
distribution for Pardot users.
PersonAccounts
Enables person accounts in your scratch org.
- More Information
-
Available in Enterprise and Developer Edition scratch orgs.
ProcessBuilder
Enables Process Builder, a Lightning Flow tool that helps you automate your business
processes.
- More Information
-
Requires configuration in the Setup menu of the scratch org.
See Lightning Process Builder in Salesforce
Help for more information.
ProductsAndSchedules
Enables product schedules in your scratch org. Enabling this feature lets you create
default product schedules on products. Users can also create schedules for individual
products on opportunities.
RecordTypes
Enables Record Type functionality. Record Types let you offer different business
processes, picklist values, and page layouts to different users.
RefreshOnInvalidSession
Enables automatic refreshes of Lightning pages when the user's session is invalid. If, however, the page detects a new token, it tries to set that token and continue without a refresh.
S1ClientComponentCacheSize
Allows the org to have up to 5 pages of caching for Lightning Components.
SalesCloudEinstein
Enables Sales Cloud Einstein features. Sales Cloud Einstein bring artificial intelligence to every step of the sales process.
- More Information
-
Available in Enterprise Edition scratch orgs.
See Sales Cloud Einstein
in Salesforce Help for more information.
SalesforceContentUser
Enables access to Salesforce content features.
SalesforceIdentityForCommunities
Adds Salesforce Identity components, including login and self-registration, to Experience
Builder. This feature is required for Aura components.
SalesUser
Provides a license for Sales Cloud features.
SAML20SingleLogout
Enables usage of SAML 2.0 single logout.
SCIMProtocol
Enables access support for the SCIM protocol base API.
SecurityEventEnabled
Enables access to security events in Event Monitoring.
ServiceCloud
Assigns the Service Cloud license to your scratch org, so you can choose how your
customers can reach you, such as by email, phone, social media, online communities,
chat, and text.
ServiceUser
Adds one Service Cloud User license, and allows access to Service Cloud features.
SessionIdInLogEnabled
Enables Apex debug logs to include session IDs. If disabled, session IDs are replaced with "SESSION_ID_REMOVED" in debug logs.
SFDOInsightsDataIntegrityUser
Provides a license to Salesforce.org Insights Platform Data Integrity managed package.
You can then install the package in the scratch org.
SingleSignOn
Enables the configuration and use of single sign-on.
Sites
Enables Salesforce Sites, which allows you to create public websites and applications
that are directly integrated with your Salesforce org. Users aren’t
required to log in with a username and password.
- More Information
-
You can create sites and communities in a scratch org, but custom domains, such as www.example.com, aren't supported.
SocialCustomerService
Enables Social Customer Service, sets post defaults, and either activates the Starter
Pack or signs into your Social Studio account.
StateAndCountryPicklist
Enables state and country picklists. State and country picklists let users select states and countries from predefined, standardized lists, instead of entering state and country data into text fields.
StreamingAPI
Enables Streaming API.
- More Information
-
Available in Enterprise and Developer Edition scratch orgs.
StreamingEventsPerDay:<value>
Increases the maximum number of delivered PushTopic event notifications within a 24-hour
period, shared by all CometD clients (API version 36.0 and earlier).
Indicate a value between 10,000–50,000.
- Supported Quantities
- 10,000–50,000, Multiplier: 1
SubPerStreamingChannel:<value>
Increases the maximum number of concurrent clients (subscribers) per generic streaming
channel (API version 36.0 and earlier). Indicate a value between
20–4,000.
- Supported Quantities
- 20–4,000, Multiplier: 1
SubPerStreamingTopic:<value>
Increases the maximum number of concurrent clients (subscribers) per PushTopic streaming
channel (API version 36.0 and earlier). Indicate a value between
20–4,000.
- Supported Quantities
- 20–4,000, Multiplier: 1
SustainabilityCloud
Provides the permission set licenses and permission sets required to install and
configure Sustainability Cloud. To enable or use Einstein Analytics
and Analytics templates, include the DevelopmentWave scratch org
feature.
TerritoryManagement
TerritoryManagement enables the original territory management feature, which is scheduled
for retirement for all customers as of Summer ’21. We encourage you
to migrate to the Enterprise Territory Management (Territory2)
scratch org setting to enable Enterprise Territory Management.
TimeSheetTemplateSettings
Time Sheet Templates let you configure settings to create time sheets automatically. For example, you can create a template that sets start and end dates. Assign templates to user profiles so that time sheets are created for the right users.
TransactionFinalizers
Enables you to implement and attach Apex Finalizers to Queueable Apex jobs.
- More Information
-
This functionality is currently in open
pilot and subject to restrictions.
See the Transaction Finalizers (Pilot) in Apex
Developer Guide for more information.
Workflow
Enables Workflow so you can automate standard internal procedures and
processes.
- More Information
-
Requires configuration in the Setup menu of the scratch org.
WorkflowFlowActionFeature
Allows you to launch a flow from a workflow action.
- More Information
-
This setting is supported only if you enabled the pilot program in your org for flow trigger
workflow actions. If you enabled the pilot, you
can continue to create and edit flow trigger
workflow actions.
If you didn't enable the pilot, use the Flows
action in the ProcessBuilder scratch org feature
instead.
WorkThanksPref
Enables the give thanks feature in Chatter.
j