INTRODUCTION

DocRetriever for SharePoint Installation Guide

This Installation Guide contains all the information you need to install DocRetriever for SharePoint.

Appassure recommends that you read through this guide and familiarize yourself with the contents. If you are experiencing problems with DocRetriever, consult this guide before you contact Customer Support.

Please follow the steps listed below to successfully perform a new installation of DocRetriever for SharePoint. This guide should be used for new installations only. Please contact support for instructions on upgrading from previous versions.

Download Installation Kit

Download the latest release of DocRetriever for SharePoint, www.appassure.com. You can get the installation from the Appassure download site. The product located on the download site is a trial version. If you are a customer, please contact sales for a customer key.

INSTALLING DOCRETRIEVER FOR SHAREPOINT

What is DocRetriever?

DocRetriever is a SharePoint recovery and migration tool offering administrators the ability to restore SharePoint object at the item-level eliminating the need to rely on SQL Server or other backups to restore SharePoint content. Delivering full-fidelity SharePoint object recovery from the SharePoint backups, offline SharePoint databases or their SQL backups, DocRetriever delivers comprehensive object-through-farm level protection for organizations that depend on SharePoint for their mission-critical business.

System Requirements

The following requirements are recommended to achieve the best performance from DocRetriever:

1. Hardware:
   • CPU – core 2 Duo 1GHz or faster
   • RAM – 2 GB or more
   • Disk Space – 100 MB (for product only, allow space for the database files you will use in restore.)
   • Network Card
2. Operating Systems Requirements:
   • Microsoft Windows 2008 R2 x64 and x86
   • Microsoft Windows 7 x64 and x86
   • Microsoft Windows 2008 x64 and x86
   • Microsoft Windows Vista x64 and x86
   • Microsoft Windows 2003 R2 SP2 x64 and x86
   • Microsoft Windows 2003 SP2 x64 and x86
   • Microsoft Windows XP SP2 x64 and x86

   NOTE:
   DocRetriever Agent has to be installed on the SharePoint Front-end Web server of the Farm. The operating system requirements for the agent are therefore constrained by Operating System versions supported by SharePoint.

3. Software Requirements:
   • Net Framework 3.5 SP1
   • Console – Locally Installed instance of the Microsoft SQL Server
     • 2005 SP2 (Standard, Enterprise, Express with Advanced Services)
     • 2008 SP1 (Standard, Enterprise, Express with Advanced Services)
     • 2008 R2 (Standard, Enterprise, Express with Advanced Services)
   • Agent –Locally installed SharePoint
     • Windows SharePoint Services 3.0
     • 2007 Web-Front-end
     • 2010 Web-Front-end

   NOTES:

   1) When using SQL Express, none of the SharePoint databases in the database set chosen as the recovery source can exceed 4GB in size. SQL Express only supports operating with database sizes up to 4GB.

   2) Windows Internal Database is NOT supported for installation with DocRetriever Console.

   3) DocRetriever´s “Content Search” feature relies on SQL’s “Full-text index search” service. When using SQL Express, the SQL Express with Advanced Services has to be installed for the “Content Search” feature in DocRetriever to work.

4. Network Requirements
   • The communication between DocRetriever Console and agents is done via TCP port 2525. Make sure this port is open on all the agents and is reachable from the host where Console is installed.
5. Security Requirements
   • DocRetriever Agent Service Account
     • Member of the Local Administrators group
     • Farm Administrator
     • Site Collection Administrator for each Web Application in the Farm
     • SysAdmin role for the SQL Server supporting the Farm
   • DocRetriever Console Account
     • SysAdmin role for the local instance of SQL Server where the DocRetriever Console is installed if using Windows Authentication mode to connect the DocRetriever Console to the local SQL instance

Supported Items

1. SharePoint versions supported:
   • Windows SharePoint Services 3.0
   • Microsoft Office SharePoint Server 2007
   • Microsoft Office SharePoint Server 2010
2. Offline SharePoint database versions supported by DocRetriever:
   • SQL Server 2005 SharePoint databases if DocRetriever console is installed with SQL 2005
   • SQL Server 2008 AND 2005 SharePoint databases if DocRetriever console is installed with SQL 2008
   • SQL Server 2008 R2, SQL Server 2008 AND 2005 SharePoint databases if DocRetriever console is installed with SQL 2008 R2
3. Offline recovery sources supported:
   • Appassure Replay Recovery Points if DocRetriever is installed on the Replay Server
     • Content database
     • Farm – Configuration database and all Content databases for the Farm have to be available
     • SharePoint Backup (Farm or Content database)
     • SQL Backup 2005 if DocRetriever console is installed with SQL 2005 (Farm or Content database)
     • SQL Backup 2005 or 2008 if DocRetriever console is installed with SQL 2008 (Farm or Content database)
     • SQL Backup 2005, 2008 or 2008 R2 if DocRetriever console is installed with SQL 2008 R2 (Farm or Content database)
   • Local disk on the machine where DocRetriever is installed
     • Content database
     • Farm – Configuration database and all Content databases for the Farm have to be available
     • SharePoint Backup (Farm or Content database)
     • SQL Backup 2005 if DocRetriever console is installed with SQL 2005 (Farm or Content database)
     • SQL Backup 2005 or 2008 if DocRetriever console is installed with SQL 2008 (Farm or Content database)
     • SQL Backup 2005, 2008 or 2008 R2 if DocRetriever console is installed with SQL 2008 R2 (Farm or Content database)

