Recover Data - SharePoint Archiver Agent

Table of Contents

Overview

The SharePoint Archiver Agent supports the following types of recoveries:

  • Non-Browse Recovery of archived documents from stubs accessible in the SharePoint User Interface.

    Note that stubs are not automatically refreshed in the SharePoint User Interface. A manual refresh is required to view stubs recovered to the Server if the Archive column is not visible.

    In the SharePoint User Interface, you can recover items only if Yes appears under the Archive column next to the item. If the Archive column is not visible after archiving, you may need to manually refresh the Browser, select View "All Documents" or "All Pictures". 

    If the Recall Archived Data menu is not visible in the SharePoint User Interface, you may need to manually refresh the Browser or it may be because multiple versions of SharePoint Servers co-exist on the same client. See Support when SharePoint 2003 and 2007 Servers Co-exist for more information.

    Unless you have Add/Update permissions to the document, you will not be able to recall archived documents.

    Library columns CommVault Stub and Archived created by SharePoint Archiver should not be changed by the user.

  • Browse and Recovery using the CommCell Console. Browse and recovery operations for SharePoint Archiver Agent can be performed from the client, agent, and backup set (i.e., archive set) levels in the CommCell Browser.
  • Browse and Recovery of archived documents directly from the archive media using the SharePoint User Interface.

    Optionally, the SharePoint Archiver Agent can be set up to use EBS Provider technology. This feature includes the following benefits:

    • Allows you to view and recover archived files directly from the media without reintroducing files to the SharePoint server
    • Archived items appear as any other file on SharePoint. Users see no change to the SharePoint user interface

    SharePoint Archiver Agent with EBS Provider Technology supports the following library types:

    • All document library content types
    • Base type
    • Enterprise Document Library
    • Pages Library
    • Publishing Library
    • Customized forms of the document library

Recoveries can be performed in-place or out-of-place, and in certain scenarios cross-application and cross-platform recoveries are also supported. (See Recovery Destinations below for comprehensive information.)

When there is a problem with the SharePoint Server or the operating system of the client computer, full system restores may be required. The SharePoint Archiver Agent relies upon the corresponding SharePoint iDataAgent to perform a full system restore of SharePoint Server data.

How to Set Up and Run a Recovery Operation

The following section provides the steps to set up and run a Recovery Operation:

  1. Enable the Archiving Rules for the subclient that contains the content you wish to archive. See Enable (Disable) Archiving Rules for step-by-step instructions and configure the Archiving Rules. In particular, decide if you want to create stubs in your environment. Even if the Archiving Rules are disabled, the Stub Rules will apply. See Configure Archiving Rules - SharePoint Archiver Agent for step-by-step instructions.
  2. Run an archive operation. See Start a Migration Archiving Operation for step-by-step instructions.
  3. Determine your Recovery Destinations.
  4. Recover one or more files with a Browse and Recovery or non-Browse Recovery operation.

Recover a File from SharePoint Server User Interface

There are several common methods for recovering an archived file. Users can provide a path to the archived files to be recovered from the CommCell Console, browse and recover archived files from the CommCell Console or, if the subclient is configured to create stubs, perform a non-browse recovery from the SharePoint Server User Interface. A non-browse recovery is any action that causes an open and read to be executed for the archived file, which automatically initiates a recovery operation. For example, you can select the Recall Archived Data menu and click on the data to view its contents.

If a subclient is configured with the Archive files only, do not create stub archiving rule option enabled, the archived files will be removed from the computer and a stub recovery is not possible. To recover files that were archived using this option, perform the procedure to Recover Data from the CommCell Console.

For step-by-step instructions, see Recover Data from SharePoint Server User Interface.

Recovery Options

The SharePoint Archiver Agent offers a variety of options for recovering selected documents, which are available in the SharePoint Archiver Agent's View All Versions or Recovery Options dialog box in the CommCell Console. These options and their descriptions are as follows:

  • Restore or Restore All Versions

    The Restore option will recover the current version. The Restore All Versions option will recover all versions of a multi-versioned document to a Version Enabled Library.

Advanced Recovery Options

Advanced recovery options and their descriptions are as follows:

  • Skip Errors and Continue

    For index-based agents, this advanced recovery option enables a recovery job to continue despite media errors. This option also provides an output file that lists the full path names of the files that failed to recover.

  • Start Job in Suspended State

    Specifies that this job will start in the Job Controller in a suspended state and cannot run until the job is manually resumed using the Resume option. This option can be used to add a level of manual control when a job is started. For example, you could schedule jobs to start in the suspended state and then choose which scheduled jobs complete by resuming the operation started in the suspended state.

  • Change Priority

    This option allows you to manually set a job priority. This is useful if you have jobs that are very important and must complete, and/or jobs that can be moved to a lower priority. For more information, see Job Priorities and Priority Precedence.

  • Recover from copy precedence

    This option allows you to select the copy from which you wish to recover. For more information on Copy Precedence, see Recovering Your Data From Copies.

  • Use Library

    Specifies the name of the library that will be used to perform the restore operation. Use this option when you wish to restore using a specific library. For example, if you know that the media containing the data you wish to restore is available in a specific library.

  • Restore deleted items

    Specifies that the recovery operation will include data that was secured during all archive operations, including deleted items.

  • Specify Time Range

    Specifies to recover data within a specified time zone and time threshold.

  • Alert

    Allows you to configure an alert using the Alert Wizard for the recovery operation.

Job Restarts

