Salesforce DX Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
How Salesforce Developer Experience (DX) Tooling Changes the Way You Work
Provide Developers Access to Salesforce DX Tools
Project Setup
Authorization
Metadata Coverage
Scratch Orgs
Supported Scratch Org Editions and Allocations
Build Your Own Scratch Org Definition File
Create a Scratch Org Based on an Org Shape
Enable Org Shape for Scratch Orgs
Org Shape Permissions
Create and Manage Org Shapes
Scratch Org Definition for Org Shape
Troubleshoot Org Shape
Create Scratch Orgs
Scratch Org Snapshots
Select the Salesforce Release for a Scratch Org
Deploy Source From Your Project to the Scratch Org
Retrieve Source from the Scratch Org to Your Project
Scratch Org Users
Manage Scratch Orgs from the Dev Hub Org
Scratch Org Error Codes
Sandboxes
Track Changes Between Your Project and Org
Work with Data
Development
Build and Release Your App
Unlocked Packages
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Create a Scratch Org Based on an Org Shape

We know it’s not easy to build a scratch org definition that mirrors the features and settings in your production org. With Org Shape for Scratch Orgs, you can leave building the scratch org definition to us. After you capture the org’s shape, you can spin up scratch orgs based on it.

Available in: Developer, Group, Professional, Unlimited, and Enterprise editions. The scratch org created from the org shape is the same edition as the source org.

Not available in: Scratch orgs and sandboxes

What’s Included in Org Shape?

Features, Metadata API settings, edition, limits, and licenses determine what we refer to as an org’s shape. For further clarification, org shape includes:

  • Metadata API settings with boolean fields.
  • Licenses associated with installed packages, but not the packages themselves. To use the associated package, install it in the scratch org created from the org shape.

Some features aren’t captured when the org shape is created. However, you can add the features manually to the scratch org definition file. See Troubleshoot Org Shape for details.

Note

What’s Not Included in Org Shape?

  • Metadata API settings with integer or string fields. However, you can manually add non-Boolean settings or other settings not included in the source org to your scratch org definition. See Scratch Org Definition for Org Shape for examples.
  • Metadata types
  • Data

Org Shapes Are Specific to a Release

Scratch org shapes are associated with a specific Salesforce release. Be sure to recreate the org shape after the source org is upgraded to the new Salesforce release. During a Salesforce major release transition, your Dev Hub org and source org can be on different release versions. See Scratch Org Definition for Org Shape for options during the transition period.

Can I See the Org Shape File?

Org shapes are internal system files and aren’t viewable.