This article discusses the Full Snapshot feature to create a complete metadata backup of an Org. This is the default interface that is launched when you add a new Snapshot Item to the Snapshot desktop. This interface is available by right clicking an asset on the desktop and also from the Options Menu.
Note: If you want to override this behavior, you can do so using the Snapshot menu > Snapshot Preferences > Extras > Select what happens when you create a new item and set Don't Automatically Open The Default Dialog option.
This is the first tab that you will see when you launch the Full Snapshot feature.
The Item Name text box defaults with the Snapshot Item's (blue icon on canvas) name. You can update it here. This is typically used to remind yourself of the Org that you are connecting with.
The Salesforce Username defaults to the username that you launched with. You can update it with the username that you want to use. This newly entered in username will be persisted upon a successful snapshot capture.
The Account Authentication options are:
- Salesforce DX - Used when your target is a scratch Org.
- Developer Edition - Used when your target is a Developer Edition Org. For developer sandboxes, please use the Sandbox Account option instead.
- Sandbox Account - Used when your target is a Sandbox Org. This option can be used for all Developer, Developer Pro, Lightning Developer Pro, Partial and Full Copy sandboxes.
- Production Account - Used when your target is a Production Org. In case your administrator has disabled login through the salesforce default https://login.salesforce.com page. For those cases, please use the Custom Domain option.
- Custom Domain - Used when you typically go to https://<my_company_name>.my.salesforce.com page to login to your Org.
- OAuth Endpoint - Used when your administrator has setup an auto-login (typically, Single Sign-On - SSO - through OAuth). You will need your OAuth login page URL to use this option. Typically, it is https://<my_company_name>.my.salesforce.com
The Salesforce Password requires your Salesforce password. This text box is hidden if you used the Salesforce DX or OAuth Endpoint Account Authentication options.
The Security Token is optional. If your location is unknown to salesforce, you will get a LOGIN_MUST_USE_SECURITY_TOKEN error and then this option will be required.
The Load Document Folders checkbox option is off by default. You can capture Salesforce Documents (these are the old Documents, not the new Salesforce Content libraries) by enabling this option.
The Load Folder Based Assets checkbox is on by default. You can capture Reports, Dashboards and Email Templates by enabling this option.
The Load Package Customizations checkbox is on by default. You can capture customizations to managed packages installed in your Org by enabling this option.
Please click Next button to go to the Take Snapshot tab. Switching to the Take Snapshot tab might take a few seconds while the system enumerates and splits the metadata into chunks to conform to the Metadata API limits.
The Take Snapshot tab is what you get to when you click the Next button on the Settings tab. The main intent to start the metadata capture process in this tab.
The Snapshot Comments text area on the left shows all the metadata types that are going to be captured. You can customize the comments by simply clicking on it and typing.
The Problems and Solutions text area on the right provides warnings if any.
You can click the Take Snapshot on the top right (orange button) to start the metadata capture process. The status of the capture process can be seen to the left of the button. The longest stage will be Waiting on Salesforce. You are waiting on Salesforce to complete its processing before Snapshot receives the metadata. This metadata capture process might take anywhere between two (2) minutes to a few (up to 5) hours to complete depending on the size of your Org.
You can cancel the metadata capture once you are in the Waiting on Salesforce stage by holding down the Esc (escape) key on your keyboard.
The Snapshot Limits File button on the bottom right exports the list of metadata selected and the Asset Groups (metadata chunks to conform to the API limits) that are automatically created. You can use this file as a template if you want to capture the exact same set of metadata across multiple Orgs.
Schedule Snapshot tab
The Schedule Snapshot tab designed to set up schedules for capturing your metadata on a timer.
Note: Snapshot is a client and hence you need to place Snapshot in Runtime Mode and leave the computer "up and running" for the schedules to execute. You can always lock the screen but if the machine is hibernated or put to sleep, your schedules will not execute.
There are three types of events that can be defined:
- One Time Event - Used when you want your schedule to execute exactly once and then turn itself off. For example, you would use this if you want to capture your Org metadata after a major deployment.
- Recurring Event - Used when you want to capture your Org metadata on a regular schedule. For example, you would use this if you want a daily/ weekly/ monthly metadata backup.
- And After That - Used after a One Time or Recurring Event, typically to move the metadata backup to another location.
Note: To save the snapshot to a particular location, please define your location in Snapshot menu > Snapshot Preferences > Folders or Content.