For most Salesforce metadata objects there are two restore type options.
Complete: Restore the a complete backup of the object to Salesforce.
Expert: Modify the raw definition of the object manually before deploying to Salesforce.
All CopyStorm/Restore simple editors look and behave similar to the ApexPage example below. Note that the only modifiable parameter is the version.
Switching the restore type to Expert will change the display to the Expert Mode Editor. For additional help see the Expert Mode Editor page.
The Deploy action (button) launches a dialog for initiating and monitoring a deployment to Salesforce. Deployments consist of three stages:
Review/update the options controlling the deployment.
Review the deployment plan.
Run the deployment.
Generally the only step a user needs to do is click on the “Deploy” button.
The Deployment Options tab controls how the deployment is executed.
The Deploy Plan tab lists a summary of all metadata objects that will be deployed. This is used as a final review prior to launching the deployment.
The Deploy Log tab shows the progress of the deployment as it happens and provides a way to cancel an active deployment.
During a deployment this tab may look like the following:
When the deployment is complete the log tab will show the final status of the deployment:
CopyStorm/Restore’s Advanced Metadata Selector provides a way to identify Metadata that has been modified at a particular point in time. After selecting the point in time, CopyStorm/Restore will automatically identify the metadata items that were modified during the provided window.
The following dialog will appear:
Provided Parameters:
Start Date (Optional): Metadata changes made after this date will be added to the Restore Set.
End Date (Optional): Metadata changes made before this date will be added to the Restore Set.
Selection Strategy
Most Recent
Use the most recent change between the Start / End dates.
Earliest
Selection Rules
Full Metadata Restore
If checked, CopyStorm/Restore will configure all newly selected metadata items to be fully restored.
If unchecked, CopyStorm/Restore will use the currently selected default.
Use the oldest change between the Start / End dates.
Keep Existing Selections
If checked, CopyStorm/Restore will keep currently selected Metadata in the Restore Set.
If unchecked, CopyStorm/Restore remove all currently selected Metadata from the Restore Set, then repopulate the Restore Set based off of the provided parameters.
The Custom Object editor is used to select the precise components of a standard or custom SObject that will be restored.
For a partial restore only particular elements of a Custom Object should be deployed. The following example will do a limited restore of several custom fields.
A complete restore will cause all properties of a Custom Object to be deployed.
An expert restore provides fine grained control at the Custom Object XML level. The initial XML can be:
The XML corresponding to the current partial editor.
The current or any past CopyStorm backup.
The current definition in Salesforce.
For additional help see the page.
The Meta Data tab enables the restoration of Salesforce metadata with surgical precision.
This tab is divided into three sections:
The Object Selector — add or remove a metadata object from the deployment set.
The Object Editor — precisely select the properties of a metadata object that should be deployed.
The Object Deployment Tools — deploy the selected metadata.
The Permission Set editor provides fine grained control for the restore of a Salesforce permission set.
Warning: Restoring a Permission Set completely replaces its definition in Salesforce. Unlike Profile restores, Permission Set restores DO NOT incrementally change a Permission Set.
For a partial restore, specific sub-components of a Permission Set are selected for the restore. A partial restore is typically used when migrating a Permission Set to a new environment where the original Permission Set contains entries related to objects/fields are not in the target Salesforce.
A complete restore will cause all properties of a Permission Set to be deployed.
An Expert restore provides fine control over the XML which is restored. See the for details.
To add a metadata object to the deployment set, click on the checkbox next to its name. Default behavior will be to load the object into the Object Editor. To remove a metadata object from the deployment set, uncheck the box next to its name.
To narrow a search for metadata objects, use the filter controls above the Object Selector list:
Meta Data Type — if selected, only metadata objects of the given type are displayed. If blank, all metadata types are shown.
Selected — if checked, only metadata object that are part of the deployment set will be shown.
Invert — when clicked, unchecks any checked items and checks all unchecked items.
Clear — when clicked, unchecks all visible checked items.
Name Filter — as characters are typed into this box, only metadata objects containing the typed text will be displayed.
The Object Editor allows selection of:
The version of the metadata object which will be deployed.
The sub-components of the metadata object which will be deployed.
There are two types of object editors:
Simple — the only available option is the version which will be deployed.
Examples include ApexPage, ApexClass, and PermissionSet.
Complex — there are multiple sub-components that can be selected individually.
An example of this is CustomObject — its sub-components include CustomFields, ValidationRules, etc…
There are several basic object deployment tools:
Deploy — deploys the selected metadata to Salesforce.
Show Plan — displays a summary of metadata in the deployment plan.
Create Deployment Directory — create a directory structure usable by the Salesforce Migration Tool to deploy the selected metadata.
Create Destruction Directory — create a directory structure usable by the Salesforce Migration Tool to delete the selected metadata.
The Profile Set editor provides fine grained control for the restore of a Salesforce Profile record.
For a partial restore, specific sub-components of a Profile are selected for the restore. A partial restore is often used when migrating a Profile to a new environment where the original Profile contains entries related to objects/fields are not in the target Salesforce.
A complete restore will cause all properties of a Profile to be deployed.
An Expert restore provides fine control over the XML which is restored. See the Expert Mode Editor for details.
Though a Partial or Complete restore of a meta data element usually works, sometimes it is necessary to edit the raw XML that will be deployed to Salesforce. The Export Mode restore type provides this feature plus a few others.
The raw data for the current partial restore, any backup in Capstorm, or the current Salesforce definition can be loaded and edited.
Differences between what will be deployed can be quickly compared with the current partial restore, any backup in Capstorm, or the current Salesforce definition.
Finding all occurrences of a pattern can be quickly performed.
Note that in Export mode, the raw data to deploy for an object is stored in the copyStormRestore file as part of the restore session configuration.
To restore a meta data object using the Export mode, simply choose Expert from the restore type pull-down menu.
The metadata to load into the left or right panels is selected using two different pulldown menus.
The “Base Version” pulldown loads metadata into the editor on the left.
The “Compare With Version” pulldown loads metadata into the comparison viewer on the right.
You will see several types of options in the pulldown menu.
The following screen shots illustrate how differences are displayed when the metadata on the left and right differ. For the example an ApexTrigger metadata objects was selected.
There two techniques for searching metadata.
Differences will be calculated automatically and can be systematically walked thru using arrow control on the right.
Specific text can be found by entering a regular expression in the Find parameter. These, too, can be systematically walked thru using arrow controls on the right.
Current Backup
Load the most recent back found in the CopyStorm database.
Current Partial
Load the metadata corresponding to the current partial selection for the metadata object.
Current Salesforce
Load the current definition from the target Salesforce instance.
Custom
Load metadata that the user has edited in this or a past session of CopyStorm/Restore.
2020-01-10 14:34:50
Load the backup from the CopyStorm database which was created on the specified date.
