in implementation guides ~ read.
Deploy Sandboxes

Deploy Sandboxes

DOWNLOAD

First things first !
To download this implementation guide, click the download button below.
If you need more information about the implementation guide, you can read the Table of Contents below.

Download

Deploy Enhancements from
Sandboxes
Salesforce Spring

salesforcedocs
Last updated February

Copyright salesforcecom inc All rights reserved Salesforce is a registered trademark of salesforcecom inc

as are other names and marks Other marks appearing herein may be trademarks of their respective owners

CONTENTS

Deploy Enhancements from Sandboxes
Sandboxes Staging Environments for Customizing and Testing
Create Clone or Refresh a Sandbox
Manage Your Sandboxes
Deploy Your Changes

Index

DEPLOY ENHANCEMENTS FROM SANDBOXES

Sandboxes create copies of your Salesforce org in separate environments Use them for development testing and training without
compromising the data and applications in your production org

IN THIS SECTION

Sandboxes Staging Environments for Customizing and Testing
Want to customize your organization in a staging environment where you can test changes without affecting your production
organization or its users Want to have an organization that users can log into and test new features before theyre productionready
Or maybe you just want to log into a Salesforce organization for training or development that mirrors your production organization
Create Clone or Refresh a Sandbox
Create a sandbox to use for development testing and training Clone a sandbox to copy its data and metadata into another sandbox
Refresh an existing sandbox to update its contents
Manage Your Sandboxes
In Setup enter Sandboxes in the Quick Find box then select Sandboxes Sandboxes displays the available sandboxes that
you purchased and a list of your sandboxes in use
Deploy Your Changes
Migrate metadata changes between Salesforce orgs by using the deployment tools available in Setup

Sandboxes Staging Environments for Customizing and Testing
Want to customize your organization in a staging environment where you can test changes without affecting your production organization
or its users Want to have an organization that users can log into and test new features before theyre productionready Or maybe you
just want to log into a Salesforce organization for training or development that mirrors your production organization
Salesforce offers sandboxes and a set of deployment tools so you can
Isolate customization and development work from your production environment until youre ready to deploy changes
Test changes against copies of your production data and users
Provide a training environment
Coordinate individual changes into one deployment to production
Whether youre an administrator adding features to an organization a solo developer writing code or a team of developers working to
enhance your organization you should work with the right tools in the right environment to build and deploy change successfully to
your production organization For a broad overview of the development process and recommendations for organizing your work see
the Application Lifecycle and Development Models module on Trailhead

IN THIS SECTION

Sandbox Types and Templates
Sandboxes are isolated from your production org so operations that you perform in your sandboxes dont affect your production
org

Deploy Enhancements from Sandboxes

Sandbox Types and Templates

Sandbox Licenses and Storage by Type
You can create different sandbox environments for your org depending on your needs for storage copy configuration and frequency
of refresh

SEE ALSO

Sandbox Types and Templates
Deploy Your Changes
Choose Your Tools for Developing and Deploying Changes

Sandbox Types and Templates
Sandboxes are isolated from your production org so operations that you perform in your sandboxes
dont affect your production org

EDITIONS

From Setup enter Sandboxes in the Quick Find box then select Sandboxes to view and
manage your existing sandboxes or create new ones

Available in both Salesforce
Classic not available in all
orgs and Lightning
Experience

Sandbox Types
Developer Sandbox

A Developer sandbox is intended for development and testing in an isolated environment A

Developer Sandbox includes a copy of your production orgs configuration metadata
Developer Pro Sandbox

A Developer Pro sandbox is intended for development and testing in an isolated environment

and can host larger data sets than a Developer sandbox A Developer Pro sandbox includes a

copy of your production orgs configuration metadata Use a Developer Pro sandbox to handle
more development and quality assurance tasks and for integration testing or user training
Partial Copy Sandbox

A Partial Copy sandbox is intended to be used as a testing environment This environment

includes a copy of your production orgs configuration metadata and a sample of your
production orgs data as defined by a sandbox template Use a Partial Copy sandbox for quality
assurance tasks such as user acceptance testing integration testing and training

