Create a Scratch Org
Last updated
Was this helpful?
Last updated
Was this helpful?
A Scratch Org is a short-lived Salesforce environment you spin up from your Developer Hub (Dev Hub). Developers use scratch orgs to validate proofs of concept, build and test unlocked packages, and experiment safely. You can create—and delete—any number of scratch orgs for each Salesforce DX project.
A module registered in AutoRABIT –
Open Scratch Org Management Hover over the Salesforce DX module and choose Scratch Org Management.
Start the wizard Click Create Scratch Org.
Tip: Some objects depend on particular profiles or other metadata. Double-check dependencies before creating your org to avoid missing components.
You can define the org in three ways:
Template file – Download the ScratchOrg DefinitionTemplate, edit locally, then upload.
Default values – Skip uploading a file and fields; AutoRABIT builds the org with defaults (you’ll be prompted to confirm).
Manual entry – Click Input Details and fill the form:
Username (email format; autogenerated if blank)
Description
Duration Days (active period)
Organization (business unit/name)
Features and Preferences (multi-select with Ctrl)
Admin Email, Country, Language
Edition (Developer, Enterprise, …)
Wait Time (1–15 min, default 6)
Click NEXT when done.
Deployment via Salesforce Org
Deployment From: Salesforce Org
Metadata Types:
Full Profiles – all profiles in source
Full Permission Sets – all permission sets
All – every metadata type
Source Org: select org
Deployment Method:
Selective Deployment – choose specific types
Full Deployment – deploy everything
Click Retrieve Metadata and pick members (use search to filter).
Click Proceed › Proceed to open deployment filters.
Deployment Filters include Ignore Warnings, Validate Only, Take Backup, etc.
Optionally enable Static Code Analysis.
Apply SEARCH / SUBSTITUTE rules if configured.
Add Deployment Notes.
Click Next to view the Deployment Summary before execution.
Deployment via Version Control
Deployment From: Version Control
Choose Version Control, Repository, Branch.
Select Metadata Types.
Pick a Deployment Method and click Retrieve Metadata (steps 5–11 are identical to the Salesforce Org flow).
Deployment via Module
Use an existing module in AutoRABIT:
Load Dataset from <Module Name> – adds the module’s dataset to the scratch org (if defined during module creation).
Include all dependent packages – deploys every package linked to the module.
Click Show Members to review metadata, then Next to continue to Assign Branch and ALM.
Assign Branch
Select Version Control, Repository, Branch.
Use Create Branch to spin up a new branch for the scratch org.
Assign User Story
Link an ALM work item to track progress:
ALM Type (JIRA, Azure DevOps, etc.)
ALM Label
Project and Sprint
Work Item
Click Next.
Assign module permissions to users; each receives an email with org details.
After submission you return to Scratch Org Management where progress is tracked.
Scratch Org Summary – click an org name for details.
View Log – see log output.
Deployment Status & Report – success, failure, timeout, etc.
Load Data – shows whether sample data was added.
Scratch Org Status – active / inactive.
Manage
Launch Scratch Org – opens the org in a new tab (allow pop-ups).
Manage Scratch Org Permissions – update user access (emails sent on change).
Actions
Delete Scratch Org – permanent deletion.
Edit ALM and Branch – change ALM link or VCS branch.
Select a Dev Hub (your main ) and enter a Scratch Org Name.
Choose your deployment source—Salesforce Org, Version Control, or an existing Module. (Need a new module? .)
