Chat now with support
Chat with Support

Welcome, Quadrotech customers to Quest Support Portal click here for for frequently asked questions regarding servicing your supported assets.

Rapid Recovery 6.1.2 - DocRetriever for SharePoint User Guide

Introduction to DocRetriever for SharePoint Installing and configuring DocRetriever
System requirements Supported items Roadmap for installing DocRetriever for SharePoint Obtaining DocRetriever installation software Guidelines for upgrading DocRetriever for SharePoint Setting up Windows user accounts for use with DocRetriever Installing, uninstalling, and repairing DocRetriever for SharePoint Creating a local service database for DocRetriever Configuring DocRetriever Console settings Manually specifying the SharePoint database location
Recovering SharePoint data with DocRetriever Working with DocRetriever log files About us Glossary

Installing DocRetriever for SharePoint

Ensure the following prerequisites are met before installing.

•
Before beginning, always verify that the machines in your configuration meet current system requirements. For more information, see System requirements.
•
The machine on which you install the DocRetriever Agent software must also have SharePoint installed and correctly configured with the appropriate SQL Server databases.
•
The machine on which you install the DocRetriever Console software must also have SQL Server and SQL Server Management Studio installed and configured.
•
If using DocRetriever in standard mode, a Rapid Recovery Core must be installed on a properly sized Core server, and the appropriate SharePoint front-end web servers must be protected on the Core (using Rapid Recovery Agent, or agentlessly).

DocRetriever contains two components. You can install both the DocRetriever Agent and the DocRetriever Console by using a single installation wizard. Upon launching the wizard, you can select the specific components you want to install.

Optionally, if you have more than one front-end web server, you can install the DocRetriever Agent on each SharePoint server. For example, if you have a substantial amount of traffic on a primary front-end web server, you may wish to install the DocRetriever Agent on another machine to relieve pressure on the primary web server.

To restore SharePoint data, the SharePoint administrator must also install the DocRetriever Console on the machine to be used to browse SharePoint offline databases. This machine must have a supported version of SQL Server or SQL Server Express, as indicated in System requirements. If using SQL Server Express, SharePoint databases must be smaller than 4 GB. To use the content search function of DocRetriever, the SQL Server Express version installed must be Microsoft SQL Server Express with Advanced Services.

* 
NOTE: The steps documented here are for SharePoint 2013 and SharePoint 2010 Central Administration. For other versions of SharePoint, the user interface differs slightly.

Complete the steps in this procedure to install DocRetriever.

1.
Download the DocRetriever installer to the destination machine as indicated in Obtaining DocRetriever installation software, and then double-click the installer.
2.
If the Open File - Security Warning dialog box appears, click Run to launch the wizard.
The Setup dialog box appears.
3.
In the language field, select the appropriate language and then click OK.
The Rapid Recovery DocRetriever for SharePoint Installation Wizard appears.
4.
On the Welcome page of the wizard, click Next to begin the installation.
5.
On the License Agreement page, select I accept the terms in the license agreement, and then click Next.
The Installation Options page appears.
6.
On the Installation Options page, if the default destination is a suitable location, proceed to the next step. If you want to change the destination folder, perform the following substeps.
a.
Click the folder icon to change the destination folder in which the wizard installs the DocRetriever files.
b.
In the Browse to destination folder dialog box, specify a different location.
c.
Verify the new location, and then click OK.
7.
On the Installation Options page, select the components you want to install from the following options:

Option

Description

Agent

Installs the DocRetriever Agent software.

* 
NOTE: To install the Agent component, you must have a supported version of Microsoft SharePoint already installed.

Console

Installs the DocRetriever Console software.

* 
NOTE: To install the Console component, you must have a supported version of Microsoft SQL Server already installed.

If you want to install both DocRetriever components on the same machine (typical for a one-machine configuration using Standalone mode), select them both at this time. Otherwise, if you attempt to install them on the same computer using separate installations, you may be forced to remove the existing component and then reinstall them both.

8.
Click Install.
The Progress page appears. The system begins the installation process.
9.
If installing the DocRetriever Agent software on this machine, and if the Set Service Login dialog box appears, enter authentication information for the service database as indicated in the following substeps. Otherwise, skip to the next step in this procedure.
a.
In the Set Service Login dialog box, in the Username text field, enter the domain name and username of the Windows user account established for DocRetriever, in the format: domain\username.
* 
NOTE: This username must be a member of the local or domain administrator group, must be a member of the SharePoint Farm administrator group, and must be a member of the SharePoint site collection administrators. It must also be granted the sysadmin database role.

For example, type MyDomain\DRAgent.

b.
In the Password text field, set the appropriate password to access the service database.
c.
In the Confirm password text field, retype exactly the password you entered in the previous text field.
d.
Then click OK.

The Set Service Login dialog box closes, and the progress of the installation wizard is displayed. Then the Completed page of the installation wizard appears.

10.
After the installation process completes, click Finish.
The installation wizard closes.
11.
Repeat this procedure for any other machines on which you want to install DocRetriever.

For example:

◦
If you installed the DocRetriever Agent component only on a SharePoint server, you can install the Agent again on other SharePoint servers.
◦
You can install the DocRetriever Console component on a Core machine, or on a machine remote from the Core. If restoring from recovery points, that remote machine must also have the Local Mount Utility installed.

The first time you open the DocRetriever Console, you are prompted to create a service database. See Creating a local service database for DocRetriever.

Uninstalling DocRetriever for SharePoint

DocRetriever Agent or DocRetriever Console must be installed to perform this task.

Complete the steps in this procedure to uninstall DocRetriever. The same process is applicable for removing the DocRetriever Agent and the DocRetriever Console.