Available in Professional
Enterprise Performance
Unlimited and
Databasecom Editions

USER PERMISSIONS

To view a sandbox
View Setup and
Configuration
To create refresh activate
and delete a sandbox
Manage Sandbox

Full Sandbox

A Full sandbox is intended to be used as a testing environment Only Full sandboxes support performance testing load testing and

staging Full sandboxes are a replica of your production org including all data such as object records and attachments and metadata
The length of the refresh interval makes it difficult to use Full sandboxes for development
We recommend that you apply a sandbox template so that your sandbox contains only the records that you need for testing or
other tasks
When you create a Full sandbox you also have to decide how much field tracking history and Chatter activity to include
The default is to omit field tracking but you can include up to days of field tracking If you track field history for many objects
in your production org specify fewer days to avoid generating an excessive amount of data
Chatter activity data can be extensive which can add a significant amount of time to your Full sandbox copy
Limit the amount of field history that you copy and copy your Chatter data only if you need it for your testing use cases

Deploy Enhancements from Sandboxes

Sandbox Types and Templates

Sandbox Templates Tab
If you have purchased a license for Partial Copy or Full sandboxes this tab lists any templates you have created
Create a Sandbox Data Template create a sandbox from a template edit or delete a template or click the template name for more
information For more information about creating a Sandbox Data Template see Create or Edit Sandbox Templates on page

Sandbox History Tab
This tab displays a log of your sandbox creation and a history of refreshes including when sandbox were created and who created them
The Sandbox History tab shows the sandboxes you created or refreshed within the last year up to entries The tab lists sandboxes
with the most recent activity the ones created or refreshed first
This tab provides information only To view or edit an existing sandbox use the Sandbox tab

Sandbox Licenses
You purchase licenses for each sandbox type and can purchase multiple licenses of each type Sandbox licenses are hierarchical Specifically
the following table shows the type of sandbox you can create with each license
Full Sandbox
license

Partial Copy
Sandbox license

Developer Pro
Sandbox license

Developer
Sandbox license

Allows you to create
Developer sandbox type
Developer Pro sandbox type
Partial Copy sandbox type
Full sandbox type

License stages are
Available
The displayed value represents the number of sandbox that youve purchased but havent used
In use
The displayed value represents the number of sandboxes that youve purchased and used
Note If you dont see a sandbox option or need licenses for more sandboxes contact Salesforce to order sandboxes for your org
When your sandbox licenses expire your existing sandboxes are subject to certain restrictions See Unlock a Sandbox on page for
resolution of license expiration issues

Understanding Sandbox Refresh Intervals
The refresh interval for each sandbox environment is calculated from when the actual sandbox copying process begins The sandbox
status changes from Pending to Processing at the start of copying

Deploy Enhancements from Sandboxes

Sandbox Licenses and Storage by Type

If other sandbox copy requests were made before yours your sandbox sometimes remains in the Pending status for some time The
refresh interval timer for your sandbox doesnt start until your request leaves this state

SEE ALSO

Create a Sandbox
Sandbox Licenses and Storage by Type
Unlock a Sandbox
General Sandbox and Sandbox Storage Limits

Sandbox Licenses and Storage by Type
You can create different sandbox environments for your org depending on your needs for storage
copy configuration and frequency of refresh

EDITIONS

Each type has different features to support the activities its designed for

Available in both Salesforce
Classic not available in all
orgs and Lightning
Experience

Table Sandboxes Available Per Edition
Sandbox Type

Professional
Edition

Performance
Edition

Unlimited
Edition

Enterprise
Edition

Developer Sandbox

Developer Pro
Sandbox

Partial Copy Sandbox

Full Sandbox

Available in Professional
Enterprise Performance
Unlimited and
Databasecom Editions

Note You can buy more sandboxes for any edition except Developer Sandbox which is bundled with addon sandboxes of other
types
The Developer Pro Sandbox addon is bundled with Developer Sandboxes
The Partial Copy Sandbox addon is bundled with Developer Sandboxes
The Full Sandbox addon is bundled with Developer Sandboxes
Table Sandbox Feature Quick Reference
Sandbox Type

