Chat now with support
Chat with Support

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

Roadmap for installing DocRetriever for SharePoint

Before beginning, always verify that the machines in your configuration meet current System requirements.

If upgrading from a previous version of DocRetriever, before installing, see the topic Guidelines for upgrading DocRetriever for SharePoint.

•
If using DocRetriever for Replay 4, you must first uninstall it before installing DocRetriever version 5.x or 6.x.
•
If using DocRetriever version 5.1x or 5.2x, you must either uninstall and then upgrade to version 6.x, or you can perform a two-step upgrade (first to DocRetriever version 5.3x, and then immediately to version 6.x).
•
If using DocRetriever version 5.3x or higher, no uninstallation is required. Simply install over the old version.

This procedure assumes you already have an appropriately installed SharePoint front-end web server, appropriately configured with SQL Server.

Follow this roadmap to find the appropriate steps to install DocRetriever in your environment:

1.
Install and configure Rapid Recovery. If using DocRetriever in standard mode, you must first install and configure Rapid Recovery Core, and then protect your SharePoint web server in the Core.
◦
For information about installing or upgrading Rapid Recovery Core, see the Rapid Recovery Installation and Upgrade Guide.
◦
For information on setting up your Core, and adding your front-end web server as a protected machine using the Agent software, or using agentless protection for a VM, see the Rapid Recovery User Guide.
2.
Create and configure a DocRetriever Console user account. The DocRetriever Console software requires a Windows user account with the appropriate permissions applied. That user account must be configured in SQL Management Studio to be granted sysadmin permissions for SQL Server. For more information, see the topic Applying the Systems Administrator database role to Windows user accounts.
3.
Create and configure a DocRetriever Agent user account. The DocRetriever Agent software requires a Windows user account with the appropriate permissions applied. That user account must be added to each web application in SharePoint; and the account must be configured in SQL Management Studio to be granted sysadmin permissions for SQL Server. For more information about the tasks required to configure an agent user account, see Setting up Windows user accounts for use with DocRetriever .
4.
Install the DocRetriever Agent software. The DocRetriever Agent software must be installed on at least one SharePoint front-end web server.
5.
Install the DocRetriever Console. This is the component from which you can load, browse, and restore SharePoint data from a recovery point or other recovery source. You must install the console on a machine with compatible versions of SQL Server. Express, Standard, and Enterprise editions of Microsoft SQL Server are supported, with specific exceptions, as listed in System requirements.
* 
NOTE: Both the DocRetriever Agent and the DocRetriever Console use the DocRetriever Installation Wizard. For more information about installing DocRetriever, see Installing DocRetriever for SharePoint.
* 
NOTE: In one- or two-server configurations using the standard mode, Quest recommends that you install the DocRetriever Console on the machine containing your Rapid Recovery Core.
6.
Create the service database. DocRetriever requires a local SQL Server database instance to maintain indexing data and stored procedures to support DocRetriever functionality. The first time you open the DocRetriever Console, you are prompted to create this database using the DocRetriever Service Database Configuration Wizard. You can also access this from the DocRetriever Console by selecting Run Configuration Wizard from the Settings menu. For more information about installing the service database, see Creating a local service database for DocRetriever.
Related tasks 
Creating a local service database for DocRetriever
Related references 
Guidelines for upgrading DocRetriever for SharePoint
Setting up Windows user accounts for use with DocRetriever
Installing, uninstalling, and repairing DocRetriever for SharePoint
Configuring DocRetriever Console settings

Obtaining DocRetriever installation software

You can obtain installation software for DocRetriever from the Rapid Recovery License Portal. From the license portal, click Downloads. On the Downloads page, scroll down to the row labeled DocRetriever for SharePoint and click Download.

The resulting binary installation file is used to install both the DocRetriever Console and the DocRetriever Agent software.

For more information about the license portal, see the Rapid Recovery License Portal User Guide. You can find Quest technical product documentation at https://support.quest.com/rapid-recovery/technical-documents.

Guidelines for upgrading DocRetriever for SharePoint