Installing DocRetriever for SharePoint

Overview

The installation process consists of deploying DocRetriever agents to Front-end Web servers of each Farm where content has to be recovered and then installing the DocRetriever console on the machine to be used to browse SharePoint offline databases.

The same installation binary is used to install agents and consoles.

Agent install

Set up the account to be used by the agent.

DocRetriever agent is designed as a windows service. In order for DocRetriever to operate correctly the agent’s service account should meet the following requirements:

• Member of the Local Administrators group
• Farm Administrator
• Site Collection Administrator for each Web Application in the Farm
• SysAdmin role for the SQL Server supporting the Farm

This guide will provide a brief walkthrough for setting up the DocRetriever service account.

1. Create a local or domain user named DRAgent
2. On the Web Front-end where you plan to install DocRetriever service add this account to the Local Administrators group
3. Open the SharePoint Central Administration for the Farm and add the account created in step 1 to the Farm Administrator’s group ( See Figures 1 through 4)


Figure 1


Figure 2


Figure 3


Figure 4

4. Next in the Central Administration for each Web Application add the account created in step1 to the Site Collection Administrators ( see Figures 5 and 6)


Figure 5


Figure 6

5. Launch the SQL Server Management Studio and connect to the SQL server supporting the Farm
6. In the left-hand tree navigate to Security -> Logins and make sure you see the account created in step 1 in the list of accounts. If you do not see the DRAgent account as shown in the figure below, add the account. Select the account, right-click and select Properties ( Figure 7)


Figure 7

7. In the Login Properties page navigate to the Server Roles on the left, check “sysadmin” role on the right-hand side and apply the changes. ( Figure 8)


Figure 8

The account configuration for the DocRetriever Agent service has been completed.

1. Download the DocRetriever installation package to the local disk of the Web Front-end Server for this Farm and launch it. The file is a self-extracting zip archive; there is no need to extract files manually prior to running the executable. The following screen should come up:

   
   Figure 9

2. After clicking Setup the installation will be unpacked and the following installation screen will be presented (Figure 10). Click Install DocRetriever Agent

   
   Figure 10

   NOTE: The installer will verify the presence and status of the SharePoint Front-end server on the local computer. If there is no SharePoint Front-end on the machine where installer is running, the install will show a message and exit.

   
   Figure 11

3. At the Welcome screen, click the Next button.

   
   Figure 12

4. Click the I accept the terms in the license agreement radio button. If you do not, you will not be able to proceed with the install. Once you have selected the correct button, click Next.

   
   Figure 13

5. Choose whether you would like to install for the current user or of anyone who logs on to this machine. It is strongly recommended that you choose Anyone for the Agent install. Choose Anyone and click Next.

   
   Figure 14

6. You can accept the default installation location for DocRetriever for SharePoint, or choose a different location. We suggest you accept the default location.

   
   Figure 15

7. Choose the account name and enter the password for the DR Service logon. This account should be granted a Log on as a service right which will happen automatically when the service is first started. Click Next. The account information you have entered will be verified and the next screen will be presented. If the account information you entered does not pass the verification you will have the opportunity to correct this.

   
   Figure 16

8. Click Finish once the install has successfully completed.

   
   Figure 17

9. After the installation has been completed, verify that the DRAgentService is installed and started using the local services management console as shown in the Figure 18 below. If for some reason the DRAgentService is not started, start the service manually.

   
   Figure 18

The DocRetriever agent service installation procedure is now completed. Please repeat this procedure for at least one Web Front-end for each farm where you plan to use DocRetriever.

Console install

Next step is installing DocRetriever restore console on the workstation where you will be accessing the restore sources. The restore sources can be any of the following: SharePoint content database, a collection of SharePoint Configuration and Content databases representing a farm, SharePoint Backup, SQL Backup containing SharePoint Databases.

DocRetriever console requires a local instance of SQL to operate, please refer to the requirements section of this document to see which SQL versions are supported for the DocRetriever Console.

1. Download the DocRetriever installation package to the local disk of the workstation where you plan to install the DocRetriever restore console and launch it. The file is a self-extracting zip archive; there is no need to extract files manually prior to running the executable. The following screen should come up:

   
   Figure 19

2. Click Setup, the archive will unpack and present the following splash screen:

   
   Figure 20