Refresh Interval

Storage Limit

Whats Copied

Sandbox Templates

Developer Sandbox

day

Data storage MB

Metadata only

Not available

Metadata only

Not available

Metadata and sample
data

Required

File storage MB

Developer Pro Sandbox

day

Data storage GB

File storage GB

Partial Copy Sandbox

days

Data storage GB

File storage GB

Deploy Enhancements from Sandboxes

Create Clone or Refresh a Sandbox

Sandbox Type

Refresh Interval

Storage Limit

Whats Copied

Full Sandbox

days

Same as your production Metadata and all data
org

Sandbox Templates
Available

SEE ALSO

Create a Sandbox
Create or Edit Sandbox Templates
Sandbox Setup Considerations

Create Clone or Refresh a Sandbox
Create a sandbox to use for development testing and training Clone a sandbox to copy its data
and metadata into another sandbox Refresh an existing sandbox to update its contents

EDITIONS

You have a few ways to copy metadata and data to a sandbox

Available in both Salesforce
Classic not available in all
orgs and Lightning
Experience

Create a sandbox
When you create a sandbox Salesforce copies the metadata from your production org to a
sandbox org While creating a Partial Copy or Full sandbox you can apply a sandbox template
if you have created one Customers create sandbox templates to define specific object data to
copy into the Partial Copy or Full sandbox
Clone an existing sandbox to copy all its data and metadata to a new sandbox

Available in Professional
Enterprise Performance
Unlimited and
Databasecom Editions

Refresh and activate an existing sandbox
Refreshing a sandbox updates the sandboxs metadata from its source org If the sandbox is a
clone or if it uses a sandbox template the refresh process updates the orgs data in addition to
its metadata

IN THIS SECTION

Create a Sandbox
When you create a sandbox Salesforce copies the metadata from your production org to a
sandbox org

USER PERMISSIONS

To view a sandbox
View Setup and
Configuration
To create refresh activate
and delete a sandbox
Manage Sandbox

Refresh Your Sandbox
Refreshing a sandbox updates the sandboxs metadata from its source org If the sandbox is a clone or if it uses a sandbox template
the refresh process updates the orgs data in addition to its metadata
Activate Your Refreshed Sandbox
If you didnt select Auto Activate while refreshing your sandbox you must activate your sandbox before you can use it
Sandbox Cloning
You can create a sandbox by cloning an existing sandbox rather than using your production org as your source Save time by
customizing a sandbox with a set of data and metadata and then replicating it Sandbox cloning simplifies having multiple concurrent
streams of work in your application life cycle You can set up a sandbox for each type of work such as development testing and
staging Your colleagues can easily clone individual sandboxes instead of sharing one sandbox and avoid stepping on each others
toes

Deploy Enhancements from Sandboxes

Create a Sandbox

Monitor Your Sandboxs Progress
From Setup enter Sandboxes in the Quick Find box then select Sandboxes The list of your sandboxes displays a progress
bar for items in the queue in progress or recently completed

Create a Sandbox
When you create a sandbox Salesforce copies the metadata from your production org to a sandbox
org

EDITIONS

From Setup enter Sandboxes in the Quick Find box then select Sandboxes

Available in both Salesforce
Classic not available in all
orgs and Lightning
Experience

Click New Sandbox
Enter a name characters or fewer and description for the sandbox
We recommend that you choose a name that

Reflects the purpose of this sandbox such as QA

Has only a few characters because Salesforce appends the sandbox name to usernames
on user records in the sandbox environment Names with fewer characters make sandbox
logins easier to type

Available in Professional
Enterprise Performance
Unlimited and
Databasecom Editions

USER PERMISSIONS

Select the type of sandbox you want
If you dont see a sandbox option or need licenses for more contact Salesforce to order
sandboxes for your org
If you reduce the number of sandboxes you purchase you are required to match the number
of your sandboxes to the number you purchased For example if you have two Full sandboxes
but purchased only one you cant create a Full sandbox Instead convert a Full sandbox to a
smaller one such as a Developer Pro or Developer sandbox depending on which types you
have available

