All Collections
Data Backup
Restoring metadata from a data backup job
Restoring metadata from a data backup job

Use Gearset's data backup jobs to easily restore configuration settings in your orgs

Quinn Kuiper avatar
Written by Quinn Kuiper
Updated over a week ago

Gearset's data backup jobs provide a comprehensive metadata restore capability. If any unwanted configuration changes are made in an org, you can easily use a snapshot from your backup job to restore the org to its previous state.

Restoring data to an org

This article explains how to restore metadata to an org. If you want to restore data (records) instead, you can see how to do that here.

Restoring metadata

Metadata restoration is done from the history of a data backup job. Here's the process:

  1. Click View details  on the data backup job from which you want to restore.

  2. Choose the date of the org snapshot you'd like to restore from and click Metadata History

  3. Select the date that you would like to restore to and click view changes

  4. From here you can see the metadata that has been backed up in that run, split into all, new, changed and deleted items.

  5. Select the Roll back button on the bottom left of the screen, this will launch a comparison between that snapshot of the org and the org's live state.

  6. Gearset will now run a comparison between the snapshot of your target org and its live state, returning the metadata differences.

  7. From the comparison results, you can view the changes and select components to restore through the standard deployment flow. The steps to follow are listed below, but for more in-depth information on how to run a metadata deployment, see our support documents here.

  8. Select an item to view the metadata differences. The diff viewer in the lower half of the screen will show the differences between the backup snapshot (on the left) and the org's live state (on the right).

  9. To add an item to your deployment package, check the box next to its name. It will then appear in the Selected items tab.

  10. When you've selected what you want to restore, click Next.

    • Gearset will now check your deployment package for any missing dependencies that are likely to cause your deployment to fail.

    • If it finds any potential issues, it will suggest changes to your package to fix them. These fixes are optional, but following the recommendations will make your package more likely to deploy successfully.

  11. Click Next  when you've reviewed the suggested changes.

    • The pre-deployment summary shows you key information about what you're about to deploy. This includes the metadata items and their change type, as well as confirming your source and target.

  12. Click Deploy now to begin the deployment.

    • Once this process begins, Gearset will upload the package to Salesforce and queue it up for release. You can also run a validation first, or specify the test level to run during the deployment from this page.

    • Once the deployment completes, it will be saved in your deployment history under the type Backup, and your org will be restored to the backup snapshot state.

What should I do if I get stuck with anything?

If you ever need support, just contact our live chat support by clicking the blue button in the bottom right in every Gearset screen.

A real human (no robots here) will get back to you very quickly! We typically reply in under 15 minutes.

Did this answer your question?