1.
On the machine from which you want to remove DocRetriever, open the Control Panel, and under Programs, click Uninstall a program.
2.
In the Programs and Features page, double-click Rapid Recovery DocRetriever for SharePoint.
* 
NOTE: Earlier versions of this software may be listed in the Control Panel as AppAssure DocRetriever for SharePoint, AppAssure Document Retriever, or Replay Document Retriever.
The Setup dialog box appears briefly, and then the Rapid Recovery DocRetriever for SharePoint Installation Wizard appears, showing the Repair/Remove page.
3.
Click Remove, and then click Next.
The Remove Options page appears.
4.
On the Remove Options page, select the components you want to remove from the following options:

Option

Description

Agent

Removes the DocRetriever Agent software.

Console

Removes the DocRetriever Console software.

Uninstall configuration settings and data

Removes all configuration settings and data.

If removing the Agent, this option removes log files.

If removing the Console, this option removes the DocRetriever Console desktop icon, and the locally installed service database supporting DocRetriever, which contains restore logs and application settings.

5.
Then click Uninstall.
The Progress page appears. The system begins the removal process. After the removal process completes, the Completed page appears.
6.
Click Finish.
The installation wizard closes.

Repairing a DocRetriever for SharePoint installation

DocRetriever Agent or DocRetriever Console must be installed to perform this task.

If files within the DocRetriever installation directory become corrupted at any point and the DocRetriever Console application or Agent service cannot start, you can use the Repair function of the installer program. This function rolls back any changes and rewrites all files needed to use DocRetriever

Complete the steps in this procedure to repair a DocRetriever installation.

1.
On the machine from which you want to repair DocRetriever, open the Control Panel, and under Programs, click Uninstall a program.
2.
In the Programs and Features page, double-click Rapid Recovery DocRetriever for SharePoint.
* 
NOTE: Earlier versions of this software may be listed in the Control Panel as AppAssure DocRetriever for SharePoint, AppAssure Document Retriever, or Replay Document Retriever.
The Setup dialog box appears briefly, and then the Rapid Recovery DocRetriever for SharePoint Installation Wizard appears, showing the Repair/Remove page.
3.
Click Repair, and then click Next.
The Repair Options page appears.
4.
On the Repair Options page, select the components you want to repair from the following options:

Option

Description

Agent

Repairs the DocRetriever Agent component

Console

Repairs the DocRetriever Console component

5.
Then click Repair.
The Progress page appears. The system begins the repair process.
6.
If, during the repair, the Set Service Login dialog box appears, enter authentication information for the service database as indicated in the following substeps. Otherwise, skip to the next step in this procedure.
a.
In the Set Service Login dialog box, in the Username text field, enter the domain name and username of the Windows user account established for DocRetriever, in the format: domain\username.
* 
NOTE: This username must be a member of the local or domain administrator group, must be a member of the SharePoint Farm administrator group, and must be a member of the SharePoint site collection administrators. It must also be granted the sysadmin database role.

For example, type MyDomain\DRAgent.

b.
In the Password text field, set the appropriate password to access the service database.
c.
In the Confirm password text field, retype exactly the password you entered in the previous text field.
d.
Then click OK.

The Set Service Login dialog box closes, and the progress of the installation wizard is displayed. Then the Completed page of the installation wizard appears.

7.
From the Completed page of the wizard, click Finish.
The repair wizard closes.

Creating a local service database for DocRetriever

After you install the DocRetriever Console, and before the first time you use the application, you are prompted to run the Service Database Configuration Wizard. This is a one-time setup step.

This wizard installs a local SQL Server database instance containing indexing data and stored procedures that support DocRetriever functionality.

* 
CAUTION: The account used to run the DocRetriever Console must have sysadmin privileges for the local SQL server instance used with the DocRetriever Console.
1.
To open the DocRetriever Service Database Configuration Wizard, do one of the following:
◦
Immediately after installing DocRetriever, launch the DocRetriever Console for the first time.
◦
Or, if you have already used the DocRetriever Console but want to change settings such as which service database is used, then from the DocRetriever Console, from the Settings menu, select Run Configuration Wizard.

The DocRetriever Service Database Configuration Wizard launches and opens the Welcome page.

2.
In the Welcome page of the wizard, read the introduction text and then click Next.
3.
In the SQL instance page of the wizard, from the database menu, select the appropriate SQL Server instance to use to create the local service database. Then click Next.
* 
NOTE: Quest recommends using the default local instance. However, you can choose any supported instance. Windows Internal Database is not supported.
4.
On the Authentication page of the wizard, select the authentication type to use to connect to the local SQL server, as described below. Then click Next.

Option

Description

Windows

If you select Windows authentication, your user account must have the sysadmin role for the selected server instance. The user name and password credentials for this option are provided automatically in the next step.

SQL Server

If you select SQL Server, your user account must have the sysadmin role for the SQL Server instance selected in the previous step. This option requires you to type the user name and password in the next step.

5.
On the Credentials page of the wizard, do the following:
◦
If using Windows authentication, click Verify.
◦
If using SQL authentication, enter your sysadmin credentials and then click Verify.
6.
On the Credentials page, when your SQL Server credentials are valid, click Next.
7.
In the Location page of the wizard, if you want to use the default location, click Next.
* 
NOTE: Quest recommends using the default installation local instance. However, you can specify a custom instance if required.

If you want to specify a custom instance, do the following:

a.
Select Use a custom location.

The location field enables.

b.
Click the ellipsis (…) next to the location field.
c.
In the Browse For Folder dialog box, navigate to the location where you want to install the local SQL Server database, and then click OK.
d.
Confirm the location in the location field, and then click Next.
8.
On the Finish page of the wizard, once the service database initializes, click Finish.

The DocRetriever Service Database Configuration Wizard closes, and shortly afterward, the DocRetriever Console appears.

Related Documents