To view a sandbox
View Setup and
Configuration
To create refresh activate
and delete a sandbox
Manage Sandbox

Select the data to include in your Partial Copy or Full sandbox
For a Partial Copy sandbox click Next and then select the template you created to specify the data for your sandbox If you have
not created a template for this Partial Copy sandbox see Create or Edit Sandbox Templates
For a Full sandbox click Next and then decide how much data to include
To include templatebased data for a Full sandbox select an existing sandbox template For more information see Create
or Edit Sandbox Templates
To include all data in a Full sandbox choose whether and how much field tracking history data to include and whether to
copy Chatter data You can copy from to days of history in day increments The default is days Chatter data
includes feeds messages and discovery topics Decreasing the amount of data you copy can significantly speed sandbox
copy time
To run scripts after each create and refresh for this sandbox specify the Apex class you previously created from the SandboxPostCopy
interface
Click Create
Tip Try to limit changes in your production org while the sandbox copy proceeds
The process takes from several minutes to several days depending on the size and type of your org
When your sandbox is ready for use you receive a notification email that your sandbox has completed copying

Deploy Enhancements from Sandboxes

Refresh Your Sandbox

To access your sandbox click the link in the notification email Users can log in to the sandbox at httpstestsalesforcecom
by appending sandboxname to their Salesforce usernames For example if a username for a production org is useracmecom
and the sandbox is named test the modified username to log in to the sandbox is useracmecomtest
Note Salesforce automatically changes sandbox usernames but not passwords New sandboxes have the default email deliverability
setting System email only The System email only setting is especially useful for controling email sent from sandboxes so
that testing and development work doesnt send test emails to your users

SEE ALSO

Sandbox Types and Templates
Sandbox Licenses and Storage by Type
Create or Edit Sandbox Templates
Sandbox Setup Considerations
Unlock a Sandbox

Refresh Your Sandbox
Refreshing a sandbox updates the sandboxs metadata from its source org If the sandbox is a clone
or if it uses a sandbox template the refresh process updates the orgs data in addition to its metadata

EDITIONS

From Setup enter Sandboxes in the Quick Find box then select Sandboxes

Available in both Salesforce
Classic not available in all
orgs and Lightning
Experience

A list of your sandboxes displays Sandboxes that you can refresh have a Refresh link next to

their name
Next to the name click Refresh
Review the Name Description and Create From values and edit these values if needed
Select the type of sandbox environment you want

A table shows the number and type of sandbox licenses available in your org You can select a

different sandbox type to refresh

If the sandbox youre refreshing is a clone this option isnt available A cloned sandbox refreshes

from its source org and retains the source orgs sandbox license type If a sandboxs source org
has been deleted the clone refreshes from your production org
Select the data you want to copy
For a Partial Copy sandbox click Next and then select a template to specify the data for your
sandbox If you have not created a template for this Partial Copy sandbox see Create or Edit
Sandbox Templates

Available in Professional
Enterprise Performance
Unlimited and
Databasecom Editions

USER PERMISSIONS

To view a sandbox
View Setup and
Configuration
To create refresh activate
and delete a sandbox
Manage Sandbox

For a Full sandbox click Next and then decide how much object data to include
To include templatebased data in a Full sandbox select an existing sandbox template For more information see Create or Edit
Sandbox Templates
To include all object data in a Full sandbox choose whether and how much field tracking history to include and whether to copy
Chatter data You can copy from to days of history in day increments The default is days Chatter data includes feeds
messages and discovery topics Decreasing the amount of data you copy can speed sandbox copy time
If you want to activate your sandbox immediately after you refresh it select Auto Activate In this case you dont receive an activation
email

Deploy Enhancements from Sandboxes

Activate Your Refreshed Sandbox

Click Create

Refreshing your sandbox can move it to a different Salesforce instance For example the sandbox can move from CS to CS If