You can specify the maximum number of allowed restart attempts and the interval between restart attempts for all data retrieve jobs. For instructions, see Job Restartability - Advanced.

Recover a Document from SharePoint

In addition to browsing and recovering documents from the CommCell Console, the SharePoint Archiver Agents provide a method to allow end-users to selectively recover documents from SharePoint clients. If the subclient was configured to create stubs during migration archiving operations, users can initiate a recovery of a previously archived item. Refer to the online help for the steps involved in performing these type of recoveries.

If a subclient is configured with the Do not create stub archiving rule option enabled, the archived items will be removed from the computer and a stub recovery is not possible. To recover items that were archived using this option, see the procedure to Recover Data from the CommCell Console.

Recovery Destinations

By default, the SharePoint Archiver Agent recovers data to the client computer from which it originated; this is referred to as an in-place recovery. You can also recover the data to another Client computer in the CommCell. Keep in mind the following considerations when performing such recoveries:

  • The destination client must reside in the same CommCell as the client whose data was archived.
  • Note that when you perform recoveries other than in-place recoveries, the recovered data assumes the rights (i.e., permissions) of the parent directory.

The following section enumerates the types of recovery destinations that are supported by the SharePoint Archiver Agent. See Recover Options - Recover Destinations - Support for a list of Agents supporting each restore/recovery destination type.

In-Place Recovery

When performing a non-browse recovery of archived data from a stub, keep in mind that the data can only be recovered in-place to the same path/destination on the same client from which the data was archived.

Out-of-Place Recovery

Keep in mind that out-of-place recoveries can only be accomplished via a Browse and Recovery operation from the CommCell Console.

Cross-Application Recoveries

  • Support for restoring/recovering/retrieving data from one application version to another generally follows the same compatibility support provided by the associated third-party application vendor, unless otherwise noted.

  • Cross-application restores for library and list items to the same or higher SharePoint Server version are supported. 

For non-browse recovery of archived data from a stub on a lower to higher version of SharePoint Server, only out-of-place recoveries using the Same path/destination is supported.

Recovery Considerations for This Agent

Before performing any recovery procedure for these agents, review the following information.

  • If the item you want to recover was archived using the Do not create stub option or the stub was manually deleted after the archive, then use the procedure to Recover a Document from the CommCell Console to perform the recovery.
  • The default timeout value for recalling data is five minutes. If a timeout error occurs, the timeout value can be increased by setting the additional settings value of nRETRY_RECALL_TIMEOUT.

  • When SharePoint Archiver archives data, it creates a database file to track the stubs that will appear in the SharePoint user interface. Stubs contain information about the archived data for recovery purposes. This file, SPDAStubDatabase.db, resides in the Job_Results folder and is not backed up with the SharePoint Database iDataAgent. Therefore, you should back up this file with the Windows File System iDataAgent to ensure that stubs can be recovered.

  • For successful archiving and recovery, the user performing the operation must have write permissions to the SPDAStubDatabase.db file that resides in the Job_Results folder.  Otherwise, you may receive the error Failed to update database with new version number.

  • If the stub database file (SPDAStubDatabase.db) is corrupted or if the Job_Results folder has moved to a new location, this database file should be restored with the Windows File System iDataAgent to the current Job_Results folder if it is not already present. If the database file is not corrupted but has moved location, you need to:

    1. Copy the file to the new Job_Results folder location.
    2. Modify the Distributed File System (DFS) Replication configuration to update the stub database file location when the SharePoint Archiver is installed on multiple Web Front End Servers.
  • When both SharePoint 2003 and SharePoint 2007 servers co-exist on the same client with the SharePoint Agent, the subclient content needs to be properly configured.

    See Support when SharePoint 2003 and 2007 Servers Co-exist for more information.

  • Items recovered from a version-enabled library are recovered to a new version.
  • When restoring libraries with SharePoint Archiver, user-defined views are not restored. You should use SharePoint Document iDataAgent instead to restore views.
  • Configuring version criteria in the Archiving Rules is not supported when recovering items from non version-enabled libraries. See Configure Archiving Rules - SharePoint Archiver Agent for more information.
  • You will be unable to retrieve archive data if the software has been uninstalled or deconfigured.

Support When SharePoint 2003 and 2007 Servers Co-Exist

When both SharePoint 2003 and 2007 servers co-exist on the same client with the SharePoint Archiver Agent, the Recall Archived Data menu may not be visible in the SharePoint User Interface.

SharePoint Portal 2003 Server Data

If the Recall Archived Data menu is not visible for SharePoint Portal 2003 Server data:

  1. Run the following command on the command line from the <Software Installation Path>\Base installation directory:

    CVAddSharePointMenu -c
  2. Restart Internet Information Services (IIS).*

SharePoint Server 2007 Data

If the Recall Archived Data menu is not visible for SharePoint 2007 Server data after upgrading to SharePoint Server 2007:

  1. From the CommCell Browser, browse any subclient content (Click Browse under the subclient Content tab.
  2. A message "SharePoint was upgraded from 2003 to 2007" will be displayed.
  3. Restart Internet Information Services (IIS).*

*Typically, the iisreset command is used to restart IIS.

Related Reports

Recovery or Retrieve Job Summary Report

The Recovery/Retrieve Job Summary Report provides a list of recovery or retrieve operations for a specified time period.

Stub Recall Job Summary Report

The Stub Recall Job Summary Report provides a list of stub recall operations for a specified time period.