3. Click Install DocRetriever Console. Installer will verify that a supported version of SQL server is installed locally. If a supported version of SQL server is not found, the installer will present the following message:

   
   Figure 21

   NOTE:
   You will not be able to proceed with the install until a supported version of the SQL Server is installed on the machine.

4. At the Welcome screen, click the Next button.

   
   Figure 22

   Click the I accept the terms in the license agreement radio button. If you do not, you will not be able to proceed with the install. Once you have selected the correct button, click Next.

   
   Figure 23

5. Choose whether you would like to install for the current user or of anyone who logs on to this machine. It is strongly recommended that you choose Anyone for the Agent install. Choose Anyone and click Next.


Figure 24

6. You can accept the default installation location for DocRetriever for SharePoint, or choose a different location. We suggest you accept the default location.


Figure 25

7. Click Install to begin the installation. The installation may take several minutes.


Figure 26

8. Click Finish once the install has successfully completed.


Figure 27

CONFIGURING DOCRETRIEVER FOR SHAREPOINT FOR THE FIRST TIME

Getting Started

DocRetriever for SharePoint uses a local instance of SQL server to perform object-level restores directly from a SharePoint backup or database file. When you start the DocRetriever Console for the first time, a one-time configuration procedure will be performed. You would not need to repeat these steps once the initial configuration has been run.

The account used to run the DocRetriever Console should have a “sysadmin” rights for the local SQL server instance that will be used with DocRetriever Console. Launch the DocRetriever Console by clicking the DocRetriever icon on your desktop

Figure 28

The following screen will be presented:

1. Click Next to begin.


Figure 29

2. Select the SQL server instance to be used for the service database.

   NOTE: The default local instance is recommended, however you can choose any supported instance. Windows Internal Database is not supported.

   
   Figure 30

3. Select the authentication type to be used to connect to the local SQL server.

NOTE:

• For Windows Authentication, account running the Console should have SysAdmin role for the local instance of SQL Server chosen in previous step.

• For SQL authentication, SQL account selected should have SysAdmin role for the local instance of SQL Server chosen in previous step.


Figure 31

4. Enter Credentials and click Next. The account credentials and necessary rights will be verified. If account credentials are incorrect or the selected account does not have enough SQL server rights, a message indicating what is wrong will be presented and user will be given the opportunity to correct the input. Click Next again.


Figure 32

5. DocRetriever will create and maintain its own small “service database” on the local instance of SQL chosen in step 2 of this configuration wizard. Optionally you can select the location of this database on disk here. We suggest you accept the default and click Next


Figure 33

6. Click Finish and DocRetriever will be launched.


Figure 34

APPLYING THE LICENSE KEY

When the DocRetriever Console is installed for the first time, it automatically generates a 14-day trial license.

The following features are UNAVAILABLE in the TRIAL mode:

1. Restoring of objects
2. Content searching and index management
3. Opening and saving of SharePoint Documents.

In the TRIAL mode you are able to open all types of recovery sources and browse their content.

To switch from the TRIAL mode to FULLY LICENSED mode you will need a license key. If you did not obtain your license key, please contact AppAssure sales at http://www.appassure.com/.

Once you have obtained the license key, open the DocRetriever Console and in the menu choose Help ->About DocRetriever for SharePoint. You will be presented with the following screen:

Figure 35

Click the License button and in the next dialog click Import:

Figure 36

Browse to the license key file that has been supplied. The supplied license file should have the “.lic” extension Click the file, then click Open. The license will be verified and if it is valid, the license details will be presented:

Figure 37

Click OK and then close the license dialog.

RESTORE PROCESS EXAMPLE

You are now ready to use DocRetriever.
To start off, go to File →Open menu or use Ctrl-O shortcut:

Figure 38

The Recovery source dialog will be shown:

Figure 39

Choose the type of SharePoint recovery source you want to open using the Open drop-down list, use the browse buttons next to the parameters drop-down fields to select the location of the source on the local disk and click Ok:

Figure 40

DocRetriever will open the SharePoint recovery source you selected, enumerate its contents and present you with a tree-oriented view of the SharePoint Content from the recovery source:

Figure 41

Browse the tree on the left to see the contents of the containers on the right. Navigate to the object you need to restore:

Figure 42

Right-click the object and select Restore from the menu, the restore wizard dialog will be shown:

Figure 43

In the Server name enter the name of one of the SharePoint Front-end servers where you have already installed the DocRetriever Agent Service, click Next:

Figure 44

DocRetriever will list the online hierarchy of the SharePoint Farm that you are connected to. This is the Farm whose Front-end server you have selected in the previous dialog. Select the destination folder to restore your object to and click Next:

Figure 45

Review the restore options and click Next, the restore operation will be performed and the restore confirmation log will be shown in the Jobs List panel of the main DocRetriever screen:

Figure 46

Double-click the log entry in the Jobs List to see the detailed information about the restore operation performed:

Figure 47

Look at the SharePoint site you have just restored the object to:

Figure 48