Restoring Salesforce Files at the Object-level


You can restore Files from Salesforce, such as Attachments, Documents, and ContentVersions, at the object-level.

Before You Begin

  • Verify that the Salesforce user who performs the restores has the required permissions.

  • In Salesforce, create a destination Sandbox that contains the same metadata as your source organization. The Commvault software does not restore metadata as part of a Sandbox restore.

    For information about creating sandboxes, go to Create a Sandbox on the Salesforce help site.

  • Add an app for the destination organization.

  • Review the objects that are not supported for restores.

  • Verify that you have enough free space (it must be at least the size of the data that you want to restore) for the data and file storage space on your destination Salesforce environment.

  • Verify that the profile, users (communityNickName), and RecordType are the same on the destination and the source.

  • Verify that the objects exist in the destination organization.

  • If you want to mask sensitive data during the restore, configure data-masking policies.


  1. From the navigation pane, go to Protect > Salesforce.

    The Salesforce page appears.

  2. For the organization that contains the data that you want to restore, click the action button , and then click Restore.

    The Select restore type page appears.

  3. Select Object level restore.

    The Backup content page appears.

    Here you can download up to 1GB of information about the objects in CSV format. Select one or more objects, and then select Download.

  4. In the upper-left area of the page, under Files, select the file objects, such as Attachments, Documents, and ContentVersions, that you want to restore.

  5. Click Restore.

    The Salesforce restore options dialog box appears.

  6. Under Destination details, from the Destination organization list, select the Salesforce destination.

  7. Under Options, set the restore options:

    • To include parent objects in the restore, from the Parent objects to restore list, select All parents.

      Important: Including parent objects has the following effects:

      • Data integrity is maintained. If parent objects are included and some parents do not exist or some parents have incorrect values, the restore still completes.

      • When objects such as User objects are updated, end users receive notifications, which might not be desirable.

    • To include child objects in the restore, from the Child objects to restore list, select the child objects.

    • To exclude some child objects, select the Exclude children check box, and then in the Children to exclude box, select the child objects that you want to exclude.

    • In the Field mappings dropdown, specify how field mapping should be prioritized in case of out-of-place restores.

      A field map is generated for all organizations during a backup job. This map indicates a link between each object and a corresponding field that can be used as a mapping field, i.e., has the same value across sandbox and production organizations. Field mappings determine how data from a source corresponds to data in a destination.

      This map is generated during the backup process, and eligible mapping fields are prioritized based on following criteria:

      • Field, which is an external Id, is unique and required

      • Field, which is unique and required

      If no fields for the object matches this criterion, we may create a new field called CvExternalId. This generated map can be modified as needed from the restore screen with the pencil icon. The automatically generated field maps can be edited by clicking on the pencil icon for the corresponding source or destination organization. New fields can be added and existing fields modified. Any changes made this way are retained for subsequent jobs to or from the destination or source organization.

      The source organization record ID is stored in the CvExternalId field as part of a restore job. Later, in subsequent jobs, this field is used to map the records with the source organization's ID. If a match is found, the record is updated. Otherwise, a new record is inserted. This is similar to an incremental restore job.

      CvPermissionSet is used to create a new permission set for newly created CvExternalId fields on the restored objects. This permission set is then assigned to the logged in user of the destination organization, allowing that user account to access or insert values in this field later during the restore job.

      The API name associated with CvExternalId is CvExternalId__c

      Choose one of four options:

      • Skip mapping fields: Do not use a map and fallback to the system default fields for mapping. (Examples include ID or default cloud-mapping fields.)

      • Use CvExternalId to map all objects: CvExternalId is a custom field created by the Commvault restore process. With this option selected, the Salesforce metadata API is used to create the custom field.

        If Salesforce restricts creating new custom fields on certain objects, it may return a FIELD_INTEGRITY_EXCEPTION error.

      • Use destination field mappings: The field map of the destination organization used for restore jobs.

      • Use source field mappings: The field map of source organization is used for restore jobs.

    • To disable the Salesforce triggers, flows, workflows, and rules only for the restore, select the Disable triggers and rules check box.

      After the restore completes, the flows, workflows, and triggers are automatically enabled.

    • To restore empty and null values for a backup, select the Restore empty fields check box.

    • To restore only changed and deleted records for a full object restore, select the Restore only changed and deleted records check box.

    • To associate all restored records in the destination org with the logged-in user as the record owner (if a record owner does not exist in the destination org), select the Associate ownership to the logged-in user check box.

    • To apply data masking, select the Apply masking on destination check box, and then from the Select data masking policy list, select the data-masking policy.

Note: You can apply data masking when you run a cross-instance restore and data masking policies are defined.

Click Submit.