Skip to main content

QuickStart guide and workflow for restore

When you perform a restore, you can:

Restore data (object/record)

  • Directly restore from a snapshot using different selection criteria or SOQL queries.

  • Compare the differences between records of a single object from two snapshots. You can selectively restore the records.

Restore Metadata

  • Directly restore from a snapshot by selecting the metadata type

  • Compare the differences between metadata types from two snapshots. You can selectively restore the metadata.

Workflow

The following diagram illustrates the restore workflow.


Before you begin

Ensure the following:

  • Source and Destination Environments are added in the Environment hub. For more information, see Configuring Environment Hub.

  • You have the required permissions. For more information, see Permissions.

Step 1: Select the type of restore you want to perform

  • Compare and restore: You can select records or metadata from a snapshot and restore them to the same or different Salesforce organization. You can also restore records using a comparison view of the created, updated, and deleted records. For more information, see Compare and Restore Records and Compare and Restore Metadata.

  • Bulk restore: You can initiate one-time restore directly from the backup or archive job listing.

Step 2: Configure a restore job

Restore jobs are now one-time executions configured through a guided wizard. The restore wizard includes the following steps:

  • Step 1 — Basic Configuration: Select the destination organization. Pre-filled read-only fields show the source Project, Backup Set, and Snapshot. Configure Additional Settings including retry count, metadata handling, and notification preferences.

  • Step 2 — Restore Settings (Optional): Fine-tune the restore using the following options: Record Selection, External ID, Exclude Objects, Exclude Fields, Data Translations, Data Mask, Validations, Junction Objects, and Batch Size.

  • Step 3 — Preview: Review the restore configuration before submitting.

Step 3: Configure data masks and other Data Restore Settings

After you have identified the records you want to restore, you can configure the following settings for the data restore:

Setting

Description

Overview

Each object in the source environment and its true or false configuration for settings.

External ID

Specify fields the application should use when trying to determine if the record already exists on the destination org. This is useful if users manually create records on the destination org or use another application to load data into the destination org.

If the data was created through a sandbox refresh (i.e. Partial or Full Sandbox), or by the Salesforce App, you do not have to define external IDs since the ID mapping between the source and destination is automatically tracked internally by the application.

Exclude Objects

Select objects to exclude or include.


📝 Note

You cannot exclude objects that already have records selected in the data template. To exclude that object, perform an exclude record operation first. You can do this under the Record Selection tab.


Exclude Fields

Select fields of an object to exclude or include.


📝 Note

If you exclude a lookup or master-detail field, the application will not consider the related object when discovering parent/child records.


Data Translations

Modify field values prior to writing them to the destination org. Use this if you need to alter the value of a field without having to directly modify the value on the source org. You can use either Regular Expressions or plain text.

Data Mask

Mask object fields using custom values for the following types: Regular Expression, Numeric Range, and Date Range. Alternatively, you can select the Automatic data mask type and random values will be generated for each field type.


📝 Note

You are able to test the data mask definitions you have created against your source environment data prior to performing a data seeding.


Validations

By default, Salesforce App will disable all validation types (e.g. Triggers, Workflows, Required Fields, etc.). Use this section to keep specific validation types and definitions enabled.

Batch Size

You can specify the batch size of records for copying data to a destination organization. The Salesforce App loads a maximum of 200 records by default.

For more information, see Restore Data.

Step 4: Initiate data restore

  1. On the Salesforce App console, click Backup.

  2. Select the backup set and open the Backups tab.

  3. Select a snapshot and click Restore.

  4. In the Restore wizard, complete the three steps and click Restore to submit the job. For more information, see Restore Data.

Step 5: Monitor restores

You can check the progress of the data restore from the Task page. For more information, see Managing Tasks.

Also, as an inSync Cloud Administrator, you can view data restore details available through a report. For more information about the generated report, see Salesforce Backup and Restore Report.

Where to go from here

Did this answer your question?