Guidelines for upgrading DocRetriever for SharePoint

If upgrading from a previous version of DocRetriever, you may need to take different actions in your environment, based on the version you have installed. Note the following guidelines:

•
If using DocRetriever for Replay 4, you must first uninstall it before installing DocRetriever version 5.x or 6.x.
•
If using DocRetriever version 5.1x or 5.2x, you must either uninstall and then upgrade to version 6.x, or you can perform a two-step upgrade (first to DocRetriever version 5.3x, and then immediately to version 6.x).
•
If using DocRetriever version 5.3x or higher, no uninstallation is required. Simply install over the old version.

Setting up Windows user accounts for use with DocRetriever

Creating a user account on a Windows Active Directory domain
Creating a local Agent user account
Adding a Windows user account to the local administrator group
Adding a Windows user account to a SharePoint farm administrator group
Adding a Windows user account to the SharePoint site collection administrators
Applying the Systems Administrator database role to Windows user accounts
Identifying SharePoint databases from SharePoint Central Administration

The Windows user accounts (or service accounts) used for both components of DocRetriever require specific roles and permissions. Each component must also have prerequisite software installed.

For each component, you can configure and use an existing Windows user account, or you can create an account with the appropriate roles and permissions.

DocRetriever Console

A supported version of SQL Server must already be installed on a machine before you can install the DocRetriever Console software on that machine.

The Windows user account that uses the DocRetriever Console must have the systems administrator (sysadmin) database role assigned to it in SQL Server. This is the only special role required by this component.

For practical purposes, especially if you want to use the DocRetriever Console from more than one machine, it is easier to use a domain user on the Windows Active Directory domain. For example, create a domain user named DocRetriever Console and apply the sysadmin role to this user. If you opt to configure a local user account, you must assign the same database role to the Windows user account for each machine with the DocRetriever Console installed.

DocRetriever Agent

A supported version of SharePoint must already be installed on a machine before you can install the DocRetriever Agent software on that machine.

DocRetriever Agent runs as a Windows service. The Windows user account that uses DocRetriever Agent must be a member of the Local Administrators group, a SharePoint farm Administrator, and a site collection administrator for each Web application in the farm. Additionally, the Windows user account must have the systems administrator (sysadmin) database role in SQL Server.

You must configure a designated Windows user account with these attributes on each SharePoint front-end web server that you want to use to restore SharePoint data.

For practical purposes, especially if you want to restore data from more than one web server, it is easier to create or designate a domain user on the Active Directory domain with these privileges. For example, create a user account called DRAgent, and then apply the appropriate Windows, SharePoint, and SQL Server membership, privileges, and database roles to that user.

* 
NOTE: The Windows service account can use any allowed account name, as long as you apply the appropriate permissions. If you opt to configure a local user account, you must repeat all steps in this process for a user on each web server.
•
Designate a Windows user account to be used for the DocRetriever Agent service. Quest recommends using a domain user in a Windows Active Directory domain. To create a domain account, see Creating a user account on a Windows Active Directory domain. To create a local user account, see Creating a local Agent user account.
•
Add the designated user account to the Windows OS local administrator's group. For more information, see Adding a Windows user account to the local administrator group.
•
Add the designated user account to a SharePoint Farm Administrator group. For more information about adding a user to a SharePoint Farm Administrator group using SharePoint central administration, see Adding a Windows user account to a SharePoint farm administrator group.
•
Add the designated user account as a SharePoint Site Collection Administrator, For more information about adding a user as a SharePoint site collection administrator using SharePoint central administration, see Adding a Windows user account to the SharePoint site collection administrators.
•
Provide the appropriate database permissions for the designated user. For more information about applying database roles to SQL server users, see Applying the Systems Administrator database role to Windows user accounts.
Related tasks 
Creating a local Agent user account
Creating a user account on a Windows Active Directory domain
Adding a Windows user account to the local administrator group
Related references 
Adding a Windows user account to a SharePoint farm administrator group
Adding a Windows user account to the SharePoint site collection administrators
Applying the Systems Administrator database role to Windows user accounts
Related Documents