youre subscribed to Trust Notifications check your subscription settings to ensure that you continue to receive updates about
unforeseen incidents and planned maintenance that affect your sandbox
Salesforce starts copying data to the sandbox
If you didnt select Auto Activate while refreshing your sandbox Salesforce sends you an email when your sandbox is ready to activate

Activate Your Refreshed Sandbox
If you didnt select Auto Activate while refreshing your sandbox you must activate your sandbox
before you can use it

EDITIONS

From Setup enter Sandboxes in the Quick Find box then select Sandboxes

Available in both Salesforce
Classic not available in all
orgs and Lightning
Experience

A list of your sandboxes displays Refreshed sandboxes that havent been activated yet show

an Activate link next to their name
Click Activate next to the sandbox you want to activate
Warning Activating a replacement sandbox that was created using the Refresh link
deletes the sandbox it is refreshing The current configuration and data are erased
including application or data changes that youve made Click the Activate link only if
you dont need the current contents of the sandbox Your production org and its data
arent affected
Salesforce deletes new sandboxes that arent activated within days Users who created
or most recently refreshed any sandboxes for your org receive at least two email
notifications before Salesforce schedules the sandbox for deletion

Available in Professional
Enterprise Performance
Unlimited and
Databasecom Editions

USER PERMISSIONS

To view a sandbox
View Setup and
Configuration
To create refresh activate
and delete a sandbox
Manage Sandbox

Sandbox Cloning

You can create a sandbox by cloning an existing sandbox rather than using your production org
as your source Save time by customizing a sandbox with a set of data and metadata and then replicating it Sandbox cloning simplifies
having multiple concurrent streams of work in your application life cycle You can set up a sandbox for each type of work such as
development testing and staging Your colleagues can easily clone individual sandboxes instead of sharing one sandbox and avoid
stepping on each others toes

IN THIS SECTION

Clone a Sandbox

When you clone a sandbox all its data and metadata are copied to the new sandbox A cloned sandbox uses the same license type

as its source org
Refresh a Cloned Sandbox
Refreshing a cloned sandbox updates the sandboxs metadata and data from its source org

Deploy Enhancements from Sandboxes

Sandbox Cloning

Clone a Sandbox

When you clone a sandbox all its data and metadata are copied to the new sandbox A cloned

sandbox uses the same license type as its source org
Note You can only clone sandboxes that are on the same major Salesforce version as the
production org During the transition to a major release some sandboxes get upgraded before
others To determine the Salesforce version for your production and sandbox orgs see this
knowledge article To determine when your production org or sandbox gets upgraded see
the Salesforce maintenance schedule
From Setup enter Sandboxes in the Quick Find box then select Sandboxes
Click New Sandbox or click Clone next to a completed sandbox
Note Some older sandboxes may not be available for cloning Unavailable source orgs
dont have a Clone link next to them
Enter a name characters or fewer and description for the sandbox
We recommend that you choose a name that

Reflects the purpose of this sandbox such as QA

Has only a few characters because Salesforce appends the sandbox name to usernames
on user records in the sandbox environment Names with fewer characters make sandbox
logins easier to type

EDITIONS

Available in both Salesforce
Classic not available in all
orgs and Lightning
Experience
Available in Professional
Enterprise Performance
Unlimited and
Databasecom Editions

USER PERMISSIONS

To view a sandbox
View Setup and
Configuration
To create refresh activate
and delete a sandbox
Manage Sandbox

If you clicked New Sandbox from the Create From dropdown select the name of the sandbox
that you want to clone
Note Some older sandboxes may not be available for cloning Unavailable source orgs dont appear in the Create From
dropdown
If you clicked Clone confirm that the sandbox name selected in the Create From dropdown is the sandbox you want to use as your
source org
Make sure that the org youre cloning has the license type that you want for your new sandbox To use a different license type
choose a different source org from the Create From dropdown
Click Next
To run scripts after each creation and refresh for this sandbox specify an Apex class that extends the SandboxPostCopy interface
The Apex class you specify must exist in your source org
Click Create
Tip Avoid making changes in your source org while the sandbox copy occurs
When your new sandbox is ready you can manage it from your production org like any other sandbox

Deploy Enhancements from Sandboxes

Sandbox Cloning

Refresh a Cloned Sandbox
Refreshing a cloned sandbox updates the sandboxs metadata and data from its source org
Note When refreshing a sandbox you cant choose a source sandbox thats on a different
major release version than the production org During the transition to a major release some
sandboxes get upgraded before others To determine the Salesforce version for your production
and sandbox orgs see this knowledge article To determine when your production org or
sandbox gets upgraded see the Salesforce maintenance schedule
From Setup enter Sandboxes in the Quick Find box then select Sandboxes

A list of your sandboxes displays Sandboxes that you can refresh have a Refresh link next to

their name

EDITIONS

Available in both Salesforce
Classic not available in all
orgs and Lightning
Experience
Available in Professional
Enterprise Performance
Unlimited and
Databasecom Editions

Next to the name of the sandbox you want to refresh click Refresh
Review the name and description and edit them if needed

USER PERMISSIONS

Review the Create From value which is the source org for the refresh If you dont want to
refresh the cloned sandbox using its original source org select a different sandbox or your
production org

To view a sandbox
View Setup and
Configuration

A cloned sandbox refreshes from its source org and retains the source orgs sandbox license

type If a sandboxs source org has been deleted the clone refreshes from your production org

To create refresh activate
and delete a sandbox
Manage Sandbox

If you want to activate your sandbox immediately after you refresh it select Auto Activate In
this case you dont receive an activation email
To run scripts after each creation and refresh for this sandbox specify an Apex class that extends the SandboxPostCopy interface
The Apex class you specify must exist in your source org
Click Create

Refreshing your sandbox can move it to a different Salesforce instance For example the sandbox can move from CS to CS If

youre subscribed to Trust Notifications check your subscription settings to ensure that you continue to receive updates about
unforeseen incidents and planned maintenance that affect your sandbox
Salesforce starts copying metadata and data to the sandbox
If you didnt select Auto Activate Salesforce emails you when your sandbox is ready to activate

SEE ALSO

Activate Your Refreshed Sandbox

Deploy Enhancements from Sandboxes

Monitor Your Sandboxs Progress

Monitor Your Sandboxs Progress
From Setup enter Sandboxes in the Quick Find box then select Sandboxes The list of
your sandboxes displays a progress bar for items in the queue in progress or recently completed

EDITIONS

To show the percentage completed of a copy in progress hover over the progress bar

Available in both Salesforce
Classic not available in all
orgs and Lightning
Experience

To see information about the sandbox including copy progress or how much time before the
next available refresh click the name
If your sandbox status is suspended or stopped for more than hour contact Salesforce customer
support

Available in Professional
Enterprise Performance
Unlimited and
Databasecom Editions

USER PERMISSIONS

To view a sandbox
View Setup and
Configuration
To create refresh activate
and delete a sandbox
Manage Sandbox

Manage Your Sandboxes
In Setup enter Sandboxes in the Quick Find box then select Sandboxes Sandboxes
displays the available sandboxes that you purchased and a list of your sandboxes in use

EDITIONS

IN THIS SECTION

Available in both Salesforce
Classic not available in all
orgs and Lightning
Experience

Sandbox Action and Status Reference
Access the list of your sandboxes in your org from the Sandbox tab Each entry shows the status
of the sandbox environment and the specific actions that you can take
Unlock a Sandbox
Sandboxes are licensed separately from the Salesforce service and are subject to restrictions
When your sandbox licenses expire Salesforce decreases the count of available sandbox licenses
for the selected sandbox type
Create or Edit Sandbox Templates
Sandbox templates control which data is copied into a sandbox
Sandbox Setup Considerations

A sandbox behaves similar to your Salesforce production org but important differences affect

how you configure and test a sandbox org

Available in Professional
Enterprise Performance
Unlimited and
Databasecom Editions

USER PERMISSIONS

To view a sandbox
View Setup and
Configuration
To create refresh activate
and delete a sandbox
Manage Sandbox

***