DocAve® 4.5 User Guide Includes All Modules The most current User Guide can be found at: http://www.avepoint.com/assets/sharepoint_user_guides/DocAve4.5-User-Guide.pdf Copyright © 2001-2008 AvePoint, Inc. All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without the prior written consent of AvePoint, 3 Second Street, Jersey City, NJ 07311 Trademarks AvePoint, DocAve and the AvePoint logo are trademarks of AvePoint, Inc. Microsoft, MS-DOS, Internet Explorer, SharePoint Portal Server 2003, Windows SharePoint Services, Windows SQL server, and Windows are either registered trademarks or trademarks of Microsoft Corporation. Adobe Acrobat and Acrobat Reader are trademarks of Adobe Systems, Inc. All other trademarks are property of their respective owners. Changes The material in this document is for information only and is subject to change without notice. While reasonable efforts have been made in the preparation of this document to assure its accuracy, AvePoint makes no representation or warranty, expressed or implied, as to its completeness, accuracy, or suitability, and assumes no liability resulting from errors or omissions in this document or from the use of the information contained herein. AvePoint reserves the right to make changes in the product design without reservation and without notification to its users. AvePoint 3 Second Street Jersey City, NJ 07311 For Technical Support, visit http://www.avepoint.com/support For Products Information, visit http://www.avepoint.com/products For Sales Contact Information, visit http://www.avepoint.com/about-us/contact-us/ © 2001-2008 AvePoint, Inc. All rights reserved. Page 2 Table of Contents 1. PREFACE ...................................................................................................................................................................12 2. INSTALLATION ..........................................................................................................................................................14 2.1 OVERVIEW OF INSTALLATION ............................................................................................................................................ 14 2.2 SYSTEM REQUIREMENTS.................................................................................................................................................. 15 2.3 INSTALLATION LOCATION.................................................................................................................................................. 17 2.4 INSTALLATION STEPS ....................................................................................................................................................... 18 2.4.1 DocAve 4.5 Server Installation ........................................................................................................................... 18 2.4.2 Setup Instructions for Https access .................................................................................................................... 26 2.4.2.1 Enable Https in the DocAve server configuration .......................................................................................................... 26 2.4.2.2 Internet Explorer Setup .................................................................................................................................................. 27 2.4.3 DocAve 4.5 Client Installation ............................................................................................................................ 29 2.4.4 Verifying the DocAve 4.5 Installation ................................................................................................................. 32 2.4.5 Accessing DocAve 4.5......................................................................................................................................... 33 2.5 UNINSTALL INSTRUCTIONS ............................................................................................................................................... 34 2.5.1 DocAve Server / Media Server Un-installation ................................................................................................... 34 2.5.2 DocAve Client Un-installation ............................................................................................................................ 34 3. CONTROL PANEL ......................................................................................................................................................36 3.1 DATA MANAGEMENT ...................................................................................................................................................... 37 3.1.1 Data Manager ................................................................................................................................................... 37 3.1.1.1 Pruning ........................................................................................................................................................................... 37 3.1.1.2 Coalescing ...................................................................................................................................................................... 39 3.1.1.3 Retention ....................................................................................................................................................................... 39 3.1.2 Storage Manager ............................................................................................................................................... 39 3.1.2.1 Physical Drive ................................................................................................................................................................. 40 3.1.2.2 Logical Drive ................................................................................................................................................................... 42 3.1.3 Security Manager .............................................................................................................................................. 43 3.1.4 Data Exclusion ................................................................................................................................................... 44 3.2 CONTROL SERVICES ........................................................................................................................................................ 45 3.2.1 Server Monitor ................................................................................................................................................... 45 3.2.2 Agent Monitor ................................................................................................................................................... 46 3.2.2.1 Common Tab .................................................................................................................................................................. 46 3.2.2.2 Advanced Tab ................................................................................................................................................................. 47 3.2.3 Agent Groups ..................................................................................................................................................... 47 3.3 REPORTING................................................................................................................................................................... 48 3.3.1 Email Notification .............................................................................................................................................. 48 3.3.2 Log Manager ..................................................................................................................................................... 50 3.3.2.1 Log Level Settings ........................................................................................................................................................... 50 3.3.2.2 Log Data Download ........................................................................................................................................................ 50 © 2001-2008 AvePoint, Inc. All rights reserved. Page 3 3.3.2.3 Log Email Notification .................................................................................................................................................... 51 3.3.3 MOM Logging Settings ...................................................................................................................................... 51 3.3.3.1 Enable MOM setting from DocAve................................................................................................................................. 51 3.3.3.2 Viewing the logs from MOM .......................................................................................................................................... 51 3.3.4 SCOM Logging Settings...................................................................................................................................... 52 3.3.4.1 Enable SCOM setting from DocAve ................................................................................................................................ 52 3.3.4.2 Viewing the logs from SCOM ......................................................................................................................................... 53 3.4 SYSTEM........................................................................................................................................................................ 53 3.4.1 Account Manager .............................................................................................................................................. 53 3.4.1.1 User ................................................................................................................................................................................ 53 3.4.1.2 Group ............................................................................................................................................................................. 54 3.4.1.3 Login Modes................................................................................................................................................................... 54 3.4.1.4 Creating a New DocAve User or Group .......................................................................................................................... 55 3.4.1.5 Editing a DocAveUser ..................................................................................................................................................... 56 3.4.1.6 Adding a Domain User to a Group ................................................................................................................................. 57 3.4.1.7 Editing a Group .............................................................................................................................................................. 58 3.4.1.8 Deleting a User or Group ............................................................................................................................................... 58 3.4.1.9 Permissions .................................................................................................................................................................... 59 3.4.1.10 Changing User Passwords ............................................................................................................................................ 60 3.4.2 Job Pruning Setting ............................................................................................................................................ 60 3.4.3 DocAve System Recovery ................................................................................................................................... 61 3.4.3.1 System Backup ............................................................................................................................................................... 61 3.4.3.2 Backup Job Report ......................................................................................................................................................... 63 3.4.3.3 System Restore ............................................................................................................................................................... 63 3.4.3.4 Restore Job Report ......................................................................................................................................................... 64 3.5 LICENSE MANAGEMENT .................................................................................................................................................. 64 3.5.1 License Manager................................................................................................................................................ 64 3.5.1.1 Viewing Current License Information ............................................................................................................................. 65 3.5.1.2 Previewing New Licenses ............................................................................................................................................... 65 3.5.1.3 Applying a License .......................................................................................................................................................... 65 3.5.2 Patch Manager .................................................................................................................................................. 65 3.5.2.1 How to Update the Server or Client ............................................................................................................................... 66 3.5.2.2 Automatic Update Setting .............................................................................................................................................. 66 3.5.3 Patch Report ...................................................................................................................................................... 67 4. DATA PROTECTION ...................................................................................................................................................68 4.1 BACKUP ....................................................................................................................................................................... 68 4.1.1 Common Setup Configurations .......................................................................................................................... 69 4.1.1.1 Common Backup Option Profiles ................................................................................................................................... 69 4.1.2 Item Level .......................................................................................................................................................... 71 4.1.2.1 Creating an Item Level Backup Plan ............................................................................................................................... 71 4.1.2.2 Setting up the Scheduling Carousel................................................................................................................................ 73 4.1.2.3 Item Level Restore Controller......................................................................................................................................... 75 © 2001-2008 AvePoint, Inc. All rights reserved. Page 4 4.1.2.4 Restore to File System .................................................................................................................................................... 80 4.1.2.5 Helpful tips on Item Level Backup .................................................................................................................................. 83 4.1.3 Site Level Backup and Restore ........................................................................................................................... 83 4.1.3.1 Creating a Site-level Backup Plan ................................................................................................................................... 84 4.1.3.2 Setting up the Scheduling Carousel................................................................................................................................ 86 4.1.3.3 Site-level Restore Controller .......................................................................................................................................... 88 4.1.3.4 Helpful Tips on Site-level Backup ................................................................................................................................... 91 4.1.3.5 Helpful Tips on an Out of Place Site-level Restore ......................................................................................................... 91 4.1.4 Subsite Level Backup and Restore ...................................................................................................................... 91 4.1.4.1 Creating a Subsite-level Backup Plan ............................................................................................................................. 92 4.1.4.2 Setting up the Scheduling Carousel................................................................................................................................ 94 4.1.4.3 Subsite-level Restore Controller ..................................................................................................................................... 96 4.1.4.4 Helpful Tips on an Out of Place Subsite-level Restore .................................................................................................... 99 4.1.5 Advanced Tips in Restore and Backup ............................................................................................................... 99 4.1.5.1 How to Move a Site to a Subsite .................................................................................................................................... 99 4.1.5.2 Ensuring Metadata and Security on an Out of Place Restore ....................................................................................... 100 4.1.5.3 Making sure that the Site page is restored properly .................................................................................................... 101 4.1.5.4 Using the Restore Arrow in Item Level Restore ............................................................................................................ 102 4.1.5.5 Using the Subsite Tree in the Subsite Restore Controller ............................................................................................. 104 4.1.5.6 Running a Backup using the Command Line Prompt ................................................................................................... 105 4.1.5.7 Restoring an Area in SharePoint 2003 .......................................................................................................................... 106 4.1.5.8 Minimum Access Levels for Backup and Restore ......................................................................................................... 107 4.1.6 Currently Supported and Unsupported Elements for Backup .......................................................................... 108 4.2 PLATFORM LEVEL BACKUP ............................................................................................................................................. 110 4.2.1 Introduction ..................................................................................................................................................... 110 4.2.2 Installation ....................................................................................................................................................... 110 4.2.3 Backup Builder ................................................................................................................................................. 112 4.2.3.1 Setting up the Backup Builder section ......................................................................................................................... 112 4.2.3.2 Selecting Content on the Data Tree ............................................................................................................................. 115 4.2.3.3 Scheduling a Backup Job .............................................................................................................................................. 118 4.2.4 Restore Controller ............................................................................................................................................ 120 4.2.4.1 Choosing a Plan through the Job Browser ................................................................................................................... 121 4.2.4.2 Specifying the Type of Restore ..................................................................................................................................... 122 4.2.4.3 Out of Place Restore .................................................................................................................................................... 124 4.2.5 Currently Supported and Unsupported Elements for Platform Level Backup .................................................. 127 4.3 HIGH AVAILABILITY (SPDR) ........................................................................................................................................... 129 4.3.1 Introduction ..................................................................................................................................................... 129 4.3.2 Installation of the DocAve 4.5 High Availability module .................................................................................. 130 4.3.3 Preparation: Setting the temporary staging location ...................................................................................... 131 4.3.4 High Availability Backup Builder ...................................................................................................................... 133 4.3.4.1 General Settings ........................................................................................................................................................... 133 4.3.4.2 Choosing the Source Content ....................................................................................................................................... 133 © 2001-2008 AvePoint, Inc. All rights reserved. Page 5 4.3.4.3 Choosing the Sync Method .......................................................................................................................................... 134 4.3.4.4 Choosing the Stand-By SQL Server ............................................................................................................................... 135 4.3.4.5 Setting up the Scheduling Carousel.............................................................................................................................. 136 4.3.5 High Availability Restore Controller ................................................................................................................. 138 4.3.5.1 Bringing the Database Online ...................................................................................................................................... 138 4.3.5.2 Bringing the Database Offline ...................................................................................................................................... 139 4.3.6 Helpful Notes on High Availability ................................................................................................................... 139 4.3.6.1 Replicating SSO databases ........................................................................................................................................... 140 4.3.6.2 High Availability module and differing SQL versions .................................................................................................... 140 4.3.6.3 Setting up for High Availability Mirroring ..................................................................................................................... 140 4.3.6.4 Log Shipping Versus SQL Mirroring .............................................................................................................................. 140 4.3.7 Troubleshooting High Availability .................................................................................................................... 141 4.3.7.1 General Information ..................................................................................................................................................... 141 4.3.7.2 Failure in loading the nodes on the High Availability module ...................................................................................... 142 4.3.7.3 If there are errors in the DocAve Agent Event Viewer ................................................................................................. 142 4.3.7.4 Log Shipping ................................................................................................................................................................. 143 4.3.7.5 SQL Mirroring ............................................................................................................................................................... 143 4.3.7.6 Log shipping from a Platform Level Backup ................................................................................................................. 144 4.3.7.7 Dump / Load from Staging ........................................................................................................................................... 145 4.3.7.8 Bring Online Issues ....................................................................................................................................................... 146 4.3.8 Currently Supported and Unsupported Elements for High Availability ............................................................ 146 4.4 TRASHBIN FOR SPS2003 / WSS2.0 ............................................................................................................................... 150 4.4.1 Installation ....................................................................................................................................................... 150 4.4.1.1 Enable TrashBin on DocAve Client Agent ..................................................................................................................... 150 4.4.1.2 Install TrashBin on Content Database .......................................................................................................................... 151 4.4.1.3 Install TrashBin Web part ............................................................................................................................................. 152 4.4.2 Un-installation ................................................................................................................................................. 153 4.4.2.1 Uninstall the TrashBin Web part .................................................................................................................................. 153 4.4.2.2 Uninstall TrashBin on Content Database ...................................................................................................................... 154 4.4.3 TrashBin Configuration .................................................................................................................................... 155 4.4.3.1 Administrative Account ................................................................................................................................................ 155 4.4.3.2 Notification .................................................................................................................................................................. 156 4.4.4 TrashBin Administration .................................................................................................................................. 156 4.4.4.1 Pruning Rule ................................................................................................................................................................. 156 4.4.4.2 Scheduling .................................................................................................................................................................... 157 4.4.4.3 Pause TrashBin ............................................................................................................................................................. 158 4.4.4.4 Clear TrashBin .............................................................................................................................................................. 159 4.4.4.5 Multiple Content Database Manipulation .................................................................................................................... 160 4.4.4.6 TrashBin Web part on SharePoint Site ......................................................................................................................... 160 4.4.4.7 TrashBin Options on SharePoint Site ............................................................................................................................ 161 5. ADMINISTRATION .................................................................................................................................................. 162 © 2001-2008 AvePoint, Inc. All rights reserved. Page 6 5.1 DISCOVERY ................................................................................................................................................................. 162 5.1.1 Farm Topology ................................................................................................................................................. 162 5.1.2 Site Structure ................................................................................................................................................... 163 5.1.3 Search .............................................................................................................................................................. 163 5.2 REPLICATOR ................................................................................................................................................................ 164 5.2.1 Replicator Installation ...................................................................................................................................... 165 5.2.2 Layout, Features, and Options ......................................................................................................................... 165 5.2.3 General Settings .............................................................................................................................................. 165 5.2.3.1 Basic Setting ................................................................................................................................................................. 166 5.2.3.2 Advanced Setting ......................................................................................................................................................... 169 5.2.3.3 Schedule....................................................................................................................................................................... 171 5.2.3.4 Two Way Replication .................................................................................................................................................... 173 5.2.3.5 Source .......................................................................................................................................................................... 177 5.2.3.6 Destination ................................................................................................................................................................... 178 5.2.4.7 Configuration File ......................................................................................................................................................... 179 5.2.4 Single Farm and Cross Farm Move .................................................................................................................. 179 5.2.4.1 Single Farm................................................................................................................................................................... 179 5.2.4.2 Cross Farm.................................................................................................................................................................... 181 5.2.4.3 Single Farm to Multiple Farms ..................................................................................................................................... 181 5.2.5 Replicator Un-installation ................................................................................................................................ 181 5.2.6 Currently Supported and Unsupported Content For Replication...................................................................... 182 5.2.6.1 Supported and Unsupported Elements for Two-Way Replication (Merge Version) ..................................................... 184 5.3 CONTENT MANAGER .................................................................................................................................................... 185 5.3.1 Content Manager Installation.......................................................................................................................... 185 5.3.2 Layout, Features, and Options ......................................................................................................................... 185 5.3.3 General Settings .............................................................................................................................................. 185 5.3.3.1 Basic settings ................................................................................................................................................................ 186 5.3.3.2 Source .......................................................................................................................................................................... 189 5.3.3.3 Content Manager Options............................................................................................................................................ 189 5.3.3.4 Destination ................................................................................................................................................................... 192 5.3.4 Single Farm and Cross Farm Move .................................................................................................................. 193 5.3.4.1 Single Farm................................................................................................................................................................... 193 5.3.4.2 Cross Farm.................................................................................................................................................................... 195 5.3.5 Content Manager Un-installation .................................................................................................................... 195 5.3.6 Currently Supported and Unsupported Content for Content Manager ............................................................ 195 5.4 SHAREPOINT ADMINISTRATOR ........................................................................................................................................ 197 5.4.1 Admin (tree mode) ........................................................................................................................................... 197 5.4.1.1 Agent Filter................................................................................................................................................................... 197 5.4.1.2 Batch Setting Instructions ............................................................................................................................................ 198 5.4.1.3 Central Administration ................................................................................................................................................. 199 5.4.1.4 Generating Reports ...................................................................................................................................................... 206 5.4.1.5 Security Center............................................................................................................................................................. 206 © 2001-2008 AvePoint, Inc. All rights reserved. Page 7 5.4.1.6 Solutions and Features ................................................................................................................................................. 209 5.4.2 Admin (search mode)....................................................................................................................................... 210 5.4.2.1 Setting the Search Scope .............................................................................................................................................. 210 5.4.2.2 Admin Search Criteria Page .......................................................................................................................................... 211 5.4.2.3 Security Search Criteria Page ....................................................................................................................................... 214 5.4.3 Activity History ................................................................................................................................................. 217 5.4.3.1 Enable Activity History ................................................................................................................................................. 218 5.4.3.2 Reports ......................................................................................................................................................................... 218 5.4.4 STSADM Interface ............................................................................................................................................ 221 5.4.5 Report Profile ................................................................................................................................................... 222 5.4.5.1 Farm Report ................................................................................................................................................................. 223 5.4.5.2 Web Application Report ............................................................................................................................................... 224 5.4.6 Currently Supported and Unsupported Functionality for Administration ........................................................ 225 5.5 EXTENSION ARCHIVER ................................................................................................................................................... 238 5.5.1 Installation ....................................................................................................................................................... 239 5.5.1.1 Enabling Extension Archiver on DocAve Client Agent Host .......................................................................................... 239 5.5.1.2 Configuring Agent Monitor for Extension Archiver ...................................................................................................... 239 5.5.1.3 Integration with SharePoint Search.............................................................................................................................. 240 5.5.2 Basic Setup for Rule Builder ............................................................................................................................. 241 5.5.3 Archiving at Different Levels ............................................................................................................................ 243 5.5.3.1 Archiving at the Document Level ................................................................................................................................. 243 5.5.3.2 Archiving Based on Document Version ........................................................................................................................ 244 5.5.3.3 Archiving Based on Attachment ................................................................................................................................... 246 5.5.3.4 Archiving at the Site Level ............................................................................................................................................ 246 5.5.3.5 Archiving at the Subsite Level ...................................................................................................................................... 248 5.5.3.6 Archiving at the List Level............................................................................................................................................. 249 5.5.3.7 Archiving at the Item Level........................................................................................................................................... 250 5.5.3.8 Archiving Based on the Item Version ........................................................................................................................... 251 5.5.4 The Restore Controller ..................................................................................................................................... 252 5.5.5 Archive Search Web Part ................................................................................................................................. 254 5.5.5.1 Installing the Web Part ................................................................................................................................................. 254 5.5.5.2 Using the Browse Web Part.......................................................................................................................................... 254 5.5.5.3 Using the Search Web Part........................................................................................................................................... 256 5.5.6 About Archived Documents ............................................................................................................................. 257 5.5.7 Uninstalling Extension Archiver ....................................................................................................................... 257 5.5.8 Supported Functionalities ................................................................................................................................ 258 5.5.8.1 Currently Supported and Unsupported Elements for 2003 Archiver ........................................................................... 258 5.5.8.2 Currently Supported and Unsupported Elements for 2007 Extension Archiver ........................................................... 259 5.6 CONTENT MANAGER FOR SP2003/WSS2.0 .................................................................................................................... 263 5.6.1 Single Farm Copy ............................................................................................................................................. 263 5.6.2 Cross Farm Copy .............................................................................................................................................. 264 5.6.3 Standby SQL Copy ............................................................................................................................................ 266 © 2001-2008 AvePoint, Inc. All rights reserved. Page 8 6. COMPLIANCE ......................................................................................................................................................... 267 6.1 COMPLIANCE MANAGER ............................................................................................................................................... 267 6.1.1 Rule Builder ...................................................................................................................................................... 267 6.1.1.1 Compliance Archiver .................................................................................................................................................... 267 6.1.1.2 Compliance Auditor ..................................................................................................................................................... 268 6.1.1.3 Content Browser .......................................................................................................................................................... 271 6.1.1.4 Setting up the Scheduling Carousel.............................................................................................................................. 273 6.1.2 Offline Download ............................................................................................................................................. 275 6.1.2.1 Set backup destination for offline download ............................................................................................................... 275 6.1.2.2 Run an offline download .............................................................................................................................................. 276 6.1.3 Offline Download Report ................................................................................................................................. 276 6.2 COMPLIANCE ARCHIVER ................................................................................................................................................ 277 6.2.1 Archive Browser ............................................................................................................................................... 277 6.2.2 Archive Search Mode ....................................................................................................................................... 279 6.2.2.1 Search Within Search Result: ....................................................................................................................................... 280 6.2.3 Activity History ................................................................................................................................................. 281 6.2.4 Offline Search Report ....................................................................................................................................... 282 6.2.5 Search Scope .................................................................................................................................................... 283 6.2.5.1 Search Setting .............................................................................................................................................................. 284 6.3 AUDITOR .................................................................................................................................................................... 285 6.3.1 Audit Report..................................................................................................................................................... 286 6.3.2 Auditor Pruning ............................................................................................................................................... 287 6.3.2.1 Auditor Pruning in MOSS 2007/WSS v3 ....................................................................................................................... 287 6.3.2.2 Auditor Pruning in SharePoint 2003/WSS v.2 ............................................................................................................... 289 6.3.2 Pruning Log ...................................................................................................................................................... 292 6.4 SP AUDITOR FOR SP2003/WSS2.0 ............................................................................................................................... 293 6.4.1 Installing and Uninstalling SP Auditor ............................................................................................................. 293 6.4.2 Auditor Rule Builder ......................................................................................................................................... 294 6.4.3 Audit Report..................................................................................................................................................... 295 6.4.4 Auditor Pruning ............................................................................................................................................... 295 6.4.4.1 Setting the Age Threshold ............................................................................................................................................ 296 6.4.4.2 Pruning Rule Selections ................................................................................................................................................ 296 6.4.4.3 Scheduling the Pruning Job .......................................................................................................................................... 296 6.4.4.4 Setting the Pruning Data Storage Location .................................................................................................................. 296 6.4.5 Pruning Log ...................................................................................................................................................... 298 7. MIGRATION ........................................................................................................................................................... 299 7.1 FILE SYSTEM MIGRATOR ................................................................................................................................................ 299 7.1.1 Installation ....................................................................................................................................................... 300 7.1.2 Un-installation ................................................................................................................................................. 300 7.1.3 Using File System Migration ............................................................................................................................ 300 7.1.4 Advanced Usage .............................................................................................................................................. 304 © 2001-2008 AvePoint, Inc. All rights reserved. Page 9 7.1.4.1 Security Mapping ......................................................................................................................................................... 304 7.1.4.2 Common Config ........................................................................................................................................................... 305 7.1.4.3 Filter Mode .................................................................................................................................................................. 307 7.1.4.4 Network Drive .............................................................................................................................................................. 308 7.1.5 Currently Supported and Unsupported Elements for File Migration ............................................................... 308 7.2 SHAREPOINT MIGRATOR LITE ......................................................................................................................................... 310 7.3 SHAREPOINT 2003 TO 2007 MIGRATOR ......................................................................................................................... 313 7.3.1 Installation ....................................................................................................................................................... 313 7.3.2 Un-installation ................................................................................................................................................. 313 7.3.3 Backup Migration ............................................................................................................................................ 314 7.3.3.1 Running SetFieldSchemaOM.exe for 2003 Item Level Backups ................................................................................... 314 7.3.3.2 Running a Backup Migration ........................................................................................................................................ 315 7.3.3.3 Migration Configurations ............................................................................................................................................. 317 7.3.3.4 Portal Listing and Portal Area Migration ...................................................................................................................... 330 7.3.3.5 Migrator User Scan Tools ............................................................................................................................................. 331 7.3.3.6 Currently Supported and Unsupported Elements for Backup Migration: .................................................................... 333 7.3.4 Live Migration .................................................................................................................................................. 334 7.3.4.1 Currently Supported and Unsupported Elements for Live Migration:.......................................................................... 336 7.4 EXCHANGE PUBLIC FOLDER MIGRATOR ............................................................................................................................ 339 7.4.1 Installation ....................................................................................................................................................... 339 7.4.2 Un-installation ................................................................................................................................................. 339 7.4.3 Using Exchange Public Folder Migrator ........................................................................................................... 340 7.4.3.1 Advanced Settings ........................................................................................................................................................ 342 7.4.3.2 Enabling Outlook Redirection ...................................................................................................................................... 343 7.4.4 Exchange Public Folder Mapping File .............................................................................................................. 343 7.4.4.1 Mapping File Contents ................................................................................................................................................. 343 7.4.4.2 Example Tasks .............................................................................................................................................................. 345 7.4.4 Currently Supported and Unsupported Elements for Public Folder Migration ................................................ 348 7.5 EROOM MIGRATOR ...................................................................................................................................................... 351 7.5.1 Installation ....................................................................................................................................................... 351 7.5.2 Un-installation ................................................................................................................................................. 352 7.5.3 Using eRoom Migrator .................................................................................................................................... 352 7.5.3.1 Normal Mode Migration .............................................................................................................................................. 353 7.5.3.2 Common Configuration ................................................................................................................................................ 357 7.5.3.3 Pre-Scan Users ............................................................................................................................................................. 360 7.5.3.4 Check-out Tool ............................................................................................................................................................. 360 7.5.3.5 Configuring Column Mapping Files .............................................................................................................................. 361 7.5.3.6 Creating and Using “metadata.xml” ............................................................................................................................. 363 7.5.3.7 Stage Mode Migration ................................................................................................................................................. 365 7.5.4 Currently Supported and Unsupported Elements for eRoom Migration .......................................................... 367 8. APPENDIX .............................................................................................................................................................. 369 © 2001-2008 AvePoint, Inc. All rights reserved. Page 10 8.1 FDCC COMPATIBILITY ................................................................................................................................................... 369 8.1.1 Configuring the DocAve Server for FDCC ......................................................................................................... 369 8.1.2 For End-User Access Using Https ..................................................................................................................... 370 RD 8.2 COMPATIBILITY WITH 3 -PARTY SQL TOOLS ..................................................................................................................... 372 8.2.1 Background ...................................................................................................................................................... 372 8.2.1.1 Possible Conflicts ......................................................................................................................................................... 372 8.2.1.2 HA Standby Environments............................................................................................................................................ 372 8.2.2 Coexistence Considerations ............................................................................................................................. 373 8.2.2.1 Platform Level Backup .................................................................................................................................................. 373 8.2.2.2 High Availability ........................................................................................................................................................... 373 8.3 FARM LEVEL BACKUP & RESTORE .................................................................................................................................... 374 8.3.1 Full Farm Backup & Restore ............................................................................................................................. 375 8.3.1.1 Full Farm Backup .......................................................................................................................................................... 376 8.3.1.2 Full Farm Restore ......................................................................................................................................................... 376 8.3.1.3 FEW Restore Settings ................................................................................................................................................... 379 8.3.2 Troubleshooting Tips........................................................................................................................................ 379 8.3.2.1 SharePoint Central Admin cannot be accessed after restore ....................................................................................... 379 8.3.2.2 If Index data is not accurate or corrupted .................................................................................................................... 380 8.3.2.3 If a Web Application cannot be accessed after restore ................................................................................................ 380 8.3.2.4 If there are problems with user profiles and properties or search settings in SSP ....................................................... 380 8.4 DOCAVE 4.5 SOLUTION FOR MICROSOFT OFFICE PROJECT SERVER 2007 ............................................................................... 381 8.4.1 About Project Server 2007 ............................................................................................................................... 381 8.4.2 Backup and Restore for Project Server 2007 .................................................................................................... 383 © 2001-2008 AvePoint, Inc. All rights reserved. Page 11 1. Preface Jump to Table of Contents About This Guide This guide describes how to install DocAve® 4.5 for Microsoft SharePoint (WSS2.0, WSS3.0, SPS2003, MOSS2007), use the Control Panel features, and focuses on the following categories (Data Protection, Administration, Compliance, and Migration) that make up the AvePoint DocAve solution suite. This guide does not explain how to install, configure, and use Microsoft SharePoint (WSS2.0, WSS3.0, SPS2003, or MOSS2007), SQL 2000 – 2005, or Windows Server 2003. In addition, the guide does not cover basic system or network administration topics, such as IP addressing, routing, and other network topology. Audience This guide is for system and SharePoint administrators who possess a working knowledge of Microsoft SharePoint (WSS2.0, WSS3.0, SPS2003, or MOSS2007), SQL 2000 – 2005, and Windows Server 2003. The audience must be familiar with following topics: Technical Support Microsoft Office SharePoint Server administration Network functions and operations Operating system, network, and storage system Before you call, make sure that you have taken these steps to try to solve the problem yourself: Reference the related User Guides (http://www.avepoint.com/support/user-guides) Reference the Knowledge Base (http://www.avepoint.com/support) Lastly: Enter a Support Ticket (http://www.avepoint.com/support/contact-support) Contact the Support Hotline (1-800-661-6588 or 201-793-1111, press ―2‖ for Support) © 2001-2008 AvePoint, Inc. All rights reserved. Page 12 Comments Your feedback is important in helping us provide the most accurate and high quality information. If you have comments or suggestions for improving this document, send us your comments by e-mail to support@avepoint.com. Be sure to include the following: Exact publication title Publication date Page numbers to which you are referring When you send information to AvePoint, you grant AvePoint a nonexclusive right to use or distribute the information in any way it believes appropriate without incurring any obligation to you. © 2001-2008 AvePoint, Inc. All rights reserved. Page 13 2. Installation Jump to Table of Contents 2.1 Overview of Installation This install guide explains the product features of AvePoint‘s latest extension in the SharePoint backup solution space. DocAve 4.5 is an enterprise strength item-level backup, recovery, and content management solution for Microsoft Windows SharePoint Services, Microsoft SharePoint Portal Server, and Microsoft Project Server (including the x64 Editions). DocAve 4.5 consists of two modules, DocAve 4.5 Server and DocAve 4.5 Client. Both modules must be installed in order to run DocAve 4.5. Operating on AvePoint‘s latest distributed software platform, DocAve 4.5 can run on any environment and is accessible from anywhere in your network via Microsoft Internet Explorer (IE). It can also monitor multiple SharePoint environments across the network. DocAve 4.5‘s main features include: Scheduled full, incremental, or differential backups at the site, subsite, and item level. Real time restoration of items, subsites, and sites directly onto your production server, or cross restore to any server on the network. ―Point & click‖ simplicity for content management at the item, subsite, and site-level. Automated data-pruning and coalescing lets users specify the data size, storage medium, and location of backup data. Single ―accessible-from-anywhere‖ web interface for central administration of all SharePoint backup/recovery/management jobs, scheduling/monitoring/reporting, user account management, and software agent management across multiple SharePoint farms. © 2001-2008 AvePoint, Inc. All rights reserved. Page 14 2.2 System Requirements DocAve Supported Platforms Microsoft Office SharePoint Server (MOSS) 2007 (x86 and x64) Windows SharePoint Services (WSS) v2 and v3 (x86 and x64) SharePoint Portal Server (SPS) 2003 (x86 and x64) Windows Server 2003 (x86 and x64) Windows Server 2008 (x86 and x64) SQL Server 2000 (x86 and x64) SQL Server 2005 (x86 and x64) (Pending) SQL Server 2008 (x86 and x64) *Note: SQL Express is not supported DocAve 4.5 Server Computer and PC with an Intel Pentium III-compatible 700-MHz processor minimum, Intel Pentium processor 4-compatible processor recommended Memory 1GB of RAM minimum, 2GB recommended Hard disk 1GB of available space minimum, 3GB recommended Operating Requires one of the following: Microsoft Windows XP, Microsoft Windows Server 2008, system Microsoft Server 2000, Microsoft Windows Server 2003 Standard Edition, Windows Server 2003 Enterprise Edition, Windows Server 2003 Datacenter Edition, or Windows Server 2003 Web Edition (includes x64 editions) .Net Framework installed Framework .NET Framework v2.0 and higher DocAve 4.5 Media Server Computer and PC with an Intel Pentium III-compatible 700-MHz processor minimum, Intel Pentium processor 4-compatible processor recommended Memory 1GB of RAM minimum, 2GB recommended Hard disk 1GB of available space minimum, 3GB recommended Operating Requires one of the following: Microsoft Windows XP, Microsoft Windows Server 2008, system Microsoft Server 2000, Microsoft Windows Server 2003 Standard Edition, Windows Server 2003 Enterprise Edition, Windows Server 2003 Datacenter Edition, or Windows Server 2003 Web Edition (includes x64 editions), .Net Framework installed Framework .NET Framework v2.0 and higher © 2001-2008 AvePoint, Inc. All rights reserved. Page 15 DocAve 4.5 Client Computer PC with an Intel Pentium III-compatible 700-MHz processor (dual Intel Xeon 3.0 GHz or and faster recommended) processor Memory 512 MB of RAM minimum, 1GB recommended Hard disk 1GB of available space minimum, 3GB recommended Operating Requires one of the following servers: Microsoft Windows Server 2003 Standard Edition, system Windows Server 2003 Enterprise Edition, Windows Server 2003 Datacenter Edition, or Windows Server 2003 Web Edition Other Front-End Web Server for SharePoint: MOSS2007/WSS3.0 or SPS2003/WSS2.0 Framework .NET Framework v2.0 and higher © 2001-2008 AvePoint, Inc. All rights reserved. Page 16 2.3 Installation Location DocAve 4.5 Server DocAve 4.5 Server can be installed on any machine on your network meeting the above requirements. The machine it is installed on will serve as the DocAve 4.5 Server, or the interface to access the DocAve 4.5 application from other machines. It is therefore recommended that you install DocAve 4.5 Server on a machine with high availability. This can be the same machine that you install the DocAve 4.5 Client on. DocAve 4.5 Media Server DocAve 4.5 Media Server can be installed on any machine on your network with enough disk space to accommodate the amount of backup data you are expecting to store. The machine it is installed on will serve as the backup data storage and management server. It is therefore recommended that you install DocAve 4.5 Media Server on a machine with high reliability. This can be the same machine that you install the DocAve 4.5 Server on. DocAve 4.5 Client The DocAve 4.5 Client should be installed on a SharePoint Server. © 2001-2008 AvePoint, Inc. All rights reserved. Page 17 2.4 Installation Steps 2.4.1 DocAve 4.5 Server Installation Installation Prerequisites: Account must have local administrative rights *Note: If the system installing the server package is running an FDCC environment, please consult the Appendix at the end of this document to ensure that the DocAve system is fully functional. Step Action 1 On the machine where you wish to install the DocAve 4.5 Server, open the DocAve 4.5 Server folder. Double click on the file entitled ―setup.exe‖, the DocAve 4.5 Install Wizard will launch. 2 Click ―Next‖ to continue. 3 Review the license agreement for IBM WASCE. Read the terms of agreement and click on the button to select ―I accept the terms in the license agreement‖, then click ―Next.‖ 4 Review the license agreement for Java Runtime Environment (JRE). Read the terms of agreement and click on the button to select ―I accept the terms in the license agreement‖, then click ―Next.‖ 5 Review the license agreement for Apache. Read the terms of agreement and click on the button to select ―I accept the terms in the license agreement‖, then click ―Next.‖ 6 Review the license agreements for AvePoint. Read the terms of each agreement and click on the button to select ―I accept the terms in the license agreement‖, then click ―Next.‖ 7 Enter the desired Username and Organization at the Customer Information screen. Verify all information, and then click ―Next.‖ 8 Select the setup type from ―Complete‖ or ―Custom.‖ If… © 2001-2008 AvePoint, Inc. All rights reserved. Page 18 Then… Select the radio button next to ―Complete‖, click ―Next‖ and proceed to Step 9. Complete *Note: With this selection, all program features will be installed, and DocAve will be installed in the default installation directory ―C:\Program Files‖. 1. Select the radio button next to ―Custom‖, click ―Next.‖ 2. Please select the components you would like to install. ―Typical Package‖ is the default installation package. ―API Feature‖ references the API of the TSM Client. This enables DocAve to use the TSM feature and transfer the data from the media server to the TSM Server. Custom *Note: If ―API Feature‖ is not selected and ―IBM TSM‖ is, in step 10, this feature will also be installed. 3. You may change the installation directory from default (C:\Program Files\AvePoint\) to another location. 4. The ―Space‖ button will show the drives available for installation with the associated available space. 5. Click ―Next‖, proceed to Step 9. Select the service(s) to install from DocAve Server and DocAve Media. The ―DocAve Server‖ is the web and communication server that will access the DocAve 4.5 User Interface. This component can be installed on any machine. 9 The ―DocAve Media Server‖ is the media management server which will communicate with the SharePoint Front-End Servers as well as the MS SQL Server. This server component will take on the ―process load‖ of the backup jobs. *Note: It is recommended to install the Media Server on a server different from a SharePoint front-end server for performance purposes. This does not apply to © 2001-2008 AvePoint, Inc. All rights reserved. Page 19 DocAve 4.5 Small Business. If… Then… DocAve Server and DocAve Media Check the boxes next to DocAve Server and DocAve Media Server, click ―Next‖ to continue to Step 10. DocAve Server Check the box next to DocAve Server, click ―Next‖ to continue to Steps 10 and 12. *Note: You will skip Step 11. DocAve Media Check the box next to DocAve Media Server, click ―Next‖ to proceed to Step 11. *Note: You will skip Step 10. Select the database you want to use for the DocAve database (either ―Built-in‖ or ‖MS SQL‖). The DocAve database stores DocAve user account information, DocAve settings, and saved backup plans. *Note: The MS SQL option currently works with the Server Authentication account only. 10 If... Then… Built-in Database Click ―Next‖, proceed to Step 11. MS SQL Click ―Next‖, proceed to Step 11, you will need to configure the MS SQL setting in Step 14. Select the type of Media Storage location from File System or IBM TSM System. 11 IBM TSM SYSTEM option will utilize the IBM Tivoli Storage Manager to backup the data into the Tivoli system. FILE SYSTEM option will store the backup data either onto a network drive or a local drive. If… © 2001-2008 AvePoint, Inc. All rights reserved. Page 20 Then… File System Click ―Next‖, proceed to Step 12. IBM TSM System Click ―Next‖, proceed to Step 12, you will need to configure the IBM TSM System settings in Step 13. 12 Click the ―Install‖ button to begin installing DocAve 4.5 Server. 13 If the end user selected the IBM TSM (Tivoli Storage Manager) System, then the end user will be presented with a configuration screen for the IBM Tivoli System. The TSM Configuration screen allows you to set the required information to communicate to the TSM server: TCP port setting needs to reflect TSM configuration TCP server address: The TSM server‘s IP address Node Name: The node is created in TSM manually, so create a node in TSM before entering Password: Set for the specified TSM Node If MS 14 SQL option is selected, the DocAve Database screen will appear: Database Server Host: MS SQL Server name Database User: Windows or MS SQL Server Authentication account Database Password: Windows or MS SQL Authentication account DocAve Database: Type in any name (for example ―DocAveDB‖). Click on the ―Test‖ button and the database will be created in the MS SQL Server Host provided. DocAve Auditor Database: Type in any name (for example ―DocAveAuditor‖). Click on the ―Test‖ button and the database will be created in the MS SQL Server Host provided. Click on the ―Confirm‖ button to continue. Once the installation is complete, the DocAve Server Configuration window will appear. 15 It is recommended to use the default settings unless a known conflict with an existing port exists. If… Install DocAve Server and DocAve Media © 2001-2008 AvePoint, Inc. All rights reserved. Page 21 Then… Database Service Port: The default port number is 11006 Database Service Name: Current machine‘s host Server using Built-in Database name or IP address Network Service Port: The default port number is 11000 Network Service Host Name: Current machine‘s host name or IP address Media Service Control Port: The default port number is 11002 Media Service Data Port: The default port number is 11003 Media Service Host Name: Current machine‘s host name or IP address WAS CE / Web Service Port: The default port number is 8080 Enable https: The default status is unchecked https Port: The default port is 8090 *Note: This can be setup in the service configuration after installation. Please refer to the setup for https in next section. WAS CE / Web Service Host Name: Current machine‘s host name or IP address DocAve Log Port: The default port number is 11001 Host Name: Current machine‘s host name or IP address Active Directory Account Name / Active Directory Account Password: This enables the option to add existing Active Directory (AD) accounts to use with DocAve. If the end user does not want to integrate with Active Directory now, leave these fields blank. *Note: Only a regular Active Directory account is necessary for integration. The user does not need to be an Admin. Auditor Staging Location: Select ―Media Server‖ to store your auditor data into the media server that you selected in Step 11; select ―Database‖ to store your auditor data into the database that you selected in Step 10. Click ―Confirm‖ to continue. © 2001-2008 AvePoint, Inc. All rights reserved. Page 22 Install DocAve Server and DocAve Media Server using MS SQL Database Network Service Port: The default port number is 11000 Network Service Host Name: Current machine‘s host name or IP address Media Service Control Port: The default port number is 11002 Media Service Data Port: The default port number is 11003 Media Service Host Name: Current machine‘s host name or IP address WasCE / Web Service Port: The default port number is 8080 Enable https: The default status is unchecked https Port: The default port is 8090 *Note: This can be setup in the service configuration after installation. Please refer to the setup for https in next section. WasCE / Web Service Host Name: Current machine‘s host name or IP address DocAve Log Port: The default port number is 11001 Host Name: Current machine‘s host name or IP address Active Directory Account Name / Active Directory Account Password: If integrating with Active Directory now, fill the account information and password for any user. This does not need to be an admin account. This enables the option to add existing Active Directory (AD) accounts to use with DocAve. If the end user does not want to integrate with Active Directory now, leave these fields blank. Auditor Staging Location: Select ―Media Server‖ to store your auditor data into the media server that you selected in Step 11; select ―Database‖ to store your auditor data into the database that you selected in Step 10. Click ―Confirm‖ to continue. © 2001-2008 AvePoint, Inc. All rights reserved. Page 23 Database Service Port: The default port number is 11006 Database Service Name: Current machine‘s host name or IP address Network Service Port: The default port number is Install DocAve Server using Built-in Database 11000 Network Service Host Name: Current machine‘s host name or IP address WasE / Web Service Port: The default port number is 8080 Enable https: The default status is unchecked https Port: The default port is 8090 *Note: This can be setup in the service configuration after installation. Please refer to the setup for https in next section. WasE / Web Service Host Name: Current machine‘s host name or IP address DocAve Log Port: The default port number is 11001 Host Name: Current machine‘s host name or IP address Active Directory Account Name / Active Directory Account Password: If integrating with Active Directory now, fill the account information and password with an account that has full administration rights for Active Directory. This enables the option to add existing AD accounts to use with DocAve. If the end user does not want to integrate with Active Directory now, leave these fields blank. Auditor Staging Location: Select ―Media Server‖ to store your auditor data into the media server that you selected in Step 11; select ―Database‖ to store your auditor data into the database that you selected in Step 10. Click ―Confirm‖ to continue. Install DocAve Server using MS SQL Database © 2001-2008 AvePoint, Inc. All rights reserved. Page 24 Network Service Port: The default port number is 11000 Network Service Host Name: Current machine‘s host name or IP address WasCE / Web Service Port: The default port number is 8080 Enable https: The default status is unchecked https Port: The default port is 8090 *Note: This can be setup in the service configuration after installation. Please refer to the setup for https in next section. WasCE / Web Service Host Name: Current machine‘s host name or IP address DocAve Log Port: The default port number is 11001 Host Name: Current machine‘s host name or IP address Active Directory Account Name / Active Directory Account Password: If integrating with Active Directory now, fill the account information and password with an account that has full administration rights for Active Directory. This enables the option to add existing AD accounts to use with DocAve. If the end user does not want to integrate with Active Directory now, leave these fields blank. Auditor Staging Location: Select ―Media Server‖ to store your auditor data into the media server that you selected in Step 11; select ―Database‖ to store your auditor data into the database that you selected in Step 10. Click ―Confirm‖ to continue. Install DocAve Media Server © 2001-2008 AvePoint, Inc. All rights reserved. Page 25 Media Service Control Port: The default port number is 11002 Media Service Data Port: The default port number is 11003 Media Service Host Name: Current machine‘s host name or IP address Network Service Port: The default port number is 11000 Network Service Host Name: DocAve Server machine‘s host name or IP address WasCE / Web Service Port: The default port number is 8080 WasCE / Web Service Host Name: Current machine‘s host or name IP address DocAve Log Port: The default port number is 11001 Host Name: Current machine‘s host name or current machine IP address Auditor Staging Location: Select ―Media Server‖ to store your auditor data into the media server that you selected in Step 11; select ―Database‖ to store your auditor data into the database that you selected in Step 10. Click ―Confirm‖ to continue. The installer will configure the DocAve 4.5 Server with the selected names and port designations by running a command prompt. Installation is now complete. Select ―Finish‖ to exit the DocAve 4.5 Server Install Wizard. 16 *Note: Due to the longer length of time required by the installation wizard to configure the WasCE ports, please wait a few minutes before continuing onto the next portion of the DocAve installation. 2.4.2 Setup Instructions for Https access DocAve 4.5 supports https access. Https encrypts and decrypts the page requests and page information between the client browser and the web server when the users access DocAve. The https setting within DocAve also supports FDCC (Federal Desktop Core Configuration). Please perform the additional steps in the Appendix at the end of this document first in order to ensure full functionality. 2.4.2.1 Enable Https in the DocAve server configuration Step Action 1 Navigate to Start All Programs AvePoint DocAve 4.5 DocAve 4.5 Server tools Server Configuration Tool Check the ―Enable https‖ option. This will change the WAS CE port to 8090. Make sure that all other ports are configured to this new value. 2 ―Use Self-Generated Certificate‖ is enabled when ―Enable https‖ is checked. If you want to use your own certificate, uncheck ―Use Self-Generated Certificate‖, then type the KeyStore location and KeyStorePassword in the pop-up window. © 2001-2008 AvePoint, Inc. All rights reserved. Page 26 3 Click on the ―Confirm‖ button. 2.4.2.2 Internet Explorer Setup Please follow the steps below to enable https access in Internet Explorer: Step Action 1 In order to be sure that Internet Explorer https access is available for FDCC environments, navigate to ―Internet Explorer‖ -> ―Internet Options‖ -> ―Advanced‖. Under this tab, enable the ―Use TLS 1.0‖ line under Security options. *Note: If you do not currently run FDCC for either Windows XP, you may skip this step. When first accessing DocAve using Internet Explorer (IE), security settings must be configured. Run DocAve‘s server application (found in the start menu) and follow the steps below. If… Then… When the user accesses DocAve on an IE 6 browser, the message below will appear: IE6 2 Click on the ―OK‖ button. When the user accesses DocAve on an IE 7 browser, it will display the security certificate prompt information: IE7 © 2001-2008 AvePoint, Inc. All rights reserved. Page 27 Select the option ―continue to this website‖ listed by the red bullet. Select the corresponding security alert depending on your version of IE. If… Then… Click on the ―OK‖ button in the Security Alert pop-up: 3 IE6 Click on the ―Certificate Error‖ button next to the Address URL: IE7 4 Click on the ―View Certificates‖ button on the pop-up. 5 Click on the ―Install Certificate…‖ button at the bottom of the window 6 Click on ―Next‖ to continue with the Certificate Import. 7 Select the ―Automatically select the certificate store based on the type of certificate‖ option, and click ―Next.‖ 8 Click on ―Finish‖ to complete the certificate import. 9 Click ―Yes‖ to install the certificate in the following pop-up. © 2001-2008 AvePoint, Inc. All rights reserved. Page 28 10 Click ―OK‖ in the prompt acknowledging the successful import. 11 Click ―Yes‖ in the security alert window. Click ―Yes‖ to allow pop-ups on the DocAve site if you are using IE 6: 12 13 The user can now log into DocAve 4.5 with their Login ID and Password. If you are using IE 6, you will need to click ―Yes‖ in the security prompt before using the DocAve GUI. 2.4.3 DocAve 4.5 Client Installation Installation Prerequisites: The machine must be either a SharePoint Front-End Web Server, SQL Server, or a source location for the migration modules (Exchange Server, eRoom Server, or File System). The account used must have administrative rights to your SharePoint and SQL system machines. This should be a SharePoint Administrator for this farm. Step Action 1 On the machine where you wish to install the DocAve 4.5 Client, open the DocAve 4.5 Client folder. Double click on the file entitled ―setup.exe‖ and the DocAve 4.5 Install Wizard will launch. 2 Click ―Next‖ to continue. 3 Review the license agreements for AvePoint and click on the button to select ―I accept the terms in the license agreement.‖ Click ―Next.‖ 4 Enter the desired Username and Organization at the Customer Information screen. Verify all information and click ―Next.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 29 Select the setup type from ―Complete‖ or ―Custom.‖ If… Then… Select the radio button next to ―Complete,‖ then click ―Next.‖ Complete 5 Custom *Note: With this selection, all program features will be installed, and DocAve will be installed in the default installation directory ―C:\Program Files‖. Select the radio button next to ―Custom,‖ then click ―Next.‖ From here, you may change the installation directory from default (C:\Program Files\AvePoint\) to another location. The ―Space‖ button will show the drives available for installation with the associated available space. 6 Click ―Next,‖ the DocAve Client installation process will automatically detect the end user‘s SharePoint environment version and select either ―For SharePoint 2003‖ or ―For MOSS 2007.‖ 7 Click the ―Install‖ button to begin installing DocAve 4.5 Client. Once the installation is complete, the DocAve Agent Configuration window will appear. It is recommended to use the default settings unless a known conflict with an existing port exists. If… Then… 8 SharePoint 2003 © 2001-2008 AvePoint, Inc. All rights reserved. Page 30 DocAve Server Name: The computer‘s host name or IP address for the machine on which DocAve Server is installed DocAve Network Service Port: The default port number is 11000 DocAve Agent Host Name: Current machine‘s host name or IP address DocAve Agent Host Full Name: Current machine‘s fully qualified domain name. DocAve Agent Port: The default port number is 10103 DocAve Web Server / WasCE Port: default is 8080 DocAve Browser Port: The default port number is 10105 Archiver/Auditor Port: The default port number is 10107 Archiver Search Port: The default port number is 10108 User Account / Password: An account which has administrative access to both the SharePoint Front-End Web Server and your SQL Server MUST be used. A SharePoint service account is recommended. AgentType: Check the box in front of the agent function. Click ―Confirm‖ to continue. MOSS 2007 DocAve Server Name: The computer‘s host name or IP address for the machine which DocAve Server is installed DocAve Network Service Port: The default port number is 11000 DocAve Agent Host Name: Current machine‘s host name or IP address DocAve Agent Host Full Name: Current machine‘s fully qualified Domain name DocAve Agent Port: The default port number is 10103 DocAve Web Server / WasCE Port: The default port number is 8080 DocAve Browser Port: The default port number is 10105 User Account / Password An account which has administrative access to both the SharePoint Front-End Web Server and your SQL Server MUST be used. A SharePoint service account is recommended. AgentType: Check the box in front of the agent function. Click ―Confirm‖ to continue. © 2001-2008 AvePoint, Inc. All rights reserved. Page 31 9 You can select the ―Encrypted‖ checkbox to have DocAve encrypt all data transmission between the client and the server. It will run automatically and does not require a password. 10 The installer will configure the DocAve 4.5 Client with the selected name and port designations. Installation is now complete. Select ―Finish‖ to exit the DocAve 4.5 Client Install Wizard. 2.4.4 Verifying the DocAve 4.5 Installation Step 1 Action Open the Services Tool on the machine where DocAve is installed. In the services listing, multiple services are listed for the DocAve Server, DocAve Media Server, and DocAve Client. If… Then… AvePoint Communication Service AvePoint Client Service AvePoint DocAve Database AvePoint DocAve Network AvePoint Tomcat AvePoint Server Services AvePoint DocAve Media AvePoint DocAve Patch AvePoint Media Server Services 2 3 To ensure proper communication between the DocAve Server and Client, the following ports must be open and available if a firewall is in place. The DocAve Server uses the following TCP ports: © 2001-2008 AvePoint, Inc. All rights reserved. Page 32 11000, 11001, 11002, 11003, 8080 The DocAve Client uses TCP port 10103. 2.4.5 Accessing DocAve 4.5 Step Action Open an Internet Explorer window and type in: http://<machine>:8080/docave 1 where <machine> is the name or IP address of the machine running DocAve Server *Note: All pop-up blockers (browser-based, third party toolbars, and LAN firewalls) must be disabled 2 The DocAve 4.5 login screen will pop-up. Select ―Local System‖ and enter the default login account information: Login ID: admin Password: admin Click ―Login.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 33 2.5 Uninstall Instructions By default, DocAve will not delete the installation folders after the uninstall has finished. This is to preserve all DocAve data and configuration information. If you wish to remove this information, please delete the DocAve installation directory. 2.5.1 DocAve Server / Media Server Un-installation Step Action 1 Proceed to the machine that DocAve Server / Media Server is installed 2 Navigate to: Start Control Panel Add or Remove Programs 3 Locate ―DocAve 4.5 Server for MOSS 2007 and WSS 3.0‖, and click ―Remove‖ 4 To continue with the un-installation of the DocAve Server / Media Server, click ―Yes‖ to verify removal. The DocAve Server / Media Server will be removed 5 Proceed to ―…\Program Files\AvePoint\DocAve4‖, delete the ―VaultServer‖ directory 2.5.2 DocAve Client Un-installation Step 1 Action Proceed to the machine that DocAve Client is installed © 2001-2008 AvePoint, Inc. All rights reserved. Page 34 2 Navigate to: Start Control Panel Add or Remove Programs 3 Locate ―DocAve 4.5 Client for MOSS 2007 and WSS 3.0‖, and click ―Remove‖ 4 To continue with the un-installation of the DocAve Client, click ―Yes‖ to verify removal, and the DocAve Client will be removed 5 Proceed to ―…\Program Files\AvePoint\DocAve4‖, delete the ―VaultClient‖ directory © 2001-2008 AvePoint, Inc. All rights reserved. Page 35 3. Control Panel Jump to Table of Contents DocAve Control Panel offers the following general administrative services: Data Management ―Data Manager‖ : Configure pruning guidelines for backup data stored on a local or network drive ―Storage Manager‖ : Setup drive locations for data storage for various DocAve Media Servers ―Security Manager‖ : Configure data compression and encryption profiles ―Data Exclusion‖ : Set filter profiles for backups Control Services ―Server Monitor‖ : Monitor and restart DocAve servers ―Agent Monitor‖ : Monitor and restart DocAve software clients, setup DocAve client work areas for temporary work files, and enter access rights to agent hosts ―Agent Groups‖ : Monitor and group agents Reporting ―Email Notification‖ : Setup email notification groups for different types of services and log level reporting ―Log Manager‖ : Setup and manage DocAve log quotas ―MOM Logging Setting‖: View all the logs generated by the DocAve Server in the MOM server. ―SCOM Logging Setting‖: View all the logs generated by the DocAve Server in the SCOM server. System ―Account Manager‖ : Control user access to DocAve ―Job Pruning Settings‖ : Setup the pruning rules for all job records ―DocAve System Recovery‖ : Setup scheduled backup and restore plans for DocAve system License Management ―License Manager‖ : Manage licenses for all DocAve solutions ―Patch Manager‖ : Manage software upgrades for all DocAve solutions ―Patch Report‖ : View details of a patch updates The ability to access the DocAve control panel should be limited to users with the highest level of administrative privileges. The following sections explain each administrative service in detail. © 2001-2008 AvePoint, Inc. All rights reserved. Page 36 3.1 Data Management DocAve Data Management offers the ability to configure pruning guidelines for backup data, setup drive locations for data storage, configure data compression and encryption profiles, and set filter profiles for backups. The DocAve Data Management will take care of all your data configuration needs. 3.1.1 Data Manager The Data Manager is setup into three sections: Pruning, Coalescing, and Retention. The Pruning feature of the Data Manager allows you to setup data pruning rules, while the Coalescing feature allows you to coalesce backups. 3.1.1.1 Pruning The DocAve Data Manager allows administrators to clear old backup data (known as Data Pruning) by defining pruning and expiration policies. Data pruning is a policy that can be included in a backup plan (all types except High Availability) which prunes or ―deletes‖ old backup data based upon parameters that the user configures. It is a customizable policy that can be set in an effort to control the amount of backup data stored on the storage device of choice. In essence it provides users the flexibility of ensuring that the storage device does not overrun its storage capacity. A Data Pruning Rule allows you specify the amount of time to keep the backup data and type of backup processes that trigger Data Pruning. Step Action 1 Click on ―New‖ to begin creating a new pruning policy. 2 Select the ―Backup Type to Trigger Data Pruning‖: Full Backup, Incremental Backup, or Differential Backup. One, two, or all of the possible backup types can be selected. Full Backup: The pruning job will be triggered when the full backup job kicks off. Incremental Backup: The pruning job will be triggers when the incremental backup kicks off. Differential Backup: The pruning job will be triggered when the © 2001-2008 AvePoint, Inc. All rights reserved. Page 37 differential backup kicks off. 3 Select the ―Trigger Time‖ data pruning should occur: before or after the backup. Before Backup: The pruning job will be triggered BEFORE the selected trigger type kicks off. For example, if a full backup trigger type is selected in conjunction with a ―Before Backup‖ trigger time, the data pruning job will occur BEFORE the full backup job is run. After Backup: The pruning job will be triggered AFTER the selected trigger type kicks off. For example, if a differential backup trigger is selected in conjunction with an ―After Backup‖ trigger time, the data pruning job will be triggered AFTER the differential backup is successfully completed. Select the number of full backup cycles to run before data pruning begins. If, for example, 2 full backup cycles are selected, once a third backup cycle runs and completes, data pruning will begin and data older than 2 cycles will be expunged. There are two methods to configure how long to keep the data. These are according to the ―Full Backup Cycle(s)‖ option or the ―Keep at Least‖ option. Please note that ―Full Backup Cycle(s)‖ takes precedence over ―Keep at Least‖. 4 Full Backup Cycle(s): One full backup is defined as a full backup, and any number of incremental and/or differential and the next full backup (but not including the next full). It always starts with the full backup. For example, in a plan with full backup on Sundays and incremental on weekdays, a cycle starts on Sunday and extends up to, but not including, the full on the following Sunday. Keep at Least: Users can specify a period of time to keep the backup data. Options include by the number of days, weeks or months. *Note: When the ―Keep at Least‖ box is checked, pruning will occur only on data older than the time selected, regardless of the number entered in the ―Full Backup Cycle(s)‖ field. 5 Finally, click ―Save As‖ and a pop-up will appear asking you for the Data Pruning Profile Name. All policies that are configured will show up underneath the ―New‖ link in the ―Data Manager‖ module. © 2001-2008 AvePoint, Inc. All rights reserved. Page 38 *Note: Pruning requires plans that contain ―Full Cycles‖. For users who have defined multiple schedules in a plan, a Full Backup should always be included to trigger the pruning rule. For pruning policies configured with ―Full Backup Cycle(s)‖, a plan without full backup will not be pruned because another full to end the cycle is not present. In order for a pruning policy to work effectively, a backup plan with at least two schedules (one for full and one for incremental and/or differential) must be built. 3.1.1.2 Coalescing Data Coalescing "merges/collapses" Incremental or Differential data chunks onto the previous Full Backup so as to save disk space needed to store backup data. Data Coalescing allows DocAve administrators to effectively stretch out Backup Cycles (to Full Backup plus the number of incremental backups until the next Full Backup) without the added risk of losing incremental data. For example, usage could be to set a monthly backup cycle where a Full Backup is performed on the 1st of every month, and an Incremental Backup is performed daily. The resulting data is one set of a Full Backup residing on your local/network drive or SAN (Storage Area Network) environment. 3.1.1.3 Retention This section allows you to set a retention policy for audit and archive data. The retention tab allows you to set a rule by either month or year, and allows you to delete the archived stub when a retention policy is set. When you select ―Delete Stub When Retention is Set‖ the stub that was created when the data was archived will be deleted as well. The ―Default Retention‖ option will reset the retention time to unlimited. 3.1.2 Storage Manager In DocAve, by default backup data is saved under the path C:\Program Files\AvePoint\DocAve4\VaultServer\DocAveMedia\data And Extension Archiver 07, Extension Archiver 03 and Compliance Archiver are saved under © 2001-2008 AvePoint, Inc. All rights reserved. Page 39 C:\Program Files\AvePoint\DocAve4\VaultServer\DocAveMedia\data5 However, it may not be very convenient to use those default paths, since setup of the system is usually installed on disc ―C‖. Dumping too much data to disc ―C‖ may decrease system performance or fill up the entire disc, causing it to crash. Therefore the customer has the option to dump the data to another location. Under the Storage Manager, the administrator can specify a Logical and Physical Drive. The ―Physical Drive‖ tab allows the administrator to define local and network shared drives for storage locations. The ―Logical Drive‖ tab allows multiple Physical Drives to be tied together as one drive. By configuring your drives properly, you can select a location to transport and save backup/archive data efficiently, without any risk of a disc crashing. 3.1.2.1 Physical Drive There are two types of drives which can be configured under ―Physical Drive.‖ One is the ―Local Drive‖ and the other is the ―Network Drive.‖ The following pages will show how to configure each of the drives. Creating a Local Drive The steps are as follows: Step Action 1 Click on ―New Drive.‖ 2 Input a name for the new drive in the ―Drive Name‖ text box. 3 Click on the ―Data Type‖ combo box: If a new drive will be used to store the backup data, select ―Backup Drive‖ here. If the new drive will be used to store archive data, select one of archive drives. For this section a drive to store backup data will be built, so choose ―Backup Drive.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 40 4 To build a local drive, click on the ―Drive Type‖ combo box and select ―Local Drive.‖ Input a valid path. 5 *Note: If the path does not exist in the system, DocAve will create the path automatically. For example, if the backup path is set to ―d:\backupdata,‖ and there is no ―backupdata‖ folder on the drive ―d,‖ the folder will be created automatically after the storage drive is built and saved. 6 Click on the ―Test Storage Settings‖ button on the bottom to test the new drive. If the information set is valid, there will be a pop-up to indicate that the test is successful. 7 Click the ―Save‖ button to save the profile for the new drive. If the drive is a backup drive, it will be listed under ―Backup Drive.‖ Creating a Network Drive Besides a local drive, storage manager can also use a network path to build a network drive. This way, the data can be saved to another accessible computer. The steps are as follows: Step Action 1 Click on ―New Drive.‖ 2 Input a name for the new drive in the ―Drive Name‖ text box. 3 For this example, create a drive to store archive data. Click on the ―Data Type‖ combo box and choose one of the archive drives. 4 Click on the ―Drive Type‖ combo box and select ―Network Drive.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 41 Input a valid path. The path must be provided in UNC-format: ―\\[network share]\ [network directory path]‖ 5 *Note: This is different from building a local drive! The specified path needs to be an existing path. The network drive builder will not automatically create a folder if the path does not exist and the network drive will not be built successfully. 6 Input the Username, Domain, and Password to set up access to the network path that data will be written to and stored. The network drive build will fail if the data entered here is incorrect. 7 Click on the ―Test Storage Settings‖ to test the new drive. If the information entered is valid, there will be a pop-up to indicate the test is successful. 8 Click the ―Save‖ to save the new drive. The new drive will be listed under one of the Archiver modules depending on the selection in Step 3. Deleting a Physical Drive To delete a physical drive, select a drive from the list to the left and click on the ―Delete‖ button. If there is no data under the selected drive, the drive will be deleted directly. If there is backup or archive data under the selected drive, there will be a pop-up to warn you that there is data present. 3.1.2.2 Logical Drive Physical drives can be grouped together to form a logical drive. By default, DocAve is preconfigured with a ―Default Logical Drive.‖ Any new physical drive will be included in ―Default Logical Drive.‖ Creating New Logical Drive The steps are as follows: Step Action 1 Click on ―New Logical Drive.‖ 2 Input a name for the new drive in the ―Name‖ box. © 2001-2008 AvePoint, Inc. All rights reserved. Page 42 3 Select the ―Data Type.‖ The data type selected should reflect the drives being grouped into the logical drive. Select Backup to create logical drive for the DocAve Backup or Archive modules. 4 Specify which physical drives will be included in the new logical drive. 5 Select the order in which the physical drive will write the data. 6 Click on ―Save‖ button to save the drive settings. *Note: Item, Site, and Subsite Backup Builder and Archiver modules will display the logical drive in the drop-down list for available storage drives. Deleting a Logical Drive To delete a logical drive, select a drive from the drive list on the left and click the ―Delete‖ button. *Note: the ―Default Logical Drive‖ cannot be deleted. Multi-media Servers If you configure multi-media servers, you can see them listed under ―Media Server.‖ You can choose any one of them to build a drive. The steps are the same as those of a single media server. 3.1.3 Security Manager The ―Security Manager‖ allows you to set passwords for the Backup and Platform Level Backup modules. Step 1 Action Click ―New‖ under Security Manager. © 2001-2008 AvePoint, Inc. All rights reserved. Page 43 2 Select the ―Application Type.‖ You can either select Platform Level Backup or ―Backup‖ to set security features for. 3 Input the password you wish to set for the module and confirm the password. 4 Select ―Save As‖ and provide a name for the new password rule. After saving the password rule, you will now be able to select this under the ―Password Protection‖ menu in the ―Backup‖ module. 3.1.4 Data Exclusion The ―Data Exclusion‖ section allows you to filter folders or documents out of the backup plan. This is a useful tool if your environment contains files that you wish to be not backed up. If your environment is exceptionally large, using ―Data Exclusion‖ can increase the speed of your backups by making allowances for data that is not of particular importance. To setup a ―Data Exclusion Rule‖ please follow the steps below: Step Action 1 Under ―Default Folder,‖ select the folder to be filtered out of a backup plan and press ―Add.‖ This will bring the selected folder to the ―To be filtered out‖ section. By default the folder listed is: forms. 2 Under ―Default Documents,‖ select the default documents to be filtered out of a backup plan and press ―Add.‖ By default the documents are: *.aspx, *.gif, *.jpg, *.mp3. Under ―User Defined,‖ select either ―Document‖ or ―Folder‖. 3 If… © 2001-2008 AvePoint, Inc. All rights reserved. Page 44 Then… ―Document‖ Enter either the path of an individual file, or a path such as *.doc to prevent the backup of all Microsoft Word documents. Select ―Add‖ to exclude the item(s). ―Folder‖ Enter the path of the folder and select ―Add.‖ 4 Everything listed under ―To be filtered out‖ will be left out of the backup plan. 5 Select ―Save As‖ to save the data exclusion plan. 3.2 Control Services 3.2.1 Server Monitor The DocAve Server Monitor provides a central interface to monitor and restart DocAve Media Servers, DocAve Database Servers, and DocAve Network Services. In addition, you will be able to view: the Process Ports, Process Host, Process Version, and the Process Status. As mentioned above, DocAve Media Servers perform actual SharePoint data backup, thus effectively distributing the backup work load across potentially multiple physical servers. DocAve Database Servers maintains internal DocAve data such as SharePoint auditing data, DocAve usage data, and DocAve internal logs. DocAve Network Services facilitates the network communication between DocAve servers and DocAve software clients. Please note that the ability to restart servers should be limited to users with highest level of administrative privileges. © 2001-2008 AvePoint, Inc. All rights reserved. Page 45 3.2.2 Agent Monitor The DocAve Agent Monitor provides a central interface to monitor and restart multiple DocAve Agent Hosts. Additionally, detailed information about the Agents is listed. *Note: User local system access may need to be set to a service account that has Administrator privileges for SharePoint if the DocAve software client cannot access SharePoint content from a local account. The Agent Monitor is divided into two sections: ―Common‖ and ―Advanced.‖ 3.2.2.1 Common Tab The Common Tab gives a brief summary of the attributes associated with each Agent. The attributes are: Agent Host Name, Agent Type, Last Registration Time, and Agent Status. In addition, you can also restart the agent from this section. After an agent in the left column is selected, the data fields represented under the ―Common‖ tab are filled in as follows: Host Name: Current host‘s name Listening Port: Listening port, by default it is assigned at 10103 Registration Date: Registration date Number of CPU: Number of CPUs on your machine Log Level: Different log levels that can be selected to alter the information and output contained in a particular log Agent Type: What components of DocAve the agent has access to Version: Current version of the selected agent Registration Time: Registration time Property: N/A Agent Name: Name of the agent Account Configuration The two options under the account configuration section are: Use local system account: This option can be selected if you have everything installed on the same machine Use SharePoint admin account: This is the default selection. Please make sure that the SharePoint account that is specified has full admin privileges to SQL and SharePoint. © 2001-2008 AvePoint, Inc. All rights reserved. Page 46 Data Location Setting The Data Location Setting can be setup so that DocAve software clients will not write temporary data to the default temporary location, which is on the DocAve software client‘s host machine: <DocAve 4.5 Install Directory>\VaultClient\temp In this section, you can specify whether to keep backup files on a local drive or a network drive. One reason why you would want to change the data location setting is because the original location is running out of space, causing the backups to crash or fail. If you select a network drive to backup to you must specify a Network Domain, Network User, Network Password, and a Path. 3.2.2.2 Advanced Tab Within the Advanced Tab you can enable the Archiver and Auditor components for each virtual server. By checking the ―Enable‖ box you can activate the Archiving and Auditing feature. After clicking ―Enable‖ and activating ―Archiving,‖ you have the option to choose one of three options: Prompt: If you select this option, when you click on an archived file a prompt will appear asking you if you would like to restore or display the file. Always Restore: If you select this option, when you click on an archived file it will automatically restore the archived file and bring it back to the production location. Always Display: If you select this option, when you click on an archived file it will automatically display the file. The file will still be located at the off-site production location. The ―Remove stubs but keep the archive data‖ button allows you to delete the stubs from your SharePoint environment. Select which Virtual Server you wish to delete the stubs from and press the ―Remove stubs but keep the archive data‖ button. The Archiver component is explained in detail in the Archiver sections of this guide. 3.2.3 Agent Groups ―Agent Groups‖ provides a central interface to monitor farms and agents configurations. It also allows you to group agents. Adding Agents to Group © 2001-2008 AvePoint, Inc. All rights reserved. Page 47 Step Action 1 Select a farm under the ―Farms‖ tab. This will allow you to see all agent groups under this farm. 2 Select the agent which you want to add to the group under ―All Agents.‖ 3 Click on the ―Add‖ button. 4 Click the ―Save as‖ button, a pop-up will come up asking you to specify a name for your group. Modifying a group You can modify a group by selecting it from the ―Farms‖ list. Once all modifications are complete, click on the ―Save‖ button to save changes. Deleting a group You can delete a group by selecting it from ―Farms‖ and clicking the delete button. 3.3 Reporting 3.3.1 Email Notification Reporting includes the ―Email Notification‖ section which allows the administrator to create various email profiles containing different mailing lists. Any backup, restore, content management, archive, or disaster recovery plans could then be configured to email to different profiles for different error, success, or warning conditions. ―Email Notification‖ allows the administrator to specify exactly what is reported, from simple summary reports to detailed URL specific reports. Follow the steps below to begin configuration of the mailing list profile. © 2001-2008 AvePoint, Inc. All rights reserved. Page 48 Step Action 1 Click on the ―New‖ on the top left section of the screen 2 Enter your POP3 or Microsoft Exchange Outgoing Mail Server (SMTP). 3 Specify a port. The default port is 25. 4 Under the ―Sender‖ field, enter the email address you would like the notifications to come from, as well as the login credentials (username, password, confirm password) in the following fields. 5 Enter the email recipients under the ―Summary‖ and ―Detailed Report Recipients.‖ Multiple recipients can be added to the recipient text box, separated by a semi-colon ―;‖. Select a notification level from both ―Summary‖ and ―Detailed Report Notification Level‖: All, Success, Warning, or Failure. 6 *Note: Notification levels can be customized by profile. For instance, you may want a specific person or group of people to only receive reports for Backups and/or Archives that have failed. Add a new email notification for each person or group. 7 Select the format which the message will be delivered in: ―HTML‖ or ―Plain Text.‖ 8 If the checkbox for ―Send All Logs To Recipient‖ is selected, it will send logs to the recipient when the backup job failed. 9 Click on the ―Test Account Settings‖ button to ensure that your notification profile is configured properly. All email recipients entered in the ―Summary‖ and ―Detailed Report‖ fields will receive a test message from the email address you specified in the ―Sender‖ field. 10 Click the ―Save As‖ button and create a notification name for this profile. All mail notifications profiles will be selectable from within DocAve‘s various backup, restore, content management, auditing, archiving, and disaster recovery plan builders. © 2001-2008 AvePoint, Inc. All rights reserved. Page 49 You should now see the profile you have created listed to left. To modify a profile, simply click on the profile in the list and make your modifications. Once you are done making your modifications, click the ―Save‖ button. 3.3.2 Log Manager The DocAve ―Log Manager‖ provides several options for managing the logs associated with DocAveWeb, DocAveNet, and DocAveMedia services. These DocAve logs record and show all actions that were performed under that service. The amount of logs to record is set via the ―Log Level Setting‖ panel and the amount of data to retain is set via the ―Log Data Download‖ panel. Additionally, you can send these logs via the ―Log Email Notification‖ panel. 3.3.2.1 Log Level Settings ―Log Level Settings‖ can be used to set log info levels for the following services: DocAveWeb: DocAve GUI hosting service DocAveNet: SharePoint backup, content management, and disaster recovery software agents DocAveMedia: Backup data processing and storage management service. Here, administrators can choose different log levels for recording across multiple DocAve media servers using the drop-down list. Logs will be generated on either ―Fatal,‖ ―Error,‖ ―Warning,‖ ―Info,‖ or ―Debug‖ levels selected by the user. 3.3.2.2 Log Data Download ―Log Data Download‖ is used to download logs for Agent Hosts, Media Server, or Web Server. This can be done by checking of any of the hosts or servers and clicking ―Download.‖ This will create a zip file that will contain all the logs. You can select a location for the download from the pop-up. *Note: All DocAve log data are stored within DocAve databases, which can be managed via the DocAve Database Manager. © 2001-2008 AvePoint, Inc. All rights reserved. Page 50 3.3.2.3 Log Email Notification ―Log Email Notification‖ is used to send the logs to a specified recipient directly from the GUI. Within the panel you can add a title or write a message to go along with the log. 3.3.3 MOM Logging Settings For those users who make use of Microsoft Operations Manager, DocAve‘s reporting services can be integrated here. 3.3.3.1 Enable MOM setting from DocAve You can enable the MOM integration from the ―Reporting,‖ ―MOM Logging Settings‖ tab under the ―Control Panel.‖ Check the box in the front of ―Enable MOM Integration‖ and enter the information as required. After entering the configuration information, click ―Test now‖ button and you will receive a complete message if DocAve can connect to the MOM server successfully by the configuration. 3.3.3.2 Viewing the logs from MOM The DocAve logs will be displayed in the MOM server. Please see the following picture for details: © 2001-2008 AvePoint, Inc. All rights reserved. Page 51 3.3.4 SCOM Logging Settings For those users who make use of System Center Operations Manager, DocAve‘s reporting services can be integrated here. 3.3.4.1 Enable SCOM setting from DocAve You can enable the SCOM integration from the ―Reporting,‖ ―SCOM Logging Settings‖ tab under the ―Control Panel.‖ Select ―Yes‖ in the front of ―Enable SCOM Integration‖ and enter the information as required. After entering the configuration information, click ―Test‖ button and you will receive a complete message if DocAve can connect to the SCOM server successfully by the configuration. Click ―Apply‖ to save. Step Action 1 Navigate to the ―Reporting‖ -> ―SCOM Logging Settings‖ tab under the ―Control Panel.‖ 2 Select ―Yes‖ in the field ―Enable SCOM Integration.‖ 3 Fill out all required information for SCOM in the fields provided: ―SCOM Server Name‖ : This is the full computer name of the SCOM server. No additional port number or any other configuration needs to be added to this field. ―Local Host Full Name‖ : The is the full computer name of the machine that has the DocAve Web server and SCOM client installed. This machine which will communicate with the SCOM server. ―Event Source Name‖ : In this field, you only need to put the name ―DocAve‖, or any other custom label. This will be an identifier in the server. For ―Records Per Sync,‖ enter a number between 10 and 100. This is up to your discretion. This is the number of records that the SCOM client will wait to collect before it sends it over to the server. 4 *Note: The lower the number of logs, the slower the performance will be as the client will spend more resources sending individual lines to the SCOM server, as opposed to batches. © 2001-2008 AvePoint, Inc. All rights reserved. Page 52 5 Choose a ―Log Level‖ from the list below (either ―Error,‖ ―Warning,‖ or ―Info‖). 6 After entering the configuration information, click ―Test‖ button and you will receive a complete message if DocAve can connect to the SCOM server successfully by the configuration. 7 Click ―Apply‖ to save the settings. 3.3.4.2 Viewing the logs from SCOM The DocAve logs will be displayed in the SCOM server. 3.4 System 3.4.1 Account Manager In DocAve 4.5, you can create several users and assign specific rights to each user. This feature allows you to easily control and maintain the access rights to DocAve from a central point, which ensures the integrity of the account. You also group users that are categorized by common specific permissions. Please be aware that only the user in a group with the right to update the Account Manager will have the right to edit users and groups. The users in the ―DocAve Administrators‖ group will always have this right. 3.4.1.1 User To log in and use DocAve, a username and password is needed. The system only has one user and password named ―admin‖ and ―admin,‖ respectively. The ―admin‖ user has full rights and this account cannot be deleted. Logging in as the ―admin‖ will allow you to create other users and assign specific rights to those new users. New users can also have the same rights as an ―admin‖ user or they can be restricted from certain actions by limiting their rights. For example, if you create a username ―user1‖ and assign them ―Item Level Backup,‖ when they log into the system they can only perform Item Level Backups and not other functions (such as Site-level © 2001-2008 AvePoint, Inc. All rights reserved. Page 53 Backup, Item Level Restore, etc.). *Note: You cannot directly assign rights to a single user. You must first create a DocAve group and assign some rights to that group. After adding the user to that group, can you assign the corresponding rights. You can also add a DocAve user and a Domain user to the same DocAve group to assign permissions. However, DocAve cannot add a user to a Domain Group. 3.4.1.2 Group DocAve Groups You can create groups in DocAve and assign a series of rights to the group. You can then add users to a specific DocAve group. The ―DocAve Administrators‖ are a built-in group that cannot be deleted with full access rights to the Account Manager (view & update) and are able to view all of the items on the control panel. You can only add additional rights to the ―DocAve Administrators‖ group, not delete or take away from the basic set of rights from the group. Domain Groups Using DocAve, you can also add users to domain groups. You can assign these groups a series of rights and permissions for all users within this group. Restrictions are: The domain should be the one that the current server belongs to. Adding a domain user will automatically add its group in DocAve, with all associated permissions during login. *Note: If a domain user belongs to many groups, they will be granted random permissions from all groups when logging in. 3.4.1.3 Login Modes There are 2 kinds of login modes: ―Local User‖ and ―Domain User‖ login Local User Login A local user is also called a ―DocAveUser.‖ This should be created and added to a DocAve group first. Initially, a DocAve user can only use the local user mode to login (with the initial username and password being ―admin‖ and ―admin,‖ respectively). This account is pre-stored on the local database since the installation of the system and cannot be deleted. When logging in as a local user, remember to choose ―Local System‖ mode at the login page. Domain User Login © 2001-2008 AvePoint, Inc. All rights reserved. Page 54 If you want the system to support domain user login mode, you need to perform the following steps: Step Action 1 When installing the system (both DocAve Server and Client), input a domain username and a corresponding password. 2 After logging in as a DocAve user of the DocAve Administrator group, or the user that has the right to manage accounts (initially you will be only able to use the admin account), choose a domain user and add it to a group. The domain user will have the rights to log into the DocAve system. When logging in as a domain user, remember to choose ―Active System‖ mode at the login page. 3.4.1.4 Creating a New DocAve User or Group Step Action The following steps are required for either the creation of a new DocAve user or a new DocAve group: If… Then… 1. Click the ―New‖ button. 2. Select the ―DocAve User‖ radio button. 3. Input a Username, Password, and Confirm Password in the text boxes provided. 1 Creating a New DocAve User *Note: The password policy can be configured. Open the file ―password-configuration.properties‖ found under ―C:\Program Files\AvePoint\DocAve4\ VaultServer\WasCE\repository\avepoint\ docave\4.5\docave-4.5.war\WEB-INF\‖ in NotePad for more info. 4. Click on the drop-down list under ―DocAve Group‖ to select a group for this user. 5. Input the Email Address, First Name, and © 2001-2008 AvePoint, Inc. All rights reserved. Page 55 Last Name of the DocAve User Creating a New DocAve Group 2 1. Click the ―New‖ button. 2. Select the ―DocAve Group‖ radio button. 3. Input the group name and a brief description of this group. Click the ―Apply‖ button to complete this process. 3.4.1.5 Editing a DocAveUser Step Action 1 Click the ―Edit‖ button. 2 Select the ―DocAveUser‖ radio button along the top. 3 Select a user from the drop-down list provided. You can now modify the password (except for a domain user), what group the user belongs to, the email address, and the user‘s information. 4 *Note: The password must contain uppercase, lowercase, numeric values or non-alphanumeric characters. 5 To save any modified changes click the ―Apply‖ button. © 2001-2008 AvePoint, Inc. All rights reserved. Page 56 3.4.1.6 Adding a Domain User to a Group Before you add a domain user, make sure that the Active Directory Account Name and Password in the DocAve Server Configuration Tool uses an account with Domain Administrator rights. Step Action 1 Click the ―Edit‖ button. 2 Select the ―DomainUser‖ radio button along the top. 3 Type in the ―Domain Username‖ in the format ―domain\username‖ and select on ―Find.‖ If the information is correct, the drop-down list should become available. A pop-up will notify you if the system is unable to find the user. Select the group you wish the user to be part of. 4 *Note: This group must already have been set for SharePoint Integration (under ―Account Manager‖ -> ―Permission‖). Select a user level from the drop down box: 5 6 If… Then… Farm Level It will load all farms under which this Domain User has Permission. Site Collection Level You should input the Site Collection‘s URL in the input field. Use the ―Add‖ button for multiple sites. All site collections will load for this domain user. Click the ―Apply‖ button. © 2001-2008 AvePoint, Inc. All rights reserved. Page 57 3.4.1.7 Editing a Group Step 1 Action Click the ―Edit‖ button. Select the ―DocAve Group‖ or ―Domain Group‖ radio button. If… Then… Type in the ―Domain Group Name‖ in the format ―domain\group name‖ and select on ―Find.‖ 2 3 Domain Group If the information is correct, the description blank is writable and the "Apply‖ button is available. (A pop-up will notify you if the system is unable to find the domain group in your system.) DocAve Group Edit the description of a particular group. Select the ―Apply‖ button. 3.4.1.8 Deleting a User or Group Step Action In order to delete a group or a single user, select the ―Delete‖ button. 1 If… Deleting a User © 2001-2008 AvePoint, Inc. All rights reserved. Page 58 Then… 1. Select the ―User‖ Radio button. 2. Select the username from the drop-down list that you wish to delete. The users information should appear in the following fields. Deleting a Group 2 1. Select the ―Group‖ Radio button. 2. Select the group from the drop-down list and choose the group you want to delete. Click the ―Delete‖ button to finish the operation. 3.4.1.9 Permissions Permissions are separated into two groups: for MOSS 2007 and for SharePoint 2003. The ―Permissions‖ screen is organized by the permissions available for each DocAve module. These modules include Data Protection, Administrator, Compliance, Migration, and Control Panel. For example, you may specify a DocAve group to have permissions to access only the Control Panel in MOSS 2007, limiting access to the other modules. Step Action 1 Select the ―Permission‖ button. 2 Search the ―Group‖ drop-down list on the top of the screen and select a group to edit permissions. Specify which permissions you would like to define: 3 ―Global‖ : These settings will apply to all farms. ―Selected Farms‖ : This will allow you to define a unique set of rules for each SharePoint farm. ―SharePoint Integration‖ : This option lets you specify permissions for SharePoint Administrator and Activity History modules. A user will only have the ability to browse and the defined permissions if they have SP Admin rights to a farm. © 2001-2008 AvePoint, Inc. All rights reserved. Page 59 4 Choose corresponding rights you want to grant to the specified group for each version. 5 Click the ―Apply‖ button to finish the operation. *Note: You can set more granular permissions for the DocAve SharePoint Administrator module by checking the ―Admin‖ box and using the ―…‖ button to the right of it. This will open a new window where you can specify which SharePoint operations you would like the user to be able to perform on each level. These permissions can be specified from the farm level down to the item level, and also in ―batch‖ or regular mode. (Batch operations are listed under the plural tabs: web applications, content databases, etc). 3.4.1.10 Changing User Passwords There are two ways to change a user‘s password using the ―Account Manager‖: 1. If a user opens the ―Account Manager,‖ they will be given the option to change their password. This password change reflects a change to the current user account only. 2. A user who owns the rights to update the ―Account Manager‖ can change any user‘s password. This is simply done by opening ―Account Manager,‖ clicking the ―Edit‖ button and selecting the desired user. At that point you can change the password for the user. *Note: You cannot modify a domain user‘s password. 3.4.2 Job Pruning Setting The ―Job Pruning Setting‖ allows users to setup the pruning rule for all job records. By default, the rule is set to ―No Pruning‖ and all the jobs will be saved. It is recommended to have a ―Job Pruning Policy‖ when you run backups frequently. This will ensure that your database will not be overloaded with data. General Job Record Pruning Rule By default, all types of job records follow the ―General Job Record Pruning Rule.‖ You can then select the rule by ―Job Life Cycle,‖ which allows you to set the number of days, weeks, or months to keep the job records. It can also be set by the ―Job Count‖ which is based off of the number entered. © 2001-2008 AvePoint, Inc. All rights reserved. Page 60 Setting a Pruning Rule for Each Feature As an enhanced feature, the ―Job Pruning Setting‖ allows for the setup of a pruning rule for each feature such as Backup, Restore, Content Manager, etc. By default, all the features will use the ―General Job Record Pruning Rule‖ until a rule for the feature is applied. Apply the Rule or “Prune Now” Once a job record pruning rule has been set, click the ―Apply‖ button or ―Prune Now‖ button. By clicking ―Apply‖, the rules will be saved and DocAve will prune the job records each time the Tomcat Service is started as the rule. By clicking ―Prune Now‖, DocAve will remember the rule and prune the job records at once. 3.4.3 DocAve System Recovery DocAve System Recovery enables the user to setup a manual or scheduled backup job for the DocAve system and then restore the DocAve system when needed. The saved DocAve System Recovery backup job can also be used on a separate new installation of the DocAve Server, enabling a quicker setup. The System Recovery backup job can be saved to a local drive or a network drive. There are 4 parts in the system recovery feature: System Backup; System Restore; Backup Job Report; and Restore Job Report. *Note: System Recovery can only restore DocAve to the latest minor version (i.e. 1.2.3), not to the latest patch release (1.2.3.4). Any upgrades will need to be downloaded and applied using the patch management system, also located in the control panel. 3.4.3.1 System Backup The System Backup includes 2 parts: Setting up the Backup Schedule and setting up the Backup Destination. Setting up the backup schedule Step Action 1 Uncheck the ―No Backup Schedule‖ option, this will activate the backup schedule. © 2001-2008 AvePoint, Inc. All rights reserved. Page 61 Click on the calendar icon ( ) next to the ―Start Time‖ field to set a start date/time for your backup in the window provided: 2 Specify the interval at which the backup will occur. Choices are: Only Once, By Hour, By Day, By Week, or By Month. If … Then … Only Once This will only run once at the specified time. By Hour Either choose this plan to run every set number of hours, or select it to run at specific hours, with the number of minutes past the hour specified by the user in the space provided. Be sure to select either ―AM‖ or ―PM‖ before choosing from the provided hours below. By Day Either set the plan to run every set number of days, or set the plan to run on weekdays or weekends. By Week Either set the plan to run every set number of weeks, or choose the days of the week to re-run this plan. By Month You can choose this plan to run on every set date of every month in the space provided (i.e., on the ―14‖th of every month). You can also set this plan to run in set months of the year, on certain days/weeks of the year. 3 Setting up the backup destination Step © 2001-2008 AvePoint, Inc. All rights reserved. Page 62 Action Select the location where the System Recovery backup job file will be saved. 1 If… Then… Local Drive Input a path such as ―C:\data‖ ( By default the path is ―C:\Program Files\AvePoint\DocAve4\DocAveData‖). Network Drive Input a path such as ―\\server\data‖ and fill in the domain name, username, and password for that drive. The account information used should have write permissions on the drive. 2 After the path has been specified, click the ―Test Drive‖ button. 3 Click ―Save‖ and then ―Run now‖ buttons at the bottom of the page to execute the backup job. *Note: If DocAve was installed using the MS SQL database, the following options can also be selected: ―Backup Online‖ : This option will allow continuous access to DocAve during the backup process. However, operations made by other users during this process may affect the database, which will cause errors with the backup. ―Backup Offline‖ : This option will stop the NET and Web services during the backup process, preventing other users from accessing DocAve. This will also ensure no errors occur during the backup process. 3.4.3.2 Backup Job Report You can monitor the selected backup job via the ―Backup Job Report.‖ The report includes the Start Time, Path, User, Status, Data Size, Progress, and Operation fields. You can delete the job report by clicking on the ―Delete‖ button. 3.4.3.3 System Restore Once a Backup Job completes successfully, the associated information will be listed on the ―System Restore‖ page along with the Backup Time, Backup Path, Backup User, Backup Status, Backup Size, and Operation fields. Clicking the ―Restore‖ button will start DocAve System Recovery process. When © 2001-2008 AvePoint, Inc. All rights reserved. Page 63 the restore job completes, you will need to log out and restart DocAve in order to see the recovered system. When using System Restore to transport the backup plans and DocAve Control Panel profiles to a new machine, simply copy the ―System Recovery Backup Job‖ files to the default path location on the new machine. You can also change the default path location to the location where the System Recovery Backup Job files were located. This can be done by going to the ―System Backup‖ tab. 3.4.3.4 Restore Job Report You can monitor the backup job via the Restore Job Report. The report includes the Start Time, Path, User, Status, Data Size, Progress, and Operation fields. You can delete the job report by clicking on the ―Delete‖ button. 3.5 License Management 3.5.1 License Manager DocAve License Manager provides a centralized location to view license information regarding all or some of DocAve‘s components. License Manager allows SharePoint administrators to view the license type and schedule of the DocAve Server. It also allows the administrator of AvePoint‘s web interface to update AvePoint server level licenses with ease by simply clicking on the import button and browsing for a new license file. The license model for DocAve 4.5 is as follows: Feature/Product Licensing Backup SPDR-HA By number of agents By number of agents Archiver Administration Replicator By number of agents By number of agents By number of agents Compliance Archiver Auditor SP03 MOSS07 By number of agents © 2001-2008 AvePoint, Inc. All rights reserved. Page 64 By number of agents By size of data being migrated (in GB) EPF SP03/MOSS07 By size of data being migrated (in GB) FS MOSS07 By size of data being migrated (in GB) eRoom MOSS07 By size of data being migrated (in GB) 3.5.1.1 Viewing Current License Information In order to view the permissions granted in the current license, open the ―License Manager‖ under the ―License Management‖ tab of the Control Panel. By selecting the various features and solutions DocAve provides from the list on the left, you can view all information to the right. *Note: When selecting migration modules, you will also be able to see the amount of GB used of your license. 3.5.1.2 Previewing New Licenses Before applying a license, you have the option of previewing it directly from the GUI. After importing the license (see the section below), you can select the ―Preview‖ button. The pop-up will show a list of all features, the number of agents or GB allotted by the license, and the expiration date. 3.5.1.3 Applying a License To apply a license file click ―Import‖ along the bottom of the GUI, browse for the license file, and then click the ―Apply‖ button. If the license file is valid, a message will appear indicating that the license update was successful. You will then be prompted to log back into DocAve. 3.5.2 Patch Manager DocAve Patch Manager allows you to update the current version of DocAve from within the DocAve GUI. *Note: Client and Server Patches must be renamed from ―.zip‖ to ―.ave‖ before proceeding to load the patch. © 2001-2008 AvePoint, Inc. All rights reserved. Page 65 3.5.2.1 How to Update the Server or Client Step Action Open the ―Patch Manger‖ tab under the ―License Management‖ section of the ―Control Panel.‖ If… 1 2 Then… 1. Select ―Server‖ radio button on the top bar. 2. Browse for the Server Patch (―.ave‖ file), then select ―Load.‖ 1. Select ―Client‖ radio button on the top bar. 2. Browse for the Client Patch (―.ave‖ file), You are applying a then select ―Load.‖ patch to the client 3. Select the client machine from the drop-down list under ―Agent Host‖ on which you wish to upgrade. Click ―Apply‖ next to the loaded patch. You are applying a patch to the server *Note: To update multiple clients, this step must be repeated for each client. 3.5.2.2 Automatic Update Setting Under ―Automatic Update Setting,” you can choose from several options regarding when and how often you would like to check if there are any new updates available: ―Download updates…‖: This option will automatically download any product updates from AvePoint and will prompt you upon logging in to perform the install. ―Notify me…‖: This will automatically prompt you if an update from AvePoint is ready, but it will wait for you to download it. ―Turn off…‖: This option will require you to check for product updates on the AvePoint website independently. ―Enable Customer Experience…‖ : This option will allow you to enroll in AvePoint‘s Customer Experience Improvement Program. By default it is unchecked. For more information, please see the ―About CEIP‖ document linked in the GUI. Pressing ―Save‖ will save your current selection and profile. Pressing ―Check Now‖ will immediately check to see if there are any new update patches. © 2001-2008 AvePoint, Inc. All rights reserved. Page 66 The progress of both the Server and Client Patches can be monitored here as well. 3.5.3 Patch Report The DocAve ―Patch Report‖ offers a centralized report that allows you to see what patches were applied and when they were applied. In addition, it will display the message given when the patch update finishes, old and new version histories, and host and server name information. Lastly, the patch report has a ―Delete‖ function to remove any patch reports from the history. All of the applied patches are organized in a history table format and allows you to set the ―Refresh‖ setting and the ―Per Page‖ setting. Using the drop-down list, you can select the fresh rate from every 3 seconds, 10 seconds, 30 seconds, or 120 seconds. You can also choose to display up to 5, 10, 20, or 30 reports per page. © 2001-2008 AvePoint, Inc. All rights reserved. Page 67 4. Data Protection Jump to Table of Contents 4.1 Backup DocAve 4.5 Backup is an enterprise-strength multi-level backup engine that seamlessly backs up content on your production SharePoint servers while still allowing that content to be searched, viewed, and accessed from within your SharePoint environment. This guide will provide a thorough understanding of the different types of backup features on the DocAve platform. DocAve contains three types of data backup, and they are differentiated based on the levels of granularity on restore: Item, Site, and Subsite-level. This guide will explain each level of backup in detail and also include helpful tips that will aid you in utilizing that particular level of backup to its full potential. Backup and restore offers the following features and more: Load balanced backup for load balanced front end servers Scheduled or immediate full, incremental, or differential backups for any SharePoint environment (as long as DocAve Clients are installed) Data pruning & coalescing via a Data Retention plan Encryption and compression of backup data via a Data Security plan E-mail notifications The ability to choose a designated DocAve media server to offload actual backup work Selectively restore SharePoint content to the same or different URL location across one or multiple SharePoint environments Real time monitoring of the progress of any backup or restore job via DocAve Job Monitor DocAve 4.5 operates on the concept of backup plans, where each backup plan allows SharePoint administrators to specify: What to backup via URL tree selection, list mode, or through a smart plan builder When to backup (up to 6 customizable schedules per plan. Schedules can be one time only, hourly, daily, weekly, or monthly) How to backup (Full, Incremental, or Differential) Where to backup (designated network or local disk drives) How to handle backup data in terms of data retention (pruning and coalescing) and security (compression and encryption) Important Note: DocAve Item and Subsite-level backup plans DO NOT lock up SharePoint SQL database index files, and thus can be scheduled to run during normal production hours. Site-level backup plans offer an option to lock the site during backup to prevent data orphanage. © 2001-2008 AvePoint, Inc. All rights reserved. Page 68 4.1.1 Common Setup Configurations These are the common setup configurations that span all three levels of backup. Area 1 is the Common Backup Options Profiles (labeled ―Item Level Backup Builder‖). Area 2 is where administrators can select the SharePoint data to be backed up. Area 3 is the scheduling carousel for the backup plan. 4.1.1.1 Common Backup Option Profiles The first and most important thing when constructing a new backup plan is selecting the various options available in Area 1 of the backup builder GUI. Options available here apply to all three levels of backup and should be configured ahead of time in the ―Control Panel.‖ Please refer to that section of the manual for more clarification. Each option is displayed as a drop down box. Each selection in the drop down box can be added or modified from the ―Control Panel.‖ ―Farm Name‖ : This contains a list of farms currently connected to SharePoint. © 2001-2008 AvePoint, Inc. All rights reserved. Page 69 ―Agent Group‖ : This allows administrators to specify an agent group or a specific agent. ―Media Server‖ : The media server is the server that will run the backup plan. It is responsible for encrypting and compressing the backup data and controlling storage. Note that it is possible to have both an agent and a media server on the same physical server. Select a media server by clicking on the drop down box. *Note: For more information on how to set up a media server, please refer to the Installation section of this guide. ―Data Exclusion‖ : This drop-down list shows the data exclusion schemes configured in the ―Data Management‖ section of chapter three under the control panel. Please note that this feature is optional. ―Email Notification‖ : This contains a list of profiles that have an associated email account. For more information on adding or editing new email reporting profiles, please refer to the ―Reporting‖ section of chapter three. Please note that this feature is optional. ―Pruning‖ : This is where the administrator can specify the pruning policy for the data generated by this backup plan. By selecting a Pruning profile, the administrator can specify how long the data generated by this plan is kept on disk. For more information on adding new profiles, please refer to the ―Data Management‖ section of chapter three. Please note that this feature is optional. ―Data Configuration‖ : This is where the administrator can specify where the encryption and compression will be carried out, whether on the Server or the Client. Please note that NO Compression and Encryption is the default option. ―Password Protection‖ : The backup data may be password protected. For more information on creating passwords, please refer to the Security Manager section of chapter three. Please note that this is optional. ―Drive‖ : This contains a list of logical drive profiles that will designate where the backup data will be stored. For more information on adding a new location for backup data, please refer to the ―Storage Manager‖ section of chapter three. About Backup Load Balance DocAve 4.5 supports backup load balance for load balanced front end servers. With this feature, you do not need to specify an agent. The DocAve Server will help you to find a disengaged front end © 2001-2008 AvePoint, Inc. All rights reserved. Page 70 server to run this job. To support this feature, you must use farm and agent group settings in the ―Agent Groups‖ tab of the ―Control Services‖ under the ―Control Panel.‖ Please refer to the ―Agent Group‖ section in of the ―Control Services part of chapter three. 4.1.2 Item Level DocAve‘s Item Level backup and restore allows administrators to backup their SharePoint environment on any level, from an entire farm down to a specific folder/list. On the restore, administrators can browse through specific folders and lists to find the exact item needed for restoration. This could include an attachment, a single document, or even a single version of a document. Backup and restore is full fidelity, with all of the item‘s original metadata maintained. Item Level backup is the most powerful backup feature in DocAve, and when combined with Site and Subsite-level backup and restore, the administrator has a modular and customizable backup system that ensures the security and integrity of their SharePoint environment. 4.1.2.1 Creating an Item Level Backup Plan After pressing ―New Plan‖ on the list to the left of the GUI, select a farm from the list displayed. Configure all of the settings under the ―Item Level Backup Builder‖ (Area 1) listed in the previous section. After selecting a farm, locate the three tabs in Area 2: Tree Mode, List Mode, and Filter Mode. Tree Mode Tree Mode is the default view. This mode allows administrators to view the entire topology of their SharePoint environment while navigating. The name of the farm you have selected should be displayed in the area directly underneath, ready for browsing. Step Action 1 Click on the name of the Agent Host that is currently selected. This will expand the host to display all of the SharePoint instances installed underneath. 2 Clicking on the name of the SharePoint instances will expand the tree further to display the top-level sites located within that specific SharePoint instance. 3 Clicking on the name of a specific top-level site will expand the tree further to display a ―.‖ (also referred to as a ―dot‖ or ―root directory‖), and also subsites located underneath that specific top-level site. © 2001-2008 AvePoint, Inc. All rights reserved. Page 71 4 Clicking on the dot expands the tree to display folders/lists and content located directly on the top-level site. Clicking on individual subsite names expands the tree to display folders/lists and content located in those individual subsites. 5 There is a check box corresponding to each level on the backup builder tree which is by default unchecked. Checking this box indicates that all content on that level (and underneath) is to be extracted and backed up, or included in the backup plan. 6 When checking a box to specify content to be backed up, the folder icon will include a colored triangle in the lower right corner. This triangle indicates that all new data created in those sites or folders/lists will be automatically included in the backup plan. This option is turned on by default. Clicking on the folder icon itself will remove the triangle, hence indicating that only content that is present at this current time will be backed up, ignoring new data. *Note: When browsing extremely large environments, the tree may split across multiple pages. To browse multiple pages, click on the ―Paging‖ icon at the top of the tree, then select the page number from the popup displayed. List Mode ―List Mode‖ is designed for large SharePoint environments, usually containing thousands, and even tens of thousands of sites. In ―List Mode‖ the administrator can browse data on a site by site basis, allowing for faster page loads (it does not require the GUI to refresh the whole SharePoint environment). After entering ―List Mode,‖ follow the steps provided in the section above for ―Tree Mode‖ selection of items. Navigation will be on a level by level basis and the ―Parent‖ link at the top of the list can be used to return to the previous level. The URL ―Current Path‖ line is there to help users keep track of which level they are currently in. Filter Mode Filter mode allows searching or filtering of sites, subsites, documents or files. This can be done by typing either the exact URL or using wildcards (*) in the appropriate fields. Step © 2001-2008 AvePoint, Inc. All rights reserved. Page 72 Action 1 Click on the ―Filter Mode‖ tab. 2 There are three options: Rule for Sites, Rule for Web and Rule for Lists. Check the box next to each level to activate the filter function for that level. 3 By default, the ―Case Sensitive‖ option will be checked. To turn off case sensitivity, uncheck the case sensitive check box. 4 Underneath each activated ―Rule,‖ input the desired URL. Wildcards (*) are supported here. For example, if your filter should identify all Microsoft Word documents, a ―*.doc‖ wildcard can be typed in this space. Any Site, Web, or List containing a Word document will either be displayed or removed from the final list according to your choice in Step 5. The check box next to each input represents the ―negate‖ feature. If you want the filter to: 5 If… Then… Include matches Click this box to set as a ―+‖ to ensure matching results are displayed. Remove matches Click this box to set as a ―-‖ to ensure matching results will not be displayed. 6 To add an additional URL/wildcard for the Rule, click on the ―Add‖ button and repeat Step 4. To delete a filter, click the ―Delete‖ button. 7 Select the ―Preview‖ button to view the results of the filter. 8 Everything that is visible in the ―Preview‖ will be included in the current backup plan. 4.1.2.2 Setting up the Scheduling Carousel After successfully determining what sites, folders, and lists are to be backed up, the next step is to set a schedule to backup this information. Using the ―Scheduling Carousel,‖ the user can determine when, © 2001-2008 AvePoint, Inc. All rights reserved. Page 73 and how often, the backup should be performed. This can be accomplished in Area 3 of the ―Backup Builder‖ GUI. Step Action 1 Select a ―Schedule‖ from the carousel. You can have up to six different schedules set at once. 2 Uncheck the ―No Schedule‖ check box to activate a Schedule. Inactive schedules are highlighted in red, active ones will be highlighted in blue. Select a Backup Type for the current schedule. Full A full backup of the selected source. Incremental A partial backup where only data that has been added since the last incremental or full backup is backed up. Differential A partial backup where only data that has been added since the last full backup is backed up. 3 *Note: Frequent consecutive differential backups have a tendency to backup the same data over and over again and fill server space quickly. For best results in high frequency backups, please use incremental backups. Incremental data saves time and storage space by backing up only the differences between incremental backups, instead of backing up the entire source location. 4 Click on the calendar icon to the right of the ―Start Time‖ field. 5 Select a date and time in the calendar pop-up window and click ―OK.‖ 6 Specify the interval at which the backup will occur. Choices are: Only Once, By Hour, By Day, By Week, or By Month. If … © 2001-2008 AvePoint, Inc. All rights reserved. Page 74 Then … Only Once This will only run once at the specified time. By Hour Either choose this plan to run every set number of hours, or select it to run at specific hours, with the number of minutes past the hour specified by the user in the space provided. Be sure to select either ―AM‖ or ―PM‖ before choosing from the provided hours below. By Day Either set the plan to run every set number of days, or set the plan to run on weekdays or weekends. By Week Either set the plan to run every set number of weeks, or choose the days of the week to re-run this plan. By Month You can choose this plan to run on every set date of every month in the space provided (i.e., on the ―14‖th of every month). You can also set this plan to run in set months of the year, on certain days/weeks of the year. 7 To create another schedule, click on an open Schedule in the carousel and repeat steps 1-5. Otherwise proceed to step 8. 8 Save the plan by clicking on ―Save As‖ and provide a plan name. After the plan has successfully been saved, it will be displayed in the narrow column area on the left. *Note: For an Incremental or Differential backup, a Full backup should be included within the same plan by including it in another available Schedule. The Incremental and Differential require a Full backup in order to function properly. We recommend using Schedule A as a Full backup on Sunday and Schedule B as an Incremental backup every day until Saturday. 4.1.2.3 Item Level Restore Controller After a backup plan has completed successfully, the backup data is ready for browsing. To perform a restore, enter the ―Restore Controller‖ to begin browsing the backup data. © 2001-2008 AvePoint, Inc. All rights reserved. Page 75 Choosing a plan Step Action 1 From the ―Item Level Backup Job Browser,‖ select the media server folder. 2 Select the farm name folder. Select the plan name folder. 3 4 A new window should open with a list of all available backups, organized by date. The list can also be filtered by date and time (using the calendar icons next to the ―From‖ and ―To‖ times), and by Full Backup (FB), Incremental Backup (IB), and Differential Backup (DB). Browse to the date and time of the desired backup data and select it using the icon next to it. Select ―OK,‖ and the Agent Host name should appear below the ―Item Level Backup Data Browser.‖ Browsing for the backup data to be restored Step Action 1 Click on the agent name to display the backup data available. 2 Browse through the backup data by clicking on the SharePoint instance to expand the top-level sites located underneath them. 3 Click on the name of a specific top-level site to expand the tree. 4 Clicking on the ―.‖ expands the tree to display folders/lists and content located directly on the top-level site. Clicking on individual subsite names expands the tree to display folders/lists and content located on those individual subsites. © 2001-2008 AvePoint, Inc. All rights reserved. Page 76 Select the data to be restored. If… Then… Restoring a file/version 1. Navigate to the location of the file/version. 2. Click the check box next to the file/version located in the list to the right. Restoring only a top-level site 1. Navigate to the site and expand its tree. 2. Click the radio button next to the site twice until it becomes a half circle ( ). 3. Click the radio button next to the ―.‖ Beneath the site and the entire top-level site contents will be selected. Restoring a subsite 1. Navigate to the subsite. 2. Click the radio button next to the subsite so select the site and its contents. 5 6 Always ensure that the ―Securities‖ and ―Properties‖ boxes are checked. This will ensure that all metadata and version histories will be restored. 7 You can select the option ―Include Workflow‖ to restore all workflow data with the file. 8 Click on the ―Data Size‖ button to display the data size for the selected backup data in the pop-up. 9 Continue to the section below titled ―Specifying the type of restore.‖ Searching for the backup data to be restored For larger backups that contain a significant amount of content, browsing through the data for the restore can be inefficient and tedious. For these cases the search mode is recommended. Step © 2001-2008 AvePoint, Inc. All rights reserved. Page 77 Action 1 2 Directly to the right of ―Item Level Backup Data Browser‖ there is an icon labeled ―Search.‖ Clicking on the icon will open a new pop-up window which allows a search for the desired restore content. In the search pop-up, search for content to be restored by the name of the site, subsite, list, folder, or file. If the exact name of the content is not known, then search can be performed via the Item Attributes, such as the name of the creator. *Note: The search can be restricted to be case sensitive by selecting the check box provided. 3 Select ―Search‖ to see a list of all results in the ―Item Level Backup Data Browser‖ window. Specifying the type of restore At the bottom section of the restore controller, the type of restore (either ―In Place‖ or ―Out of Place‖) can be selected. An In Place restore allows the restore of backup data to its original location. An out of place restore allows the user to specify an alternate location for the backup data to be restored to. For more information about the out of place restore please refer to sections 4.1.4.4 and 4.1.5.2. Step Action Select either an ―In Place‖ restore or ―Out of Place‖ restore by selecting the corresponding options in the window. If Then In Place Select either an individual Agent or a Group to restore the data to from the drop-down list. 1 Out of Place 1. Click the ―…‖ button to the right of the destination field. This will open the ―Restore Destination‖ window 2. Select an Agent Host from the drop-down list 3. Navigate to the location for the restoration. 4. Check the box next to the location to select it as the destination. 5. Select ―OK.‖ *Note: There is a blank field corresponding to each level in the URL tree. DocAve can create a new site, subsite, or © 2001-2008 AvePoint, Inc. All rights reserved. Page 78 folder/list by providing a name in the blank field. Make sure that the box has been checked before typing. For a new top-level site, the full URL should be used. At the subsite or folder/list level, just the name of the location is sufficient. 2 Select a time for the restore to run. By default, ―Now‖ is selected and will run the process as soon as the ―Go‖ button is pressed. You can set a scheduled date and time for this restore by pressing the ―Schedule‖ button and entering the appropriate information. Select a ―Restore Option‖ from the drop-down list If… Then… DocAve will not restore the content if it already exists on the destination. Not Overwrite 3 For example, if an entire folder‘s content is selected for restore, but only one document was removed from the destination folder, only the removed document will be restored. Overwrite DocAve will restore the content over whatever exists on the destination. This will delete the content on the destination and replace it with the content selected to be restored. Append This option will allow DocAve to update the destination with the selected data to be restored. Data that already exists will not be deleted; data that is not already present will be added. Replace The ―Replace‖ option will delete all content on the destination before performing the restore. This can be used to remove unwanted content that will not be deleted by the ―overwrite‖ option. (This can be looked at as a ―Reset‖ function.) Default User Mapping If you wish to perform a restore using an account that was originally not in the Active Directory, some issues may arise. Use the ―SP2007ItemConfig.cfg‖ file provided in the path below to solve this: VaultClient\data\SP2007 (on the 2007 Agent machine) © 2001-2008 AvePoint, Inc. All rights reserved. Page 79 The following lines can be edited: <UserMappings defaultUser="Domain\DefaultUserName"> </UserMappings> Replace the following code: ―Domain‖ : The domain in which the new Active Directory user has been added. ―DefaultUserName‖ : The username created in the Active Directory. *Note: Do not use this for users that already exist in the Active Directory, only for new users. Domain Mapping If you wish to restore a user from one domain to another domain successfully when you perform an item level restore across domains, use the ―SP2007ItemConfig.cfg‖ file provided in the path below to solve this: VaultClient\data\SP2007 (on the 2007 Agent machine) The following lines can be edited: <DomainMapping SourceDomain= "domainName" DestinationDomain= "domainName" /> <DomainMappings> could contain multiple <DomainMapping> entries (nodes). Each entry added (using the format above) represents a pair of domain names. For example, ―D1‖ is the domain name in the source, and ―D2‖ is the domain name in the destination. When you perform a restore from D1 to D2, the users under D1 will use users of the same name in D2 to do this restore (e.g.C1\user1=D2\user1, C1\user2 =D2\user2, etc.). *Note: This user must already exist in the destination domain. <UserMapping SourceUser="domain\user" DestinationUser="domain\user" /> This can be used to map user to another use across domains. For example, a definition could use ―<UserMapping SourceUser= ―D1\userA‖ DestinationUser= ―D2\userB‖>‖. If you restore a site from D1 to D2, ―userA‖ will be restored as ―userB.‖ 4.1.2.4 Restore to File System For MOSS 2007 / WSS v.3 item level backup users, there is now a function for restoring data to any file © 2001-2008 AvePoint, Inc. All rights reserved. Page 80 system. The ―Restore to File System‖ feature allows you recover backup data to any network or local drive, while maintaining the structure of the content. *Note: Since metadata of files located in a File System is not as robust as it is in SharePoint, some metadata will be lost if you intend on re-introducing these files to a SharePoint environment at a later time. Other metadata will be mapped to new fields (i.e. ―Modified‖ to ―Last modified at…‖). In order to perform a restore, please follow the steps below: Step Action 1 Under the Item Level Backup heading on the navigation panel, select the ―Restore to File System‖ tab. 2 In the ―Item Level Backup Job Browser,‖ navigate through the backup data to the plan you wish to restore. 3 Select the desired plan using the radio button to the left. The tree will load in the space below. 4 Using the ―Item Level Backup Data Browser,‖ navigate to the content you wish to restore by clicking on each level to expand the content beneath it. Clicking the ―.‖ will display the folders and lists located directly on these subsites. Choose the data to be restored from the tree. *Note: To see the amount of content selected, use the ―Data Size‖ button at the lower right section of the screen. If… 5 File / File Version All other levels © 2001-2008 AvePoint, Inc. All rights reserved. Page 81 Then… After browsing to the location, use the ― ‖ arrow to view individual items / item versions. Use the checkbox to select the desired files. Using the icons to the left of each level, select the backup content to be restored. Clicking this icon once will select all children beneath this level, and a half-shaded icon indicates that only some items are selected. 6 For large environments, you can use the search function to browse for backup data. Select the ―Search‖ button and enter search conditions in the given fields, including wildcards (*). This search can be made case sensitive. Pressing ―Search‖ again will expand the tree to show all content matching the search conditions. *Note: If only general information is known about the file, you can perform a search on the Item Attributes level. An example of this would be the name of the creator. In the location on the right, specify a destination for this restore. If… Then… Local Drive 1. By clicking on the icon in the area below, navigate to the appropriate disk drive / directory to restore the content to. 2. Select the appropriate level using the radio button. 3. To create a new directory, use the blank field under each level to enter a folder name. Network Drive 1. After selecting the network drive option, press the ―Config‖ button. 2. Enter a location, domain, username and password in the space provided. You can test this configuration using ―Test.‖ 3. Choose ―Save As,‖ and your current drive should be saved to the list on the left. 4. You can also simply choose a previously configured network drive using the drop-down menu. 7 Select a ―Restore Option‖ from the drop-down list provided. If… 8 Then… DocAve will not restore the content if it already exists on the destination. Not Overwrite For example, if an entire folder‘s content is selected for restore, but only one document was removed from the © 2001-2008 AvePoint, Inc. All rights reserved. Page 82 destination folder, only the removed document will be restored. Overwrite 9 DocAve will restore the content over whatever exists on the destination. This will delete the content on the destination and replace it with the content selected to be restored. Select either the ―Go‖ button or the ―Schedule‖ button to configure the restore. The schedule button will allow you to select the date and time of the restore from a popup. You may enter a ―Description‖ in the field provided to help distinguish this job in the Job Monitor. 4.1.2.5 Helpful tips on Item Level Backup Compared to site and sub site-level backups, the item level backup will allow to backup files down to the folder or even down to the individual files. It is highly recommended that for every subsite and site-level backup that there is also a corresponding Item Level Backup of the same subsite or site. It is important to note that an Out of Place restore will not carry over web parts or alerts. The administrator must reinstall the web parts on the destination agent and recreate any existing alerts. 4.1.3 Site Level Backup and Restore The Site-level is the highest level in the SharePoint environment, it‘s also known as a top-level site. A site-level backup involves backing up the entire site including all of the subsites and the items beneath and within it. *Note: Site Level is the fastest backup out of the three levels. However, it is recommended that you use Item Level Backup or Platform Level Backup to ensure full granularity on restore. Only use Site Level Backup if you have an extremely large number of items per site, or if you have any trouble replicating workflows with Item or Platform Level Backup. © 2001-2008 AvePoint, Inc. All rights reserved. Page 83 4.1.3.1 Creating a Site-level Backup Plan Upon completing configuration of the common backup options in the Control Panel, proceed to the backup builder under ―Site-level‖ to begin creating a plan for site-level backup. First, configure the settings in first area of the Backup Builder GUI using section 4.1.1.1 (Common Backup Option Profiles) as a guide. Then, locate the 3 tabs in Area 2 directly underneath the Backup Option Profiles: Tree Mode, List Mode, and Filter Mode. *Note: Site-level Backup builder offers an extra option to toggle site locking. This will lock the SharePoint site to Read-only mode until the backup job is finished executing. Although un-checking ―Lock Site‖ will not the lock the SharePoint site during the Backup, please be aware that this can cause data orphanage. The locking of a site and data orphanage is further explained in the Helpful Tips for Site-level Backup section below. Tree Mode Tree Mode is the default view. The name of the Farm selected should be displayed in the area directly underneath, ready for browsing. Step Action 1 Click on the name of that Farm. This will expand the host to display the SharePoint instances installed underneath. 2 Clicking on the name of the SharePoint instances will expand the tree further to display the top-level sites located within that specific SharePoint instance. 3 Click the check box of the desired top-level site. All content on that level and underneath that level will be backed up. 4 When checking a box to specify content to be backed up, the folder icon will include a colored triangle ( ). The triangle indicates that all new data created in those sites or folders/lists will be automatically picked up by the backup plan. This option is turned on by default. Clicking on the folder icon itself will remove the triangle, hence indicating that only content that is recognized at this current time will be backed up. *Note: When browsing extremely large environments, the tree may split across multiple pages. To browse multiple pages, click on the ―Paging‖ icon at the top of the tree, then select the page number from the popup displayed. © 2001-2008 AvePoint, Inc. All rights reserved. Page 84 List Mode List Mode is designed for large SharePoint environments. In List Mode the administrator can browse data on a level by level basis, limiting the amount of content on the screen. Step Action 1 Click on the ―List Mode‖ tab to enter List Mode. 2 Please follow the steps listed in Tree Mode to select content to be backed up. 3 Clicking on the ―Parent‖ link allows the administrator to return to the higher level of granularity above. The ―Current Path‖ line helps users keep track of which level they are in. Filter Mode Filter mode allows for sites be filtered out of the list display. This can be done by typing the exact URL or using wildcards (*) in the search. Step Action 1 Click on the ―Filter Mode‖ tab. 2 Check the box next to ―Rules for Sites‖ to activate the filter function for that level. 3 By default, the ―Case Sensitive‖ option will be checked. To turn off case sensitivity, uncheck the case sensitive check box. 4 Underneath each activated ―Rule,‖ input the desired URL. Wildcards (*) are supported here. For example, if your filter should identify all Microsoft Word documents, a ―*.doc‖ wildcard can be typed in this space. Any Site, Web, or List containing a Word document will either be displayed or removed from the final list according to your choice in Step 5. © 2001-2008 AvePoint, Inc. All rights reserved. Page 85 The check box next to each input represents the ―negate‖ feature. If you want the filter to: 5 If… Then… Include matches Click this box to set as a ―+‖ to ensure matching results are displayed. Remove matches Click this box to set as a ―-‖ to ensure matching results will not be displayed. 6 To add an additional URL/wildcard for the Rule, click on the ―Add‖ button and repeat Step 4. To delete a filter, click the ―Delete‖ button. 7 Select the ―Preview‖ button to view the results of the filter. 8 Everything that is visible in the ―Preview‖ will be included in the current backup plan. 4.1.3.2 Setting up the Scheduling Carousel Step Action 1 Select a ―Schedule‖ from the carousel. You can have up to six different schedules set at once. 2 Uncheck the ―No Schedule‖ check box to activate a Schedule. Inactive schedules are highlighted in red, active ones will be highlighted in blue. Select a Backup Type for the current schedule. 3 Full A full backup of the selected source. Incremental A partial backup where only data that has been added since the last incremental or full backup is backed up. © 2001-2008 AvePoint, Inc. All rights reserved. Page 86 Differential A partial backup where only data that has been added since the last full backup is backed up. *Note: Frequent consecutive differential backups have a tendency to backup the same data over and over again and fill server space quickly. For best results in high frequency backups, please use incremental backups. Incremental data saves time and storage space by backing up only the differences between incremental backups, instead of backing up the entire source location. 4 Click on the calendar icon to the right of the ―Start Time‖ field. 5 Select a date and time in the calendar pop-up window and click ―OK.‖ Specify the interval at which the backup will occur. Choices are: Only Once, By Hour, By Day, By Week, or By Month. If … Then … Only Once This will only run once at the specified time. By Hour Either choose this plan to run every set number of hours, or select it to run at specific hours, with the number of minutes past the hour specified by the user in the space provided. Be sure to select either ―AM‖ or ―PM‖ before choosing from the provided hours below. By Day Either set the plan to run every set number of days, or set the plan to run on weekdays or weekends. By Week Either set the plan to run every set number of weeks, or choose the days of the week to re-run this plan. By Month You can choose this plan to run on every set date of every month in the space provided (i.e., on the ―14‖th of every month). You can also set this plan to run in set months of the year, on certain days/weeks of the year. 6 © 2001-2008 AvePoint, Inc. All rights reserved. Page 87 7 To create another schedule, click on an open schedule in the carousel and repeat steps 1-5. Otherwise proceed to step 8. 8 Save the plan by clicking on ―Save As‖ and provide a plan name. After the plan has successfully been saved, it will be displayed in the narrow column area on the left. *Note: For an Incremental or Differential backup, a Full backup should be included within the same plan by including it in another available Schedule. The Incremental and Differential require a Full backup in order to function properly. We recommend using Schedule A as a Full backup on Sunday (or any day of the week that sees very little traffic) and Schedule B as an Incremental backup every day until Saturday. 4.1.3.3 Site-level Restore Controller After a backup plan has completed successfully, the backup data is ready for browsing. To perform a restore, click the ―Restore Controller‖ under ―Site-level‖ to begin browsing the backup data. Choosing a plan Step Action 1 From the ―Site-level Backup Job Browser,‖ select the media server folder. 2 Select the farm name folder. Select the plan name folder. 3 4 A new window should open with a list of all available backups, organized by date. The list can also be filtered by date and time (using the calendar icons next to the ―From‖ and ―To‖ times), and by Full Backup (FB), Incremental Backup (IB), and Differential Backup (DB). Browse to the date and time of the desired backup data and select it using the icon next to it. Press ―OK,‖ and the Agent Host name should appear below the ―Site-level Backup Data Browser.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 88 Browsing for the backup data to be restored Step Action 1 Click on the Agent Name to display the backup data available. 2 Browse through the backup data by clicking on the SharePoint instance to expand the top-level sites located underneath them. 3 Click the check box next to the site to be restored. This indicates that all content on that level and underneath that level is selected for restoration. 4 Click on the ―Data Size‖ button to display the data size for the selected backup data in the pop-up. Searching for the backup data to be restored For larger backups that contain a significant amount of content, browsing through the data for the restore can be inefficient and tedious. For these cases the search mode is recommended. Directly to the right of ―Site-level Backup Data Browser‖ there is an icon labeled ―Search‖. Clicking on the icon will open a new pop-up window which allows a search for the desired content to be restored. This search gives the option of searching by sites or by wildcards (*). If a wildcard is used, only sites containing files matching that wildcard will be included in the list. Specifying the type of restore At the bottom section of the restore controller, the type of restore (either ―In Place‖ or ―Out of Place‖) can be selected. An in place restore allows the restore of backup data to its original location. An out of place restore allows the user to specify an alternate location for the backup data to be restored to. Step 1 Action Select either an ―In Place‖ restore or ―Out of Place‖ restore by selecting the corresponding options in the window. If … © 2001-2008 AvePoint, Inc. All rights reserved. Page 89 Then … In Place Out of Place Select either an individual Agent or a Group to restore the data to from the drop-down list. 1. Click the ―…‖ button to the right of the destination field. This will open the ―Restore Destination‖ window 2. Select an Agent Host from the drop-down list 3. Navigate to the location for the restoration. 4. Check the box next to the location to select it as the destination. 5. Select ―OK.‖ *Note: There is a blank field corresponding to each level in the URL tree. DocAve can create a new site, subsite, or folder/list by providing a name in the blank field. Make sure that the box has been checked before typing. For a new top-level site, the full URL should be used. At the subsite or folder/list level, just the name of the location is sufficient. 2 Select a time for the restore to run. By default, ―Now‖ is selected and will run the process as soon as the ―Go‖ button is pressed. You can set a scheduled date and time for this restore by pressing the ―Schedule‖ button and entering the appropriate information. Select a ―Restore Option‖ from the drop-down list If… Then… DocAve will not restore the content if it already exists on the destination. Not Overwrite 3 For example, if an entire folder‘s content is selected for restore, but only one document was removed from the destination folder, only the removed document will be restored. Overwrite DocAve will restore the content over whatever exists on the destination. This will delete the content on the destination and replace it with the content selected to be restored. Append This option will allow DocAve to update the destination with the selected data to be restored. Data that already exists will not be deleted; data that is not already present will be added. © 2001-2008 AvePoint, Inc. All rights reserved. Page 90 4.1.3.4 Helpful Tips on Site-level Backup Please note that the site-level backup and restore will actually lock the SharePoint environment to read-only mode until the job has finished. SharePoint must be locked in order to prevent data orphanage. Data orphanage can occur during a Site-level backup because SharePoint users might attempt to change data on the SharePoint site during the backup process. Since DocAve locks SharePoint to read-only mode, it is highly recommended that you do your site-level backups on the weekend. Site-level is one of the more demanding backups out of the three different levels of backup. So, depending on the server specifications, there may be a decrease in performance when attempting to backup during normal working hours. Installing the DocAve Server and Media Server on dedicated hardware will reduce the performance impact. 4.1.3.5 Helpful Tips on an Out of Place Site-level Restore The Out Of Place restore is a powerful tool that will allow you to copy sites from one Agent Host to another Agent Host (or from one virtual server to another virtual server). Please note below some important facts regarding an Out of Place restore: Be careful to specify the entire path when providing the name of the new folder. An Out of Place restore will not carry over web parts or alerts. Web parts must be reinstalled on the destination agent and recreating the alerts. Make sure that the site selected for an out of place restore does not already exist on the destination agent. During the restore process the DocAve will look up the unique site ID of the SharePoint site. If ―Not Overwrite‖ is selected in the restore option and the unique ID exists in the destination then nothing will be restored. If ―Overwrite‖ is selected in the restore option and the unique ID exists in the destination then the restore will fail with an error. 4.1.4 Subsite Level Backup and Restore DocAve‘s Subsite-level backup and restore allows administrators to backup their SharePoint environment on the subsite-level. When restoring, instead of having to restore entire top-level sites, administrators can restore a specific subsite or a collection of subsites. *Note: It is recommended that you use Item Level Backup or Platform Level Backup to ensure full © 2001-2008 AvePoint, Inc. All rights reserved. Page 91 granularity on restore. Only use Subsite Level Backup if you have an extremely large number of items per site, or if you have any trouble replicating workflows with Item or Platform Level Backup. 4.1.4.1 Creating a Subsite-level Backup Plan Upon completing configuration of the common backup options in the Control Panel, proceed to the backup builder under ―subsite-level‖ to begin creating a plan for subsite-level backup. First, configure the settings in first area of the Backup Builder GUI using section 4.1.1.1 (Common Backup Option Profiles) as a guide. Then, locate the 3 tabs in Area 2 directly underneath the Backup Option Profiles: Tree Mode, List Mode, and Filter Mode. Tree Mode Tree Mode is the default view. This mode allows administrators to view the topology of their SharePoint environment while navigating up to the subsite-level. The name of the farm you selected should be displayed in the area directly underneath, ready for browsing. Step Action 1 Click on the name of that Agent Host. This will expand the host to display the SharePoint instances installed underneath. 2 Clicking on the name of the SharePoint instances will expand the tree further to display the top-level sites located within that specific SharePoint instance. 3 Clicking on the name of a specific top-level site will expand the tree further to display a ―.‖ (dot or root directory), and also subsites located underneath that specific top-level site. The ―.‖ contains folders/lists and content located directly on the top-level site. In subsite-level backup, the end user will not be able to click on a subsite name and expand the tree any further. 4 There is an empty box corresponding to each level on the backup builder tree, the box is by default unchecked. checking the box indicates that all content on that level and underneath that level is to be extracted and backed up. 5 When checking a box to specify content to be backed up, the folder icon will include a colored triangle ( ). The triangle indicates that all new data created in those sites will be automatically picked up by the backup plan. This option is turned on by default. Clicking on the folder icon itself © 2001-2008 AvePoint, Inc. All rights reserved. Page 92 will remove the triangle, hence indicating that only content that is recognized at this current time will be backed up. *Note: When browsing extremely large environments, the tree may split across multiple pages. To browse multiple pages, click on the ―Paging‖ icon at the top of the tree, then select the page number from the popup displayed. List Mode List Mode is designed for large SharePoint environments, with upwards of thousands, and even tens of thousands of sites. In List Mode the administrator can browse data on a site by site basis, and allows for faster page loads since it will not require the GUI to refresh the whole SharePoint environment. After entering List Mode, follow the steps provided in Tree Mode. Navigation will be on a level by level basis and the Parent link can be used to return to the previous level. The URL Path line indicates which level the user is in. Filter Mode Filter mode allows for sites be filtered out of the list display. This can be done by typing the exact URL or using wildcards (*) in the search. Step Action 1 Click on the ―Filter Mode‖ tab. 2 There are two options: Rule for Sites and Rule for Web. Check the box next to each level to activate the filter function for that level. 3 By default, the ―Case Sensitive‖ option will be checked. To turn off case sensitivity, uncheck the case sensitive check box. 4 Underneath each activated ―Rule,‖ input the desired URL. Wildcards (*) are supported here. For example, if your filter should identify all Microsoft Word documents, a ―*.doc‖ wildcard can be typed in this space. Any Site, Web, or List containing a Word document will either be displayed or removed from the final list according to your choice in Step 5. 5 The check box next to each input represents the ―negate‖ feature. If you want the filter to: © 2001-2008 AvePoint, Inc. All rights reserved. Page 93 If… Then… Include matches Click this box to set as a ―+‖ to ensure matching results are displayed. Remove matches Click this box to set as a ―-‖ to ensure matching results will not be displayed. 6 To add an additional URL/wildcard for the Rule, click on the ―Add‖ button and repeat Step 4. To delete a filter, click the ―Delete‖ button. 7 Select the ―Preview‖ button to view the results of the filter. 8 Everything that is visible in the ―Preview‖ will be included in the current backup plan. 4.1.4.2 Setting up the Scheduling Carousel Step Action 1 Select a ―Schedule‖ from the carousel. You can have up to six different schedules set at once. 2 Uncheck the ―No Schedule‖ check box to activate a Schedule. Inactive schedules are highlighted in red, active ones will be highlighted in orange. Select a Backup Type for the current schedule. 3 Full A full backup of the selected source. Incremental A partial backup where only data that has been added since the last incremental or full backup is backed up. Differential A partial backup where only data that has been added since the last full backup is backed up. © 2001-2008 AvePoint, Inc. All rights reserved. Page 94 *Note: Frequent consecutive differential backups have a tendency to backup the same data over and over again and fill server space quickly. For best results in high frequency backups, please use incremental backups. Incremental data saves time and storage space by backing up only the differences between incremental backups, instead of backing up the entire source location. 4 Click on the calendar icon to the right of the ―Start Time‖ field. 5 Select a date and time in the calendar pop-up window and click ―OK.‖ Specify the interval at which the backup will occur. Choices are: Only Once, By Hour, By Day, By Week, or By Month. If … Then … Only Once This will only run once at the specified time. By Hour Either choose this plan to run every set number of hours, or select it to run at specific hours, with the number of minutes past the hour specified by the user in the space provided. Be sure to select either ―AM‖ or ―PM‖ before choosing from the provided hours below. By Day Either set the plan to run every set number of days, or set the plan to run on weekdays or weekends. By Week Either set the plan to run every set number of weeks, or choose the days of the week to re-run this plan. By Month You can choose this plan to run on every set date of every month in the space provided (i.e., on the ―14‖th of every month). You can also set this plan to run in set months of the year, on certain days/weeks of the year. 6 © 2001-2008 AvePoint, Inc. All rights reserved. Page 95 7 To create another schedule, click on an open schedule in the carousel and repeat steps 1-5. Otherwise proceed to step 8. 8 Save the plan by clicking on ―Save As‖ and provide a plan name. After the plan has successfully been saved, it will be displayed in the narrow column area on the left. *Note: For an Incremental or Differential backup, a Full backup should be included within the same plan by including it in another available Schedule. The Incremental and Differential require a Full backup in order to function properly. We recommend using Schedule A as a Full backup on Sunday (or any day of the week that sees very little traffic) and Schedule B as an Incremental backup every day until Saturday. 4.1.4.3 Subsite-level Restore Controller After a backup plan has completed successfully, the backup data is ready for browsing. To perform a restore, click the ―Restore Controller‖ under ―Site-level‖ to begin browsing the backup data. Choosing a plan Step Action 1 From the ―Subsite-level Backup Job Browser,‖ select the media server folder. 2 Select the farm name folder. Select the plan name folder. 3 4 A new window should open with a list of all available backups, organized by date. The list can also be filtered by date and time (using the calendar icons next to the ―From‖ and ―To‖ times), and by Full Backup (FB), Incremental Backup (IB), and Differential Backup (DB). Browse to the date and time of the desired backup data and select it using the icon next to it. Press ―OK,‖ and the Agent Host name should appear below the ―Site-level Backup Data Browser.‖ Browsing for the backup data to be restored © 2001-2008 AvePoint, Inc. All rights reserved. Page 96 Step Action 1 Click on the Agent Name to display the backup data available. 2 Browse through the backup data by clicking on the SharePoint instance to expand the top-level sites located underneath them. 3 Click the check box next to the site to be restored. This indicates that all content on that level and underneath that level is selected for restoration. 4 Click on the ―Data Size‖ button to display the data size for the selected backup data in the pop-up. Searching for the backup data to be restored For larger backups that contain a significant amount of content, browsing through the data for the restore can be inefficient and tedious. For these cases the search mode is recommended. Directly to the right of ―Subsite-level Backup Data Browser‖ there is an icon labeled ―Search‖. Clicking on the icon will open a new pop-up window which allows a search for the desired content to be restored. This search gives the option of searching by sites or by wildcards (*). If a wildcard is used, only sites containing files matching that wildcard will be included in the list. Specifying the type of restore At the bottom section of the restore controller, the type of restore (either ―In Place‖ or ―Out of Place‖) can be selected. An in place restore allows the restore of backup data to its original location. An out of place restore allows the user to specify an alternate location for the backup data to be restored to. Step Action Select either an ―In Place‖ restore or ―Out of Place‖ restore by selecting the corresponding options in the window. 1 If Then In Place Select either an individual Agent or a Group to restore the data to from the drop-down list. © 2001-2008 AvePoint, Inc. All rights reserved. Page 97 Out of Place 1. Click the ―…‖ button to the right of the destination field. This will open the ―Restore Destination‖ window 2. Select an Agent Host from the drop-down list 3. Navigate to the location for the restoration. 4. Check the box next to the location to select it as the destination. 5. Select ―OK.‖ *Note: There is a blank field corresponding to each level in the URL tree. DocAve can create a new site, subsite, or folder/list by providing a name in the blank field. Make sure that the box has been checked before typing. For a new top-level site, the full URL should be used. At the subsite or folder/list level, just the name of the location is sufficient. 2 Select a time for the restore to run. By default, ―Now‖ is selected and will run the process as soon as the ―Go‖ button is pressed. You can set a scheduled date and time for this restore by pressing the ―Schedule‖ button and entering the appropriate information. Select a ―Restore Option‖ from the drop-down list If… Then… DocAve will not restore the content if it already exists on the destination. Not Overwrite 3 For example, if an entire folder‘s content is selected for restore, but only one document was removed from the destination folder, only the removed document will be restored. Overwrite DocAve will restore the content over whatever exists on the destination. This will delete the content on the destination and replace it with the content selected to be restored. Append This option will allow DocAve to update the destination with the selected data to be restored. Data that already exists will not be deleted; data that is not already present will be added. © 2001-2008 AvePoint, Inc. All rights reserved. Page 98 4.1.4.4 Helpful Tips on an Out of Place Subsite-level Restore The Out Of Place restore is a powerful tool that will allow you to copy sites from one Agent Host to another Agent Host (or from one virtual server to another virtual server). Please note below some important facts regarding an Out of Place restore: When creating a new Subsite, all that is needed is to specify the name of the new subsite in the textbox on the subsite-level. So, for example, the path would be ―new_sub_site.‖ An Out of Place restore will not carry over web parts or alerts. Web parts must be reinstalled on the destination agent and recreating the alerts. Make sure that the site selected for an out of place restore does not already exist on the destination agent. During the restore process the DocAve will look up the unique site ID of the SharePoint site. If ―Not Overwrite‖ is selected in the restore option and the unique ID exists in the destination then nothing will be restored. If ―Overwrite‖ is selected in the restore option and the unique ID exists in the destination then the restore will fail with an error. 4.1.5 Advanced Tips in Restore and Backup This section will focus on the more advanced methods of using DocAve to its full potential. Before you try these methods it would be best to understand the basics of the DocAve program and the different levels of restore. There are different scenarios where DocAve can be used to restructure a SharePoint environment. 4.1.5.1 How to Move a Site to a Subsite As a SharePoint environment shrinks, an administrator might encounter a scenario where a site once created on the top-level is now more suitable as a subsite. This section will investigate how DocAve can allow you to move a top-level site to the level of a subsite. Please understand that this will move the entire site and its contents to one level below. Step 1 Action Proceed to the ―Item Level Backup Builder.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 99 2 Select the top-level site and its ―.‖ folder 3 Proceed to run a Full Backup. 4 Once the backup completes, proceed to the ―Item Level Restore Controller.‖ 5 Navigate to the backup data and open the contents. 6 From the Item Level Data Backup Browser, expand the tree down to the contents of the ―.‖ directory. 7 *Important: Select all of the content under the root site except for the galleries. These galleries are ―Master Page Gallery,‖ ―List Template Gallery,‖ ―Site Template Gallery,‖ and ―Web part Gallery.‖ These galleries should only be present on the top-level site, not the subsite. 8 Proceed to set up an out of place restore and select the desired destination subsite. 9 Click ―Go‖ and the site will be moved down to a subsite. 4.1.5.2 Ensuring Metadata and Security on an Out of Place Restore DocAve can be used to do an Out of Place Restore of items from one Agent Host to another Agent Host. To guarantee that the Metadata and Security is carried over properly, please follow these steps: Step 1 Action Proceed to the ―Item Level Restore Controller.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 100 2 From the Backup Data, select the Media Server and the Agent Host. 3 Select the desired backup data. 4 The ―Data Browser‖ will populate now and you can expand down to the individual items in the tree. 5 You can either select the entire content tree, specific libraries, or just an individual item. 6 Select the entire ―Shared Documents‖ folder. 7 Directly underneath ―Path Info‖ you will see two check boxes labeled ―Property‖ and ―Security.‖ Please make sure that both of these are selected. 8 Proceed with your Out of Place Restore. After the restore has completed you should see that the original metadata, version histories, and user security information has been carried over to the new destination. 4.1.5.3 Making sure that the Site page is restored properly If you did an Out of Place restore of a site using a site-level restore and the site is not loading properly when you attempt to view it, please follow the directions below in order to apply the content again. In order to do this the end user must have an Item Level Backup of the site the Out of Place Restore is from. Step 1 Action Proceed to the ―Item Level Restore Controller.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 101 2 From the Backup data, select the Media Server and the Agent Host. 3 Then select the desired plan. 4 The Data Browser will populate now and the end user can now expand down to the individual items in the tree. 5 Expand the root content folder which is specified by the ―.‖ 6 Expand the ―{System Folder}‖ and select the radio button by the folder. 7 On the right panel, underneath ―Path Info,‖ you should see a file named ―default.aspx.‖ This file holds the layout of your Site. Make sure this file is selected for restore. 8 Proceed with the Out of Place Restore. After the restore has completed, the layout will be copied over to the new destination location. 4.1.5.4 Using the Restore Arrow in Item Level Restore In the Item Level Out of Place Restore, there is a feature that will allow the end user to promote a subsite to a new top-level site. If the top-level site does not exist, it will be created. After selecting the Out of Place restore option, within the restore destination pop-up window, there will be a green arrow ( ) alongside the blank input field toggle at the top site-level. Depending on whether the arrow is pointing up or down, the behavior of the restoration differs. Using the Restore Arrow to Promote a Subsite to a New Top-level Site If the Item Level Plan consists of a subsite that the end user wishes to promote to a new top-level site, follow the directions below: © 2001-2008 AvePoint, Inc. All rights reserved. Page 102 Step Action 1 Proceed with the steps to select the subsite to restore. 2 Select the Out of Place Restore toggle. 3 Then click on the ―… ‖ button to bring up the Restore Destination pop-up. 4 Navigate to the site-level of the destination web application and select the input field with a green arrow next to it using the radio button. 5 Click the Restore (Green) Arrow until it is facing up. This means that the subsite will be promoted to a top-level site. 6 Provide the full URL path for the new destination. This site will be created automatically. 7 Click ―OK.‖ 8 Click ―Go‖ on the restore controller. Using the Restore Arrow to Copy Subsites under a New Top-level Site If the Item Level Plan consists of a subsite that the end user wishes to copy under a new top site then please follow the instructions below: Step 1 Action Proceed with the steps to select the subsite to restore. © 2001-2008 AvePoint, Inc. All rights reserved. Page 103 2 Select the Out of Place Restore toggle. 3 Then click on the ―… ‖ button to bring up the Restore Destination pop-up. 4 Navigate to the site-level of the destination web application and select the input field with a green arrow next to it. 5 Click the Restore (Green) Arrow until it is facing down. This means that the subsite will be copied under a top-level site. 6 Provide the full URL path for the new destination. That site will be created automatically. 7 Click ―OK.‖ 8 Click ―Go‖ on the restore controller. 4.1.5.5 Using the Subsite Tree in the Subsite Restore Controller In the Subsite-level Restore Controller, there are icons by each subsite that, when clicked, will select all the children of that subsite. When the end user has not clicked the icon then individual subsites and individual children of the subsites can be selected. Please be aware that are a three scenarios that the administrator must be aware of when using this functionality. Please note the destination titles and location of the restore for each scenario, as well as the subsites selected: *Note: The symbol ( x ) used below indicates that the subsite has been selected. Scenario 1 The destination is ―http://servername/sites/test‖ and the selected subsites with their children are © 2001-2008 AvePoint, Inc. All rights reserved. Page 104 restored out of place. The results are below: Selected (x) (x) (x) (x) Restored …/sites/example/sub001 …/sites/test/sub001/ …/sites/example/sub001/sub002 …/sites/test/sub001/sub002 …/sites/example/sub001/sub003 …/sites/test/sub001/sub003 …/sites/example/sub001/sub004 …/sites/test/sub001/sub004 Scenario 2 The destination listed is ―http://servername/sites/test/sub010‖ and the selected subsites with their children are restored out of place. The results are below: Selected Restored (x) (x) (x) …/sites/example/sub001 …/sites/test/sub010/ …/sites/example/sub001/sub002 …/sites/test/sub010/sub002 …/sites/example/sub001/sub003 …/sites/test/sub010/sub003 …/sites/example/sub001/sub004 …/sites/test/sub010/sub004 Scenario 3 The destination listed is ―http://servername/sites/test‖ and the selected subsites with their children are restored out of place. The results are below: Selected Restored (x) (x) (x) …/sites/example/sub001 …/sites/test/ …/sites/example/sub001/sub002 …/sites/test/sub002 …/sites/example/sub001/sub003 …/sites/test/sub003 …/sites/example/sub001/sub004 …/sites/test/sub004 4.1.5.6 Running a Backup using the Command Line Prompt Below is the command line syntax procedure and example for running a DocAve backup plan via the © 2001-2008 AvePoint, Inc. All rights reserved. Page 105 command prompt. Before running the command line backup, a backup plan must be created from the DocAve 4.5 GUI. During the backup plan creation, a schedule does not have to be set when using windows command prompt or any other third party applications to run the backup plans. Once the backup plan is created from DocAve 4.5 GUI, run the following command to invoke the backup job from a third party schedule (cmd): Example: C:\Program Files\AvePoint\DocAve4\VaultServer\DocAveCommand\bin> DocAveBackup –t F –l I07 –a testeserver4 –n ―Ar_site_FB‖ Usage: DocAveBackup –t <backupType> – l <backupLevel > –a <agentName > –n ―<planName>‖ backupType: F (full), I (Incremental), or D (Differential) backupLevel: I (Item Level), S (Site-level), or W (Subsite-level). Add ―03‖ or ―07‖ (as in the example above) to specify the restore for either 2003 or 2007. planName: The name entered in the DocAve GUI. By putting quotations around the name the prompt will run the specific plan entered. Use the local directory to map to the C:\program files >AvePoint>DocAve4\VaultServer\DocAvecommand\bin> When the example above is entered, this text should appear: ―The backup process started: the plan Ar_site_FB is being executed.‖ 4.1.5.7 Restoring an Area in SharePoint 2003 This section is only applicable if both your Source Agent and your Destination Agent are running SharePoint Portal Server 2003, since areas and sub areas do not exist in Windows SharePoint Services 2.0, MOSS 2007 and Windows SharePoint Services 3.0. Restoring an area is a two step restore process: the user must restore the area structure first, followed by the contents of the area. *Note: If you have a large number of areas and sub areas, you should contact AvePoint‘s technical support team for the best practices in making sure all of your areas and sub areas are being properly backed up and restored. The steps below can be used for both in place or out of place restores: © 2001-2008 AvePoint, Inc. All rights reserved. Page 106 Step Action 1 Perform an Item Level Backup of the area folder and the root site. 2 Proceed to the 2003 Item Level Restore. 3 Select the desired plan and expand the ―Item Level Backup Data Browser.‖ 4 Select the areas and sub areas that you wish to restore. These can be found when expanding the ―area:http://…‖ location. An example of a sub area is ―:Home:Topics:Divisions‖ 5 Proceed to do a restore of the selected areas and sub areas into the destination agent or virtual server. 6 Once the restore is complete, match up the area with the content folders from ―http://…‖ to the area structure folder in ―area:http://…‖ 7 Select the content folders that reside with the portal‘s main site. 8 Once the proper folders are selected, make sure that overwrite is selected proceed with the restore process. 4.1.5.8 Minimum Access Levels for Backup and Restore In order to perform a backup or restore on the item, site, and subsite levels, we recommend using an account with full administrative access to SharePoint and the SQL servers. However, backup and restore can still be performed using an account with the following access: Member of the local admin group (enough to access the files on the local SharePoint server) Member of the SharePoint farm admin group Member of the database owner group of the SharePoint content DB © 2001-2008 AvePoint, Inc. All rights reserved. Page 107 4.1.6 Currently Supported and Unsupported Elements for Backup Source Libraries Type Document Library Supported Form Library Supported Wiki Page Library Supported Picture Library Supported Translation Management Library Supported Data Connection Library Supported Slide Library Supported Report Library Supported Communications Announcements List Contacts Tracking Lists Custom Lists Web Pages Status Supported Supported Discussion Board Supported Links Supported Calendar Supported Tasks Supported Project Tasks Supported Issue Tracking Supported Survey Supported Custom List Supported Custom List in Datasheet View Supported Languages and Translators Supported KPI Lists Supported Import Spreadsheet Supported Basic Page Supported Web part Page Supported Sites and Workspaces Supported Workflow Customization required RSS Customization required Alerts Supported My Alerts Alerts in SP 2003 Personal Site & My Site Supported Metadata Single line of text Supported Multiple lines of text Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 108 Choice (menu to choose from) Supported Number Supported Currency Supported Date and Time Supported Lookup Supported Yes/No Supported Person or Group Supported Hyperlink or Picture Supported Calculated Supported Business Data Supported Version settings Supported Column Settings Supported Permissions Supported Version Histories Documents Supported Security & Properties Lists © 2001-2008 AvePoint, Inc. All rights reserved. Page 109 Supported 4.2 Platform Level Backup 4.2.1 Introduction Platform Level Backup is a farm level recovery solution which enables SharePoint Administrators to backup Web Applications, Content Databases, search and index servers and front-end servers. Platform Level Backup can also backup file system resources on the front-end servers. By using the DocAve Platform Level Backup module, SharePoint administrators can: Setup scheduled or immediate Full, Incremental, or Differential backups for any SharePoint environment where DocAve Backup agents are installed. Backup to a specific data location, with optional pruning, by selecting ―Data Retention.‖ Setup encryption and compression to backup data via the Data Manager. Select email notification rules created in the Control Panel‘s ―Email Notification‖ section. Choose designated DocAve media server to offload backup Jobs. Selectively restore SharePoint content down to the item version level. Monitor real time progress of any backup or restore jobs (via DocAve Job Monitor) DocAve backup plans do not lock up SharePoint SQL database index files, and thus can be scheduled to run during normal production hours. DocAve 4.5 operates on the concept of backup plans, where each backup plan allows SharePoint administrators to specify: What component of the SharePoint farm to backup. When to backup (schedule a future time to run a backup plan via scheduling carousel; specify up to six customizable schedules per plan). How to backup (Full, Incremental, or Differential). Where to backup (via media servers which then write data to designated network/local/mapped disk drives). How to handle backup data (pruning and coalescing via Data Retention Manager; security and compression via Data Security Manager). What level of granularity can be used on restore. *Note: Currently the Platform Level Backup module cannot support SQL Server Embedded Edition (SSEE). 4.2.2 Installation Before the administrator can use SharePoint Platform Level Backup, the Platform Level Backup module needs to be enabled. © 2001-2008 AvePoint, Inc. All rights reserved. Page 110 To ensure that Platform Level Backup is enabled on the DocAve Agent Host, please proceed as follows: Steps Actions 1 Log onto the server where the DocAve Agent will be installed. 2 Click the ―Start‖ button located on the menu taskbar and navigate to ―all Programs‖ -> ―AvePoint DocAve 4.5.‖ 3 Open the ―Client Configuration Tool.‖ 4 Specify any significant port and machine configurations. Proceed to the ―Data Protection‖ tab and select the type of DocAve Agent to install. If ... Then … The Agent is specified to be a ―Control Agent.‖ This component is required to be installed on the SharePoint front-end web server. In a SharePoint farm with multiple front-end web servers, only one SharePoint front-end web server should be configured as ―Platform Level Backup Control Agent.‖ The Agent is specified to be a ―Member Agent.‖ This component can be installed on any server in the SharePoint farm. For example, Platform Level Backup Member Agent can be installed on the Database server, Index server and/or front-end server. 5 6 Click ―Confirm‖ to finish the configuration and restart the DocAve Agent Services. DocAve Platform Level Backup loads and browses for the Member Agents through the Control Agent. It also performs backups for both Control and Member Agents. © 2001-2008 AvePoint, Inc. All rights reserved. Page 111 *Note: Platform Level Backup supports SQL clustering. If cluster failover support is required, a member agent must be installed on each SQL cluster node, otherwise a member agent only needs to be installed on the active node. When configuring the member agent, be sure the ‗Agent Name‘ field matches the cluster physical node name. Also, the DocAve agent account should have the following permissions: ―View Server State‖ permission on SQL server to query the SQL cluster nodes. For permissions in general (not only in cluster): Member of the local administrator group Granted the following privileges in local security policy (log off and log back in to let these changes take effect): ―Act as part of the operating system‖ and ―Replace a process level token‖ For a SharePoint Control Agent User, also needs SP Farm Admin, Database Creator, SysAdmin For a SQL Server Member Agent User, need SysAdmin server role 4.2.3 Backup Builder Platform Level Backup backs up data based on rules that the administrator specifies. To build a new Platform Level Backup rule, please follow the directions in each of the following sections. 4.2.3.1 Setting up the Backup Builder section Steps Actions 1 Click on the tab for ―Data Protection.‖ 2 On the left side of the screen, click on ―Platform Level Backup.‖ 3 Select ―Backup Builder‖ under the ―Platform Level Backup‖ section. 4 Select the Agent Host using the drop down box. Only ―Platform Level Backup Control Agents‖ are listed under Agent Host drop down window. This is a mandatory input field. © 2001-2008 AvePoint, Inc. All rights reserved. Page 112 5 Select the Media Server which will process the backup. 6 Select a storage drive from the ―Drive‖ drop down box. A Logical Drive is created from the Control Panel. For more information on adding a new Logical Drive, refer to the section on the ―Control Panel‖ in this user guide. By default, the ―Default Logical Drive‖ is selected. Configure the extra optional policies. If … Then … The ―Email Notification‖ drop down box contains a list of profiles that have an associated email account. The user chooses to include an ―Email Notification‖ policy. 7 The user chooses to include a ―Pruning‖ policy. The email notification profiles that are listed are manually populated using the Control Panel. For more information on adding new email reporting profiles, please refer to the ―Control Panel‖ section of this user guide. The ―Pruning‖ drop down box contains a list of pruning policies that were created in the Control Panel ―Data Retention‖ section. The Data Security drop down box is where the administrator can specify the security and compression profiles. The user chooses to include a ―Data Configuration‖ policy. The user chooses to include a ―Backup Method‖ policy. © 2001-2008 AvePoint, Inc. All rights reserved. Page 113 The options available are: No Compression and Encryption Server Compression Server Encryption Server Compression and Encryption Client Compression Client Encryption Client Compression and Encryption The ―Backup Method‖ drop down box is where the administrator can specify the method to backup database. Here DocAve 4.5 supplies two options. One is VDI, the other one is VSS. The VDI method is selected by default. See the section below for a description of VDI/VSS. The user chooses to include a ―Password Protection‖ policy. The user checks the option for ―Copy Only.‖ The user can password lock the backup data by setting up a policy in the Control Panel. If a 3rd party Microsoft tool is backing up the same database, the Platform Level Backup module may conflict with the 3rd party tool. The ―Copy Only‖ option will use a special mode in order to backup the database. *Note: ―Copy Only‖ will allow the user to only execute full Platform Level backups. VDI versus VSS VDI option uses SQL Server Virtual Device Interface (VDI) to protect the SharePoint databases. It is a flexible stream based backup/restore method. VSS option uses Microsoft Volume Shadow Copy Service (VSS) snapshot technology. A VSS Backup will have less impact on the SQL server because the length of time to perform the snapshot is usually much shorter than a regular backup. In addition, it does not need to pause the SharePoint indexing crawl during backup. In order to use the VSS option for the Platform Level Backup module please make sure that the following SharePoint hotfixes are applied: http://support.microsoft.com/kb/940349/ - VSS update for Windows Server 2003 http://support.microsoft.com/kb/934525/ - Security Update for SPS 3.0 http://support.microsoft.com/kb/937832/ - Security Update for SPS 2007 *Note: If the first backup run is a differential or incremental backup, it will be forced to run as a full backup. After changing the attribute of a plan, such as adding a database, changing it into copy-only, etc, you should save this plan again. VSS supports multi-plan parallel running. Although you can create a multi-plan to assign the task, these plans cannot be run at the same time. VSS cannot support SQL Server Cluster 2000 VSS cannot backup SharePoint Learning Kit © 2001-2008 AvePoint, Inc. All rights reserved. Page 114 DocAve 4.5 does not support SSP differential restore due to a known Microsoft VSS issue. If the users select the differential or incremental node on the restore GUI, the related nodes for SSP are not available. The following is a comparison chart to help decide which method best fits your needs: 1 2 3 4 5 6 7 8 9 Feature Backup‘s impact on SQL server SQL 2005 support SQL 2000 support Out of place restore (db, index) Pause index crawl during backup SPDR-HA log shipping from Platform Level Backup Requires SharePoint hotfix SSP restore from differential backup Multiple plans run in parallel VDI VSS Small Full, Diff., Incr. Full, Diff., Incr. Yes Yes Minimal Full, Diff., Incr. Full, Incr. No No Yes No No Yes Yes Yes No Yes 4.2.3.2 Selecting Content on the Data Tree After completing the configuration of the common backup options listed in the previous section, proceed on to selecting the data to be backed up. Steps Actions 1 On the backup tree builder window, name of the Agent Host selected should be displayed in the area directly underneath. Clicking on the Agent displays the SharePoint Farm topology. 2 The expanded tree mode lists the ―SharePoint_Config,‖ ―Windows SharePoint Services Web Application,‖ ―WSS_Content,‖ ―WSS_Administration,‖ ―SSP,‖ ―Global Search Settings,‖ ―InfoPath Form Services ,‖ ―Solutions,‖ ―FBA Databases,‖ ―SLK DB,‖ ―SSO,‖ ―Windows SharePoint Solutions‖ and SharePoint ―Front-End Web Servers.‖ Except for the SharePoint Front-End Web Servers, the tree can be expanded to the lowest level. For each selected level: If… © 2001-2008 AvePoint, Inc. All rights reserved. Page 115 Then... SharePoint_Config It will display the SharePoint configuration database. Windows SharePoint Services Web Application It will display the SharePoint Web Application and the web application‘s Content Database(s). WSS_Administrator It will display the WSS_Administrator database. Global Search Settings It will display the Global Search Setting database. Shared Services It will display the SharePoint Shared Service Provider (SSP) related components, including SSP database, search database and index. If project server is installed, project server databases are also listed under SSP. Windows SharePoint Solutions It will display the SharePoint solution‘s installation files. InfoPath Form Services It will display all the form templates that are installed on the SharePoint Web Front End and Form Services Configuration. FBA Database It will display the form authentication databases and web applications‘ config information in ―config.xml.‖ Front-End Web Servers It will display the IIS settings, SharePoint template hive, custom features, and custom site definitions. File system folders can also be expanded and included. SharePoint Learning Kit (SLK) This will display the SLK database that has been applied on the SharePoint farm. © 2001-2008 AvePoint, Inc. All rights reserved. Page 116 IIS Settings 3 In order to back up the IIS, website properties, files, and settings must all be backed up together. See the section below for more details. There is a check box corresponding to each level on the data tree, the box is unchecked by default. Checking the box indicates that all content on that level and underneath that level will be backed up. *Note: DocAve 4.5 supports SSP and Project Server backup and restore. In order to run a Project Web Access (PWA) backup and restore, the PWA, the web application to which the PWA belongs, and the databases located beneath the PWA must be selected (see the picture below): If the items mentioned are not all selected, the PWA site cannot be used after the restore. PWA also supports out-of-place restores. Backup of IIS Settings In order to perform a backup of IIS settings, back up all the necessary components using the steps below: Step Action Backup the Website Properties by selecting the ―SharePoint Central Administration‖ node under the IIS tree. 1 This will create three files in the job folder called ―website.xml‖, ―appPool.xml‖, and ―Rootwebsite.xml‖ to record the configuration of the IIS. All of this metadata is stored in the media server. © 2001-2008 AvePoint, Inc. All rights reserved. Page 117 Backup the Security and Files in the IIS path. This is represented by the ―Local Disk‖ folder under the ―SharePoint Central Administration‖ node under the IIS Tree. 2 The folder ―C:\Inetpub\wwwroot\wss\VirtualDirectories‖ will be backed up in this step. This includes the ISAPI Filter, securities, web application directory, and many other items. Backup the IIS settings by checking the corresponding node for the tree: 3 This will backup all global properties and configurations for IIS. Three files are created and stored as metadata: ―Global.xml‖ : Properties that are global to the ―www‖ service ―GlobalIISAppPool.xml‖ : Properties that are global to all application pools ―Info.xml‖ : properties that are global to all web sites. 4.2.3.3 Scheduling a Backup Job After selecting the data content to be backed up, specify the frequency of the backup job. Step 1 Action Select a ―Schedule‖ from the carousel. You can have up to six different schedules set at once. © 2001-2008 AvePoint, Inc. All rights reserved. Page 118 2 3 Uncheck the ―No Schedule‖ check box to activate a Schedule. Inactive schedules are highlighted in red, active ones will be highlighted in blue. By selecting the ―Restore Granularity Level‖ checkbox, you can set the level of granularity on restore. Choosing the Item or Item Version level will allow you to restore individual files and file versions during a Platform Level restore. *Note: Generating index files to increase restore granularity will result in longer indexing times for each backup job. Select a Backup Type for the current schedule. Full A full backup of the selected source. Incremental This backup will track the transfer log changes. Differential This will create a partial backup where only database file changes are saved. 4 *Note: Frequent consecutive differential backups have a tendency to backup the same data over and over again and fill server space quickly. For best results in high frequency backups, please use incremental backups. Incremental data saves time and storage space by backing up only the differences between incremental backups, instead of backing up the entire source location. 5 Click on the calendar icon to the right of the ―Start Time‖ field. 6 Select a date and time in the calendar pop-up window and click ―OK.‖ Specify the interval at which the backup will occur. Choices are: Only Once, By Hour, By Day, By Week, or By Month. 7 If … Then … Only Once This will only run once at the specified time. © 2001-2008 AvePoint, Inc. All rights reserved. Page 119 By Hour Either choose this plan to run every set number of hours, or select it to run at specific hours, with the number of minutes past the hour specified by the user in the space provided. Be sure to select either ―AM‖ or ―PM‖ before choosing from the provided hours below. By Day Either set the plan to run every set number of days, or set the plan to run on weekdays or weekends. By Week Either set the plan to run every set number of weeks, or choose the days of the week to re-run this plan. By Month You can choose this plan to run on every set date of every month in the space provided (i.e., on the ―14‖th of every month). You can also set this plan to run in set months of the year, on certain days/weeks of the year. 8 To create another schedule, click on an open Schedule in the carousel and repeat steps 1-7. Otherwise proceed to step 9. 9 Save the plan by clicking on ―Save As‖ and provide a plan name. After the plan has successfully been saved, it will be displayed in the narrow column area on the left. *Note: For an Incremental or Differential backup, a Full backup should be included within the same plan by including it in another available Schedule. The Incremental and Differential require a Full backup in order to function properly. We recommend using Schedule A as a Full backup on Sunday and Schedule B as an Incremental backup every day until Saturday. 4.2.4 Restore Controller After a backup job successfully completes, the backup data is ready for browsing. To perform a restore, click the ―Restore Controller‖ under ―Platform Level Backup‖ to begin browsing the backup data. © 2001-2008 AvePoint, Inc. All rights reserved. Page 120 4.2.4.1 Choosing a Plan through the Job Browser Steps Actions 1 Across the top of the GUI, locate the section that is titled ―Backup Job Browser.‖ 2 Click on the Media Server. 3 Select the Agent Host. 4 Select the backup plan from which data needs to be restored. 5 Select the date that the backup plan was run to retrieve the data. 6 From the ―Backup Data Browser‖ below, select the farm name to expand the tree. 7 If the Platform Level backup plan has been specified to run on a level lower than the Content Database, you can select the ―Detail‖ button to open a pop-up containing all contents. 8 Browse the tree in the pop-up to locate the data you would like to recover. Clicking the ―.‖ Will expand the contents under each root directory. *Note: The tree will only expand to the backup level previously selected when designing the Platform Level Backup plan. 9 Select the content that you wish to restore using the space provided. All items / item versions will be listed in the area on the right. 10 For large environments, you may limit the results displayed in either tree using the ―Search‖ button. You are limited to the ―Sites‖ level on the main tree, but the ―Details‖ view allows you to search on all levels. © 2001-2008 AvePoint, Inc. All rights reserved. Page 121 4.2.4.2 Specifying the Type of Restore Steps Actions Select either an ―In Place‖ restore or ―Out of Place‖ restore by selecting the corresponding options in the window. 1 If … Then … In Place Select either an individual Agent or a Group to restore the data to from the drop-down list. Out of Place Please refer to the section on ―Out of Place Restore‖ below. 2 Next to the ―Destination Agent Host‖ tab is the ―Safe Restore‖ option. After backing up the database using the VDI method and choosing the ―Overwrite‖ restore option, this option can be used. In ―Safe Restore,‖ the Platform Level Backup module will restore to a temporary database first to ensure the success of the restore. 3 After selecting the restore type, an administrator can fill out the schedule section if restore needs to be run at a later time. To run the restore immediately, select the ―Go‖ button. Select a ―Restore Option.‖ If … Then … DocAve will not restore the content if it already exists on the destination. 4 Not Overwrite Overwrite © 2001-2008 AvePoint, Inc. All rights reserved. Page 122 For example, if an entire Web Application is selected for restore, but content already exists in the SharePoint farm, it will not be overwritten by the data from the backup. DocAve will restore the content over whatever exists on the destination. This will delete the content on the destination and replace it with the content selected to be restored. 5 1. Select any of the optional Advanced Settings available by clicking on the ―Advanced‖ button. If … Then … Platform Level Backup will restore the databases to the database server, but will not make the connections with the database to the SharePoint environment. 2. ―Restore Databases Only‖ This is useful for when the SharePoint environment is not setup yet (i.e. during a whole farm restore), or for cases where user wants to perform manual steps of bringing up or down specific environments after the database restore. *Note: Configuration databases and Central Administration databases can only be restored by selecting this option. The Platform Level Backup solution will restore the databases to the most recent state if the SQL transaction logs are still available on server. ―Restore Databases to Most Recent State‖ For example, if a backup job completed at 1:00 PM and the database server crashes at 2:00 PM. Platform Level Backup will try to restore the databases to the most recent functioning state (at 1:59 PM) even though the last backup data is from 1:00 PM. This option allows you to specify the location to restore the front-end files (This will include the SharePoint templates and extra file system folders). 3. ―Restore Front-End Files‖ If the folder specified does not exist, Platform Level Backup will create the folder on each front-end Server to restore the files. *Note: By default, if no location is entered, the Platform Level Backup will restore the files to the original locations. If the file exists, Platform Level © 2001-2008 AvePoint, Inc. All rights reserved. Page 123 Backup will proceed to overwrite the old file, however if the file is in use it will be skipped. 6 Once the restore settings are configured, click the ―Go‖ button and Platform Level Backup will begin the restore process or schedule the restore job to be executed at a later time. 4.2.4.3 Out of Place Restore The out of place restore feature allows the user to copy the data from one SharePoint farm over to another farm. *Note: The SharePoint Learning Kit (SLK) is not compatible with the out-of-place restore function. Steps Actions 1 After following the steps to select the backup data, select the ―Out of Place‖ option for the restore. 2 A new window will appear labeled ―Destination Component Options.‖ In the drop down box, please select the ―Destination Agent Host.‖ Click on ―Set Restore Parameter.‖ Depending on the source selection, the user will have a different set of parameters. If … Then … If the user selected the source to be just a ―Database.‖ The user must provide the following information: Database Server – the name of the database server where the database will be moved to. Database Name – the new database name you will give on the destination server. Database Location – the file location of the database Parent WebApp URL – the web application on SharePoint where you will attach the database. Windows Authentication – this is a TRUE 3 © 2001-2008 AvePoint, Inc. All rights reserved. Page 124 and FALSE drop down box for the Windows Authentication. Database User – specify the database user if the DocAve Agent does not have an account with administrative rights to the SQL server. Database Password - specify the database user password if the DocAve Agent does not have an account with administrative rights to SQL. If the user selected the source to be just a ―Web Application.‖ The user must provide the following information: ―Zone‖ : The backup zone of the web application ―Description‖ : The new name of the web application ―Port‖ : The new port of the web application ―Host Header‖ : The host header of the web application ―Path‖ : The IIS path of the web application ―Load Balance URL‖ : The new URL for the web application ―App Pool User‖ : The Application pool user for the new web application ―App Pool Password‖ : This will be the Application pool user‘s password If the user selected the source to be both a ―Web Application‖ the “Web Application‘s Content Database.‖ The user must then provide the information from both the Web Application and Database sections. 4 Select all ―Restore Options‖ and ―Advanced‖ settings listed in the previous section. 5 After selecting the restore type, the administrator can fill out the schedule section if restore needs to be run at a later time. To run the restore immediately, select ―Go.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 125 Front-End Web Out of Place Restore DocAve 4.5 Platform Level Backup supports backup and restore Front-End Web. Different from other restores, when ―Front-End Web Feature‖ is specified in the backup plan to restore, the settings in the ―Advanced‖ tab cannot not be selected. To perform a Front-End Web Out of Place Restore, please proceed as follows: Steps Action 1 Specify the plan you want to restore. 2 Select the ―Out of Place‖ option. There will display a section on the right called ―Destination Component Options.‖ 3 Select the Member Agent Host in the drop down box. 4 Click on the Agent Host name. 5 Expand the tree mode to the location you want to restore and select the option of the corresponding location. 6 After selecting the restore type, the schedule can be set for a later restore. 7 To run the restore immediately, click the ―Go‖ button. *Note: The restore location for the ―Front-End Web‖ should be specified in the same template as in the backup or the ―Extra File System Folders.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 126 4.2.5 Currently Supported and Unsupported Elements for Platform Level Backup For this table: "Y" means this feature is supported "N" means this feature is not supported "N/A" means this environment is not available for this backup method "DB Only" means must use the ―Database Only‖ method to restore "Any" means you can use any type backup (full, differential, and incremental) Backup Method Backup Components VDI VSS Copy Only ConfigDB Y Y Y CA Content DB Y Y Y Content DB Y Y Y Web Application Y Y N/A Project Server Y Y Y SSP Y Y Y SSO Y Y Y Global Search Setting Y Y N/A SP Solution Y Y N/A FBA DB Y N/A Y SLK DB Y N/A Y Infopath Template Y Y N/A Infopath Services Y Y N/A IIS Setting Y Y N/A SP Template Y Y N/A Customer Feature Y Y N/A Site Definition Y Y N/A File System Y Y N/A Restore Method DB Only Restore Most Recent Restore Safe Restore Overwrite Not Overwrite Cross Restore Schedule Restore © 2001-2008 AvePoint, Inc. All rights reserved. Page 127 VDI Y Y Y Y Y Y Y Backup Method VSS Y Y Y N/A N/A N Y Copy Only Y N/A N/A N/A N/A N/A Y Environment SQL2000 SQL2005 SQL2000Cluster SQL2005Cluster Inter Farm SSO BDC Authentication Form Authentication Security Server Compression Server Encryption Server Compression and Encryption Client Compression Client Encryption Client Compression and Encryption VDI Y Y Y Y Y Y Y Backup Method VSS Y Y N Y N N N VDI Y Y Backup Method VSS Copy Only Y Y Y Y Copy Only N/A Y N/A Y N/A N/A N/A Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y VDI Restore VSS Copy Only ConfigDB DB Only DB Only DB Only CA Content DB DB Only DB Only DB Only Content DB Web Application Project Server Any Any Any Any Any Full Backup Full Backup Full Backup Full Backup SSP Full and Differential Backup Full Backup Full Backup SSO Global Search Setting SP Solution Infopath Template FBA DB Any N/A N/A N/A Any Any N/A N/A N/A N Full Backup N/A N/A N/A Full Backup Data Protection Password Backup Components © 2001-2008 AvePoint, Inc. All rights reserved. Page 128 SLK DB Infopath Services IIS Setting SP Template Customer Feature Site Definition File System Comment: Any N Full Backup N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A "N/A" means the component is not available for DB, it will always perform a full backup, even if differential or incremental backup method is selected. 4.3 High Availability (SPDR) As a note, High Availability is also listed as ―SPDR‖ in the Data Protection module of DocAve for SharePoint 2003. 4.3.1 Introduction The DocAve ―High Availability‖ module is a ―one-switch‖ disaster recovery solution for Microsoft Windows SharePoint Services, Microsoft SharePoint Server, and Microsoft Project Server. It enables SQL database replication to a standby environment in order to minimize downtime. The High Availability module provides disaster recovery on the content database level. Main features of the High Availability module are: • Full, scheduled, or up to the minute replication of content databases to a standby SQL server. • Industry strength data-packet level fault tolerance to ensure full fidelity data replications over any network. • Offers ―point & click‖ simplicity to SQL server replication and disaster recovery. • Ensures minimal downtime disaster coverage of multiple SharePoint environments to any standby SQL server or across multiple online production SQL servers. • Central administration of all disaster recovery tasks, database replication scheduling / monitoring / reporting, software patch and license management, user account management, and software agent management across multiple SharePoint servers from a single ―accessible-from-anywhere‖ web interface. Please note that currently the SharePoint High Availability module is not compatible with SQL Express. © 2001-2008 AvePoint, Inc. All rights reserved. Page 129 4.3.2 Installation of the DocAve 4.5 High Availability module Below is a sample configuration of a SharePoint Farm using DocAve 4.5 High Availability. To install the DocAve High Availability module, please follow the instructions below. Steps Actions 1 Please make sure that there are DocAve clients installed on the SharePoint Web Front-End (WFE) and the SharePoint SQL back-end. 2 Log onto the production SharePoint WFE. 3 Under Windows, proceed to Start All Programs AvePoint DocAve 4.5 DocAve 4.5 Client Tools VaultClient Client Configuration Tool. © 2001-2008 AvePoint, Inc. All rights reserved. Page 130 4 Please make sure that the checkbox for the High Availability Sync Agent has been checked. 5 Log onto the production SharePoint SQL back-end. 6 Proceed to StartAll ProgramsAvePoint DocAve 4.5Client ToolsVaultClientClient Configuration Tool. 7 Please make sure that in the check boxes below that the High Availability SQL Agent has been checked. 8 Log onto the standby SharePoint WFE. 9 Proceed to StartAll ProgramsAvePoint DocAve 4.5Client ToolsVaultClientClient Configuration Tool. 10 Please make sure that in the check boxes below that the High Availability Sync Agent has been checked. 11 Log onto the standby SharePoint SQL back-end. 12 Proceed to StartAll ProgramsAvePoint DocAve 4.5Client ToolsVaultClient Client Configuration Tool. 13 Please make sure that in the check boxes below that the High Availability SQL Agent has been checked. 4.3.3 Preparation: Setting the temporary staging location The DocAve 4.5 High Availability module will initially replicate the database to a temporary staging © 2001-2008 AvePoint, Inc. All rights reserved. Page 131 location before it is fully replicated into the standby SQL server. The requirements for this are located in the troubleshooting section. If there is not enough space on the SQL server to store the data, then the temporary staging location can be modified in the Agent Monitor of the Control Panel, and a separate local or network drive can be assigned as the staging location: Steps Actions 1 Log-in to the DocAve 4.5 GUI. 2 Access the ―Control Panel‖ ―Control Services‖ ―Agent Monitor‖ section. 3 Select the DocAve Agent by clicking on the name in the left panel. 4 Find the ―Data Location Settings‖ section on the lower part of the GUI. Select the ―Location Type‖ (Local or Network). If … Then … Local Drive Provide the path to the new staging location. This entry should be in the ―c:\directory‖ format 5 Network Drive 6 1. Provide the full UNC path to the new staging location. This should be in the ―\\<servername>\<sharename>\<directory>‖ format. 2. Enter the information for an account with write permissions to the network share in the space provided. Once the appropriate fields are filled in, click ―Save‖ to apply the changes. © 2001-2008 AvePoint, Inc. All rights reserved. Page 132 4.3.4 High Availability Backup Builder In order to begin creating the High Availability (HA) plan, go to the ―Data Protection‖ tab in the DocAve 4.5 GUI and select ―High Availability‖ ―Backup Builder.‖ 4.3.4.1 General Settings The following are general settings for High Availability: ―Email Notification‖ : At the top of the main screen, an email notification alert drop down box is available. This allows an administrator to receive status notifications via email of the High Availability replication job. To configure the email notification setting, please refer to the DocAve 4.5 Control Panel User Guide. ―Password‖ : To encrypt the High Availability backup data, select the check box next and enter a password for data encryption. When you want to restore this backup data, you should enter this password again. ―Compression‖ : Selecting this checkbox will compress the backup data before migrating and decompressed after migration. This will greatly enhance the speed of the migration process. ―Encryption‖ : Selecting this checkbox. It enables the administrators to encrypt the data during the transfer of the replication. ―Throttle Control‖ : Click on Throttle button, open a pop-up. This function will enable you to specify what network bandwidth you want to use for the replication process. Select the Enable, and input a positive integer in the input field. If uncheck the Enable, it will use the entire bandwidth to transfer the data between the product server and standby SQL server. *Note: Data password, Compression, Encryption and Throttle Control only can be used when the users selected sync method is Log shipping or SQL Mirroring. 4.3.4.2 Choosing the Source Content Steps © 2001-2008 AvePoint, Inc. All rights reserved. Page 133 Actions In the ―High Availability Backup Builder,‖ under the ―Production Server‖ section, select a farm from the ―SharePoint Agent Host‖ menu. 1 *Note: This may take a few moments to load in the ―Farm Component Root‖ section below. 2 Expand the ―Farm Component Root‖ section and the web applications and corresponding content databases available for backup will be displayed. 3 The user can then select a Web Application, SSO or SSP to replicate over to the standby SQL server. 4.3.4.3 Choosing the Sync Method Under the ―Production Server‖ section, you can select the Sync Method to use between the two servers: If … Then … This option will do a replication at the log level. Log Shipping This level of replication will only be up to date by a few hours. This option will do a replication at the transaction level. SQL Mirroring Log Shipping from Platform Level Backup This level of replication will only be up to date by an hour or less, but this level of replication requires three times the log generation speed. This means that the network transfer speed between production and standby should be faster than 3 times the log generation speed on production. For example, if production server produces 1GB worth of logs per day, the network should be able to transfer at least 3GB per day. This sync method will allow the Platform Level Backup module and the High Availability module to backup/replicate the same database. This sync method will require the user to run a Platform Level Backup of the database. The High Availability module can execute the Platform Level © 2001-2008 AvePoint, Inc. All rights reserved. Page 134 Backup directly from this module. In order to do this, select ―Dump to a Location‖ and press the ―Set Location‖ button that appears. A pop-up window will appear. Specify the Platform Level Backup dump location as either a local or network location using the drop-down list. If a local location is selected, you will see the appropriate Media Server below. If you choose to dump to a network location, enter the appropriate information in the fields provided. Select ―Test‖ if it is a network drive, or select ―OK‖ to confirm. *Note: ―Log Shipping from Platform Level Backup‖ can only support backups that have been executed using the VDI method. For more information, please see the Platform Level Backup section of this user guide. This option will do a Log Shipping backup and place the backup on the DocAve SQL Agent‘s staging location. Dump to A Local Location Administrators will then have to create a ―Load From Location‖ rule to copy the dumped data from the staging location into the standby SQL server. 4.3.4.4 Choosing the Stand-By SQL Server Steps Actions 1 Proceed to the ―Stand-By Server‖ section. 2 From the ―SQL Agent Host‖ drop down box, select a destination SQL machine to replicate the databases to. 3 After selecting an Agent Host, the ―SQL Instance‖ drop down box will populate. © 2001-2008 AvePoint, Inc. All rights reserved. Page 135 4 If … Then … There is no instance name. Select the Default Instance from the drop-down box. There is an instance name or multiple instance names. Select the destination instance from the drop-down box. If the replication was executed with a ―Dump to A Local Location‖, check the ―Load From Remote Location‖ option. *Note: The source and destination staging folders cannot be the same for SP2003 SPDR. 4.3.4.5 Setting up the Scheduling Carousel Steps Actions 1 Select a ―Schedule‖ from the carousel. You can have up to six different schedules set at once. 2 Uncheck the ―No Schedule‖ check box to activate a Schedule. Inactive schedules are highlighted in red, active ones will be highlighted in blue. Select a ―Snyc Level‖ for the current schedule. 3 If … Then ... Full High Availability will replicate data from the production database to the standby database. Incremental High Availability will replicate only the transaction log changes. 1. It is recommended to only create an incremental schedule. After the first initial full SQL replication (which can be selected and ―Run Now‖), only incremental scheduled jobs will be needed. © 2001-2008 AvePoint, Inc. All rights reserved. Page 136 *Note: If the ―Sync Method‖ is set to ―SQL Mirroring‖ then only the full replication option will be available. 4 Click on the calendar icon to the right of the ―Start Time‖ field. 5 Select a date and time in the calendar pop-up window and click ―OK.‖ Specify the interval at which the backup will occur. Choices are: Only Once, By Hour, By Day, By Week, or By Month, or Always Run. If … Then … Only Once This will only run once at the specified time. By Hour Either choose this plan to run every set number of hours, or select it to run at specific hours, with the number of minutes past the hour specified by the user in the space provided. Be sure to select either ―AM‖ or ―PM‖ before choosing from the provided hours below. By Day Either set the plan to run every set number of days, or set the plan to run on weekdays or weekends. By Week Either set the plan to run every set number of weeks, or choose the days of the week to re-run this plan. By Month You can choose this plan to run on every set date of every month in the space provided (i.e., on the ―14‖th of every month). You can also set this plan to run in set months of the year, on certain days/weeks of the year. Always Run This option will allow the mirroring to occur every minute. 6 © 2001-2008 AvePoint, Inc. All rights reserved. Page 137 7 To create another schedule, click on an open Schedule in the carousel and repeat steps 1-5. Otherwise proceed to step 8. 8 Save the plan by clicking on ―Save As‖ and provide a plan name. After the plan has successfully been saved, it will be displayed in the narrow column area on the left under the title ―SPDR-HA Sync Plan.‖ 4.3.5 High Availability Restore Controller The High Availability ―Restore Controller‖ consists of the following features: ―Bring Online‖ and ―Bring Offline.‖ 4.3.5.1 Bringing the Database Online The High Availability Restore Control module enables administrators to bring the replicated SQL databases online or offline. An administrator will need to create the virtual servers on the standby SharePoint server prior to bringing the database online. To bring a database online, perform the following: Steps Actions 1 In the High Availability ―Restore Controller,‖ select the ―Bring Online‖ tab from the top. 2 Select the High Availability ―SPDR Agent Host‖ from the drop-down list. Select the desired ―Farm Component Type‖ from the drop-down list: either the ―Web Application,‖ ―SSP,‖ or ―SSO.‖ 3 If … Then … SSP or SSO are selected. Select the SQL Agent Host and the SSO or SSP server under the ―Database Root‖ listed below. © 2001-2008 AvePoint, Inc. All rights reserved. Page 138 Web Application Select the Web Application from the corresponding drop-down list. 4 Select the SQL Agent Host. If the security information is the same as that already used by DocAve‘s disaster recovery, select the ―integrated security‖ option. Otherwise, enter the necessary information in the SQL User name and password fields. 5 Select a Database under the ―Database Root‖ listed below. 6 Select the databases to bring Online and click the ―Bring Online‖ button. 4.3.5.2 Bringing the Database Offline To bring a database offline, click on the ―Bring Offline‖ tab and perform the following: Steps Actions 1 Select the High Availability ―SPDR Agent Host‖ and the SharePoint ―Web Application‖ from the drop-down lists. 2 Select the Database under the ―Database Root‖ tree below. 3 Click the ―Bring Offline‖ button and it will notify the administrator that the SQL database has been successfully taken offline. The SharePoint content will no longer be visible. 4.3.6 Helpful Notes on High Availability This section will focus on several tips to fully utilize the High Availability solution. © 2001-2008 AvePoint, Inc. All rights reserved. Page 139 4.3.6.1 Replicating SSO databases In the situation where an attempt is made to replicate SSO databases but fails: Check the domains of the two machines hosting the SharePoint environment. If the source and destination machines are on the same domain, then the end user will not be able to replicate the SSO databases. The reason for this is that DocAve will use native Microsoft SharePoint API in order to replicate the SSO, but the current SharePoint API has a limitation that will not allow similar domain replications. 4.3.6.2 High Availability module and differing SQL versions In the situation when a replication fails: The first thing to check is the current version of the end user‘s SQL. The High Availability module works on the database level, but there are limits to working on that level. If the end user has two differing SQL versions, the High Availability module to fail during the replication process. For example, if the end user‘s production 2007 environment is using SQL 2000 and the development 2007 environment is using SQL 2005, a replication between environments is impossible because of the limitations of SQL. 4.3.6.3 Setting up for High Availability Mirroring In the situation that if High Availability Mirroring fails: Make sure that the fully qualified domain name of the DocAve Agents on both the production and the disaster recovery servers are reachable from each other. Configuring the fully qualified domain name can be done on either the DNS or the Host‘s file. 4.3.6.4 Log Shipping Versus SQL Mirroring This section will focus on the differences between Log Shipping and SQL Mirroring. The main difference between the two is that Log Shipping is a schedule based replication while SQL Mirroring is an event-driven (transaction level) replication. For Log Shipping, the data synchronization between the production and the standby environment is dependent on how frequently the replication can run and finish. If the user selects the ―Always Run‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 140 option, the data can be synchronized up to 10 to 20 minutes in difference. In normal situations, the difference between the production and the standby environment would be a difference of a few hours. SQL Mirroring is considered a transaction level replication which means that the standby database will be closely synched with the production database. *Note: Log Shipping is considered a ―warm standby,‖ SQL Mirroring is referred to as a ―hot standby.‖ 4.3.7 Troubleshooting High Availability Please refer to the scenarios below for common troubleshooting methods for the High Availability module. 4.3.7.1 General Information For simple troubleshooting needs: Make sure that the SQL Server that is installed on the production and the standby machines are using either the ―Standard‖ or ―Enterprise‖ editions. The High Availability module can only support these editions. High Availability (HA) SQL Mirroring can co-exist with the Platform Level Backup module. However, in order for the Platform Level Backup and the HA module to co-exist, the user must do the following: Steps Actions 1 Create a High Availability mirroring plan using the previous sections as a guide. 2 Execute the initial sync of the High Availability mirroring. © 2001-2008 AvePoint, Inc. All rights reserved. Page 141 3 Proceed to run a Platform Level full backup. *Note: If the user brings online the standby environment, then the High Availability SQL Mirroring must be synched again before attempting any other Platform Level Backups. In order for High Availability to work, the database must be in ―full‖ Recovery model, otherwise the replication will fail. However, please note that the SQL database being on ―Full‖ Recovery will require more administrative overhead in order to manage the log growth. 4.3.7.2 Failure in loading the nodes on the High Availability module If the account configuration information in the DocAve "Control Panel‖ ―Agent Monitor‖ does not have administrative rights to the SQL server, the nodes will fail to load in the High Availability plan builder. 4.3.7.3 If there are errors in the DocAve Agent Event Viewer There may be issues with the DocAve temporary staging location. Please refer to the scenarios below: Full Sync job requirements: Please make sure that the production High Availability (HA) SQL Agent‘s staging location contains enough hard disk space to cover the database backup size (with a 1 GB buffer). For example, if the database backup size is 3 GB, make sure that the overall production HA SQL Agent staging location contains a total of 4 GB of free space. If the user decides to configure the standby HA SQL Agent‘s staging location to be stored on the same drive as the acutal SQL database files, make sure that there is enough hard disk space to cover the database backup size: the actual database size plus a 1 GB buffer. For example, if the database size is 4 GB and the database backup size is 3 GB, the hard disk must have a total of 8 GB free. Incremental Sync job requirements: Make sure that the production HA SQL Agent‘s staging location contains enough hard disk space to cover the log backup size with a 1 GB buffer. © 2001-2008 AvePoint, Inc. All rights reserved. Page 142 For example, if the log backup size is 1 GB, the user must make sure that the overall production HA SQL Agent staging location contains a total of 2 GB of free space. On the standby HA SQL Agent‘s staging location, make sure there is enough hard disk space to cover the log backup size with a 1 GB buffer. For example if the database size is 1 GB, make sure that the overall staging HA SQL Agent location contains a total of 2 GB of free space. Using a Network Location: If you want to use a network location to store temporary backup or restore data, please make sure to enaple the ―xp_cmdshell‖ on the Microsoft SQL Server 2005 Surface Area Configuration. 4.3.7.4 Log Shipping Please refer to the information below for information on the High Availability Log Shipping option: After the ―Log Shipping‖ replication completes, the SQL database will show as ―Standby‖ on the SQL Management Studio. If the database already exists on the standby SQL server, the sync job will fail with the error ―the database already exists.‖ In this case, please manually delete the database on the standby server and try again. Please make sure that the database recovery model is not set to ―Simple‖ recovery model or the ―Bulk Logged‖ recovery model. Currently, the High Availability Log Shipping option will not support the ―Simple‖ Recovery model or the ―Bulk Logged‖ Recovery model. 4.3.7.5 SQL Mirroring Please refer to the information below for information on the High Availability SQL Mirroring option: After the mirroring has completed, the database status on the standby database will be marked as ―Principal,‖ and the database status will be marked as ―Mirror.‖ In order to use the SQL Mirroring option, make sure that the production SQL and the standby SQL are using SQL Server 2005 with the same edition and version. © 2001-2008 AvePoint, Inc. All rights reserved. Page 143 Also please make sure that the SQL Server 2005 is using at least Service Pack 1. Finally if SQL Server 2005 x32 is installed, this will only support 10 databases for mirroring. This specification is actually a SQL Server 2005 limitation. If the SQL Mirroring option fails with the following error in the DocAve Agent eventViewer: ―The server network address "TCP://avepoint2007.msxml.com:5022" cannot be reached or does not exist. Check the network address name and that the ports for the local and remote endpoints are operational…‖ Then the user must clean up the failed mirroring. For this situation please consult an AvePoint technical support representative in order to walk you through the SQL mirroring clean up. You can also use the ―HAMirrorCleanUpTool‖ provided by technical support. 4.3.7.6 Log shipping from a Platform Level Backup The High Availability module can replicate from an existing Platform Level Backup (Full or Incremental) backup as mentioned previously. Please be aware of the following information: Log shipping from Platform Level Backup data can only be used if the Platform Level backup used the VDI method. High Availability and Platform Level Backup must use the latest data. If no there is no recent data (within the hour), the HA will report the error message: ―No recent backup data.‖ If the recovery model of the database is set to either ―Simple‖ or ―Bulk Logged,‖ using HA Log Shipping from a Platform Level Backup will only be successful the first time. Background information: Current SharePoint Disaster Recovery – Platform Level Backup and High Availability (HA) log shipping cannot co-exist because SQL databases can only have one backup thread. If both Platform Level Backup and HA log shipping are running on the same database, their backups will interfere with each other. Please see the Appendix below for more information. This new feature is added to address this limitation. In the mode when they both co-exist, database backup will be backed up by Platform Level Backup first, then the HA standby server will read backup © 2001-2008 AvePoint, Inc. All rights reserved. Page 144 data from media server to build standby databases. : Steps Action 1 Create the Log Shipping from Platform Level Backup plan 2 Execute the initial sync of the Log Shipping from Platform Level Backup *Note: Log shipping from Platform Level Backup does not support the ―Copy Only‖ option. If you select Copy Only to run a backup in Platform Level Backup, the backup data from Platform Level Backup cannot be used in HA Log shipping from Platform Level Backup. 4.3.7.7 Dump / Load from Staging Please use the following information to clarify the ―Dump‖ and ―Load From Staging‖ option for the High Availability module: Using the Log Shipping option, please make sure to copy the following file extensions from the production to the standby server: *.dump and *.dat. *Note this data will be stored on the SQL Agent‘s staging location. Using the SQL Mirroring option please make sure to copy the following file extensions from the production to the standby server: For DocAve 4.1.5.0 it will be a *.dump and *.dat; for DocAve 4.1.6.0 it will be *.dump, *.dat and *.log Please note this data will be stored on the SQL Agent‘s staging location. Using the Log Shipping from a Platform Level Backup dump, a folder will be created for the specific DocAve Media Server. The name rule used is: ―HA_media_name_planID_jobID‖ Please copy this folder from the product to the standby server. © 2001-2008 AvePoint, Inc. All rights reserved. Page 145 4.3.7.8 Bring Online Issues Please refer to the information below if there are issues in bringing a synched database online: If bringing online the Content Database fails, make sure that the there is a stable network connection to the database. Usually, if a ―Bring Online‖ of a Content Database fails, please refresh the GUI and attempt the process again. If the synched database cannot be loaded in the High Availability recovery controller then make sure that the database name does not already exist in MOSS 2007. Also please check that the standby HA SQL Agent‘s staging location contains the ―.cfg‖ file. This will be used for the ―Bring Online‖ process. If bringing online the SSO Database fails, make sure the following information is the same as the MOSS server: SSO Admin ID, SSO AppDef, and Admin ID (domain\username). Please make sure that Domain is the same as the MOSS server, otherwise this misconfiguration will cause an error. Make sure that the Microsoft Single Sign-on Service is open and opened by the domain user. If bringing online the SSP Database fails, make sure that the following information is correct: SSP Name, SSP Admin ID (domain\username) and the SSP Admin password. In general, make sure to enter all the information the same way as was used when creating the SSP in SharePoint Central Administration for the first time. If the wrong information has been entered then a DocAve pop-up will indicate an error in configuration. After bringing the SSP Database online, the administrator will have to start the SharePoint search services. 4.3.8 Currently Supported and Unsupported Elements for High Availability Source Web Type Log Shipping(FULL) Sync Method © 2001-2008 AvePoint, Inc. All rights reserved. Page 146 Status Known Issues Supported One DB can only Application do Full Log Shipping once Log Shipping(Incremental) Sync Method SQL Mirroring Sync Method Log Shipping From Platform Level Backup Sync Method Dumping & Loading Compress Sync DB with a Data Password Bring Offline a target side's Web Application Email Notification Bring Online with Windows Authentication Log Shipping From Platform Level Backup Sync Method Supported Supported Supported Supported Supported Supported Supported Supported Supported Bring Online with A User defined SQL Login Supported Throttle Control Encryption Supported Supported Platform Level Backup using "Server Compression" backup Platform Level Backup using "Server Encryption" backup Platform Level Backup using "Server Compression and Encryption" backup Platform Level Backup using "Client Compression" backup Platform Level Backup using "Client Encryption" backup Platform Level Backup using "Client Compression and Encryption" backup Platform Level Backup Backup With a "Password Protection" Platform Level Backup using "VDI" backup © 2001-2008 AvePoint, Inc. All rights reserved. Page 147 Requires Platform Level Backup 's Incremental backup data Supported Supported Supported Supported Supported Supported Supported Supported Requires the SQL Server use the mixed authentication mode Scheduled Jobs Platform Level Backup using "VSS" backup Platform Level Backup using "Copy Only" backup Not Supported Not Supported Log Shipping Sync Method SQL Mirroring Sync Method Log Shipping From Platform Level Backup Sync Method Supported Supported Bring Online Supported Not Supported Log Shipping(FULL) Sync Method Supported Log Shipping(Incremental) Sync Method Supported SQL Mirroring Sync Method Supported Log Shipping From Platform Level Backup Sync Method Supported SSP Dumping & Loading Compress Sync DB with a Data Password Email Notification Bring Online with Windows Authentication Supported Supported Supported Supported Supported Bring Online with A User defined SQL Login Supported Throttle Control Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 148 One DB can only do Full Log Shipping once Requires the Recovery Model of the SSP's SharedService DB is FULL Requires Platform Level Backup's Incremental backup data and the Recovery Model of the SSP's SharedService DB is FULL Requires the SQL Server use the mixed authentication mode Encryption Log Shipping(FULL) Sync Method Log Shipping(Incremental) Sync Method SQL Mirroring Sync Method Log Shipping From Platform Level Backup Sync Method SSO Dumping & Loading Compress Sync DB with a Data Password Email Notification Bring Online with Windows Authentication Supported Supported Supported Supported Supported Requires Platform Level Backup's Incremental backup data Supported Supported Supported Supported Supported Bring Online with A User defined SQL Login Supported Throttle Control Encryption Supported Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 149 One DB can only do Full Log Shipping once Requires the SQL Server use the mixed authentication mode 4.4 TrashBin for SPS2003 / WSS2.0 Some of the main features of DocAve‘s TrashBin solution includes: End-user initiated real time restore of deleted contents in SharePoint. Customized web part added onto a SharePoint site that allows the end-user to browse through the deleted data to restore on the fly. Full fidelity ―undelete‖ maintains all of the metadata, securities, and version histories. TrashBin is enabled/disabled by content database, capturing deletions events from all sites within that specific content database. Deleted content is not duplicated and therefore does not require additional disk space for storage. The overall architecture of the TrashBin product consists of two main parts: the ―TrashBin‖ option under the ―Data Protection‖ GUI within DocAve 4.5 and the ―TrashBin Web part‖ for the SharePoint environment. For the TrashBin to work properly, both of these parts need to be installed correctly in your environment. The ―TrashBin Administration GUI‖ is the central management interface for TrashBin across all the content databases in all the virtual servers that are located on one front-end SharePoint web server. TrashBin captures and stores all deleted data from all ―SharePoint Aware‖ applications. The TrashBin Administration GUI automatically discovers all the SharePoint virtual servers, backend SQL database instances, and all content databases for display. It also automatically detects the newly added SharePoint virtual servers, content databases, and SQL database instances. The customized TrashBin web part allows user to browse, select, and restore deleted documents. The administrator has to install the web part on the portal/virtual server where they want to use the TrashBin application. The Web part works on the front-end and allows the user to see the deleted data and manipulate it. In terms of security, a user can only view or recover items that they‘re given access rights to. 4.4.1 Installation 4.4.1.1 Enable TrashBin on DocAve Client Agent Before using the TrashBin solution, the Administrator must confirm that the ―TrashBin‖ solution is enabled on the DocAve Client Agent Host. To confirm that the TrashBin solution is enabled on the DocAve Client Agent Host, complete the following steps: © 2001-2008 AvePoint, Inc. All rights reserved. Page 150 Step Action 1 Proceed to SharePoint 2003 Front End where DocAve agent has been installed, open Client Configuration Tool found within DocAve Client Tools of the Start Menu. Check off DocAve TrashBin and click Confirm. 2 *Note: There is no TrashBin for MOSS 2007 4.4.1.2 Install TrashBin on Content Database This and the following sections refers to the TrashBin GUI. To install the TrashBin on the Content Database, please follow the steps below: Step Action 1 Within the DocAve 4.5 GUI, select ―Data Protection.‖ 2 Select the ―SP2003/WSS2.0‖ tab in the lower left corner. 3 Click on the ―TrashBin‖ tab. 4 Select your Agent Host from the drop-down list. 5 Select the ―Content Database‖ (Content DB) radio button. 6 Click on the SharePoint Server link, then the Virtual Server to display the Content DB. Place a check mark next to the Content DB to populate the information boxes on the right. © 2001-2008 AvePoint, Inc. All rights reserved. Page 151 7 Click on the ―Install TrashBin‖ button to install. 8 At this point, the administrator can setup the ―Pruning Rule‖ and the ―Schedules,‖ this will be explained more thoroughly in the ―TrashBin Administrator‖ section. Click the ―Save‖ button. 9 *Note: After installing the TrashBin, when you select the Content DB, the status will be set to ―Ready.‖ This means that the TrashBin is ready and operational. Users can use TrashBin to do deletion capture, and the TrashBin Web part for any restore operations 4.4.1.3 Install TrashBin Web part To install the TrashBin Web part, complete the following steps: Step 1 Action Within the ―SP2003/WSS2.0‖ ―TrashBin‖ tab, select the ―Install Web part‖ button after selecting the Agent Host. After you have installed the TrashBin Web part, Internet Information Services (IIS) must be restarted: 2 1. On the SharePoint Front-end Web Server, open up the Command Prompt by typing ―cmd‖ within Start menu Run. 2. In the Command Prompt, type ―iisreset /noforce‖ to stop and restart the internet services. *Note: Use the ―/noforce‖ parameter to help prevent data loss in case the IIS services cannot be stopped within the one minute time-out period. If you are certain that it is safe to force an IIS restart, you can omit the ―/noforce‖ parameter. However, be aware that you could lose data if you do not include this parameter. 3 Proceed to the SharePoint site where the administrator wants the TrashBin web part to be installed © 2001-2008 AvePoint, Inc. All rights reserved. Page 152 4 In the ―Actions‖ pane on the left side, click ―Edit Page.‖ 5 On the ―Modify Shared Page‖ menu (upper-right corner), point to ―Add Web parts,‖ followed by ―Browse.‖ 6 In the task pane, select the ―Virtual Server Gallery‖ link. 7 Under ―Web part List‖ in the task pane, drag the AvePoint TrashBin to a zone on the page. 8 Close the ―Add Web parts‖ window. 4.4.2 Un-installation In order to uninstall the DocAve TrashBin, you will need to first remove the TrashBin Web part, then uninstall the web part and TrashBin from the Content Database. 4.4.2.1 Uninstall the TrashBin Web part To uninstall the TrashBin Web part complete the following steps: Step Action 1 Proceed to the location where TrashBin Web part is installed and click on the drop down arrow associated within the ―AvePoint TrashBin Restore‖ section. 2 At this point, the TrashBin Web part will be highlighted with dashed lines. Click on the drop down arrow and select ―Delete.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 153 3 Within the ―SP2003/WSS2.0‖ tab of the DocAve GUI, highlight the ―TrashBin‖ tab. Select the proper virtual server‘s content, click the ―Uninstall Web part‖ button. After you have uninstalled the TrashBin Web part, Internet Information Services (IIS) must be restarted: 4 1. On the SharePoint Front-end Web Server, open up the Command Prompt by typing ―cmd‖ within Start menu Run. 2. In the Command Prompt, type ―iisreset /noforce‖ to stop and restart the internet services. *Note: Use the ―/noforce‖ parameter to help prevent data loss in case the IIS services cannot be stopped within the one minute time-out period. If you are certain that it is safe to force an IIS restart, you can omit the ―/noforce‖ parameter. However, be aware that you could lose data if you do not include this parameter. 4.4.2.2 Uninstall TrashBin on Content Database To uninstall TrashBin from the Content Database, complete the following steps. Step Action 1 Within the DocAve 4.5 GUI, select the ―Data Protection‖ tab. 2 Select ―SP2003/WSS2.0.‖. © 2001-2008 AvePoint, Inc. All rights reserved. Page 154 3 Click on the ―TrashBin‖ tab. 4 Select your Agent Host from the drop-down list. 5 Select the ―Content DB‖ radio button. 6 Click on the SharePoint Server link, then the Virtual Server to display the Content DB. Place a check mark next to the proper Content DB and this will populate the information boxes on the right. Click on the ―Uninstall TrashBin‖ button. 7 *Note: Uninstalling the TrashBin will set the Content DB status to ―Not Installed.‖ The user will not be able to use TrashBin Web part for any operations on the specific Content DB. 4.4.3 TrashBin Configuration 4.4.3.1 Administrative Account To administrate TrashBin, users should have full administrative privileges for DocAve, SharePoint Portal Server (or Windows SharePoint Server), and SQL Database. You can check the account setting follow the below steps: Step Action 1 Within the DocAve 4.5 GUI, select ―Control Panel.‖ 2 Navigate to ―Control Services‖ and find the ―Agent Monitor.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 155 3 Select the Agent on which to enable TrashBin. Detailed information pertaining to this DocAve Agent will load on the right. 4 Under the ―Account Configuration‖ section, make sure the account being used has full administrative privileges for the SharePoint Server and SQL Database. 4.4.3.2 Notification Email reports can be scheduled after each TrashBin pruning run so as to notify the administrator of successes or failures. Notification profiles must first be setup in the ―Control Panel‖ before selecting this option in TrashBin. Step Action 1 Within the DocAve 4.5 GUI, select ―Control Panel.‖ 2 Navigate to ―Reporting‖ and ―Email Notification.‖ Fill in the boxes according to the specifications in the ―Control Panel‖ section of this user guide. 3 Click on the ―Test Account Settings‖ to send a test e-mail. 4 Click ―Save As‖ to finish creating an email profile. 5 Under the TrashBin GUI, the ―Notification‖ drop-down list will now have the selected email profiles. 4.4.4 TrashBin Administration 4.4.4.1 Pruning Rule The administrator can setup TrashBin pruning rules so that any item deleted more than a specific number of hours, days, months, and weeks must be removed from TrashBin. It is wise to keep the length of the pruning rule small, preferably less than or equal to the expiration date. © 2001-2008 AvePoint, Inc. All rights reserved. Page 156 The ―TrashBin Quota‖ option works in conjunction with the duration (―How Long‖) set for the pruning rule. Therefore if the TrashBin data size is larger than TrashBin Quota size, the contents of the TrashBin will be deleted. Administrator can follow the below steps to setup the pruning rule: Step Action 1 Within the DocAve 4.5 GUI, select the ―Data Protection‖ ―SP2003/WSS2.0‖ ―TrashBin‖ tab. 2 Select your Agent Host from the drop-down list 3 Select the ―Content DB‖ radio button. 4 Click on the SharePoint Server link, then the Virtual Server to display the Content DB. Place a check mark next to the proper Content DB. 5 Proceed to the ―Pruning Rule‖ section, and set values for the ―How Long‖ and\or ―TrashBin Quota‖ pruning rules described above. 6 Press the ―Save‖ button after setting up the pruning rule. 4.4.4.2 Scheduling TrashBin pruning can be activated manually or at a designated time via pruning schedules. Un-checking the ―No Schedule‖ option will allow you to setup a pruning schedule. Pruning schedules specify the specific time of the day (or day of the week) that will activate a TrashBin pruning operation specified above. There is one schedule available per content database. Step © 2001-2008 AvePoint, Inc. All rights reserved. Page 157 Action 1 Within the DocAve 4.5 GUI, select the ―Data Protection‖ ―SP2003/WSS2.0‖ ―TrashBin‖ tab. 2 Select your Agent Host from the drop-down list. 3 Select the ―Content DB‖ radio button. 4 Click on the SharePoint Server link, then the Virtual Server to display the Content DB. Place a check mark next to the proper Content DB. 5 Choosing ―Select Time‖ under the Start Time option will bring up a calendar pop-up. Set the specific date and time you would like the pruning rules to be run. 6 The ―Interval‖ option will allow you to set the number of hours, days, and weeks to repeat this process. 7 Click the ―Save‖ button after the schedule is set. 4.4.4.3 Pause TrashBin The TrashBin should be paused if the SharePoint environment is undergoing any major topography changes, such as deleting entire site collections or moving sites/subsites to a different URL. TrashBin should only be resumed to capture deletion events from a user‘s normal operations. Step Action 1 Within the DocAve 4.5 GUI, select the ―Data Protection‖ ―SP2003/WSS2.0‖ ―TrashBin‖ tab. 2 Select your Agent Host from the drop-down list. © 2001-2008 AvePoint, Inc. All rights reserved. Page 158 3 Select the ―Content DB‖ radio button. 4 Click on the SharePoint Server link, then the Virtual Server to display the Content DB. Place a check mark next to the proper Content DB. Pressing the ―Pause TrashBin‖ button will set the Content DB to ―Paused‖ status. This suspends TrashBin from capturing all deletion events. 5 *Note: Users can still use TrashBin Web part for any restore operations during a TrashBin pause. 4.4.4.4 Clear TrashBin The Administrator can clear the TrashBin manually, regardless of the age of deleted documents, lists, or folders. Step Action 1 Within the DocAve 4.5 GUI, select the ―Data Protection‖ ―SP2003/WSS2.0‖ ―TrashBin‖ tab. 2 Select an Agent Host from the drop-down list. 3 Select the ―Content DB‖ radio button. 4 Click on the SharePoint Server link, then the Virtual Server to display the Content DB. Place a check mark next to the proper Content DB. Press the ―Clear TrashBin‖ button: 5 © 2001-2008 AvePoint, Inc. All rights reserved. Page 159 4.4.4.5 Multiple Content Database Manipulation With DocAve you can manipulate TrashBin settings for multiple content databases. You can apply all of these settings and features (Uninstall TrashBin, Pause TrashBin, Clear TrashBin, Pruning Rules and Schedules, etc.) to all or any content databases and run multiple actions. Step Action 1 Within the DocAve 4.5 GUI, select the ―Data Protection‖ ―SP2003/WSS2.0‖ ―TrashBin‖ tab. 2 Select an Agent Host from the drop-down list. 3 Select the ―Content DB‖ radio button. 4 Click on the SharePoint Server link, then the Virtual Server to display the Content DB. Using checkmarks, you can select which content database you would like to manipulate. 4.4.4.6 TrashBin Web part on SharePoint Site With DocAve you can manipulate TrashBin settings for multiple content databases. You can apply all of these settings and features (Uninstall TrashBin, Pause TrashBin, Clear TrashBin, Pruning Rules and Schedules, etc…) to all or any content database of your choice and run multiple actions. Step Action 1 Within the DocAve 4.5 GUI, select ―Data Protection‖. 2 Click on the ―SP2003/WSS2.0‖ tab. 3 Click on the ―TrashBin‖ tab. © 2001-2008 AvePoint, Inc. All rights reserved. Page 160 4 Select your Agent Host from the drop-down list 5 Select the content DB radio button 6 Click on the SharePoint Server link, then the Virtual Server to display the Content DB, Via checkmarks you can select which content database you would like to manipulate. 4.4.4.7 TrashBin Options on SharePoint Site Step 1 Action Click on ―AvePoint TrashBin Restore‖ under the ―Modify Shared Page‖ button. At this point you can change the Appearance, Layout, as well add other options accordingly. Below will give a brief overview of the ―Miscellaneous‖ option: ―HomeURL‖ – refers to a TrashBin Web part added on a MySite page. The HomeURL needs to be set to personal URL for TrashBin Web part to display deleted items. *Note: this should be done so the TrashBin users will not have to type in the proper URL every time TrashBin is accessed. 2 ―Remove Trash After Restore‖ – Removes items from TrashBin after a user initiated restore. This option is set by default. Copies of deleted documents will remain in the TrashBin until the administrator empties it from the DocAve GUI, or the item expired based on set expiration policies. ―Show Version and Attachment Detail Button‖ – Displays the ―Show Detail‖ button on the TrashBin Web part and allows the user to browse. © 2001-2008 AvePoint, Inc. All rights reserved. Page 161 5. Administration Jump to Table of Contents 5.1 Discovery The ―Discovery‖ module provides a real time overview of your SharePoint environment and automatically discovers new sites regardless of the numbers of servers. It provides information on server topology, functions, and roles in a graphic display. The module consists of three parts listed as tabs along the top of the ―Discovery‖ GUI: ―Farm topology,‖ ―Site Structure,‖ and ―Search.‖ The following sections will provide a detail explanation of each. 5.1.1 Farm Topology The first part of the ―Discovery‖ module is the ―Farm Topology.‖ Farm Topology provides you with detailed information about your DocAve Agents and SharePoint topology, such as server and SharePoint components installed and the status of SharePoint services on a specific SharePoint farm. 2 1 3 ―Area 1‖ – Displays all the farms in a list. *Note: If the farm name is too long to be shown, it will be clipped showing ―…‖ instead. You may view the entire name by hovering over the farm name. © 2001-2008 AvePoint, Inc. All rights reserved. Page 162 ―Area 2‖ – Displays the agent host names. It also allows you to zoom in and out on your topology by clicking the (+) and (-) icons. ―Area 3‖ – Displays the agent information including: Agent Name, System Environment, Microsoft Office SharePoint Server 2007 (MOSS 2007) Version and .NET Version. Once the farm icon is clicked in Area 2, the SharePoint services status will be displayed in this area. 5.1.2 Site Structure The second part of Discovery module is the ―Site Structure.‖ This tab will allow you to display the entire SharePoint environment in a tree structured view. You can use this option to view the environment down to the item level. *Note: When viewing extremely large environments, the tree may split into multiple pages. Click on the page number below to view additional content. 5.1.3 Search The third tab of the Discovery module is the ―Search‖ feature. This feature will allow you search for contents among all SharePoint agents, regardless of whether DocAve is installed or not. Step Action Select either ―Domain Mode‖ or ―IP Range Mode‖ for searching based on your needs. If… Then… In the space provided, enter the Domain Name, Username, and Password. You can also enable a ―Server Filter‖ using the corresponding checkbox. This field supports wildcards (*). 1 Domain Mode The following information will be displayed in the table below: © 2001-2008 AvePoint, Inc. All rights reserved. Page 163 ―Host Name‖ : The name of the agent. ―Username‖ and ―Password‖ : Here you may enter more specific username and password information if you have not been granted enough IP Range Mode permission to view the agent information in the search results based on the previous entry. ―OS‖ : This field will display detailed information on the Operating System running on the agent. You can use the triangle provided to show/hide the detailed information. Input a valid IP range in the fields provided. Enter a Username and Password for this field as well. The table below will be populated with the information you have input. 2 Press the ―Add‖ button to populate the search scope list below. 3 Use the checkbox next to each level to include in the agent search plan. 4 Select the ―Scan for SharePoint Instances‖ button to generate a list of all agents to the left. 5 The icon ― ‖ indicates that a DocAve agent has been installed on this instance. The ― ‖ icon will refresh the tree. The ― ‖ icon will remove this instance from the list. *Note: Once all of the agents have been scanned the information will be saved to a database. Refresh the trees as necessary to ensure that you have the most updated information. When browsing extremely large environments, the tree may be split across multiple pages. To browse these pages, click the ―Paging‖ icon at the top of the tree, followed by the page number from the list on the bottom of the page. 5.2 Replicator The ―Replicator‖ module allows the seamless migration of content from one location to another within Microsoft SharePoint 2007. This migration can be performed within the same SharePoint farm, or from one SharePoint farm to another. Replicator is a powerful tool and is considered real time, live copy because no backup is needed. Replicator allows the administrator to restructure the content and topology of his/her SharePoint environment easily and accurately. © 2001-2008 AvePoint, Inc. All rights reserved. Page 164 5.2.1 Replicator Installation Before using ―Replicator,‖ make sure that it is installed and enabled within the ―DocAve Agent Configuration Tool.‖ Under this tool, ensure the ―Replicator‖ option is selected for each agent. To properly use Replicator, a DocAve Agent should be installed on each front-end web server. This is required in order to perform cross farm migrations. 5.2.2 Layout, Features, and Options Replicator can copy specific content from one location to another. Although it does have scheduling options, it is not meant to perform ―automatic‖ real time replication of an entire SharePoint farm. For this type of replication, please see AvePoint‘s Data Protection module to enable scheduled backup. The key use of Replicator is to allow the administrator to copy documents, libraries, sites, etc. from one location to another seamlessly and quickly. Typically, the administrator must first backup the content and then perform an out of place restore. This requires the administrator to go through a two step process in order to copy content. With Replicator, the administrator has a simple and easy-to-use interface that allows the process to be done in one step. 5.2.3 General Settings DocAve 4.5 Replicator operates on the concept of plans. A previously created plan can be selected from the Plan Root, or a new plan can be created. The general fields for any plan are: ―Plan Name‖: This lists the plan name if a specific plan was selected. It will read ―[New Plan]‖ by default if the current plan has not been saved yet. ―One-Way Replication‖: This option will replicate the data from the source to the destination. ―Two-Way Replication‖: This option will achieve dual replication between the source and the destination. The data in the source will be replicated in the destination, and the data in the destination will be replicated to the source. See the advanced setting section below for more information. © 2001-2008 AvePoint, Inc. All rights reserved. Page 165 5.2.3.1 Basic Setting Choosing from the following options will restore the corresponding items: ―Content‖: This will replicate all items, files, and versions. ―Include Workflow‖: Workflow will replicate all customized workflows in one-way replication only. This option is not supported in two way replication. ―Configuration‖: Replicating configurations and properties will replicate the items specified below: Properties Level Category Look and Feel Site Collection Galleries Site Administration © 2001-2008 AvePoint, Inc. All rights reserved. Page 166 Configuration Title, description, and icon Tree view Site theme Top-link bar Quick launch Save site as template Reset to site definition Master page Site content types Site columns Site templates List templates Web parts Workflows Regional setting Site libraries and lists Site usage reports User alerts RSS Site Collection Administration Look and Feel Galleries Site Site Administration Site Collection Administration List / Library General Settings © 2001-2008 AvePoint, Inc. All rights reserved. Page 167 Search visibility Sites and workspaces Site features Delete this site Related Links scope settings Search settings Search scopes Search keywords Recycle bin Site directory settings Site collection usage reports Site collection features Site hierarchy Portal site connection Site collection audit settings Audit log reports Site collection policies Title, description, and icon Tree view Site theme Top-link bar Quick launch Save site as template Reset to site definition Master Page Site content types Site columns Regional settings Site libraries and lists Site usage reports User alerts RSS Search visibility Sites and workspaces Site features Delete this site Related Links scope settings Go to top-level site settings General settings Title, description, and icon Versioning settings Permissions and Management Communications Customized Columns Content Type Advanced settings Audience targeting settings Delete this document list/library Save library/list as template Permissions for this document library Manage checked out files Workflow settings Information management policy settings RSS All All Hidden Lists List Template Gallery All Converted Forms All Master Page Gallery All Normal Site / Web Reporting Metadata All Reporting Templates All Site Template Gallery All Web Part Gallery All Personal Site Workflow History All ―Security‖: Replicating securities will copy over users, groups, and permissions. Security and permissions can only be replicated if the content exists in the destination, or if ―Content‖ is selected as well. *Note: Replicating securities will only add access permissions from the source to the destination. It will not remove user permissions, even if overwrite has been selected. ―Data Configuration‖: ―No compression and encryption‖: does not compress the data before migrating and decompressed after migration, it is default. ―Compression only‖: compress the data before migrating and decompressed after migration. This will greatly enhance the speed of the migration process. ―Encryption only‖: encrypt the data in migration process. This will greatly enhance the security of migration process. ―Compression and Encryption‖: compress the data before migrating and decompressed after migration, encrypt the data in migration process. ―Email Notification‖: Shows a drop down of possible email notifications to choose from. These profiles are triggered in the event of a failure or success of a job. They are created within the ―Reporting‖ section of the ―Control Panel.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 168 ―Transmit with Archiver Stubs‖: Allows customer to choose the stubs that it has been archived. If you want to replicate the archived data, please enable this box before selected the ―Content‖ box. It is optional. ―Description‖ Entering content in the ―Description‖ field will uniquely tag the copy job, making it easily identifiable from the Job Monitor‘s ―Job Report.‖ 5.2.3.2 Advanced Setting Byte Level Differencing ―Byte Level Differencing‖: Selecting this checkbox will reduce the quantity of data in the transmission by transferring only modified information from the source to the destination. It is a way of reducing the amount of data transmitted with each replication. When a ―Base File‖ (the original file) becomes a ―Version File‖ (the current file after modification), DocAve will only transfer the ―Delta File‖ (all modified information) from the source to the destination. After the transmission, the Delta File and the Base File will merge into a Version File. For example, if an original file of size 52 MB is replicated, modified, and then replicated again using ―Byte Level Differencing,‖ the transferred data (Delta File) may only be as small as 2 MB. (This will depend on the amount of data edited). To setup the ―Byte Level Differencing‖, please follow the steps below: Step Action 1 Select the ―Byte Level Differencing‖ check box. 2 Select a source agent from the drop-down box in Source. © 2001-2008 AvePoint, Inc. All rights reserved. Page 169 3 Set the ―Byte Level Base File Storage Path‖ in the source. 4 Click the ―Setup‖ button to open a pop-up. Select a location type from the drop-down list. If… Then… Local Location 1. Input the path in the field provided. 2. Click ―Test‖ button to test this path. 3. Select ―OK.‖ Network Location 1. Input the ―Network Domain,‖ ―Network User,‖ ―Network Password‖ and the ―Path‖ in the corresponding fields for this destination. 2. Click the ―Test‖ button to test this path. 3. Select ―OK.‖ 5 6 Select a agent from the destination agent drop-down box. *Note: Only the selected agents in the destination field will be included in the drop-down box. 7 Set the ―Byte Level Base File Storage Path‖ in the destination 8 Click the ―Setup‖ button to open a pop-up. Select a location type from the drop-down list. 9 If… Then… Local Location 1. Input the path in the field provided. 2. Click ―Test‖ button to test this path. 3. Select ―OK.‖ Network Location 1. Input the ―Network Domain,‖ ―Network User,‖ ―Network Password‖ and the ―Path‖ in the corresponding fields for this destination. 2. Click the ―Test‖ button to test this path. 3. Select ―OK.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 170 Throttle Control ―Throttle Control‖: This function will enable you to specify the start time and bandwidth consumption of the migration process. To setup the ―Throttle Control,‖ please follow the steps below: Step Action 1 Enable the ―Throttle Control‖ check box in the GUI. 2 You can specify the job to run at another time by selecting the ―Start the job at‖ check box. Click on the calendar icon to specify a date and time. 3 If you want to limit the bandwidth allowed to the Replicator module, please select the ―Run the job using‖ check box and specify a network bandwidth (positive integer) using the size field and select KB or GB from the drop-down box. 5.2.3.3 Schedule Copy or Restore time and method options can be set via two schedules, where administrators can choose only once, per minute, hour, day, week, or month schedules. For each schedule, administrators can also specify, Full, Incremental (Replicate Modifications, Replicate Deletion) Schedule: Just like the Backup and Restore modules, the user can set schedules that would cover their SharePoint environment via a ―live‖ copy. In most cases, the administrator will likely © 2001-2008 AvePoint, Inc. All rights reserved. Page 171 copy content immediately. However, this option can be used to schedule the copy for off-hours or to periodically push specific content to other sites. Step Action 1 Select a agent from the ―Destination Agent‖ drop-down box 2 Enable the ―Schedule A‖ or ―Schedule B‖ check box to enable scheduling. 3 Set a start time for your replication using the calendar icon next to the ―Start Time‖ field. Specify the interval at which the backup will occur. Choices are: Only Once, By Hour, By Day, By Week, or By Month. 4 If … Then … Only Once This will only run once at the specified time. By Minute This will let you choose an interval of 15, 30, or 45 minutes. By Hour Either choose this plan to run every set number of hours, or select it to run at specific hours, with the number of minutes past the hour specified by the user in the space provided. Be sure to select either ―AM‖ or ―PM‖ before choosing from the provided hours below. By Day Either set the plan to run every set number of days, or set the plan to run on weekdays or weekends. By Week Either set the plan to run every set number of weeks, or choose the days of the week to re-run this plan. By Month You can choose this plan to run on every set date of every month in the space provided (i.e., on the ―14‖th of every month). You can also set this plan to run in © 2001-2008 AvePoint, Inc. All rights reserved. Page 172 set months of the year, on certain days/weeks of the year. Select either a full or incremental replication. If … Then … Full This will copy all contents from the source to the destination. This option copies the changes to the destination (including creating / deleting / updating the Document Library, Folder, or Document) that have been made to the source since the last replication job. In the event where the source site is large, choosing the incremental option will save significant time on replication. ―Replicate Modifications‖: The ―Replicate Modifications‖ option will modify items in the destination if they have been modified in the source. This is only available with Incremental option. 5 Incremental ―Replicate Deletion‖: The ―Replicate Deletion‖ option will delete items in the destination if they have been deleted in the source. This is only available with Incremental option. For example if there are three items on the source (item1, item2, and item3), run the replication process. Delete ―item1‖ from the source and run an incremental replication with ―Replicate Deletion‖ enabled. The result will be ―item1‖ removed from the destination. *Note: If no full replication has been performed previously, the incremental option will perform a full replication by default. 5.2.3.4 Two Way Replication Two-Way Replication will allow for mirroring of the source and destination files. If an item was edited © 2001-2008 AvePoint, Inc. All rights reserved. Page 173 in either location, Replicator will update the corresponding file in the other location using conflict resolution rules (listed below). The term ―conflict Ruler‖ used in this section means that the same item was added, modified or deleted in the source and destination separately. These files can overlap in document library name, or the same ID in the ―Generic List.‖ In the event of a data conflict, the replication will run using the ―Conflict Resolution‖ established using the following steps: Step 1 Action Select the ―Two-Way Replication‖ radio button. Set the policy for the conflicted items. 2 *Note: If the user selecteds the Two-way Replication but not set in the Conflict Resolution Policy pop-up, it will run the replication according to the default settings. If … Then … ―Evaluating Sequence / Evaluating Entity‖: The user can select the number from the drop-down box corresponding to the sequence for evaluation. The number will set the priority sequence in the two-way replication when an item conflicts. The options include Agent, Time and Version: 3 Conflict Ruler © 2001-2008 AvePoint, Inc. All rights reserved. Page 174 ―Agent‖: If the user selected this as the first evaluating standard, the user can choose between ―Primary‖ or ―Secondary‖ as the source. The data in the source will overwrite the data in the destination. ―Time‖: If the user selected this as the first evaluating standard, the data with the latest modified time (or created time) will overwrite the data at the other end. ―Version‖: If the user selected this as the first evaluating standard, the data which has the latest version will overwrite the data in the other end. 4 Conflict Resolution ―Skip‖: When the rules are being applied, if there are the same name files in the source and destination, this file will not be treated. ―Overwrite‖: All of the original rules will be deleted and changed to reflect the new ones. ―Merge Version‖: If this option is selected, conflicting versions will be merged during the two-way replication. The user can view all versions in the version list. ―Email Notification‖: The ―Email Notification‖ drop 5 Other Options down box contains a list of profiles that have an associated email account. These profiles are triggered when encountering a conflict event in a job. They are created within the ―Reporting‖ section of the ―Control Panel.‖ *Note: The user must select a source first and only select one node in the source. The node types in the source and destination should be the same, and the node in the source and destination should be on the same level. Also, ―Replicate Deletion‖ in the Two-Way Replication only be available when the user selected the overwrite method. Logic for Two Way Replication The logic for the ―Two Way Replication‖ feature is as follows: 1. Added/modified data does not conflict in the source and destination: Action Taken Data added/modified in the ―Primary‖ Data added/modified in the ―Secondary‖ 2. Result Data will replicate from Primary to Secondary Data will replicate from Secondary to Primary Added/modified data and version does conflict in the source and destination: Option Selected ―Overwrite‖ option is selected Action Taken ―Time Rule‖ takes effect ―Agent Rule‖ takes effect © 2001-2008 AvePoint, Inc. All rights reserved. Page 175 Result It will take the latest modified time to apply as the standard of replication It will replicate the data and ―Primary‖ is selected as the standard for replication ―Agent Rule‖ takes effect and ―Secondary‖ is selected as the standard for replication ―Version Rule‖ takes effect Same data is modified/added in the Primary and Secondary ―Merge Version‖ option is selected 3. from the Primary to the Secondary. It will replicate the data from the Secondary to the Primary It will replicate the newest version (deleting the old one). The items will be replicated to each other as a merged version. The ―version list‖ will contain all modified/added items. Data deleted in Primary/Secondary Option Selected If ―Replicate Deletion‖ was selected If ―Replicate Deletion‖ is controlled by Skip / Overwrite Action Taken Result The deleted item will be ―Agent‖ is the first standard removed from the Primary for evaluation. and Secondary ―Time / Version‖ is the first standard for evaluation and The modified item will the item is deleted on one overwrite the delete. side, modified on the other. ―Time / Version‖ is the first standard for evaluation and The deleted item will be item was deleted on one removed from the Primary side, no change on the and Secondary other. It will not run the deletion Skip is selected. operation regardless of the rules set. Overwrite is selected. Deletion will run. *Note: Merge Version supports Document, Form, Picture, Translation Management, Data Connection, and Slide libraries. ―Form Template‖ in the document library and all other forms of lists cannot be replicated using this function. © 2001-2008 AvePoint, Inc. All rights reserved. Page 176 5.2.3.5 Source The ―Source Agent‖ is where the user can select the location of the files or folders to be copied from the Source URL Tree. Step Action 1 Select the ―Source Agent.‖ 2 Select the ―Virtual Server‖ that populates for the selected agent below. This will load the SharePoint structure. 3 Continue to click on the links to expand the tree until the desired location is reached. 4 Select one of the replication options described in the section below: either Content, Security, Workflow, Configuration, or a combination of the above. Dump To Local Location Selecting the ―Dump to Local Location‖ check box will download the data to local location. After running a job, a folder will be created with the backup data. By default, the storage location for ―Dump to Local Location‖ is: C:\Program Files\AvePoint\DocAve4\VaultClient\temp\ContentReplicator The default storage location can be changed under ―Control Panel‖ ―Agent Monitor.‖ Select the agent and specify the new storage location under ―Data Location Setting.‖ Please note that this is the same temporary storage location as used in site and subsite backups. *Note: Checking of the ―Dump To Local Location‖ will automatically gray out the ―Destination‖ tab. This is because the data will be stored locally on your system. After performing a successful ―Dump To Local Location‖ replication, you can replicate the data by selecting ―Load From Staging Location‖ under the ―Destination‖ tab. © 2001-2008 AvePoint, Inc. All rights reserved. Page 177 5.2.3.6 Destination The ―Destination‖ tab is where the user can select the location of where to copy the selected data. Step Action 1 Select the ―Destination‖ fields. 2 Check the corresponding box next to each appropriate destination agent. 3 Select the ―Virtual Server‖ that populates for the selected agent below. This will load the SharePoint structure. 4 Continue to click on the links to expand the tree until the desired location is reached. You can select multiple destinations from this tree. You may choose one of the following options during the replication process: If … Then … Backup before Copy Selecting this option will backup the data on the destination server before replicating the data. This is to ensure that if any data is changed or overwritten, an ―Undo‖ function can be applied (see the ―Job Monitor‖ section for more details). Check this option and click the arrow icon to expand it. Select the media server and drive. Please specify the Media Server and destination drive for the backup data to be saved to. 5 This option will allow you to reload the replicated data if the ―Dump to Local Location‖ option was used. Load from Staging Location © 2001-2008 AvePoint, Inc. All rights reserved. Page 178 Click the ―Browse‖ button and select the location type from the pop-up (either Local or Network). Enter all of the necessary path information. *Note: By default, the staging location is: ―C:\Program Files\AvePoint\DocAve4\VaultClient\temp\ContentR eplicator‖ 5.2.4.7 Configuration File The configuration file ―ContentReplicator.xml‖ can be found under the folder ―\VaultClient\data‖ in the AvePoint directory. The content is as follows: <ContentReplicator> <MergeVersion supportAllList="false"/> <ByteLevelDiff sizeLimit="64"deleteBaseFileTimeLimit="90"/> </ContentReplicator> <MergeVersion supportAllList="false"/> : This line determines whether or not all lists are merged. If it is set to false, then only the six listed in the previous section will be replicated. *Note: If set to true, some unsupported data types may be lost. <ByteLevelDiff sizeLimit="64"deleteBaseFileTimeLimit="90"/> : This line sets the configuration for Byte Level Differencing. The function ―sizeLimit‖ is the number of KB to be reached before the item is replicated. The function ―deleteBaseFileTimeLimit‖ is the number of days to keep an unmodified base file in the ―Byte Level Base File Storage‖ location. 5.2.4 Single Farm and Cross Farm Move 5.2.4.1 Single Farm The example below will demonstrate the moving of a document from one site to another located on ―live‖ production machines. The document named ―ALL_FAQS‖ on the ―Demo2007:9001‖ Shared © 2001-2008 AvePoint, Inc. All rights reserved. Page 179 Documents folder will be copied to the Shared Documents folder of ―Demo2007:9000.‖ Please note the time stamp and securities associated with the file. Step Action 1 Select ―New Plan.‖ 2 Select the ―Demo2007:9001‖ Agent under ―Source Agent.‖ 3 Locate and select the ―ALL_FAQ‖ document under the SharePoint Tree. 4 Click on the ―Destination‖ Tab. 5 Check off the ―Enable‖ box under the ―Demo2007:9000‖ tab. 6 Select the ―.‖ directory. 7 Click ―Save As‖ and specify a name. 8 Select the ―Run Now‖ button. The results are shown in the figure below: © 2001-2008 AvePoint, Inc. All rights reserved. Page 180 *Note: There are API restrictions which limit the way Replicator drops selected data onto the destination location. It is not a one-to-one copy as the data is dropped at the site/subsite-level. Replicator allows administrators to copy a site / subsite / list / folder / document / list item from its source to a site / subsite at its destination. Data that is copied to the destination location will keep its parent associations as well. 5.2.4.2 Cross Farm For a Cross Farm replication of data, the same steps that were taken in a Single Farm migration can be implemented. The only difference would be that the destination reflects the name of the Agent that was installed on the other front-end web server. 5.2.4.3 Single Farm to Multiple Farms The Replicator allows you to move content from a single farm across many farms in one move (one-to-many replication). This process is similar to that of a single farm, except you will select multiple agents on destination: After selecting the content on ―Source,‖ use the tabs to ―Enable‖ multiple agents. You can set independent schedules for each Agent. *Note: In order to run the replication to all Agents, do not select ―Run Now‖ from the ―Destination‖ menu. This will only replicate to the selected agent! Please select the ―Source‖ tab again before selecting ―Run Now‖ to ensure all Agents are replicated to. 5.2.5 Replicator Un-installation To uninstall Replicator, open the DocAve Agent Configuration tool and uncheck the ―Replicator‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 181 option. 5.2.6 Currently Supported and Unsupported Content For Replication Source Libraries Type Document Library Supported Form Library Supported Wiki Page Library Supported Picture Library Supported Translation Management Library Supported Data Connection Library Supported Slide Library Supported Report Library Supported Communications Announcements List Contacts Discussion Board Tracking Lists Links Supported Supported Supported Supported Tasks Supported Project Tasks Supported Issue Tracking Supported Survey Supported Supported Custom List in Datasheet View Supported Languages and Translators Supported KPI Lists Supported Import Spreadsheet Supported Basic Page Supported Web part Page Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 182 Known Issues* Supported Calendar Custom Lists Custom List Web Pages Status 1. Some customizations are not supported. 2. The image in the Web part cannot be replicated between the sites successfully. Such as from the subsite to topsite. Sites and Workspaces Supported Workflow Supported RSS Supported Alerts Supported Metadata Security & Properties Single line of text Supported Multiple lines of text Supported Choice(menu to choose from) Supported Number Supported Currency Supported Date and Time Supported Look up Supported Yes/No Supported Person or Group Supported Hyperlink or Picture Supported Calculated Supported Business Data Supported Version settings Supported Column Settings Supported Permissions This function cannot be such steadily in Supported some levels except site-level and web level. Version Histories Documents Lists © 2001-2008 AvePoint, Inc. All rights reserved. Page 183 Supported Supported 5.2.6.1 Supported and Unsupported Elements for Two-Way Replication (Merge Version) Source Libraries Type Document Library Supported Form Library Supported Wiki Page Library Supported Picture Library Supported Translation Management Library Supported Data Connection Library Supported Slide Library Supported Report Library Supported Communications Announcements List Contacts Discussion Board Tracking Lists Links Supported Supported Supported Supported Calendar Supported Tasks Supported Project Tasks Supported Issue Tracking Supported Survey Supported Custom Lists Custom List Web Pages Status Supported Custom List in Datasheet View Supported Languages and Translators Supported KPI Lists Supported Import Spreadsheet Supported Basic Page Supported Web part Page Supported Sites and Workspaces © 2001-2008 AvePoint, Inc. All rights reserved. Page 184 Unsupported Known Issues* 5.3 Content Manager The ―Content Manager‖ module allows the seamless migration of content from one location to another within Microsoft SharePoint 2007. It supports one to one replication. This migration can be performed within the same SharePoint farm, or from one SharePoint farm to another. Content Manager is a powerful tool and is considered real time, live copy because no backup is needed. Content Manager allows the administrator to restructure the content and topology of his/her SharePoint environment easily and accurately. 5.3.1 Content Manager Installation Before using ―Content Manager,‖ make sure that it is installed and enabled within the ―DocAve Agent Configuration Tool.‖ Under this tool, ensure the ―Content Manager‖ option is selected for each agent. To properly use Replicator, a DocAve Agent should be installed on each front-end web server. This is required in order to perform cross farm migrations. 5.3.2 Layout, Features, and Options Content Manager can copy specific content from one location to another one. Although it does have scheduling options, it is not meant to perform ―automatic‖ real time replication of an entire SharePoint farm. For this type of replication, please see AvePoint‘s Data Protection module to enable scheduled backup. The key use of Content Manager is to allow the administrator to copy documents, libraries, sites, etc. from one location to another seamlessly and quickly. Typically, the administrator must first backup the content and then perform an out of place restore. This requires the administrator to go through a two step process in order to copy content. With Content Manager, the administrator has a simple and easy-to-use interface that allows the process to be done in one step. 5.3.3 General Settings DocAve 4.5 Content Manager operates on the concept of plans. A previously created plan can be selected from the Plan Root, or a new plan can be created. The general fields for any plan are: ―Plan Name‖: This lists the plan name if a specific plan was selected. It will read ―[New Plan]‖ by default if the current plan has not been saved yet. © 2001-2008 AvePoint, Inc. All rights reserved. Page 185 ―Adv mode‖: If you choose this mode, you can set many settings such as configuration, securities, workflows, etc. ―Native mode‖: You can set schedule, email notification and some basic settings. 5.3.3.1 Basic settings Choosing from the following options will restore the corresponding items: ―Content‖: This will replicate all items, files, and versions. ―Include Workflow‖: Workflow will replicate all customized workflows in one-way replication only. This option is not supported in two way replication. ―Configuration‖: Replicating configurations and properties will replicate the items specified below: Properties Level Category Look and Feel Site Collection Galleries Site Administration © 2001-2008 AvePoint, Inc. All rights reserved. Page 186 Configuration Title, description, and icon Tree view Site theme Top-link bar Quick launch Save site as template Reset to site definition Master page Site content types Site columns Site templates List templates Web parts Workflows Regional setting Site libraries and lists Site usage reports User alerts Site Collection Administration Look and Feel Galleries Site Site Administration List / Library Site Collection Administration General Settings © 2001-2008 AvePoint, Inc. All rights reserved. Page 187 RSS Search visibility Sites and workspaces Site features Delete this site Related Links scope settings Search settings Search scopes Search keywords Recycle bin Site directory settings Site collection usage reports Site collection features Site hierarchy Portal site connection Site collection audit settings Audit log reports Site collection policies Title, description, and icon Tree view Site theme Top-link bar Quick launch Save site as template Reset to site definition Master Page Site content types Site columns Regional settings Site libraries and lists Site usage reports User alerts RSS Search visibility Sites and workspaces Site features Delete this site Related Links scope settings Go to top-level site settings General settings Title, description, and icon Versioning settings Advanced settings Audience targeting settings Delete this document list/library Save library/list as template Permissions for this document library Permissions and Management Manage checked out files Workflow settings Information management policy settings Communications RSS Customized Columns All Content Type All Hidden Lists List Template Gallery All Converted Forms All Master Page Gallery All Normal Site / Web Reporting Metadata All Reporting Templates All Site Template Gallery All Web Part Gallery All Personal Site Workflow History All ―Security‖: Replicating securities will copy over users, groups, and permissions. Security and permissions can only be replicated if the content exists in the destination, or if ―Content‖ is selected as well. *Note: Replicating securities will only add access permissions from the source to the destination. It will not remove user permissions, even if overwrite has been selected. ―Data Configuration‖: ―No compression and encryption‖: does not compress the data before migrating and decompressed after migration, it is default. ―Compression only‖: compress the data before migrating and decompressed after migration. This will greatly enhance the speed of the migration process. ―Encryption only‖: encrypt the data in migration process. This will greatly enhance the security of migration process. ―Compression and Encryption‖: compress the data before migrating and decompressed after migration, encrypt the data in migration process. ―Email Notification‖: Shows a drop down of possible email notifications to choose from. These profiles are triggered in the event of a failure or success of a job. They are created within the ―Reporting‖ section of the ―Control Panel.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 188 ―Transmit with Archiver Stubs: Allows customer to choose the stubs that it has been archived. If you want to replicate the archived data, please enable this box before selected the ―Content‖ box. It is optional. ―Description‖ Entering content in the ―Description‖ field will uniquely tag the copy job, making it easily identifiable from the Job Monitor‘s ―Job Report.‖ 5.3.3.2 Source The ―Source Agent‖ is where the user can select the location of the files or folders to be copied from the Source URL Tree. Step Action 1 Select the ―Source Agent.‖ 2 Select the ―Virtual Server‖ that populates for the selected agent below. This will load the SharePoint structure. 3 Continue to click on the links to expand the tree until the desired location is reached. 4 Select one of the replication options described in the section below: either Content, Security, Workflow, Configuration, or a combination of the above. 5.3.3.3 Content Manager Options Choosing from the following options will restore the corresponding items: *Note: Replicating securities will only add access permissions from the source to the destination. It will not remove user permissions, even if overwrite has been selected. Properties © 2001-2008 AvePoint, Inc. All rights reserved. Page 189 Level Category Look and Feel Galleries Site Collection Site Administration Site Collection Administration Site Look and Feel © 2001-2008 AvePoint, Inc. All rights reserved. Page 190 Configuration Title, description, and icon Tree view Site theme Top-link bar Quick launch Save site as template Reset to site definition Master page Site content types Site columns Site templates List templates Web parts Workflows Regional setting Site libraries and lists Site usage reports User alerts RSS Search visibility Sites and workspaces Site features Delete this site Related Links scope settings Search settings Search scopes Search keywords Recycle bin Site directory settings Site collection usage reports Site collection features Site hierarchy Portal site connection Site collection audit settings Audit log reports Site collection policies Title, description, and icon Tree view Site theme Top-link bar Galleries Site Administration Site Collection Administration General Settings List / Library Permissions and Management Communications Customized Columns Content Type Quick launch Save site as template Reset to site definition Master Page Site content types Site columns Regional settings Site libraries and lists Site usage reports User alerts RSS Search visibility Sites and workspaces Site features Delete this site Related Links scope settings Go to top-level site settings General settings Title, description, and icon Versioning settings Advanced settings Audience targeting settings Delete this document list/library Save library/list as template Permissions for this document library Manage checked out files Workflow settings Information management policy settings RSS All All Hidden Lists List Template Gallery All Converted Forms All Master Page Gallery All Normal Site / Web Reporting Metadata All Reporting Templates All Site Template Gallery All Web Part Gallery All Personal Site Workflow History All © 2001-2008 AvePoint, Inc. All rights reserved. Page 191 Dump To Local Location Selecting the ―Dump to Local Location‖ check box will download the data to local location. After running a job, a folder will be created with the backup data. By default, the storage location for ―Dump to Local Location‖ is: C:\Program Files\AvePoint\DocAve4\VaultClient\temp The default storage location can be changed under ―Control Panel‖ ―Agent Monitor.‖ Select the agent and specify the new storage location under ―Data Location Setting.‖ Please note that this is the same temporary storage location as used in site and subsite backups. *Note: Checking of the ―Dump To Local Location‖ will automatically gray out the ―Destination‖ tab. This is because the data will be stored locally on your system. After performing a successful ―Dump to Local Location‖ replication, you can replicate the data by selecting ―Load from Staging Location‖ under the ―Destination‖ tab. 5.3.3.4 Destination The ―Destination‖ tab is where the user can select the location of where to copy the selected data. Step Action 1 Select a ―Destination Agent‖ from drop-down box. 2 Select the ―Virtual Server‖ that populates for the selected agent below. This will load the SharePoint structure. 3 Continue to click on the links to expand the tree until the desired location is reached. 4 You may choose one of the following options during the replication process: If … © 2001-2008 AvePoint, Inc. All rights reserved. Page 192 Then … Backup before Copy Selecting this option will backup the data on the destination server before replicating the data. This is to ensure that if any data is changed or overwritten, an ―Undo‖ function can be applied (see the ―Job Monitor‖ section for more details). Please specify the Media Server and destination Drive for the backup data to be saved to. Load from Staging Location This option will allow you to reload the replicated data if the ―Dump to Local Location‖ option was used. Please browse to the location of the replicated data. If … Then … Immediately Click ―Run now‖ button. If you check the ―Keep ID‖ button, this will keep the source database ID in the destination after being replicated. You may also enter a description for this job in the field provided. Scheduled 1. Uncheck the ―No Schedule‖ to specify a time to run the job using the calendar icon. Otherwise you can also save a ―No Schedule‖ plan directly. 2. Select ―Save As‖ to save this plan. 5 *Note: If you select a site in the source, using the promote arrow, you can promote this site to a site collection. 5.3.4 Single Farm and Cross Farm Move 5.3.4.1 Single Farm The example below will demonstrate the moving of a document from one site to another located on ―live‖ production machines. The document named ―ALL_FAQS‖ on the ―Demo2007:9001‖ Shared Documents folder will be copied to the Shared Documents folder of ―Demo2007:9000.‖ Please note the time stamp and securities associated with the file. Step © 2001-2008 AvePoint, Inc. All rights reserved. Page 193 Action 1 Select ―New Plan.‖ 2 Select the ―Demo2007:9001‖ Agent under ―Source Agent.‖ 3 Locate and select the ―ALL_FAQ‖ document under the SharePoint Tree. 4 Select ―Demo2007:9000‖ under ―Destination‖. 5 Select the ―.‖ directory. 6 Click ―Save As‖ and specify a name. 7 Select the ―Run Now‖ button. The results are shown in the figure below: *Note: There are API restrictions which limit the way Replicator drops selected data onto the destination location. It is a one-to-one copy as the data is dropped at the site/subsite-level. Replicator allows administrators to copy a site / subsite / list / folder / document / list item from its source to a site / subsite at its destination. Data that is copied to the destination location will keep its parent associations as well. © 2001-2008 AvePoint, Inc. All rights reserved. Page 194 5.3.4.2 Cross Farm For a Cross Farm replication of data, the same steps that were taken in a Single Farm migration can be implemented. The only difference would be that the destination reflects the name of the Agent that was installed on the other front-end web server. 5.3.5 Content Manager Un-installation To uninstall Content Manager, open the DocAve Agent Configuration tool and uncheck the ―Content Manager‖ option. 5.3.6 Currently Supported and Unsupported Content for Content Manager Components Function Content Manager (Adv mode) Web application Site collection Site Library Same level List replication Folder Item or Column View Low level to Attachment high level Reply Alert me Workflow Version User Group One to more agents Content only replication Configuration only replication Security only replication One-way Replicator © 2001-2008 AvePoint, Inc. All rights reserved. Page 195 Status Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Unsupported Supported Supported Supported Content Manager (Native mode) One-way © 2001-2008 AvePoint, Inc. All rights reserved. Page 196 Content and configuration replication Content and security replication Configuration and security replication Concurrent threads Email Notification Include workflow Data Configuration Migrate Archiver Stubs Throttle Control Dump/load Backup/undo Include Workflow Byte level Schedule Incremental Replicate Modification Incremental Replicate Deletion Differential type replication Differential level change Web application Site collection Same level Site Library replication List or Low level to Folder high level Item Column Reply Keep ID Attachment One to more agents Differential type replication Differential level change Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Unsupported Unsupported Unsupported Unsupported Unsupported Unsupported Unsupported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Unsupported Supported Unsupported 5.4 SharePoint Administrator ―SharePoint Administrator‖ condenses many of the jobs that a typical Administrator performs into a single GUI. The following sections will explain the multiple views available for managing the SharePoint environment. 5.4.1 Admin (tree mode) The tree mode of the SharePoint Administrator module offers you a full view of your SharePoint environment with all files included. You can expand each farm, web application, site, etc. down to the item level and perform all SharePoint operations on the selected content. When exploring extremely large environments, the tree may be split across multiple pages. Please select the page number at the bottom of the tree to view additional data. 5.4.1.1 Agent Filter To limit the content displayed in the tree, set up an Agent Filter to limit the scope: Step Action 1 Select the ―Manage Filter‖ button. 2 Choose to set up either a ―Public‖ or a ―Private‖ filter. A ―Public‖ filter will allow all DocAve users to use this filter. A ―Private‖ filter will only be available to the user who created it. 3 Using the ―->‖ and ―<-‖ buttons, add and remove agents from the ―Selected Agent‖ list. This list represents all of the agents included in the filtered tree. 4 Enter a name for the filter in the designated field. 5 Press the ―Agent Filter‖ button to return to the list of created filters. © 2001-2008 AvePoint, Inc. All rights reserved. Page 197 6 You can either select the public or private filters built in the previous menu. Clicking on the ―edit‖ button will allow you to make changes to your filter and ―delete‖ will remove the filter. 7 Click on the name of a filter will load the tree mode with the filtered content displayed only. 5.4.1.2 Batch Setting Instructions DocAve allows the administrator to apply settings to batches of sites, farms, web applications, content databases, etc. When selecting multiple data types from the tree view, a list of possible batch settings will appear in both the Central Administration and the Security Center tabs to the right. The possible batch settings for each level are listed in the sections below, as well as with any necessary detailed explanations. To apply batch settings, please follow the steps below: Step Action 1 Click on the ―Farms‖ icon to expand the tree. 2 Navigate to the desired content and select it using the checkboxes. 3 From the right, you can see a list of all possible batch settings. Select the desired one to continue. 4 In the bulk settings pop-up window, you will see the list of all selected content at the top. 5 In the row next to each ―Setting Name‖ you can select to edit the field using the checkbox to the left. Once selected, the ―Edit‖ icon will turn to a colorful ― .‖ *Note: A setting name marked with a ―*‖ means it is a necessary option. 6 When editing each setting field, you can select whether to edit it for each item individually, or as the same value for every web application: © 2001-2008 AvePoint, Inc. All rights reserved. Page 198 If … Then … 1. Input the values in the corresponding field. Same values 2. Click the ― ‖ button to confirm your setting or click the ― ‖ button to reset the value to the previous setting. 1. Click the ― ‖ button to open the popup window. A list of the web applications should be displayed. Different values 2. Select the checkbox for the web application you would like to edit and then input the value in the corresponding field. Using the box next to ―Object‖ will select all web applications. *Note: You can also fill in the selected fields using the ―Update‖ section. The value you enter here will be updated for all selected objects. 3. Click ―OK.‖ The edit icon will change to ― 7 .‖ Select the ―Apply‖ button to confirm the changes. 5.4.1.3 Central Administration This section of the manual will explain all of the actions that can be taken on the SharePoint environment from each level of the tree (under the Central Administration tab). Operations on the Farm Level The following table shows the operations that can be performed on a SharePoint farm (Italicized items are currently disabled): Operation Generate Report Manage Farm Features Default Database Server © 2001-2008 AvePoint, Inc. All rights reserved. Page 199 Location in SharePoint N/A – See the section below Central Administration Operations Central Administration Operations Check Services Enabled In This Farm Configure Session State Records Center Html Viewer Usage Analysis Processing Antivirus Information Management Policy Configuration Central Administration Application Management Central Administration Application Management Central Administration Application Management Central Administration Application Management Central Administration Operations Central Administration Operations Settings List Settings / Document Library Settings Manage Settings for Single Sign-On Time Job Status Time Job Definitions Master Site Directory Settings Site Directory Links Scan Quiesce Farm Data Retrieval Service Outgoing E-mail Settings Incoming E-mail Settings Custom Properties Central Central Central Central Central Central Central Central N/A Administration Administration Administration Administration Administration Administration Administration Administration Operations Operations Operations Operations Operations Operations Operations Operations Batch Settings on Farm Level The following operations support batch settings currently: Generate Report Operations on the Web Application Level The operations that can be performed on a SharePoint web application are: Operation Generate Report Web Application Outgoing E-mail Settings Web Application General Settings Site Use Confirmation and Deletion Delete This Web Application Custom Properties Extend Web Application Block File Types Create Site Collection © 2001-2008 AvePoint, Inc. All rights reserved. Page 200 Location in SharePoint N/A – See the section below Central Administration Application Management Central Central Central N/A Central Central Central Administration Application Management Administration Application Management Administration Application Management Administration Application Management Administration Operations Administration Application Management Define Managed Paths Self-Service Site Management Remove SharePoint From IIS Web Site Manage Web Application Feature Central Central Central Central Administration Administration Administration Administration Application Application Application Application Management Management Management Management Batch Settings for Web Application Level The following operations support batch settings currently: Generate Report Web Application Outgoing E-mail Settings Web Application General Settings Site Use Confirmation and Deletion Custom Properties Create Site Collection Operations on the Content Database Level The operations that can be performed on the content database level are: Operation Manage Content Database Settings Custom Properties Site Collection List Create Site Collection Location in SharePoint Central Administration Application Management Content Databases N/A N/A – see the section below. Central Administration Application Management *Note: To remove a content database, select the option from the ―Manage Content Database Settings‖ pop-up. *Note: The ―Site Collection List‖ function operates differently than the SharePoint content database settings. You can display each site by clicking on its link in the pop-up window. *Note: Different from the SharePoint ―Create Site Collection‖, DocAve supports site collection creation under a specified content database. *Note: In ―Manage Content Database Settings,‖ you can view the size and free space of the SQL Database. This information can also be listed in custom reports for the content database level. © 2001-2008 AvePoint, Inc. All rights reserved. Page 201 Batch Settings for the Content Database Level: The following operations support batch settings currently: Manage content database settings Custom Properties Create Site Collection Remove Content Database Operations on Site Collection Level The operations that can be performed on the site collection level are: Operation Create Site Enable RSS Search Scopes Search Settings Search Keywords Portal Site Connection Site Collection Features Delete the Site Collection Site Templates List Templates Web parts Deploy Site Maximum Depth Site Collection Quotas and Locks Move Site Action © 2001-2008 AvePoint, Inc. All rights reserved. Page 202 Location in SharePoint Logo on Site Collection Site Actions Create Sites and Workspaces *Note: You should select a language from drop-down box in the ―Language Option‖ field according to language of your specified SharePoint environment. Logo on Site Collection Site Actions Site Settings Central Administration Central Administration Central Administration Logo on Site Collection Site Actions Site Settings Logo on Site Collection Site Actions Site Settings Logo on Site Collection Site Actions Site Settings N/A (see the section below below) *Note: The ―Deploy Site Maximum Depth‖ function provides a feature to deploy the site maximum depth. Once this depth is specified, the customer will only be able to create subsites to the specified depth. Enter the number in the space provided in the pop-up. Central Administration Application Management *Note: The ―Move Site Action‖ feature allows the user to move a site collection URL to a new content database. In order to use this action, there should be at least two content databases within the web application. Batch Settings for Site Collection level: The following operations support batch settings currently: Create Site Portal Site Connection Delete the Site collection Site Collection Quotas and Locks Operations on Site-Level The operations that can be performed on the site level are: Operation Create Site Site Theme Search Visibility Regional Settings User Alerts RSS Settings Delete This Site Custom Properties Title, Description, and Icon Master Pages Site Content Types Site Features Reset to Site Definition Site Columns Create List / Library Location in SharePoint Logo on Site Collection Site Actions Create Sites and Workspaces Logo on a Site Site Actions Site Settings Logo on a Site Site Actions Site Settings Logo on a Site Site Actions Site Settings Logo on a Site Site Actions Site Settings Logo on a Site Site Actions Site Settings Batch Settings for Site-Level: The following operations support batch settings currently: Site Theme Regional settings Delete this site Custom Properties © 2001-2008 AvePoint, Inc. All rights reserved. Page 203 Operations on List/Library Level The operations that can be performed on the list/library level are: Operation Version Settings Advanced Settings Title, description and navigation User Alerts / Alert Me RSS Setting Delete this list/library Create New Folder Audience Targeting Settings Location in SharePoint Access a List/Lib. Settings List Settings Access a List/Lib. Settings List Settings Access a List/Lib. Settings List Settings Access a List/Lib. Actions Alert Me Access a List/Lib. Settings List Settings Batch settings for List/Library Level: The following operations support batch settings currently: Version settings Advanced Settings Alert Me Delete these lists/libraries Operations on Folder Level The operations that can be performed on the folder level are: Operation Delete Alert Me View Properties Edit Properties Create New Folder Connect to Outlook Operations on file/item level © 2001-2008 AvePoint, Inc. All rights reserved. Page 204 Location in SharePoint Select a folder Select a folder Select a folder Select a folder Select a folder N/A The operations that can be performed on the file / item level are: Operation Edit Item Delete Item Alert Me Location in SharePoint Select a list Select a list Select a list Operations on Shared Services Provider The operations that can be performed on the site level are: Operation Edit Shared Service Provider Manage Search Content source User Profiles and properties Profile Services policies My Site Setting Trusted My Site host location Published links to Office client applications Personalization Site links File types Default content access account Server name mappings Search-based alerts Specify authoritative pages Usage repeating Location in SharePoint Shared Services Administration Select a SSP Shared Services Administration Select a SSP Search Setting Content Sources and crawl schedules Shared Services Administration Select a SSP Shared Services Administration Select a SSP Shared Services Administration Select a SSP Shared Services Administration Select a SSP Shared Services Administration Select a SSP Shared Shared Setting Shared Setting Shared Setting Shared Setting Shared Setting Shared Services Administration Select a SSP Services Administration Select a SSP Search Services Administration Select a SSP Search Services Administration Select a SSP Search Services Administration Select a SSP Search Services Administration Select a SSP Search Services Administration Select a SSP Batch Settings for SSP: The following operations support batch settings currently: Edit Shared Services Provider: © 2001-2008 AvePoint, Inc. All rights reserved. Page 205 5.4.1.4 Generating Reports Check this option to get a report for multi-farm. The differences will be displayed in highlight in the main report. In addition, DocAve also generates a difference report to help the user comparison. After setting up profiles using the ―Report Profiles‖ tab of the SharePoint Administrator module, you can view custom reports for the Farm and Web Application levels. To generate these reports, follow the steps below: Step Action 1 Open the Admin (tree or search mode) module and choose the list of farms (or web applications) that you would like to view reports for. 2 Select ―Generate Report‖ in the Central Administration tab. 3 In the pop-up, select a ―Farm Level Report Profile‖ (set in the Report Profiles module) from the drop-down. 4 If multiple farms are selected, you can generate a single ―merged‖ report using the ―Get Merged Report‖ button. If the ―Including Difference Report‖ is selected, all differences will be highlighted in the merged report. A separate report containing highlighted information will also be generated. 5 You can view report these reports either instantly or by downloading them to your machine. *Note: The reports are generated in ―.pdf,‖ ―.xls,‖ and ―.xml‖ format. 5.4.1.5 Security Center Operations on Farm Level The operations that can be performed on the farm level are: Operation Add Users © 2001-2008 AvePoint, Inc. All rights reserved. Page 206 Location in SharePoint Add Groups Service Accounts All People Groups Site Collection Permissions Central Administration Application Management Batch Settings for Farm Level The following operations support batch settings currently: Add Users Add Groups Windows Service Account Operations on Web Application Level The operations that can be performed on a SharePoint web application are: Operation Security for Web Part Pages User Permissions for Web Application Policy for Web Application Authentication Providers Manage Permission Policy Levels Location in SharePoint Batch settings for Web application level: The following operations support batch settings currently: Security for Web Part Pages User Permissions for Web application Policy for Web application Authentication Providers Operations on Site Collection Level The operations that can be performed on a the site collection level are: Operation Add Users Add Groups © 2001-2008 AvePoint, Inc. All rights reserved. Page 207 Location in SharePoint Logo on a Site Collection Site Actions Site Settings People and Groups New Logo on a Site Collection Site Actions Site Settings People and Groups New Edit User Permissions Delete Users and Groups Anonymous Access Site Collection Administrators Groups All People Site Collection Permission Clone Account Permission Logo on a Site Collection Site Actions Site Settings Advanced Permission Actions Logo on a Site Collection Site Actions Site Settings *Note: For ―Groups,‖ ―All People,‖ and ―Site Collection Permission,‖ you must select an item of the list in the pop-up window by clicking on it to see additional settings. Batch settings for Site Collection level: The following operations support batch settings currently: Add User Add Group Site Collection Administrators Edit User Permissions Delete Users and Groups Anonymous Access Operations on Site Level Operation Add Users Add Groups Edit User Permissions Delete Users and Groups Groups All People Site Permissions Anonymous Access Batch settings for Site-level: © 2001-2008 AvePoint, Inc. All rights reserved. Page 208 Location in SharePoint Logo on a Site Collection Site Actions Site Settings People and Groups New Logo on a Site Collection Site Actions Site Settings People and Groups New Logo on a Site Collection Site Actions Site Settings Advanced Permission Actions The following operations support batch settings currently: Add Users Add Groups Edit User Permissions Delete Users and Groups Anonymous Access Operations on List/Library Level The operations that can be performed on the list/library level are: Operation Add Users Permissions For This List/Library Manage Checked Out Files Location in SharePoint Batch settings for List/Library Level: The following operations support batch settings currently: Add Users 5.4.1.6 Solutions and Features You can also uninstall / manage the ―Solutions‖ and ―Features‖ available to SharePoint, found in the Central Administration menu, as well as the Central Administration Operations Global Configuration. In order to use this feature, expand the SharePoint tree to the ―Solutions‖ and ―Features‖ level. These are located directly under the farm level, typically at the bottom of the list. Installing and Deploying Solutions Clicking on the ―Solutions‖ listing in the tree will display a list of all installed solutions on the selected farm. To install a solution to multiple farms, select ―Install‖ under the ―Cross Install Solutions‖ column. Here you can select multiple agents to install this solution to. Clicking on the solution‘s name will allow you to see details regarding this solution. ―Retract Solution‖ and ―Deploy Solution‖ will display a new window with schedule times and web applications, allowing © 2001-2008 AvePoint, Inc. All rights reserved. Page 209 you to either deploy or retract a solution as you would directly from SharePoint. Managing Features Selecting the ―Features‖ listing in the tree will show all features installed on farm with several details and information regarding this. Under the ―Action‖ column, you can choose to uninstall any features. You cannot, however, install any new features from this GUI. 5.4.2 Admin (search mode) For large SharePoint environments and known content (including web applications, site collections, sites, lists, databases, and folders), we recommend using the ―Admin (Search Mode)‖ for rapid navigation and management of settings. There are two options for searching content: ―Admin‖ and ―Security.‖ This module allows you to search the content of SharePoint and modify it as described in the Admin (tree mode) section above on both the Administration and Security level. For more detail, please refer to section 4.3.1 ―Admin (tree mode).‖ *Note: The ―Admin (search mode)‖ guide will use the following area references: 5.4.2.1 Setting the Search Scope In order to perform any searches in the Admin (seach mode), you must set a scope for DocAve to search under. Once you have set a scope, it can be used again. The following steps describe the initial steps for a simple content search: © 2001-2008 AvePoint, Inc. All rights reserved. Page 210 Step Action When setting the search scope, you can either select content from the tree-view in Area 1, or limit this view using the Search (Scope) Filter in Area 4. If Browse Entire Structure 1 Then… Select the ―Farms‖ tab in Area 1 to expand the SharePoint tree structure. For large environments, please be patient while the tree loads. 1. Click on the arrow in the Search Filter to expand it. 2. Enter the search conditions desired. For details on Use Search this search box, please refer to the 5.1.3 section on Scope searching in the discovery module. 3. Click on the ―Search‖ button at the bottom of this area to run the scope search. 4. You can now browse through the content in the restricted tree view in Area 1. Using the tree view in Area 1, select all content you desire to be included in the scope using the checkboxes next to each item. 2 *Note: When exploring extremely large environments, the tree may be split across multiple pages. Please select the page number at the bottom of the tree to view additional data. 3 Once the desired scope has been selected, press the ―Add‖ button at the bottom of Area 1. This will create a list of scopes in Area 2. 4 To clear all checked data in the tree view, select the ―Clear‖ button. To remove an item from the search scope, either uncheck the corresponding box, or delete the selected scope using the ―Delete‖ button. Now that a scope has been set for the search, you can search for individual content using the sections listed below. 5.4.2.2 Admin Search Criteria Page This section will allow you to search for content within the search scope specified in the previous section: © 2001-2008 AvePoint, Inc. All rights reserved. Page 211 Step Action 1 In the lower right corner of the GUI, select the ―Admin‖ radio button and press the ―Search Criteria‖ button. In the popup window, you will see radio buttons corresponding to the different levels you can search on. If … Then … Web Application Select this option. Site Collection You may check the ―Specify Site Collection Template‖ option to limit the search to only of a certain type of site collection. You can select multiple templates from the list provided, or specify a custom template using the blank space provided. Choosing the ―Auditing Enabled‖ function will include all site collections for which the audit function has been enabled in SharePoint. You may check the ―Specify Site Template‖ option to limit the search to only a certain type of site. You can select multiple templates from the list provided, or specify a custom template using the blank space provided. 2 Site List / Library © 2001-2008 AvePoint, Inc. All rights reserved. Page 212 Choosing the ―Auditing Enabled‖ function will include all site collections for which the audit function has been enabled in SharePoint. You may also select the recurrence level: ―Recurs to all‖ : This will select all layers of the site to be included in the search. This is selected by default. ―Recurs to depth‖ : You may enter a positive integer to specify the number of layers to be included in the search. Choosing the ―Auditing Enabled‖ function will include all site collections for which the audit function has been enabled in SharePoint. Choosing the ―Versioning Enabled‖ option will include all lists and libraries for which versioning has been enabled in SharePoint. Database 3 Select this option. You may select the recurrence level using the radio buttons provided: ―Recurs to all‖ : This will select all layers of the site to be included in the search. This is selected Folder by default. ―Recurs to depth‖ : You may enter a positive integer to specify the number of layers to be included in the search. Using the ―Search term‖ checkbox, you can specify specific content to search for in the areas selected above. The ―+‖ and ―-‖ checkbox will allow you to include or filter the specified content. This field accepts wildcards (*). You can add multiple restrictions by selecting the ―Add‖ button. You may also set filters based on the ―User/Group‖ and ―Permission‖ criteria, described in the ―Security Search‖ pop-up section below. 4 *Note: Conditions applied to any of the three categories for ―Search Criteria‖ will limit the results in the other fields. 5 Select ―Set‖ to apply the search criteria. 6 Select ―Save as‖ to save the search to the list in Area 3. You can reuse these searches later. Choose either to run this plan immediately, or ―offline.‖ Offline will allow you to leave the DocAve GUI and still be able to view the search results from the Job Monitor. This is recommended for large environments. 7 *Note: For large searches, you can cancel them using the ―Stop‖ button in the lower right. If… Then… Immediately Select ―Start Search‖ to display the content resulting from the search conditions. A pop-up will appear with a list of all available content. © 2001-2008 AvePoint, Inc. All rights reserved. Page 213 8 Select the ―Offline Search‖ button. After this has Offline completed, you may view the results from the Job Monitor under the ―Admin Search‖ heading. From this display, click on the content‘s name to display the SharePoint location. You can also check the result(s) using the checkbox on the left, giving you access to all single and batch settings listed in the Admin (tree mode) section above. *Note: When there are an extremely large number of results returned, the tree may split across multiple pages. To browse multiple pages, click on the ―Paging‖ icon at the top of the tree and choose the page number from the popup displayed. 5.4.2.3 Security Search Criteria Page This category will allow you to apply search criteria on three levels: ―SharePoint Criteria,‖ ―User/Group,‖ and ―Permission Criteria.‖ The different categories are listed below. SharePoint Criteria Using the SharePoint Criteria category you can select multiple SharePoint levels to search on: Step 1 Action In the lower right corner of the GUI, select the ―Security‖ radio button and press the ―Search Criteria‖ button. In the popup window, you will see check boxes corresponding to the different levels you can search on. You may select one or multiple restrictions. 2 If … Then … Farm Select this option. Web Application Select this option. Site Collection Select this option. © 2001-2008 AvePoint, Inc. All rights reserved. Page 214 List / Library 3 Select this option. You may select the recurrence level using the radio buttons provided: ―Recurs to all‖ : This will select all layers of the site to be included in the search. This is selected Site by default. ―Recurs to depth‖ : You may enter a positive integer to specify the number of layers to be included in the search. You may select the recurrence level using the radio buttons provided: ―Recurs to all‖ : This will select all layers of the site to be included in the search. This is selected Folder by default. ―Recurs to depth‖ : You may enter a positive integer to specify the number of layers to be included in the search. Using the ―Search term‖ checkbox, you can specify specific content to search for in the areas selected above. The ―+‖ and ―-‖ checkbox will allow you to include or filter the specified content. This field accepts wildcards (*). You can add multiple restrictions by selecting the ―Add‖ button. 4 Select ―Set‖ to apply the search criteria, or skip this step and apply a filter from one of the other Security tabs. 5 Select ―Save as‖ to save the search to the list in Area 3. You can reuse these searches later. 6 Select ―Start Search‖ to display the content resulting from the search conditions. A pop-up will appear with a list of all available content. 7 From this display, click on the content‘s name to display the SharePoint location. You can also check the result(s) using the checkbox on the left, giving you access to all single and batch settings listed in the Admin (tree mode) section above. Any settings specified here will limit the search results set in the other tabs. These search results can also be exported in .PDF, .CSV, and .XML formats. User/Group © 2001-2008 AvePoint, Inc. All rights reserved. Page 215 This tab is useful when searching for content that users or groups have access to. Step Action 1 Select one of the two input fields: AD Users or groups, or FBA Users. Multiple names can be entered and separated by a semi-colon. You can search for a user or group using the ― ‖ button. 2 From the popup you can either select ― ‖ to search for a user or ― ‖ to search for a group. From the search results list, select the user/group you want and click ―Add.‖ 3 You can verify the names entered into the field by selecting the ― 4 If you check ―Also search parent AD groups‖ option, the parent AD groups will be displayed in the search result. 5 If you select ―Include AD group members in downloaded report‖, you can view the AD group member information in the downloaded search report. There are two options for you to choose: ―Direct member only‖, ―All members‖. Selecting the corresponding radio button, you can view the related information. 6 Select ―Set‖ to apply the search criteria, or skip this step and apply a filter from one of the other Security tabs. 7 Select ―Save as‖ to save the search to the list in Area 3. You can reuse these searches later. 8 Select ―Start Search‖ to display the content resulting from the search conditions. A pop-up will appear with a list of all available content. 9 From this display, click on the content‘s name to display the SharePoint location. You can also check the result(s) using the checkbox on the left, giving you access to all single and batch settings listed in the Admin (tree mode) section above. Any settings specified here will limit the search results set in the other tabs. Permission Criteria © 2001-2008 AvePoint, Inc. All rights reserved. Page 216 ‖ button. In this tab, you can limit the search results based on permissions: Step 1 2 Action You may select a permission to limit the results by from the following list: Any Permission Full Control Design Contribute Read Limited Access View Only You can also use the radio buttons below to create a more general search: ―Exact Permission‖ : Returns search results meeting the permission field exactly. ―Exact Permission or Better‖ : Returns search results of permission levels equal to or greater than the permission field specified. 3 You may set the search results to contain only inherited permissions and/or explicitly granted permissions. 4 Select ―Set‖ to apply the search criteria, or skip this step and apply a filter from one of the other Security tabs. 5 Select ―Save as‖ to save the search to the list in Area 3. You can reuse these searches later. 6 Select ―Start Search‖ to display the content resulting from the search conditions. A pop-up will appear with a list of all available content. 7 From this display, click on the content‘s name to display the SharePoint location. You can also check the result(s) using the checkbox on the left, giving you access to all single and batch settings listed in the Admin (tree mode) section above. Any settings specified in the Security Search criteria sections above will overlap. For instance, if you want to search only on the site level for a specific group, and see only those sites for which they have full access, all three tabs can be combined to produce this result. 5.4.3 Activity History This section will describe how to use ―Activity History‖ to audit all actions performed from the © 2001-2008 AvePoint, Inc. All rights reserved. Page 217 ―Administrator‖ module. Please choose ―Administration‖ ―SharePoint Administrator‖ and select ―Activity History.‖ 5.4.3.1 Enable Activity History Please follow the following steps to enable activity history. This will allow you to specify the farms to manage archives for: Step Action 1 Click on the ―Enable Activity History‖ option in the column on the right. 2 The ―Database Location‖ field allows you to specify a location for the audit database which stores the Activity History. You can change this location and select ―Apply‖, but the default location is: ―… \AvePoint\DocAve4\VaultServer\Derby\auditor\auditor‖ 3 Select a farm from the list in the middle column to display the tree structure in the right window. To monitor activity for this farm or content underneath it, select the checkbox next to the corresponding level in the tree view and press the ―Add Scope‖ button. 4 *Note: When selecting content, you will be unable to select both a parent and child node to add simultaneously, since the child node will automatically be audited with the parent node. 5 Check the content you desire from the middle column and select ―Delete‖ to remove items from the scope. *Note: If you have selected content from the farms list and added it to the scope, when selecting sub content in the farm list a pop-up window a warning will ask you to confirm that you want to select the sub content instead. 5.4.3.2 Reports The ―Reports‖ option offers a centralized location that allows you to look over, download, or upload the resulting report of the activity history. It lists the archive in a history table format and provides © 2001-2008 AvePoint, Inc. All rights reserved. Page 218 several options for viewing the data. SP Operation The resulting reports from the following steps will show information on the general operation of the SharePoint environment: Step 1 Action You may specify the ―Refresh‖ setting for the activity history as 3, 10, 30, or 120 seconds. You also may refresh the table instantly using the ―Refresh‖ button. To restrict the report field, you can use the ―Display By‖ option. This allows you to specify reports based on: ―Agent Host,‖ ―Action,‖ ―Operation,‖ ―Node Type,‖ ―Status,‖ and ―User Name.‖ 2 3 The second drop down list will allow you to specify content under the first option. For example, you can view operation reports based on whether they succeeded or not. Using the ―per page‖ drop down list, you can specify the number of reports per page, whether 5, 10, 20, or 30. The ―Previous‖ and ―Next‖ buttons will allow you to page through the content. You can export the reports using the ―Export‖ button. Select a local path or a network location for the log. *Note: The exported data will be in ―.csv‖ format and should be opened using Microsoft Excel. If … Then … 4 Local Drive In the ―Location‖ field, enter a path in the ―C:\data\‖ format. 5 1. Select the ―Network Drive‖ checkbox 2. Enter the destination in the ―Location‖ field using the format : ―\\192.168.1.1\c$\data‖ Network Drive 3. In the fields below ―Location,‖ specify the Domain, User Name, and Password for the corresponding account. After exporting the data, the report table will be empty. If you desire to view any previous report information, browse for the report and select the ―Import‖ button. *Note: The browse field also accepts URLs for the network drives specified in © 2001-2008 AvePoint, Inc. All rights reserved. Page 219 the previous step. Site Quotas & Locks This section will display all information regarding your SharePoint Site Quotas and Locks. Step Action 1 Check the ―Enable tracking of Quotas and Locks‖ checkbox. 2 Set the repeat interval for the frequency of how often to gather the data store on the server. This will also refresh the table. Click ―Save‖ to set this option. 3 Using the ―Agents‖ drop down menu, select the agent you desire view reports for. Click the ―Check Now‖ button to refresh the table immediately. 4 5 6 7 *Note: By default, this information is updated every 10 minutes. However, ―Check Now‖ will alert the Agent to send any updated data to the server database immediately. It will then gather this data. To restrict the report field, you can use the ―Display By‖ option. This allows you to specify reports based on either ―Site Collection‖ or ―Lock.‖ The second drop down list will allow you to specify content under the first option. For example, you can either specify the view to include locked or unlocked sites, or the site collection under the specified agent. Using the ―per page‖ drop down list, you can specify the number of reports per page, whether 5, 10, 20, or 30. The ―Previous‖ and ―Next‖ buttons will allow you to page through the content. For each site collection listed in the history, you can select the ―ShowChart‖ function. This will show the space usage of the site collection in a pop-up window: ―Current Usage‖: This option will show the current warning size, used size, and unused size in a pie graph. © 2001-2008 AvePoint, Inc. All rights reserved. Page 220 ―View History‖: This option will show the current usage, warning, and maximum using a coordinate graph. ―Print Image‖: The displayed graph can be sent to a printer using this option. Clicking on the ―View‖ button will display a pop-up with the owner, title, description, and quota template change history 8 5.4.4 STSADM Interface DocAve supplies a user interface method to run STSADM commands for Microsoft SharePoint. Please follow the steps below to execute scheduled (or immediate) STSADM commands: Step Action 1 From the ―Administration‖ module, select the ―STSADM Interface‖ under ―SharePoint Administrator.‖ 2 Click the checkbox in front of the server names in the left column that will be running the STSADM command. © 2001-2008 AvePoint, Inc. All rights reserved. Page 221 Using the ―Operation‖ filed, select an STSADM command to run. 3 *Note: Please ensure you are running the latest version of DocAve 4.5 to have a complete list of commands. As SharePoint upgrades their interface, this module will also be updated to include new or missing commands. 4 Input the necessary parameters in the fields provided below the command. You can either run this command on a schedule or immediately. If … Then … Either select the ―Submit‖ button or click ―Run now‖ from the schedule section below. Immediately *Note: If you select the ―Submit‖ option, a job report will not be created for this command in the Job Monitor. 5 1. 2. 3. Scheduled 4. Uncheck the ―No Schedule‖ box. Specify a time to run the command using the calendar icon. Select ―Save As‖ to save this command. A list of saved commands can be found on the lower left section of this GUI. You can also reload or delete a previously scheduled task using the corresponding buttons at the bottom of the GUI. *Note: DocAve‘s STSADM interface is intended only to supply an interface to STSADM. Though you can schedule commands, it does not enhance any functionality of STSADM. Any errors received from this module should be referenced in the Microsoft SharePoint Administration Guide. 5.4.5 Report Profile This section describes how users can specify the contents of their farm and web application reports using the ―Report Builder.‖ These reports can be generated using the ―Generate Report‖ settings from the SharePoint Admin (tree and search modes). © 2001-2008 AvePoint, Inc. All rights reserved. Page 222 Report builder contains two configurations: Farm Report and Web Application Report. Default reports contain all information. If you would like to view custom reports about your farms or web applications, you must first configure a new plan using this module. 5.4.5.1 Farm Report In order to set up a farm report profile, follow the steps below: Step Action 1 The profiles will be listed under Farm Report section heading after you have saved it. Select ―[New Report Profile]‖ to begin to configuring the farm report profile. A farm report contains five parts: Farm, Web Application, Content Database, Site Collection and Site: 2 ―Farm‖ : Configuration database, Default database server, Anti-virus, Single sign-on settings, Outgoing e-mail settings, Incoming e-mail settings, Current license, Farm type, Security Setting, Properties, Servers and services, Solutions, Features, Farm features, and Shared services ―Web Application‖ : General settings, Properties, IIS settings, Security settings, Managed paths, Blocked file types, Web application features ―Content Database‖ : General settings, Properties ―Site Collection‖ : General settings, Regional settings, Security settings, RSS settings, Search, Site collection features, Site collection usage (see section below) ―Site‖ : General settings, Security settings, Site features, Site usage (see section below) *Note: You can also use the blue arrows next to each corresponding level to expand for more options on reporting. Since the contents of these headings may not be the same for all farms, these options were provided for greater flexibility for each farm. 3 Once you have configured all features, select ―Save As‖ to create a new profile. The newly created profile will be available from the ―Generate Report‖ function in the SharePoint Administrator module. © 2001-2008 AvePoint, Inc. All rights reserved. Page 223 4 You can use the ―Reload‖ function to reset the selected features to the most recent saved setting. ―Delete‖ will erase the currently selected plan. *Note: If you only select the section titles of web application, content database, site collection, and site in the report builder, your output will only show the farm information by web application URL, content database name, and size in MB. However, if you do not select the title, it will not show any contents for that section, regardless of what is selected under its heading. Enabling Site / Site Collection Usage Data In order to view the Site Collection and Site usage data in the reports, you must first enable this in the SharePoint settings, otherwise only ―zeros‖ will appear in the generated report. Step Action 1 Using the SharePoint Administrator module, select the farm level and the ―Central Administration‖ tab. 2 Select the ―Usage Analysis Processing‖ option to open the popup. 3 Select the checkbox for ―Enable Logging‖ and ―Enable usage analysis processing. 4 You can configure any of the customizable options for log files. Be sure to select the operating times to record usage analysis. 5 Click ―OK‖ to apply these settings. After the first day or two, you should be able to notice changes to your generated reports‘ usage data. 5.4.5.2 Web Application Report To specify the contents of a web application report, please refer to the Farm Report section above. © 2001-2008 AvePoint, Inc. All rights reserved. Page 224 The only limit will be the lack of a ―Farms‖ category to specify report data. All additional functionality will be the same. 5.4.6 Currently Supported and Unsupported Functionality for Administration Components Discovery Central Admin (Tree Mode) Function Topology Picture Zoom in Picture Zoom out Picture Farm Topology Save Picture Print Picture View Service on Server Site Structure Tree Mode View Search by Domain Mode Search by IP Range Mode Search For Windows Search Instance Scan For SP Instances Search by Site Collection Generate Report Manage Farm Features Default Database Check services enabled in this farm Configure session state Records Center HTML Viewer Farm Usage Analysis Processing Antivirus Information management policy configuration Manage Settings for Single Sign-On Timer job status Timer job definitions Master site directory © 2001-2008 AvePoint, Inc. All rights reserved. Page 225 Status Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Unsupported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported settings Site directory links scan Quiesce farm Data retrieval service Outgoing E-Mail Settings Incoming E-mail Settings Custom Properties Web Applications Supported Supported Supported Supported Supported Supported Quota Templates Create web application(Batch) Supported Generate Report(Batch) Web application outgoing e-mail settings(Batch) Web Application General Settings(Batch) Site use confirmation and deletion(Batch) Delete this web application(Batch) Custom Properties(Batch) Extend web application Blocked File Types Create Site Collection(Batch) Define Managed Paths Self-service Site Management Remove SharePoint From IIS Web Site Manage Web Application Features Supported Content Databases Add Content Database Supported Content DB Manage Content Database Settings(Batch) Custom Properties(Batch) Site Collection List Create Site Collection(Batch) Remove Content Database( Batch Only) Web Application © 2001-2008 AvePoint, Inc. All rights reserved. Page 226 Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Site Collection Site Library / List © 2001-2008 AvePoint, Inc. All rights reserved. Page 227 Create site(Batch) Enable RSS Search scopes Search Settings Search keywords Portal Site Connection(Batch) Site Collection Features Delete the site collection(Batch) Site templates List templates Web Parts Deploy Site Maximum Depth Site Collection Quotas And Locks(Batch) Move site action Create site Create site(Batch) Site Theme(Batch) Search visibility Regional Settings(Batch) User Alerts RSS settings Delete This Site(Batch) Custom Properties(Batch) Title, description, and icon Master pages Site content types Site Features Reset to Site Definition Site columns Create List/Library(Batch) Add a web part(Batch) Version Settings(Batch) Advanced settings(Batch) Title, description and navigation User Alerts(Batch) Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported supported Unsupported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Folder Item Document SSP Central Admin (Search Mode) WebApplication © 2001-2008 AvePoint, Inc. All rights reserved. Page 228 RSS Setting Delete this list/library Delete this list/library(Batch) Create New Folder Audience targeting settings Delete Alert Me View properties Edit properties Create New Folder Alert Me Delete Item Alert Me Edit SSP Properties(Batch Only) Edit Shared Services Provider Manage Search Content Sources User profiles and properties Profile services policies My Site settings Trusted My Site host locations Published links to Office client applications Personalization site links File types Default content access account Server name mappings Search-based alerts Usage reporting Specify authoritative pages Extend web application Generate Report Define managed paths Supported Supported Unsupported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Data Base Site Collection © 2001-2008 AvePoint, Inc. All rights reserved. Page 229 Blocked file types Custom properties Web application outgoing e-mail settings Web application general settings Create site collection Self-service site management Site use confirmation and deletion Delete this web application Remove SharePoint from IIS web site Manage Web application features Generate report(Batch) Web application outgoing e-mail settings(Batch) Web application general settings(Batch) Site use confirmation and deletions(Batch) Delete these web applications(Batch) Custom properties(Batch) Create site collection(Batch) Manage content database settings Site Collection List Custom Properties Create Site Collection(Batch) Manage content database settings(Batch) Site Collection List(Batch) Custom Properties(Batch) Custom Properties(Batch) Site collection quotas and Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Site © 2001-2008 AvePoint, Inc. All rights reserved. Page 230 locks Site templates Move site action Search settings Site columns Search scopes Search keywords Enable RSS Delete the site collection Deploy site maximum depth Web parts List templates Site collection features Create site Portal site connection Create site(Batch) Portal site connection(Batch) Delete these site collection(Batch) Site collection quota and locks(Batch) Create site Site theme Search visibility Regional Settings User Alerts RSS setting Delete this site Custom properties Title description and icon Master pages Site content type Site feature Reset to site definition Site columns Create site(Batch) Site theme(Batch) Regional settings(Batch) Delete these sites(Batch) Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Library/List Custom properties(Batch) List\library: Version setting List\library: Advanced setting List\library: Title description and navigation List\library: User alters List\library: RSS setting List\library: Delete this list List\library: Create new folder List\library: Audience targeting settings List\library: Version setting(Batch) List\library: Advanced setting(Batch) List\library: Alter me (Batch) List:Delete these lists (Batch) Folder Farm Security Center (Tree Mode) Web Application © 2001-2008 AvePoint, Inc. All rights reserved. Page 231 Library: Delete these libraries(Batch) Library: Delete this library Alert me Delete View properties Edit properties Create new folder Add Users(Batch) Add Groups(Batch) Service accounts(Batch) All People Groups Site Collection Permissions Security For Web Part Pages(Batch) User Permissions for Web Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Unsupported Supported Supported Supported Supported Supported Supported Application(Batch) Policy for Web Application(Batch) Authentication Providers(Batch) Manage Permission Policy Levels Add Users(Batch) Add Groups(Batch) Edit User Permissions(Batch) Delete Users And Groups(Batch) Site Collection Site Library / List Folder Item © 2001-2008 AvePoint, Inc. All rights reserved. Page 232 Anonymous Access(Batch) Site Collection Administrators(Batch) Groups All People Site Collection Permissions Clone account Permission Add Users(Batch) Add Groups(Batch) Edit User Permissions(Batch) Delete Users And Groups(Batch) Groups All People Site Permissions Clone account Permission Anonymous Access(Batch) Add Users(Batch) Permissions for this list/library Manage checked out files Manage permissions Manage permissions Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Farm Web Application Security Center (Search Mode) Site Collection Site © 2001-2008 AvePoint, Inc. All rights reserved. Page 233 Offline search Scope filter Stop Search FBA User Edit Permission(Batch) Delete Permission(Batch) Add Users(Batch) Inherit parent(Batch) Break Inherit(Batch) Change Group(Batch) Down PDF Report Down CSV Report Down XML Report Add Groups(Batch) Edit Permission(Batch) Delete Permission(Batch) Add Users(Batch) Inherit parent(Batch) Break Inherit(Batch) Change Group(Batch) Down PDF Report Down CSV Report Down XML Report Edit Permission(Batch) Delete Permission(Batch) Add Users(Batch) Inherit parent(Batch) Break Inherit(Batch) Change Group(Batch) Down PDF Report Down CSV Report Down XML Report Add Groups(Batch) Edit Permission(Batch) Delete Permission(Batch) Add Users(Batch) Inherit parent(Batch) Break Inherit(Batch) Change Group(Batch) Down PDF Report Down CSV Report Supported Supported Supported Supported Supported Supported Supported Unsupported Unsupported Supported Supported Supported Supported Unsupported Supported Supported Supported Unsupported Unsupported Supported Supported Supported Supported Supported Supported Supported Unsupported Unsupported Supported Supported Supported Supported Unsupported Supported Supported Supported Supported Supported Supported Supported Supported Activity History STSADM Interface Report Profile Down XML Report Recurs Search Add Groups(Batch) Edit Permission(Batch) Delete Permission(Batch) Add Users(Batch) Inherit parent(Batch) Library / List Break Inherit(Batch) Change Group(Batch) Down PDF Report Down CSV Report Down XML Report Edit Permission(Batch) Delete Permission(Batch) Add Users(Batch) Inherit parent(Batch) Break Inherit(Batch) Folder Change Group(Batch) Down PDF Report Down CSV Report Down XML Report Recurs Search Add Scope Enable Activity Delete Scope History Move Auditor Data Auto refresh Display By Option Export to local or SP Operation network driver Import from file Enable Auto Pruning Auto refresh Display By Option Site Quotas & Locks Show Chart Change History *Note: Please refer to the GUI for the latest list of supported functions. Configuration database Default database server Farm Anti-virus Single sign-on settings © 2001-2008 AvePoint, Inc. All rights reserved. Page 234 Supported Unsupported Unsupported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Unsupported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Replicator Outgoing e-mail settings Incoming e-mail settings Current License Security settings Farm type Properties Servers and services Solutions Features Farm Features Shared services General settings Web Application Features Blocked file types Web Application Managed Paths Security settings IIS settings Properties General settings Content DB Properties General settings(MB) Regional settings Security settings Site Collection RSS settings Search Site Collection Features Site Usage General settings Security settings Site Site Features Site Usage Site collection to site collection Site to site Library to library List to list Two-way Replication Folder to folder Include workflow Email Notification Backup/undo Schedule © 2001-2008 AvePoint, Inc. All rights reserved. Page 235 Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Two-way (merge version) Byte Level Differencing © 2001-2008 AvePoint, Inc. All rights reserved. Page 236 Incremental sync delete Sub site below site collection Test run Dump\load Concurrent Threads Select more Destination One to more agents Throttle Control Different level replication Different type replication Sync delete sub site Sync delete view Sync delete user Document Library Form Library Picture Library Translation Management Library Data Connection Library Slide Library Wiki Page Library Report Library Announcements Contacts Discussion Board Links Calendar Tasks Project Tasks Issue Tracking Survey Custom List Custom List in Datasheet View Languages and Translators Import Spreadsheet KPI Lists One-way replication Two-way replication Supported Unsupported Unsupported Unsupported Unsupported Supported Unsupported Unsupported Unsupported Unsupported Unsupported Unsupported Unsupported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported CLI One-way replication © 2001-2008 AvePoint, Inc. All rights reserved. Page 237 Test run Dump/load One-way Replication Two-way Replication Web application Site collection Site Library List Same Folder level Item replication Column View Attachment Reply Alert me Workflow Version User Group Unsupported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Different level replication Unsupported One to more agents Supported Content only replication Configuration only replication Security only replication Content and configuration replication Content and security replication Configuration and security replication Concurrent threads Email Notification Include workflow Compress Byte Level Differencing Throttle control Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Dump/load Test run Dump/load Backup/undo Schedule Incremental Replicate Modification Incremental Replicate Deletion Select more Destination Differential type replication Differential level change Sync delete sub site Sync delete view Sync delete user One-way replication Include workflow Change Property of Source by XML File Concurrent Threads Throttle Control Email Notification Backup/undo Schedule Compress Byte Level Differencing Two-way replication Supported Supported Supported Supported Supported Supported Supported Unsupported Unsupported Unsupported Unsupported Unsupported Supported Supported Supported Supported Supported Supported Supported Unsupported Unsupported Unsupported Unsupported 5.5 Extension Archiver The Extension Archiver is a business-rule enabled item level archiving engine that seamlessly moves content off of the production SQL servers while still allowing that content to be indexed, searched, viewed, and accessed from within the SharePoint environment. Archiver will move the specified content off of the SQL database, from which SharePoint writes data to, into a data file that can be stored on a local or network drive, file system, and/or a SAN environment. In order to use the Extension Archiver module, we recommend using an account with full administrative access to SharePoint and the SQL servers. However, backup and restore can still be performed using an account with the following access: Member of the local admin group (enough to access the files on the local SharePoint server) Member of the SharePoint farm admin group © 2001-2008 AvePoint, Inc. All rights reserved. Page 238 Member of the database owner group of the SharePoint content DB 5.5.1 Installation Before using the Archiver manager, the Administrator must confirm that the Archiver solution is enabled on the DocAve Client Agent Host and within the Agent Monitor (inside DocAve‘s ―Control Panel‖). 5.5.1.1 Enabling Extension Archiver on DocAve Client Agent Host To confirm that the Archiver solution is enabled on the DocAve Client Agent Host, complete the following steps: *Note: Enabling the Archiver solution will require an IIS Reset. Factor this in when installing Extension Archiver. Step Action 1 Navigate to ―Start Menu‖ -> ―AvePoint DocAve 4.5‖ -> ―DocAve 4.5 Client tools‖ and run the ―Client Configuration Tool.‖ 2 Select the ―Admin‖ tab in the configuration tool. Check the ―Extension Archiver for MOSS 2007‖ box. 3 4 *Note: For SharePoint 2003, the checkbox is titled ―Extension Archiver for SharePoint 2003‖. Click ―Confirm.‖ 5.5.1.2 Configuring Agent Monitor for Extension Archiver The Archiver feature needs to be turned on from the control panel before rules can be created: © 2001-2008 AvePoint, Inc. All rights reserved. Page 239 Step Action 1 From the DocAve GUI, select the ―Control Panel‖ tab. 2 Navigate to ―Control Services‖ ―Agent Monitor.‖ 3 In the column to the right of the navigation panel the servers with the DocAve Agents installed will be displayed. Please select the agent server to enable Archiver. 4 Select the ―Advanced‖ tab in the navigation panel. For all virtual servers running under the DocAve Agent, select ―Enable‖ and ―Archiving‖ to activate the Extension Archiver feature. 5 *Note: For more detail on the functionality of the other options, please refer to the ―Control Panel‖ section of this manual. 5.5.1.3 Integration with SharePoint Search In order to ensure that you can search Archive data directly from the SharePoint native search (in MOSS 2007 only), please follow the steps below: Step Action 1 Navigate to ―Start Menu‖ -> ―AvePoint DocAve 4.5‖ -> ―DocAve 4.5 Client tools‖ and run the ―Client Configuration Tool.‖ 2 Select the ―Admin‖ tab in the configuration tool. 3 Select the ―Integrate with SharePoint Search‖ option beneath the ―Extension Archiver‖ field. © 2001-2008 AvePoint, Inc. All rights reserved. Page 240 4 Click ―Confirm.‖ An IIS restart is recommended after enabling this option. 5 Within the SharePoint environment, enable a ―Crawl‖ service to detect the archive data. This can be done from the ―Add Content Source‖ page. Please consult your SharePoint manual for details. 6 When creating an archive plan, be sure to enable the ―Generate Index‖ option described in the section below. 5.5.2 Basic Setup for Rule Builder To build a new archiving rule, please proceed to the ―Rule Builder‖ under the Archiver section of navigation menu. After enabling Archiver, complete the following steps to create a basic archiving rule: Step Action 1 Under ―Administration‖ -> ―Extension Archiver‖ -> ―Rule Builder,‖ select ―New Rule‖ from the column on the left. 2 Select an Agent from the ―Farm Name‖ drop-down box. Make sure that the selected agent has content enabled for archiving as described in the section above. 3 Specify the ―Agent Group‖ from the available list. This list can be configured in the ―Control Panel.‖ 4 Select a Media Server to archive the content to. You can specify the logical drive on the Media Server to archive the content to using the ―Drive‖ drop-down menu. 5 Select an Email Notification and Data Retention policy previously configured in the ―Control Panel‖ from the drop down menu. 6 Select a ―Data Configuration‖ option. You can select whether to compress or encrypt data on the server and client side here. 7 If you do not plan on running this job now, you can set it to run on a schedule by un-checking the ―No Schedule‖ checkbox. Using the calendar icon next to the ―Start Time‖ field, select a date and time for the archive © 2001-2008 AvePoint, Inc. All rights reserved. Page 241 job to run. Also, set an interval for recurring rules based on an hourly, daily, weekly, or monthly schedule. Choose from the four properties described below, and check the corresponding boxes next to the desired settings: ―Open Audit‖ : Enable SharePoint‘s auditing feature during this job with this option. This will enable it on all sites included in the archive plan. In order to permanently enable this within SharePoint, please consult your SharePoint user guide. *Note: This option is not available in the SharePoint 2003 version of Extension Archiver. Also, you must set the ―Accessed Time‖ rule when building the rules in order for this to take effect. ―Test Archiving‖ : This option will not move any content during the Archive, it will only generate a job report containing information on the amount of data to be archived based on the rules applied. You can locate this report in ―Job Monitor.‖ ―Create Stub‖ : This option will create a 1 KB stub in the original location of the archived files. If no stub is created, you will be unable to view this content from the SharePoint environment. It is selected by default. ―Generate Index‖ : In order to ensure that the archived content can be fully indexed and searched, enable this option. To enable indexing simply check the ―Generate Index‖ box and configure cache settings. 8 *Note: In order to search for the archived item from SharePoint, you must install the necessary web part. Please see the section below for more information. 9 10 Browse through the farm using the Tree Mode, List Mode, or Filter Mode (described in detail in the Data Protection Module). Select the content using the checkboxes next to each corresponding level. Using the scheduling carousel, assign archiving rules based on the section below (―Archiving at Different Levels‖). © 2001-2008 AvePoint, Inc. All rights reserved. Page 242 11 Select ―Save As‖ to set the plan. If it is set to run on a schedule, no further steps are required. 12 Select ―Run Now‖ if you desire to begin the archiving process immediately. 5.5.3 Archiving at Different Levels Using the Rule Building carousel, you can select various levels to assign archiving rules. At least one field should be filled in under each rule before saving this setting. It supports the wildcard ―*.*‖ in Document, Document version and Attachment rule and the wildcard ―*‖ in other rules. Stubs will be created in your SharePoint Document Libraries, allowing you to restore archived contents directly from SharePoint. However, these stubs will not be created for custom list items, and you must use the restore controller or custom web part to accomplish this. *Note: When using the Extension Archiver in SharePoint 2003, you will only be able to create rules on the ―Attachment,‖ ―Document,‖ ―Document Version,‖ and a ―Common‖ level. The first three tabs are nearly the same for both 2003 and 2007 environments, but the ―Common‖ level is most similar to the ―Objects within the Site‖ filter of the ―Site‖ tab. 5.5.3.1 Archiving at the Document Level Archiving at the Document Level allows users to archive away documents and all of their corresponding versions according to established archiving rules. Step Action 1 Using the rule building carousel, select ―Document‖ and check the ―Enable‖ box. The corresponding red tab should now be colored blue. 2 In the ―Document Name‖ field, either enter the name of a specific document or enter any wildcard (*). For example, to archive all Microsoft Word documents, enter ―*.doc‖ in this field. © 2001-2008 AvePoint, Inc. All rights reserved. Page 243 Fill in the optional time fields: ―Accessed Time,‖ ―Created Time,‖ and ―Modified Time‖ by selecting the ―……‖ button. *Note: The ―Accessed Time‖ field is not available in the SharePoint 2003 version. 3 If … Then … Before Select this box and use the calendar icon to choose a date and time. Any content on this level created / accessed / modified before this time will be archived. Older Than Select this box and enter a positive integer for the number of days, weeks, months, or years old the content should begin archiving. 4 You can create a rule using the ―Owner‖ field that can be set in SharePoint. 5 You can enter a name in the field of ―Last Modifier‖ for this archiving rule. 6 Using the ―Document Size‖ field, a positive integer can be entered (and set to KB, MB, or GB). Any file larger than the specified number will be archived. 7 The ―How Long to Keep Stub‖ option will limit the amount of time the stub is kept in the SharePoint environment. Once this stub is removed, the content can no longer be accessed through SharePoint. This value can be specified in days, weeks, months, and years. 8 You can also archive based on the ―Column‖ rule by clicking the ―Column Settings‖ button. This refers to any column related to an item in the SharePoint environment. Either enter the column information in the given fields to the left, or specify custom metadata using the ―Add‖ button to the right. 5.5.3.2 Archiving Based on Document Version Archiving based on the Document Version will archive based on the versions on a particular document or document type. © 2001-2008 AvePoint, Inc. All rights reserved. Page 244 Step Action 1 Using the rule building carousel, select ―Document Version‖ and check the ―Enable‖ box. The corresponding red tab should now be colored blue. 2 In the ―Document Name‖ field, either enter the name of a specific document or enter any wildcard (*). For example, to archive all Microsoft Word documents, enter ―*.doc‖ in this field. Fill in the optional ―Modified Time‖ field by selecting the ―……‖ button. 3 If … Then … Before Select this box and use the calendar icon to choose a date and time. Any content on this level created / modified before this time will be archived. Older Than Select this box and enter a positive integer for the number of days, weeks, months, or years old the content should begin archiving. 4 You can enter the name of the last person to modify this document in the field ―Modifier.‖ 5 Using the ―Document Size‖ field, a positive integer can be entered (and set to KB, MB, or GB). Any file larger than the specified number will be archived. Using the ―Keep History Version‖ field, you can enter the number of past versions to keep on the SharePoint production server. All previous versions will be archived. 6 *Note: The current version does not count. If ―1‖ is entered, the current version is kept along with one additional version history. To keep only the current document version, enter ―0‖ in this field. 7 The ―How Long to Keep Stub‖ option will limit the amount of time the stub is kept in the SharePoint environment. Once this stub is removed, the content can no longer be accessed through SharePoint. This value can be specified in days, weeks, months, and years. © 2001-2008 AvePoint, Inc. All rights reserved. Page 245 5.5.3.3 Archiving Based on Attachment The Attachment rule will archive attachments to list items within SharePoint. Step Action 1 Using the rule building carousel, select ―Attachment‖ and check the ―Enable‖ box. The corresponding red tab should now be colored blue. 2 In the ―Attachment Name‖ field, either enter the name of a specific attachement or enter any wildcard (*). For example, to archive all Microsoft Word documents, enter ―*.doc‖ in this field. Fill in the optional ―Created Time‖ field by selecting the ―……‖ button. 3 If … Then … Before Select this box and use the calendar icon to choose a date and time. Any content on this level created / modified before this time will be archived. Older Than Select this box and enter a positive integer for the number of days, weeks, months, or years old the content should begin archiving. 4 You can create a rule using the ―Owner‖ field that can be set in SharePoint. 5 Using the ―Attachment Size‖ field, a positive integer can be entered (and set to KB, MB, or GB). Any file larger than the specified number will be archived. 6 The ―How Long to Keep Stub‖ option will limit the amount of time the stub is kept in the SharePoint environment. Once this stub is removed, the content can no longer be accessed through SharePoint. This value can be specified in days, weeks, months, and years. 5.5.3.4 Archiving at the Site Level Archiving at the Site-level allows users to archive entire sites (with their children nodes) according to established archiving rules. © 2001-2008 AvePoint, Inc. All rights reserved. Page 246 Step Action 1 Using the rule building carousel, select ―Site‖ and check the ―Enable‖ box. The corresponding red tab should now be colored blue. Under the ―Apply To‖ field, select either the ―Entire Site‖ or ―Objects within the Site.‖ If … Then … Entire Site In this mode the entire site matching the search criteria will be archived. Users attempting to access an archived site will see a SharePoint site containing a web part allowing them to browse the archived content. This mode will create a base rule for archiving to be used in conjunction with others. If you use this rule, you must establish another rule to handle the content of these sites. 2 Objects within the Site For example, if an ―Objects within the Site‖ rule is established with a ―Site Size Trigger‖ of 10 GB, any content in sites over that size will be eligible for archiving. The content will not be archived if it does not match any of the other rules provided. *Note: This field is most similar to the ―Common‖ tab of the SharePoint 2003 Extension Archiver. 3 In the ―Name‖ field, either enter the name of a specific site or enter any wildcard (*). Fill in the optional time fields: ―Accessed Time,‖ ―Created Time,‖ and ―Modified Time‖ by selecting the ―……‖ button. 4 If … Then … Before Select this box and use the calendar icon to choose a date and time. Any sites created / accessed / modified before this time will be archived. Older Than Select this box and enter a positive integer for the number of days, weeks, months, or years old the content should begin archiving. © 2001-2008 AvePoint, Inc. All rights reserved. Page 247 5 You can create a rule using the ―Owner‖ field that can be set in SharePoint. 6 You can enter a name in the ―Template‖ field to select sites that all follow a similar template. 7 Using the ―Site Size Trigger‖ option, enter a positive integer set to KB, MB, or GB. Any site larger than the specified number will be archived. 8 The ―Objects within the Site‖ function also has another rule that can be set named ―Site Quota Trigger.‖ Once the ―Start at Upper Bound‖ percentage is reached, archiving will begin and continue until the ―Stop at Lower Bound‖ percentage is reached. For example, if an upper bound of 70% is set with a lower bound at 30%, any site with content greater than 70% of the quota will begin archiving content according to the pre-set rules until a quota of 30% is reached. 5.5.3.5 Archiving at the Subsite Level Archiving at the subsite level allows for archiving of subsites with their children nodes according to established archiving rules. Step Action 1 Using the rule building carousel, select ―Subsite‖ and check the ―Enable‖ box. The corresponding red tab should now be colored blue. Under the ―Apply To‖ field, select either the ―Entire Subsite‖ or ―Objects within the Subsite.‖ 2 If … Then … Entire Subsite In this mode the entire subsite matching the search criteria will be archived. Users attempting to access an archived subsite will see a SharePoint site containing a web part allowing them to browse the archived content. © 2001-2008 AvePoint, Inc. All rights reserved. Page 248 Objects within the Subsite This mode will create a base rule for archiving to be used in conjunction with others. If you use this rule, you must establish another rule to handle the content of these subsites. *Please see the ―Archiving at the Site Level‖ section for an example rule. 3 In the ―Name‖ field, either enter the name of a specific subsite or enter any wildcard (*). Fill in the optional time fields: ―Accessed Time,‖ ―Created Time,‖ and ―Modified Time‖ by selecting the ―……‖ button. 4 If … Then … Before Select this box and use the calendar icon to choose a date and time. Any subsites created / accessed / modified before this time will be archived. Older Than Select this box and enter a positive integer for the number of days, weeks, months, or years old the content should begin archiving. 5 You can create a rule using the ―Owner‖ field that can be set in SharePoint. 6 You can enter a name in the ―Template‖ field to select sites that all follow a similar template. 5.5.3.6 Archiving at the List Level Step Action 1 Using the rule building carousel, select ―List‖ and check the ―Enable‖ box. The corresponding red tab should now be colored blue. 2 Under the ―Apply To‖ field, select either the ―Entire List‖ or ―Objects within the List.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 249 If … Then … Entire List In this mode the entire list matching the search criteria will be archived. Users attempting to access an archived list will see a SharePoint site containing a web part allowing them to browse the archived content. Objects within the List This mode will create a base rule for archiving to be used in conjunction with others. If you use this rule, you must establish another rule to handle the content of these subsites. *Please see the ―Archiving at the Site Level‖ section for an example rule. 3 In the ―Name‖ field, either enter the name of a specific list or enter any wildcard (*). Fill in the optional time fields: ―Accessed Time,‖ ―Created Time,‖ and ―Modified Time‖ by selecting the ―……‖ button. 4 5 If … Then … Before Select this box and use the calendar icon to choose a date and time. Any subsites created / accessed / modified before this time will be archived. Older Than Select this box and enter a positive integer for the number of days, weeks, months, or years old the content should begin archiving. You can create a rule using the ―Owner‖ field that can be set in SharePoint. 5.5.3.7 Archiving at the Item Level Step 1 Action Using the rule building carousel, select ―Item‖ and check the ―Enable‖ box. The corresponding red tab should now be colored blue. © 2001-2008 AvePoint, Inc. All rights reserved. Page 250 2 In the ―Name‖ field, either enter the name of a specific item or enter any wildcard (*). For example, to archive all Microsoft Word documents, enter ―*.doc‖ in this field. Fill in the optional time fields: ―Accessed Time,‖ ―Created Time,‖ and ―Modified Time‖ by selecting the ―……‖ button. 3 If … Then … Before Select this box and use the calendar icon to choose a date and time. Any item created / modified before this time will be archived. Older Than Select this box and enter a positive integer for the number of days, weeks, months, or years old the content should begin archiving. 4 You can create a rule using the ―Owner‖ field that can be set in SharePoint. 5 You can enter a name in the field of ―Last Modifier‖ for this archiving rule. 6 Enter the ―Content Type‖ to be archived in the field provided. This can either be a standard SharePoint content type (Announcement, Contact, Document, etc.) or a custom type. 7 You can also archive based on the ―Column‖ rule by clicking the ―Column Settings‖ button. This refers to any column related to an item in the SharePoint environment. Either enter the column information in the given fields to the left, or specify custom metadata using the ―Add‖ button to the right. 5.5.3.8 Archiving Based on the Item Version Step 1 Action Using the rule building carousel, select ―Item Version‖ and check the ―Enable‖ box. The corresponding red tab should now be colored blue. © 2001-2008 AvePoint, Inc. All rights reserved. Page 251 2 In the ―Name‖ field, either enter the name of a specific item or enter any wildcard (*). For example, to archive all Microsoft Word documents, enter ―*.doc‖ in this field. Fill in the optional ―Modified Time‖ field by selecting the ―……‖ button. 3 4 If … Then … Before Select this box and use the calendar icon to choose a date and time. Any content on this level created / modified before this time will be archived. Older Than Select this box and enter a positive integer for the number of days, weeks, months, or years old the content should begin archiving. You can enter the name of the last person to modify this item in the field ―Last Modifier.‖ Using the ―Keep History Version‖ field, you can enter the number of past versions to keep on the SharePoint production server. All previous versions will be archived. 5 *Note: The current version does not count. If ―1‖ is entered, the current version is kept along with one additional version history. To keep only the current item version, enter ―0‖ in this field. 5.5.4 The Restore Controller Although you can choose to allow individual users to restore archived content to production direct from the SharePoint site, the Restore Controller is a quick way to restore archived documents from the DocAve GUI back onto the SharePoint environment directly. To execute an archive restore through the Restore Controller, complete the following steps: Step Action 1 Select ―Restore Controller‖ below the ―Extension Archiver‖ section of the DocAve ―Administration‖ module. 2 In the ―Extension Archiver Job Browser‖ section, navigate through the media servers and agents to find the content you would like to restore from. © 2001-2008 AvePoint, Inc. All rights reserved. Page 252 3 After selecting the level containing the desired content to be restored, a pop-up should appear. Using the radio button, select the field that the data was archived from. Press ―OK‖ when you have selected the content. *Note: Using the ―From‖ and ―To‖ calendar fields, you can restrict the archive jobs listed. In the ―Extension Archiver Data Browser,‖ expand the tree containing your SharePoint farm. 4 *Note: If you do not wish to browse for the items to be restored, there is a ―Search‖ function available. The search can be based on search criteria such as: Sites, Subsites, Lists, Folders, Items, and Item Attributes. The ―From/To‖ time fields point to the archived time. 5 The ―Path Info‖ area to the lower right will show the items and version histories available under each level. Select individual or all documents to restore. You can also select all content under each level using the radio button to the left of each level. 6 You can select the ―Property‖ and ―Security‖ options to restore all metadata and permissions set for the file. 7 Select an Agent Group to restore to. Select a ―Restore Option‖ from the drop-down list If… Then… DocAve will not restore the content if it already exists on the destination. 8 Not Overwrite Overwrite 9 For example, if an entire folder‘s content is selected for restore, but only one document was removed from the destination folder, only the removed document will be restored. DocAve will restore the content over whatever exists on the destination. This will delete the content on the destination and replace it with the content selected to be restored. Select either the ―Go‖ button or the ―Schedule‖ button to configure the restore. The schedule button will allow you to select the date and time of the restore from a popup. © 2001-2008 AvePoint, Inc. All rights reserved. Page 253 You may enter a ―Description‖ in the field provided to help distinguish this job in the Job Monitor. 5.5.5 Archive Search Web Part When DocAve Archiver archives a document, the file is moved off the SharePoint Database, and is no longer searchable through the default SharePoint Search Engine. The DocAve ―Archive Search‖ web part will allow the searching of these archived files. 5.5.5.1 Installing the Web Part DocAve will automatically install the web part to SharePoint when the Extension Archiver is installed in the ―Client Configuration Tool.‖ Step Action 1 You still must add the web part to the website. Go to the SharePoint Site ―Site Actions‖ ―Edit Page.‖ 2 Click the ―Add a Web part‖ button. 3 Under the ―Miscellaneous‖ group, check the box next to ―SPArchiveBrowser‖ and click the ―Add‖ button. 5.5.5.2 Using the Browse Web Part After this web part has been installed to the SharePoint site, you can now search for archived content using the ―Search‖ or ―Browse‖ feature. Below is a description of the ―Browse‖ feature. Step © 2001-2008 AvePoint, Inc. All rights reserved. Page 254 Action 1 Navigate to the SharePoint page with the web part installed. 2 Using the ―From Time‖ and ―To Time‖ fields, you can specify a time and date range to search for the archived content. Select the calendar icons to specify the range. 3 After specifying the range, select ―Browse‖ to open the archived data browser. 4 Using the tree on the left, browse for the content you would like to view. You can either select individual documents on the right, or select all documents under a specific level using the radio buttons on the left. 5 By clicking on the file name link, a popup will display all metadata columns and their corresponding values. You can choose to ―Display the File‖ using the corresponding button to view the content. *Note: If there is no metadata associated to the file, a ―No Column Information‖ popup will occur. 6 Check the ―Security‖ and ―Property‖ checkboxes to restore all security and metadata information pertaining to the selected content. You can specify a restore option for the selected content If… Then… DocAve will not restore the content if it already exists on the destination. 7 Not Overwrite Overwrite © 2001-2008 AvePoint, Inc. All rights reserved. Page 255 For example, if an entire folder‘s content is selected for restore, but only one document was removed from the destination folder, only the removed document will be restored. DocAve will restore the content over whatever exists on the destination. This will delete the content on the destination and replace it with the content selected to be restored. 5.5.5.3 Using the Search Web Part After this web part has been installed to the SharePoint site, you can now search for archived content using the ―Search‖ or ―Browse‖ feature. Below is a description of the ―Search‖ feature. Step Action 1 Navigate to the SharePoint page with the web part installed. 2 Select the ―Search‖ button. 3 You can enter the URL for the search ―Scope‖ in the field provided. By default, the Site the web part is installed to will be entered in this field. 4 Enter the search criteria in the ―Word‖ field. Press the ― ‖ button to complete the search. You can view detailed information on this item by clicking on the search results. *Note: Wildcards (*) are not accepted in this field. 5 Using the ―Show Advanced Options‖ button, you can specify limits to the search based on: ―Matching results‖ : show results from content and/or metadata ―Date Range‖ : restrict results to data archived Today, Yesterday, in the last few days, or in a specific range set by the ―From/To‖ fields. ―Sampling‖ : Sampling will return a random percentage of the content selected, or one document every specific number of files. ―SharePoint Type‖ : The type of the file, either a document, item, web (subsite), list, or folder. ―File Format‖ : Allows you to restrict the content to either include or omit a specific extension. *Note: Multiple fields can be selected using ―ctrl + click.‖ ―Content Type‖ : Allows you to restrict the content to either include or omit a specific type of SharePoint content. *Note: Multiple fields can be selected using ―ctrl + click.‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 256 6 You can also restrict the search to simple metadata (―Author‖ and ―Last Modified Time‖), or to advanced by clicking the ―More Metadata‖ button. You can specify the conditions in the column on the left, and use the ―Add‖ button to create a list of filters on the right. 7 Once you set your filters, press the ― ‖ button to show the results. You can view details of the results by clicking on the file title. 8 Under the results, select the ― ‖ button to restore the content. 5.5.6 About Archived Documents Once a document is successfully archived it, will still be accessible from within SharePoint. DocAve creates a stub in the place of the archived item, allowing end users to access the document via either the SharePoint page or the default SharePoint search. The archived content will receive a new icon, with a graphical ―A‖ ( ) indicating that AvePoint‘s Extension Archiver has archived the content. The size of the archived content will also be reduced to 1KB. If the ―Prompt‖ option was selected in the Agent Monitor, when an end user attempts to open an archived file, they will be presented with a prompt page. This prompt page will allow the end user to choose between the ―Display‖ or ―Restore‖ option as described in earlier sections of this user guide. Archived documents can also be searched using the native SharePoint search. In order to use this, a crawl service must be started from SharePoint. Please see your SharePoint user guide for more information. All securities will be retained when users search for the file directly from SharePoint. 5.5.7 Uninstalling Extension Archiver To disable Archiver the end user must disable it from the ―Client Configuration Tool‖ on the target SharePoint Front End server. To uninstall DocAve Archiver, complete the following steps: Step © 2001-2008 AvePoint, Inc. All rights reserved. Page 257 Action 1 2 From the target SharePoint front end server, navigate to ―Start‖ -> ―AvePoint DocAve 4.5‖ -> ―DocAve 4.5 Client Tools‖ -> ―Client Configuration Tool.‖ From this screen locate Extension Archiver (Archiver for SP 2003) and uncheck the ―DocAve Extension Archiver for MOSS 2007‖ (or Archiver) found within the Data Protection tab. Click ―Confirm.‖ *Note: Disabling the Extension Archiver solution will require an IIS Reset. 3 Open the DocAve GUI and navigate to the ―Control Panel‖ -> ―Control Services‖ -> ―Agent Monitor.‖ 4 Select the desired Agent Host from the list on the left. 5 Open the ―Advanced‖ tab. 6 Uncheck the ―Enable‖ box, along with the Archiving box. 5.5.8 Supported Functionalities The following sections describe the supported elements for 2003 and 2007. 5.5.8.1 Currently Supported and Unsupported Elements for 2003 Archiver Source Libraries Type Document Library Supported Form Library Supported Picture Library Supported Communications Announcements List Status Supported Contacts Supported Discussion Board Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 258 Known Issues* Tracking Lists Links Supported Tasks Supported Issues Supported Survey Supported Events Supported Custom List Supported Custom List in Datasheet View Supported Import Spreadsheet Supported Security & Version settings Supported Properties Column Settings Supported Permissions Supported Document Library Supported Custom Lists Version Histories Form Library Site Templates Personal Sites . Supported Picture Library Supported Team Site Supported Blank Site Supported Document Workspace Supported Basic Meeting Workspace Supported Blank Meeting Workspace Supported Decsion Meeting Workspace Supported Social Meeting Workspace Supported Multipage Meeting Workspace Supported My Site Supported 5.5.8.2 Currently Supported and Unsupported Elements for 2007 Extension Archiver Source Document Type Status Document Library Supported Form Library Supported Picture Library Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 259 Known Issues* Document Version Attachment Item Item Version Translation Management Library Supported Data Connection Library Supported Report Library Supported Document Library Supported Form Library Supported Picture Library Supported Translation Management Library Supported Data Connection Library Supported Report Library Supported Announcements Supported Calendar Supported Tasks Supported Project Tasks Supported Custom List Supported Custom List in Datasheet View Supported Languages and Translators Supported Issue Tracking Supported Announcements Supported Contacts Supported Links Supported Calendar Supported Tasks Supported Project Tasks Supported Issue Tracking Supported Custom List Supported Custom List in Datasheet View Supported Languages and Translators Supported Announcements Supported Contacts Supported Links Supported Calendar Supported Tasks Supported Project Tasks Supported Issue Tracking Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 260 Site Custom List Supported Custom List in Datasheet View Supported Languages and Translators Supported PWA Site Supported Project Server Workspace Supported Team Site Supported Blank Site Supported Document Workspace Supported Wiki Site Supported Blog Supported Basic Meeting Workspace Supported Blank Meeting Workspace Supported Decision Meeting Workspace Supported Social Meeting Workspace Supported Multipage Meeting Workspace Supported Document Center Supported Records Center Supported Site Directory Supported Search Center with Tabs Supported Not overwrite and overwrite My Site Host Supported restored but Web Part still appeared Subsite Search Center Supported Collaboration Portal Supported Publishing Portal Supported Team Site Supported Blank Site Supported Document Workspace Supported Wiki Site Supported Blog Supported Basic Meeting Workspace Supported Blank Meeting Workspace Supported Decision Meeting Workspace Supported Social Meeting Workspace Supported Multipage Meeting Workspace Supported Document Center Supported Records Center Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 261 Site Directory Supported Search Center with Tabs Supported Not overwrite and overwrite My Site Host Supported restored but Web Part still appeared List Search Center Supported Collaboration Portal Supported Project Server Workspace Supported Publishing Portal Supported Document Library Supported Form Library Supported Wiki Page Library Supported Picture Library Supported Translation Management Library Supported Announcements Supported Contacts Supported Discussion Board Supported Links Supported Calendar Supported Tasks Supported Project Tasks Supported Issue Tracking Supported Custom List Supported Custom List in Datasheet View Supported Languages and Translators Supported KPI Lists Supported Import Spreadsheet Supported Basic Page Supported Web part Page Supported Sites and Workspaces Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 262 Some customizations are not supported. 5.6 Content Manager for SP2003/WSS2.0 Content Manager is a feature on the DocAve software that will allow you to copy content from one location to another, similar to the Replicator module for MOSS 2007. The copy can be done on either the same or a different SharePoint farm, or from a standby SQL server. This guide will provide you an understanding on how to use Content Manager and its three different copying methods. Typically, to move content from one location and another you must backup the content and restore it using an out of place restore. Content Manager provides a useful interface to aid in copying content, creating a seamless one step process. Please understand that Content Manager can copy contents from one location to another location, but it cannot do automatic real time replication of an entire Share Point farm. This must not be confused with the abilities of the Share Point Disaster Recovery (SPDR) features. 5.6.1 Single Farm Copy Performing a Single Farm copy in Content Manager will copy contents within the same farm only. Data can be copied to other virtual servers, sites, subsites, and libraries. Other areas can also be copied to using SharePoint Portal. Please follow the instructions below to setup a Single farm copy using Content Manager. Step Action 1 Select the Agent host from the ―Destination Agent‖ drop down box. 2 Select the ―Single Farm‖ tab in the Source Option section. 3 Select the ―Virtual Server‖ from the drop-down list. 4 Select the ―Content Database‖ from drop-down list. © 2001-2008 AvePoint, Inc. All rights reserved. Page 263 5 After clicking on the Destination Agent name, the ―Data Object Tree‖ will populate. All of the contents of that particular Virtual Server and Content Database will be displayed. 6 You can navigate through the contents by clicking on each level to expand below. Using the radio button next to the corresponding levels, select what content you would like to copy. 7 On the right panel you will be able to select a ―Virtual Server‖ for the Destination Agent. 8 By clicking on the Agent to expand its corresponding levels below, select the level of the tree to copy data to using the radio buttons. You may specify a new level to copy the content to by using the blank field under each level. 9 You can specify the copy to run on a schedule using the ―Schedule‖ popup. Select a time and date from the calendar icon and select ―OK.‖ Specify a ―Restore Option‖ from the list below: 10 11 If … Then … Not-Overwrite The contents (lists / folders / documents) will be replicated from the source to the destination. If a file already exists, it will be ignored. Overwrite Copies the contents from the source to the destination by overwriting any contents (lists / folders / documents) in the destination with the same name. You may enter a description in the appropriate field to make the job more identifiable in the Job Monitor. Select ―Go‖ to run the copy immediately. *Note: For instructions on performing Single Farm SQL copies, please see the instructions for a ―Cross Farm‖ below. 5.6.2 Cross Farm Copy Content Manager will allow you to copy content from one SharePoint farm to another using the ―Cross Farms‖ tab. For example, this function can be used to copy a site from a development environment to a production environment. Please follow the instructions below to setup a Cross Farm copy using © 2001-2008 AvePoint, Inc. All rights reserved. Page 264 Content Manager: *Note: This only works on the Content DB level, so you must be able to provide the SharePoint Database, the instance of that database, and an account that has full administrative privileges. Step Action 1 Select the Agent host from the ―Destination Agent‖ drop down box. 2 Select the ―Cross Farms‖ tab in the Source Option section. Specify ―Server Name,‖ ―Instance Name,‖ ―User Name,‖ and ―Password‖ for the SQL Server. 3 You can select the ―SQL Default‖ option to simply enter the Server Name and Instance, using the account information specified in the Agent Monitor. 4 Select ―Get DB‖ to load the database in the area below. You can also select ―Reset‖ to clear the fields. 5 Select a database from the drop down box. 6 Select the data you wish to copy over to the Destination Agent Host using the radio buttons next to the corresponding levels. 7 On the right panel you will be able to select a ―Virtual Server‖ for the Destination Agent. 8 Select the level of the tree to copy data to using the radio buttons. Click on each level to expand the content below. You may specify a new level to copy the content to by using the blank field under each level. 9 Specify a ―Restore Option‖ from the list below: If … Then … © 2001-2008 AvePoint, Inc. All rights reserved. Page 265 10 Not-Overwrite The contents (lists / folders / documents) will be replicated from the source to the destination. If a file already exists, it will be ignored. Overwrite Copies the contents from the source to the destination by overwriting any contents (lists / folders / documents) in the destination with the same name. You may enter a description in the appropriate field to make the job more identifiable in the Job Monitor. Select ―Go‖ to run the copy immediately. 5.6.3 Standby SQL Copy When you select the Standby SQL tab in Content Manager, this indicates that you will copy contents from a Standby SQL database that is being used as a content database of a SharePoint farm. In SharePoint you can specify different content databases for your SharePoint virtual servers. You can also un-associate content databases with the SharePoint farm. When copying content from a standby SQL, you must make sure that the SQL is not associated to any SharePoint farms, and that it is not live (i.e. being used for production). Please follow the directions for a ―Cross Farm‖ copy listed above to perform a Standby SQL copy using Content Manager. © 2001-2008 AvePoint, Inc. All rights reserved. Page 266 6. Compliance Jump to Table of Contents DocAve‘s ―Compliance‖ module can backup data from a SharePoint environment in immutable form to a selected Media Server. Compliance supplies a way to audit backup data, and download and view the file metadata, usage and audit reports in detail. 6.1 Compliance Manager 6.1.1 Rule Builder This is the combined Auditor / Archiver rule builder. In order to use the Compliance Archiver module, we recommend using an account with full administrative access to SharePoint and the SQL servers. However, backup and restore can still be performed using an account with the following access: Member of the local admin group (enough to access the files on the local SharePoint server) Member of the SharePoint farm admin group Member of the database owner group of the SharePoint content database. Using the tabs, enable either ―Archiver,‖ ―Auditor‖ or both. Beneath each level, specify the settings in the following steps. 6.1.1.1 Compliance Archiver In order to specify the data to be archived, follow the steps below: Step Action 1 Navigate to ―Rule Builder‖ under ―Compliance Manager‖ in the ―Compliance‖ module. 2 Select a ―Farm Name‖ and ―Agent Group‖ from the drop down menu. This will populate the content browser below. 3 Under the Archiver tab, select a ―Media Server‖ from the dropdown menu. This server will contain the Archive files. Select a drive on this server from the pre-configured list (see the ―Control Panel‖ section of this user guide). © 2001-2008 AvePoint, Inc. All rights reserved. Page 267 4 You can specify ―Data Exclusion‖ and ―Retention‖ policies, as well as ―Email Notification‖ settings based on those configured in the ―Control Panel.‖ 5 Set the optional compression and encryption options from the ―Data Configuration‖ menu. By default, no compression or encryption will be performed. 6 Under Archiver, you can select the ―Generate Index‖ option. This will allow the archived data to be searched. By default, this is checked. Check off the content you would like to archive. The colored triangle on the folder icon indicates that all new content will have the archive rules applied automatically. This can be unchecked by clicking on the folder icon. 7 *Note: You must apply archiving to each site on the same level individually (rules will trickle down to children below if selected). This means that the URL must be highlighted and displayed in the ―Path‖ field. 6.1.1.2 Compliance Auditor The ―Rule Builder‖ can be used to create a schedule for auditing data. Step Action 1 Select a Farm from the appropriate drop down box. You can enable ―Filter‖ or ―List Mode,‖ described in the Data Protection section of this manual. 2 The ―User Exclusion‖ option allows you to audit (or exclude) specific users from these reports. This will open a popup, allowing you to ―Add‖ users to the list. The ―+‖ icon indicates that the user will be audited, but ―-‖ will exclude this user from the report. 3 You can select an ―Apply Rule Option‖ for applying the Audit Rules. There are three choices in this drop down box: ―Not Overwrite‖: When the rules are being applied, if a file already has Audit Reporting turned on for any feature, the new rules will not be applied. ―Overwrite‖: All of the original rules will be deleted and changed to reflect the new ones. ―Append‖: This option will allow DocAve to update the audit rules that are currently attached to the contents. All previous settings will be © 2001-2008 AvePoint, Inc. All rights reserved. Page 268 kept, and any new rules will be applied. 4 Click on the Agent name to expand the tree mode. The tree mode can be expanded down to the item level. Check off the content you would like to audit. The colored triangle on the folder icon indicates that all new content will have the audit rules applied automatically. This can be unchecked by clicking on the folder icon. 5 6 *Note: You must apply auditing to each site on the same level individually (rules will trickle down to children below if selected). This means that the URL must be highlighted and displayed in the ―Path‖ field. You may use the ―Auditor Batch Setting‖ though, this option allows the user to apply the audit settings to all list items that are checked. Select a function to apply to this schedule: ―Fetch Audit Data‖: This function will allow DocAve to pull the audit data into the program. ―Apply Rule‖: This will apply the rules specified in the ―Audit‖ tab, which will be described in the next few steps. ―Trickle Down‖: Trickle down will apply all rules to the current site-level and all of its contents. *Note: By default, SharePoint will automatically ―trickle down‖ all audit rules when applied on the site level. However, if the rule is set to run on another level, you must reapply the audit rules to track any new content added. In order to no content is missed, we recommend reapplying rules on a daily schedule. Set the audit operations. Extra steps required for specific auditing features are listed below. 7 ―Inherit parent settings‖ is default option when checking any content lower than the site-level. This will automatically inherit the audit settings of the sites above that level. If you want to set the individual settings for selecting the report content, uncheck this option to activate the others options. You may select to view Audit Reports when any of the listed actions are taken on the selected contents. *Note: By default, the parent site will have no ―Audit Operation Settings‖ checked. You must select either ―Actions to Audit‖ (which will generate a complete Audit Report), or individual items in order to Audit data. © 2001-2008 AvePoint, Inc. All rights reserved. Page 269 8 You can enter the time you wish to keep the data in the SharePoint database using the ―Keep audit data in SharePoint for ____ days‖ field. This will remove the data from the SharePoint SQL database and store it within DocAve. 9 Save the plan using the ―Save As‖ button. Auditing Site Deletion In order to audit site deletion, you must be running DocAve version 4.5.2.0 or higher. This solution is only required for auditing a top-level site deletion. All others will be audited automatically after checking the ―Delete‖ box under ―Actions to Audit.‖ Step Action Using Windows Explorer, navigate to: 1 ―…\AvePoint\DocAve4\VaultClient\bin\SP2007ComArch\‖ Located under the main installation directory. 2 Locate the ―INSTALL.cmd‖ file and run it. A command prompt should open showing ―Operation completed successfully‖ after a few moments. 3 Using DocAve‘s SharePoint Administrator module, expand the farm tree to the ―Solutions‖ level for the instance containing the installed file. 4 After highlighting the ―Solutions‖ level, click on the ―auditlogviewfeature.wsp‖ function under the Central Administration tab. 5 In the pop-up, select ―Deploy Solution‖ from the top left corner. 6 This item can be deployed only globally. Select a time for deployment and press ―OK.‖ 7 After this solution is deployed, you can check the ―Delete‖ box under ―Actions to Audit‖ for Compliance Auditor on the site level. © 2001-2008 AvePoint, Inc. All rights reserved. Page 270 To view results of this action from the ―Audit Report‖ module, please select the ―Others‖ checkbox under the ―Actions‖ tab of the report options. This option will also allow you to view the ―site deletion‖ operation. 8 *Note: If you do not have the SharePoint Administrator module from DocAve, you can also deploy this solution using SharePoint‘s Central Administration -> Operations -> Global Management -> Solution Management tab. Please consult your SharePoint user guide for more information. 6.1.1.3 Content Browser DocAve supports three ways to browse for data to include in the Archive plan: Tree Mode, List Mode, and Filter Mode. Tree Mode Tree Mode is the default view. This mode allows administrators to view the entire topology of their SharePoint environment while navigating. The name of the farm you have selected should be displayed in the area directly underneath, ready for browsing. Step Action 1 Click on the name of the Agent Host that is currently selected. This will expand the host to display all of the SharePoint instances installed underneath. 2 Clicking on the name of the SharePoint instances will expand the tree further to display the top-level sites located within that specific SharePoint instance. 3 Clicking on the name of a specific top-level site will expand the tree further to display a ―.‖ (also referred to as a ―dot‖ or ―root directory‖), and also subsites located underneath that specific top-level site. 4 Clicking on the dot expands the tree to display folders/lists and content located directly on the top-level site. Clicking on individual subsite names expands the tree to display folders/lists and content located in those individual subsites. 5 There is a check box corresponding to each level on the tree which is by default unchecked. Checking this box indicates that all content on that level (and underneath) is to be extracted and archived, or included in the backup plan. © 2001-2008 AvePoint, Inc. All rights reserved. Page 271 6 When checking a box to specify content to be backed up, the folder icon will include a colored triangle in the lower right corner. This triangle indicates that all new data created in those sites or folders/lists will be automatically included in the archive plan. This option is turned on by default. Clicking on the folder icon itself will remove the triangle, hence indicating that only content that is present at this current time will be archivedup, ignoring new data. *Note: When browsing extremely large environments, the tree may split across multiple pages. To browse multiple pages, click on the ―Paging‖ icon at the top of the tree, then select the page number from the popup displayed. List Mode ―List Mode‖ is designed for large SharePoint environments, usually containing thousands, and even tens of thousands of sites. In ―List Mode‖ the administrator can browse data on a site by site basis, allowing for faster page loads (it does not require the GUI to refresh the whole SharePoint environment). After entering ―List Mode,‖ follow the steps provided in the section above for ―Tree Mode‖ selection of items. Navigation will be on a level by level basis and the ―Parent‖ link at the top of the list can be used to return to the previous level. The URL ―Current Path‖ line is there to help users keep track of which level they are currently in. Filter Mode Filter mode allows searching or filtering of sites, subsites, documents or files. This can be done by typing either the exact URL or using wildcards (*) in the appropriate fields. Step Action 1 Click on the ―Filter Mode‖ tab. 2 There are three options: Rule for Sites, Rule for Web and Rule for Lists. Check the box next to each level to activate the filter function for that level. 3 By default, the ―Case Sensitive‖ option will be checked. To turn off case sensitivity, uncheck the case sensitive check box. © 2001-2008 AvePoint, Inc. All rights reserved. Page 272 4 Underneath each activated ―Rule,‖ input the desired URL. Wildcards (*) are supported here. For example, if your filter should identify all Microsoft Word documents, a ―*.doc‖ wildcard can be typed in this space. Any Site, Web, or List containing a Word document will either be displayed or removed from the final list according to your choice in Step 5. The check box next to each input represents the ―negate‖ feature. If you want the filter to: 5 If… Then… Include matches Click this box to set as a ―+‖ to ensure matching results are displayed. Remove matches Click this box to set as a ―-‖ to ensure matching results will not be displayed. 6 To add an additional URL/wildcard for the Rule, click on the ―Add‖ button and repeat Step 4. To delete a filter, click the ―Delete‖ button. 7 Select the ―Preview‖ button to view the results of the filter. 8 Everything that is visible in the ―Preview‖ will be included in the current archive plan. 6.1.1.4 Setting up the Scheduling Carousel After successfully determining what sites, folders, and lists are to be archived, the next step is to set a schedule to archive this information. Using the ―Scheduling Carousel,‖ the user can determine when, and how often, the archive should be performed. Step Action 1 Uncheck the ―No Schedule‖ check box to activate a Schedule. An active schedule will be highlighted in blue. Inactive schedules are highlighted in red. You can specify up to six schedules. © 2001-2008 AvePoint, Inc. All rights reserved. Page 273 Select a ―Scan Type‖ for the current schedule. If… Then… Full Item A full archive of the selected source will be performed. A partial archive where only data that has been modified since the last full (or folder level) archive. 2 Folder Level Update *Note: When auditing data, be careful when using the ―Folder Level Update.‖ This uses the ―Modified Date‖ property of each folder. However, SharePoint only updates this field on setting or permission changes, it does not update this field as items within the folder are modified. As a result, changed contents may be overlooked by the Auditor using this option. 3 Click on the calendar icon to the right of the Start Time field. 4 Select a date and time in the calendar pop-up window. Then click ―OK.‖ Specify the interval at which the backup will occur. Choices are: Only Once, By Hour, By Day, By Week, or By Month. If … Then … Only Once This will only run once at the specified time. By Hour Either choose this plan to run every set number of hours, or select it to run at specific hours, with the number of minutes past the hour specified by the user in the space provided. Be sure to select either ―AM‖ or ―PM‖ before choosing from the provided hours below. By Day Either set the plan to run every set number of days, or set the plan to run on weekdays or weekends. 5 © 2001-2008 AvePoint, Inc. All rights reserved. Page 274 By Week Either set the plan to run every set number of weeks, or choose the days of the week to re-run this plan. By Month You can choose this plan to run on every set date of every month in the space provided (i.e., on the ―14‖th of every month). You can also set this plan to run in set months of the year, on certain days/weeks of the year. 6 To create another schedule, click on an open Schedule in the carousel and repeat steps 1-5. Otherwise proceed to step 7. 7 Save the plan by clicking on ―Save As‖ and provide a plan name. After the plan has successfully been saved, it will be displayed in the narrow column area on the left. 6.1.2 Offline Download Content manager allows you to specify a location for displaying the results of the search. This allows users with large environments to perform other operations while the results are downloading. 6.1.2.1 Set backup destination for offline download Step 1 Action Navigate to ―Offline Download Locations‖ under Compliance Manager. Specify either a local location or a network drive. 2 If… Then… Local drive Select the local drive checkbox. Input the path to the desired folder. If the specified path does not exist, DocAve will create it. Network drive Select the network drive checkbox and input the path. You must also specify a Domain, User Name, and Password for this drive. © 2001-2008 AvePoint, Inc. All rights reserved. Page 275 3 Click on the ―Test drive‖ button to test the path you have entered. 4 Click on the ―Save As‖ button to use this profile in the Compliance Manager. 6.1.2.2 Run an offline download Step Action Navigate to ―Archive Search Mode‖, run a search refer to the Section 6.2.2 of this manual. 1 2 At the bottom of the GUI, select a driver name from the drop-down box. 3 Enter a job name in the field. 4 Click Offline Download button. 6.1.3 Offline Download Report After running offline downloads, the user can view the all offline download actions from the offline download report. Step 1 Action Navigate to ―Offline Download Report‖ under the Compliance Manager. © 2001-2008 AvePoint, Inc. All rights reserved. Page 276 2 Select the user and the status from the drop-down box. 3 The user can select the item number that will be displayed on per page from the drop-down box. The choices are: 5,10,20,30. 4 If the offline download failed, the user can click Download Again button to restart this offline download. 5 The user can delete the plan by clicking Delete button. 6.2 Compliance Archiver The ―Compliance Archiver‖ is designed to allow the archiving of any data off of the Microsoft SharePoint Database while meeting legal requirements like HIPAA, SEC, 402.5, SOX, and many more. 6.2.1 Archive Browser Step Action 1 Navigate to ―Archive Browser‖ under Compliance Archiver. 2 Click on Media Server name and expand the structure until the desired web application can be seen. © 2001-2008 AvePoint, Inc. All rights reserved. Page 277 Click on web application name to open a pop-up. 3 4 Specify a date range for the data search by clicking the calendar icon. 5 Select a site by checking off its radio box. 6 Click the OK button. 7 The selected web application will appear under the Compliance Archiver Data Browser. If… 8 Expand it level by level further to the folder you want. © 2001-2008 AvePoint, Inc. All rights reserved. Page 278 Then … Select the file radio box. And files in this folder will be displayed in the right section a. Open a pop-up window. b. Enter the keyword in the corresponding input field. The user can select the date range The user can select Case Sensitive option. Click on Search button c. d. 9 10 Select the desired file and do the operations you want in the pop-up by clicking on the file name or Update Review Status button. The user can export this file by clicking on Export Selected Search Results button. 6.2.2 Archive Search Mode Step Action 1 Within Compliance Archiver, navigate to ―Archive Search Mode.‖ 2 Select a search scope from the drop-down box and enter the keyword in the input field. 3 For more advanced options, please click on the Show Advanced Options button. 4 The more setting option will displayed below for selecting. © 2001-2008 AvePoint, Inc. All rights reserved. Page 279 5 The user can also select a Search Setting plan which is set up before from the drop-down box. If… Then… 1. 2. 3. Click on Search button. 4. 6 5. 1. Click on Offline Search button. 2. 3. The search result will be displayed below. Select the file you want and click on the file name or ―Update Review Status‖ button. View the pop-up for file info, Detail, Attachments, Review, and Audit information. The user can edit the review status and add comment in this pop-up. The user can export this file by clicking on Export Selected Search Results button. Provide the offline job name in the pop-up window. Other operations can be completed while the search is running. Proceed to the ―Offline Search Report‖ for the job status. 6.2.2.1 Search Within Search Result: After setting the search scope and search setting, the user runs a search in the compliance manager. DocAve supports the user search within the search result. Step Action 1 Within Compliance Archiver, navigate to ―Archive Search Mode‖. 2 Do a search refer to the steps in ―Archive Search Mode‖ and view the search result below. © 2001-2008 AvePoint, Inc. All rights reserved. Page 280 3 Click on the Show Advanced Options button. 4 The more setting option will displayed below for selecting. The user can set a new search setting. And the search scope will be set as the current search result by default. 5 Then click Search. 6.2.3 Activity History DocAve supports audit SharePoint users operations and view the audit report. Step Action 1 Navigate to ―Activity History‖ under Compliance Archiver. 2 Select an Actions and a user from the drop-down box. 3 Select a start time and an end time by clicking on the calendar icon. This is optional. 4 Click on the four buttons below, it will help the user to view the report they want. At the bottom of the GUI, the user can set the download configuration. 5 6 If… © 2001-2008 AvePoint, Inc. All rights reserved. Page 281 Then… If the user wants to download all records Select the All records radio box, and click download button. If the user wants to download the records which is within a time range Select the Appointed records radio box and specify a start time and end time by clicking the calendar icon. Click Download button. 6.2.4 Offline Search Report If the user selects to run the offline search, the user should navigate to the ―Offline Search Report‖ to view the report. Step Action Select the user, status, scope name you want to view from the drop-down box. 1 2 The user can select the item number that will be displayed on per page from the drop-down box. 3 Click on View. The data in the offline search will be displayed on the GUI. 4 The user can select the file they want and View the pop-up for file info, Detail, Attachments, Review, and Audit information. The user can also edit the review status and add comment in this pop-up and export this file by clicking on Export Selected Search Results button or run an offline download. 5 If the user wants to restart a specified offline search, the user can click Restart button. And Delete button will help the user to delete the one they want. © 2001-2008 AvePoint, Inc. All rights reserved. Page 282 6.2.5 Search Scope Archive Search Mode allows you to search through all archived data using specified search scopes and settings. In order to use the Archive Search Mode to browse the data you must first set the Search Scope below. A search setting can also be configured to reuse the ―Advanced‖ search options. Offline Download Location setup can also be implemented to allow you to view the data while offline. Setting a ―search scope‖ is mandatory for using the Archive Search Mode. Here, you can view the farm in tree mode and select the appropriate content to be viewed for each search. Step Action 1 Navigate to ―Search Scope‖ under the Compliance Archiver. 2 Select a farm from the drop-down box 3 Click on the farm name to expand the tree. Expand to the level of the content you desire. 4 Select the content for the search scope at the level you want and select using the corresponding check box. 5 Click the ―Save As‖ button to save this plan. 6 Provide a plan name in the pop-up window. 7 After the plan has successfully been saved, it will be displayed in the narrow column area on the left. You can edit these plans using the ―Save‖ button after making any changes. © 2001-2008 AvePoint, Inc. All rights reserved. Page 283 6.2.5.1 Search Setting Archive Search Mode has an ―Advanced‖ search option that allows you to limit search results. You can save these settings to be used multiple times by specifying them under the ―Search Setting‖ section. Step Action 1 Navigate to ―Search Setting‖ under Compliance Archiver. 2 Select a plan from the Search Setting drop-down box to edit an existing one. You can leave this field blank if you are creating a new one. Under the search setting, there are many options for the user to set up the search conditions: 3 4 ―Keyword‖ : This field allows you to search for keywords in the content selected. It will return all hits for this keyword in either content or names. Multiple entries can be separated by ―;‖, ―OR‖, or ―-‖. ―Matching results‖ : Selecting either ―content‖ or ―metadata‖ will limit the keyword results returned to either content or metadata. ―Archive date range‖ : This will allow the user to specify the date range that the content was archived. ―Sampling‖ : Sampling will return either a random percentage of the content selected, or every specific number of files. This will allow you to randomly sample the SharePoint content. ―File format‖ : Using this field, you can specify multiple file types to either return or exclude from the search. Use the ―ctrl + click‖ option to select multiple types. You can also specify a custom extension in the ―Other…‖ field provided. ―Content Type‖ : Using this field, you can specify multiple content types to either return or exclude from the search. Use the ―ctrl + click‖ option to select multiple types. You can also specify custom contents using the ―Other…‖ field. You can either specify simplified metadata, either the ―Author‖ or the ―Last modified‖ time for searching. © 2001-2008 AvePoint, Inc. All rights reserved. Page 284 The ―More metadata‖ button will show additional options for searching. 5 Select the ―Condition‖ from the drop-down box in the left column. Enter the corresponding ―Value‖ in field provided. 6 To add search conditions for customized SharePoint metadata, select the ―Add‖ button and fill out the new field provided. You can add and delete from this list as much as is necessary. 7 Click ―Save As‖ to specify a name for this search setting. *Note: Supported file types in Archiver Supported Doc Txt Pdf Htm Html Xls Ppt Rtf Xml Docx Xlsx Unsupported All content in picture format, video format, and audio format cannot be searched in Archiver. 6.3 Auditor Compliance Auditor can audit users‘ operations in item, list, and site-level. This feature does not support webapp auditing. © 2001-2008 AvePoint, Inc. All rights reserved. Page 285 6.3.1 Audit Report Step Action 1 Select the options you want. Web Application: allows the user to select a web application from the drop down box. Site Collection: allows the user to select a site collection from the drop down box. User: allows the user to input a username they want to view. Exact Match: check off this option means the input username should be exact, and the related reports will be displayed. Action: DocAve supplies all actions here, and allows the user to check off the option you want. Item: allows the user to input the item name they want. Type: allows the user to select the type from the drop down box. Start time: allows the user to specify a time and to get the report after that time. End time: allows the user to specify a time and to get the report before that time. Time Zone: allows the user to specify a time zone and to get the report in that time zone. 2 After the users selecting the options they want, the related report will be displayed below the selection options. You can sort the report by columns, both in ascending and decending order (indicated by the arrows on the column header). 3 At the bottom of the GUI, the user can click on the First、Previous、 Next、Last button to view the audit report. Or input an integer in the input field next to Goto button, and then click on Goto button to the page you want. 4 Click on Download button, the user can download the audit report (CSV file format). © 2001-2008 AvePoint, Inc. All rights reserved. Page 286 6.3.2 Auditor Pruning Auditor Pruning helps user to prune the auditor report according to their needs. 6.3.2.1 Auditor Pruning in MOSS 2007/WSS v3 Step Action If If you select Prune by specified time range option Then… Select the radio box in front of the Before and click on the calendar icon to specify a time. Or select the radio box in front of the How Long, enter an integer number in the input field and select an interval from the drop-down box. Then specify a time by clicking on the calendar icon, the plan will be run from this time point. 1 If you select Prune based on schedule option 2 The interval option is provided for the users to specify an interval running this plan and getting the report. Enter an integer number in the input field and select an interval. Select an interval from the drop-down box. The choices are: Only Once, Hour, Day, Week, and Month. Then, specify a time point by clicking on the calendar icon. The users can choose a network drive or a local location to download the report. Network Drive: Check off the Network Drive box, and enter the Domain, User, Password and Location in the corresponding field. Local Location: Enter the location path in the field. © 2001-2008 AvePoint, Inc. All rights reserved. Page 287 3 Compress and Encrypt options : The user can select these options to compress and encrypt the report. 4 Click on the Web Application tab to select the web applications you want to view in the report. Click on the web applications you want in the Available Web Applications field and click the Add button. This web application will be added into the selected web application field. The users can also remove the selected web applications by clicking on the Remove button. 5 . 6 Click on the Site Collection tab to select the site collections. Enter the site collection name in the corresponding field, then click Add button to select it. The users can also remove the selected one by clicking on the Remove button. 7 8 Click on User tab to select the user and to get the related report. 9 Enter the username and click Add button. The users can also remove the selected one by clicking on the Remove button. © 2001-2008 AvePoint, Inc. All rights reserved. Page 288 Click on Action tab. 10 All the actions will be displayed in the left area. Select and add the actions you want by clicking on the Add button, or click on the Remove button to remove the ones you selected. 11 Click on Save As to save this plan. 12 Select the plan you want at the left column. And click on Apply button to activate this plan on schedule or click on Run now button to run this plan immediately. Disable button can be clicked on when the user decide to quit this plan. 6.3.2.2 Auditor Pruning in SharePoint 2003/WSS v.2 Step Action 1 Check off Enable to select a time or an interval. Select the radio box in front of the Before and click on the calendar icon to specify a time. Or select the radio box in front of the How Long, enter an integer number in the input field and select an interval from the drop-down box. Then specify a time by clicking on the calendar icon, the plan will be run © 2001-2008 AvePoint, Inc. All rights reserved. Page 289 from this time point. 2 Click on the Web Application button to select the web applications you want to view in the report. Click on the web applications you want in the Available Web Applications field and click the Add button. This web application will be added into the selected web application field. The users can also remove the selected web applications by clicking on the Remove button. 3 . 4 Click on the Site Collection button to select the site collections. Enter the site collection name in the corresponding field, then click Add button to select it. The users can also remove the selected one by clicking on the Remove button. 5 6 Click on User button to select the user and to get the related report. 7 Enter the username and click Add button. The users can also remove the selected one by clicking on the Remove button. © 2001-2008 AvePoint, Inc. All rights reserved. Page 290 8 Click on Action button. All the actions will be displayed in the left area. Select and add the actions you want by clicking on the Add button, or click on the Remove button to remove the ones you selected. 9 10 The interval option is provided for the users to specify an interval running this plan and getting the report. Select an interval from the drop-down box. The choices are: Only Once, Hour, Day, Week, and Month. Then, specify a time point by clicking on the calendar icon. Note: This option cannot be selected when the user checked off Enable option. 11 The users can choose a network drive or a local location to download the report. Network Drive: Check off the Network Drive box, and enter the Domain, User, Password and Location in the corresponding field. Local Location: Enter the location path in the field. © 2001-2008 AvePoint, Inc. All rights reserved. Page 291 12 Compress and Encrypt options : The user can select these options to compress and encrypt the report. 13 Click on Save As to save this plan. Select the plan you want at the left column. And click on Apply button to activate this plan on schedule or click on Run now button to run this plan immediately. Disable button can be clicked on when the user decide to quit this plan. 6.3.2 Pruning Log The Pruning Log provides a list of all the pruned log reports based on the criteria set in auditor pruning. The log provides you with the rule name, the result, the number of rows pruned, and the date and time which the information was pruned. © 2001-2008 AvePoint, Inc. All rights reserved. Page 292 6.4 SP Auditor for SP2003/WSS2.0 The SP Auditor allows SharePoint Administrators to monitor and track all SharePoint interactions. The SP Auditor enables your administrators to complete the following: Record and track all interactions in SharePoint by powerful quotes such as date and time created, modified, deleted, updated, renamed, checked-in, checked-out, accessed, and moved Ability to enable/disable auditing from the entire portal level, site-level, subsite-level, list level, specified user level, and/or specified item-level Ability to track the life of an item from creation to deletion. Enables managers to track employees‘ workflow to maximize efficiency 6.4.1 Installing and Uninstalling SP Auditor Before using the Archiver solution, the Administrator must confirm that the Archiver solution is enabled on the DocAve Client Agent Host and also turned on for the agent within Agent Monitor located inside DocAve Control Panel. To confirm that the Archiver solution is enabled on the DocAve Client Agent Host, complete the following steps. Step Action 1 On the DocAve SP2003 Agent, open Client Configuration Tool found within DocAve Client Tools of the Start Menu. 2 Within the DocAve Agent Configuration, navigate to the Data Protection Tab. 3 Check off DocAve Auditor and click Confirm. To turn on the Archiver solution within Agent Monitor of the DocAve Control Panel, complete the following steps © 2001-2008 AvePoint, Inc. All rights reserved. Page 293 Step Action 1 Within the DocAve 4.5 GUI, select Control Panel. 2 Navigate to Control Services and find Agent Monitor. 3 Select the Agent which to enable Auditor Detailed information pertaining to this DocAve Agent will load on the right. 4 Above the Agent Host and Agent Type fields, open the Advanced tab. 5 Check off the Enable box and also the Auditing box 6.4.2 Auditor Rule Builder Before Auditor can begin tracking and monitoring SharePoint interactions, rules need to be built to specify which portals, sites, subsites, and lists are to be audited. Rule Builder is accessible under the SP Auditor section of the navigation menu. Follow the steps below to create an auditor rule Step Action 1 Specify the Agent Host by bringing down the drop down box. 2 Click on the Agent Host name to expand the tree of the SharePoint farm. © 2001-2008 AvePoint, Inc. All rights reserved. Page 294 3 Select the Agent which to enable Auditor Detailed information pertaining to this DocAve Agent will load on the right. 4 Check what is to be audited. You may choose to audit the entire virtual server, a particular site, subsite, list or document library. 5 Click Save As and a Web Dialog box will pop-up. Enter the desired name of the new Auditor Rule and click OK to save the rule. To enable the Auditor Rule, selected the saved Auditor Rule and click the Enable button. If the Auditor Rule is already enabled, to disable the rule, click the Disable button. *Note: Only one rule can be activated per Agent Host at the same time 6.4.3 Audit Report The Auditor Report is where you are able to view all SharePoint interaction based on the selections made in the Rule Builder. You can filter the report by Agent Host, Virtual Server, and/or a specific user. The report gives you the total number of pages and rows in the current Report Log. The number of rows displayed per page can also be modified. The log file will continue to grow if Auditor Pruning is not set up. For more information concerning Auditor Pruning, consult the next selection. At the bottom of the screen are navigation options to advance through the report log. The Auditor Report gives the option of downloading the entire report into a Microsoft Excel spreadsheet format based on your currently applied Auditor Report filters. Click the Download button and save the file to the desired directory. 6.4.4 Auditor Pruning Auditor Pruning allows administrators to set an age threshold on the report log. There are many SharePoint interactions everyday and the Auditor Report can grown quite large. Thus an Auditor Pruning rule is recommended. All pruned report log information will be stored in a .csv file in a directory you specify. © 2001-2008 AvePoint, Inc. All rights reserved. Page 295 6.4.4.1 Setting the Age Threshold To set an Age Threshold, the Before option or How Long option must be selected. Before: allows you to set a specific time and day. How Long: allows you to set a specified range. This range can be hourly, daily, weekly, or monthly. 6.4.4.2 Pruning Rule Selections By default, Auditor Pruning prunes all report logs. Auditor Pruning allows you to prune only certain logs based on the SharePoint Farm, user, and/or action performed, Auditor. To setup the pruning rule selections, complete the following steps. Step Action 1 Select the agents you wish to prune under Available agents and click the Add button to make your selection. 2 Click on the User button and enter the username of the user interactions you wish to prune and Click the Add button to make your selection. 3 Click on the Action button and select the action to prune and click Add. You can make multiple selections by holding down the Control key and clicking on your selections. 6.4.4.3 Scheduling the Pruning Job The section below allows you to indicate how often you would like the pruning job to run. Once the initial start time is set, the pruning job will automatically run based on the interval selected. 6.4.4.4 Setting the Pruning Data Storage Location The final step of Auditor Pruning is to set the data directory for pruned report logs to be stored. © 2001-2008 AvePoint, Inc. All rights reserved. Page 296 Local Drive To store the pruned data locally on your media server, simply enter the directory path for the storage location Network Drive To store the pruned data on a network shared drive, perform the following: Step Action 1 Click on the check box for Network Drive. 2 Enter a domain account and password which has write access to the network share. 3 Enter the full UNC path of the network drive location. Once you have set your pruned data storage location, you are now ready to save your pruning rule. © 2001-2008 AvePoint, Inc. All rights reserved. Page 297 Click on the Save As button and enter a name for the newly created Rule. Click OK and you should now see your created Rule listed in the left pane. 6.4.5 Pruning Log The Pruning Log provides a list of all the pruned log reports based on the criteria set in auditor pruning. The log provides you with the rule name, the result, the number of rows pruned, and the date and time which the information was pruned. You have the option of restoring the pruned log report back into the currently log or deleting the log report from the Pruned Storage Location. To restore the log back into the current log, simply click on the Restore button associated with the desired tag. To restore the log back into the current log, simply click on the Restore button associated with the desired log. To delete the log file from the Pruned Data Staging, click on the Delete button. © 2001-2008 AvePoint, Inc. All rights reserved. Page 298 7. Migration Jump to Table of Contents DocAve offers several modules to migrate information into the SharePoint environment: ―File System Migrator‖ : This function easily imports files from a front-end webserver file system into a SharePoint environment. ―SharePoint Migrator Lite‖ : Allows documents and folders to be migrated from a SharePoint 2003 or WSS 2.0 environment to a MOSS 2007 or WSS 3.0 environment via ―Live Migration.‖ ―SharePoint 2003 to 2007 Migrator‖ : Migrate over data (Sites / Subsites / Files / Folders) from a SharePoint 2003 or WSS 2.0 environment to a MOSS 2007 or WSS 3.0 environment. ―Exchange Public Folder Migrator‖ : Move content from Microsoft Exchange Public folders into a SharePoint environment. ―eRoom Migrator‖ : Migrate eRoom content into a SharePoint environment. In order to use the migrator modules, we recommend using an account with full administrative access to SharePoint and the SQL servers. However, backup and restore can still be performed using an account with the following access: Member of the local admin group (enough to access the files on the local SharePoint server) Member of the SharePoint farm admin group Member of the database owner group of the SharePoint content DB 7.1 File System Migrator File system migration supplies a way for administrators to migrate file system data from the source to the selected list or folder in SharePoint document libraries. A single file or folder can be specified from the source and placed into an existing SharePoint document library or a new folder can be created at the destination. © 2001-2008 AvePoint, Inc. All rights reserved. Page 299 7.1.1 Installation To make sure the File System Migration module is enabled, please follow the steps below: Step Action 1 Navigate to the ―Client Configuration Tool.‖ 2 Under the ―Migration‖ tab verify that the ―File Migrator‖ option is checked. 3 Press ―Confirm‖ and restart the Client services. *Note: DocAve Agents can be installed on any file system for use with the File System Migrator. 7.1.2 Un-installation To uninstall the File System Migration module, please follow the steps below: Step Action 1 Navigate to the ―Client Configuration Tool.‖ 2 Under the ―Migration‖ tab verify that the ―File Migrator‖ option is not checked. 3 Press ―Confirm‖ and restart the Client services. 7.1.3 Using File System Migration In order to use this module follow the steps below: © 2001-2008 AvePoint, Inc. All rights reserved. Page 300 Step Action 1 On the DocAve GUI, navigate to ―Migration‖ ―File System.‖ 2 Select your ―Source Agent‖ from the drop-down box. This will populate the drives on the local machine. 3 Click on the agent name to expand the tree. Browse the tree structure from the drives below and search for the folder to import content from. In order to see the files inside the folder, open 4 the file browser by clicking on the ― ‖ button in the middle of these columns. 5 Once you have found the content you would like to migrate, select it by checking the appropriate files on the file browser, or by selecting the folder from the tree browser by clicking the radio button next to it. Checking the Security box either in the file browser or next to the ―Source Agent‖ means the security of this file will be migrated into SharePoint. If… Then… Current Node Security All the securities in the current node will be migrated to the specified SharePoint site. ―---― : This will include all securities for the nodes you selected in the tree. This will be migrated to the specific SharePoint site. 6 Global Security ―Restore all security‖ : All securities in the folders selected will be migrated to the SharePoint site. ―No Security‖ : All the securities in the folders selected will not be migrated to the specified SharePoint site. © 2001-2008 AvePoint, Inc. All rights reserved. Page 301 7 On the right side of the screen, select your Destination Agent from the drop-down box. 8 Navigate through the tree structure of the SharePoint environment to find the desired destination site. 9 Click on the site name to see any available document libraries where you can send your data. 10 Click on the corresponding radio button next to the document library to select it. You can also select the radio button next to the blank input field to create a new folder under the selected site. After running this plan, the selected data will be migrated to this new folder. Schedule Migration can be set to run on a schedule: Step Action 1 Uncheck the ―No Schedule‖ box to enable scheduling. 2 Set a start time for your replication using the calendar icon next to the ―Start Time‖ field. Specify the interval at which the backup will occur. Choices are: Only Once, By Hour, By Day, By Week, or By Month. 3 If … Then … Only Once This will only run once at the specified time. By Hour Either choose this plan to run every set number of hours, or select it to run at specific hours, with the number of minutes past the hour specified by the user in the space provided. Be sure to select either ―AM‖ or ―PM‖ before choosing from the provided © 2001-2008 AvePoint, Inc. All rights reserved. Page 302 hours below. By Day Either set the plan to run every set number of days, or set the plan to run on weekdays or weekends. By Week Either set the plan to run every set number of weeks, or choose the days of the week to re-run this plan. By Month You can choose this plan to run on every set date of every month in the space provided (i.e., on the ―14‖th of every month). You can also set this plan to run in set months of the year, on certain days/weeks of the year. Select either a full or incremental replication. If … Then … Full This will copy all contents from the source to the destination. 4 Incremental This option copies the changes to the destination (including creating / deleting / updating the Document Library, Folder, or Document) that have been made to the source since the last migration job. In the event where the source site is large, choosing the incremental option will save significant time on replication. *Note: If no full migration has been performed previously, the incremental option will perform a full replication by default. Under ―Restore Options,‖ select not-overwrite, overwrite or append: 5 If … Then … Not-Overwrite The contents (lists / folders / documents) will be migrated from the source to the destination. If a file already exists, it will be ignored. © 2001-2008 AvePoint, Inc. All rights reserved. Page 303 Overwrite Copies the contents from the source to the destination by overwriting any contents (lists / folders / documents) in the destination with the same name. Append This option is for the purpose of creating versions. It copies contents from the source to the destination, but in the case when the same name already exists in the destination, an additional copy will be created as a newer version (example: ―filename‖+‖_1,2,3‖ etc.). 6 Entering content in the ―Description‖ field will uniquely tag the copy job, making it easily identifiable from the Job Monitor‘s ―Job Report.‖ 7 Select the ―Save As‖ button and enter a name for this plan. 8 Click the ―Run Now‖ button, or wait for the appropriate schedule. For multiple schedules, select the ―Schedule B‖ tab. 7.1.4 Advanced Usage 7.1.4.1 Security Mapping After selecting the SharePoint destination, you can activate this option and load customized permissions to the specified SharePoint destination. Step Action 1 Next to the ―Mapping‖ option on the top of the GUI, click on the ―Config‖ button. A window should open. 2 The left column displays the Windows permissions. The administrator can choose the corresponding permissions they want in SharePoint from the drop-down box on the right side. These permissions are: Full Control, Design, Contribute, Read, Limited Access, and View Only. 3 When setting up a migration, you can select this profile from the drop-down box. © 2001-2008 AvePoint, Inc. All rights reserved. Page 304 7.1.4.2 Common Config To run a File System Migration, there is a required configuration called ―Common Config‖ (to the right of the ―Mapping Config‖ button). Step Action Click on the button ―Common Config‖ at the top section of the GUI to open a pop-up window. 1 *Note: If it is the first time using the ―Common Config‖ option, there will only be a single ―FileMigratorConfig.xml‖ file. The default file ―FileMigratorConfig.xml‖ can be configured and used in the following ways: If … Then … Using default XML file to migrate Click the radio button next to the title ―FileMigratorConfig.xml‖ and click ―OK‖ on the bottom of the window. 1. Click the radio button next to the title ―FileMigratorConfig.xml‖. Click ―Download‖ button and save it to any location. 2. Modify the value in XML file with the information you wish to use. This step is described in detail below. 2 Using user-defined XML to migrate 3. After completing the configuration, upload the file using the ―Upload‖ button. *Note: If the file name was changed in the customization process, the new file will be added in the pop-up. If the file name is still ―FileMigratorConfig.xml‖, it will overwrite the previous one. 4. Select the customized XML file and click the ―OK‖ button on the bottom of the window. © 2001-2008 AvePoint, Inc. All rights reserved. Page 305 Formatting the configuration file ―FileMigratorConfig.xml‖ follows the template below: <?xml version="1.0" encoding="utf-8"?> <FileMigrator> <LengthHandel MaxFolderNameLen="128" MaxFileNameLen="128"/> <IllegalReplace> <Item IllegalChar="~" ReplaceChar ="T"/> <Item IllegalChar="#" ReplaceChar ="N"/> <Item IllegalChar="%" ReplaceChar ="P"/> <Item IllegalChar="&amp;" ReplaceChar ="A"/> <Item IllegalChar="{" ReplaceChar ="L"/> <Item IllegalChar="}" ReplaceChar ="R"/> <Item IllegalChar="." ReplaceChar ="_"/> </IllegalReplace> <CustomMeta> <ruleItem path="C:\WINDOWS" filter="*.txt" type="FILE" contentType="Document"> <Item Name ="MyCategory" Value="TextFile"/> <Item Name ="UploadBy" Value="FMUpload"/> </ruleItem> </CustomMeta> </FileMigrator> <!-&amp; = & &gt; = > &lt; = < &quot; = " &apos; = ' All SharePoint illegal chars --> ~ " # % & * : < > ? / \ { | }. The file includes three parts: <FileMigrator> ―LengthHandel MaxFolderNameLen‖ and ―MaxFileNameLen‖ will control the filename‘s maximum length. If the folder or filename exceed the byte length that be defined, the system will save the name as the defined length according to priority, and automatically prune the extra bytes. The truncated file name will be recorded in the zip package in the ―Job Report‖. *Note: The filename length should be adjusted to include the extension. © 2001-2008 AvePoint, Inc. All rights reserved. Page 306 <Illegal Replace> This option will replace any illegal SharePoint characters with valid characters. *Note: The last paragraph of the template is a comparison chart. When adding custom entries, please use the code given at the end of the document to fill the ―Item IllegalChar‖ field. For example: If the special character ―>‖ is added, fill the field with ―&gt‖ instead. <CustomMeta> The custom metadata fields are defined as follows: - ―ruleItem path‖ : the location of the files - ―filter‖ : the filenames and extensions - ―type‖ : the file types - ―contentType‖ : the existing content type of a file (in SharePoint settings) - ―Item Name‖ : If the source files match the conditions above, the files will contain the new column named ―Item Name=‖ in Share Point, - value: the value of the ―Item Name‖ column in SharePoint 7.1.4.3 Filter Mode Click the ―Config‖ button at the bottom right corner of the GUI and select the ―Filter‖ tab in the pop-up. From here, you can set up a filter rule for the files in the source. The filter includes two rules: File Name Filter and File Size Filter. Once you have completed this process, select the ―Set‖ button. Name Filter You can filter files using the given field. The ― ‖ means the files be found will included in the plan. The ― ‖ means the files found will be excluded in the plan. You can change the plus/minus sign by clicking on the icon. This field also accepts wildcards (*). Add or delete a rule by clicking on the Add button or Delete button. An example for the name filter would be to find the files whose extension name is .jpg and whose name is not 123: File Size Filter Check off the box next to File Size to activate this filter. Choose the file size by selecting ―greater than‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 307 (>), ―less than‖ (<), or ―equals‖ (=) from the drop-down list and enter a value in the input field. Select either ―KB,‖ ―MB,‖ or ―GB‖ from the list. 7.1.4.4 Network Drive Step Action 1 Navigate to the ―Network Drive‖ Tab of the ―Config‖ pop-up. 2 Enter the network drive address on the ―Location‖ field. 3 Click on the ―Test‖ button to verify the location. 4 Enter the Domain, Username, and Password that can access the network drive. 5 Click ―Save as‖ button to save this profile. A list of saved profiles will appear on the left. 7.1.5 Currently Supported and Unsupported Elements for File Migration Source Destination Status Individual file Document Library Form Library Wiki Page Library Picture Library Translation Management Library Data Connection Library Report Library Supported Multi-file folder Individual Folder and the content under the Folder Multi-level Folders and the content under the Folders © 2001-2008 AvePoint, Inc. All rights reserved. Page 308 Supported Supported Supported Supported Known Issues* Individual disk The entire disk and the content under the disk Share Documents Manually enter Folder Supported Supported The disk and the partial Folders and Files under this disk Supported Shared Folder Supported Security & Properties File Properties Supported Folder Security Supported File Security Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 309 . 7.2 SharePoint Migrator Lite SharePoint Migrator Lite allows the transfer of single files and folders into your SharePoint environment. To use the SP Migrator Lite module, follow the steps below: Step Action 1 On the DocAve GUI navigate to the ―SharePoint Lite‖ tab under the ―Migration‖ module. 2 Select your source SP2003 agent from the drop-down list in the middle of this screen. Underneath this drop-down list, enter in the SQL information related to this agent (Server Name, Username, Instance Name, and Password). 3 *Note: You can choose to enter in all of the information manually or enter in the SQL server name and check off ―SQL Default.‖ This will open another page where you can enter in your Server Name and Instance Name. Many times only entering the Server Name is enough. 4 Select the appropriate content database of the site you wish to migrate from the ―Database‖ drop-down list. Once this is selected, your SharePoint sites will populate underneath this section. 5 Select the content you wish to migrate by selecting the radio button next to the library. You can select specific items by opening up the file browser and selecting those items. 6 Once you have selected what you would like to Migrate, choose a SharePoint 2007 agent from the Destination Agent Drop-down list. The structure should pop-up underneath it. Select your destination location by clicking on the radio button. You can also create a destination location by selecting the blank option and typing in the appropriate location. Once all of your options are set, you can save all of this information as a plan. Once the plan is saved you can run the plan now by pressing the Run Now button or setting up a schedule for it to be executed at a later point in time. Schedule © 2001-2008 AvePoint, Inc. All rights reserved. Page 310 Migration can be set to run on a schedule: 1 Uncheck the ―No Schedule‖ box to enable scheduling. 2 Set a start time for your replication using the calendar icon next to the ―Start Time‖ field. Specify the interval at which the backup will occur. Choices are: Only Once, By Hour, By Day, By Week, or By Month. If … Then … Only Once This will only run once at the specified time. By Hour Either choose this plan to run every set number of hours, or select it to run at specific hours, with the number of minutes past the hour specified by the user in the space provided. Be sure to select either ―AM‖ or ―PM‖ before choosing from the provided hours below. By Day Either set the plan to run every set number of days, or set the plan to run on weekdays or weekends. By Week Either set the plan to run every set number of weeks, or choose the days of the week to re-run this plan. By Month You can choose this plan to run on every set date of every month in the space provided (i.e., on the ―14‖th of every month). You can also set this plan to run in set months of the year, on certain days/weeks of the year. 3 4 Select either a full or incremental replication. If … © 2001-2008 AvePoint, Inc. All rights reserved. Page 311 Then … Full Incremental This will copy all contents from the source to the destination. This option copies the changes to the destination (including creating / deleting / updating the Document Library, Folder, or Document) that have been made to the source since the last migration job. In the event where the source site is large, choosing the incremental option will save significant time on replication. *Note: If no full migration has been performed previously, the incremental option will perform a full replication by default. Under ―Restore Options,‖ select not-overwrite, overwrite or append: If … Then … Not-Overwrite The contents (lists / folders / documents) will be migrated from the source to the destination. If a file already exists, it will be ignored. Overwrite Copies the contents from the source to the destination by overwriting any contents (lists / folders / documents) in the destination with the same name. Append This option is for the purpose of creating versions. It copies contents from the source to the destination, but in the case when the same name already exists in the destination, an additional copy will be created as a newer version. 5 6 Entering content in the ―Description‖ field will uniquely tag the copy job, making it easily identifiable from the Job Monitor‘s ―Job Report.‖ 7 Select the ―Save As‖ button and enter a name for this plan. 8 Click the ―Run Now‖ button, or wait for the appropriate schedule. For multiple schedules, select the ―Schedule B‖ tab. © 2001-2008 AvePoint, Inc. All rights reserved. Page 312 7.3 SharePoint 2003 to 2007 Migrator 7.3.1 Installation To make sure the SharePoint 2003 Migration module is installed, follow the steps below on the SharePoint 2007 machine: Step Action 1 Navigate to the ―Client Configuration Tool.‖ 2 Under the ―Migration‖ tab verify that the ―SharePoint Migration‖ option is selected. 3 Press ―Confirm‖ and restart the Client services. This will allow the front-end machine to appear on the GUI as a destination agent. 7.3.2 Un-installation To uninstall the SharePoint 2003 Migration module, follow the steps below: Step Action 1 Navigate to the ―Client Configuration Tool.‖ 2 Under the ―Migration‖ tab, uncheck the ―SPS 2003 to MOSS 2007 Migrator‖ and/or ―SPS 2003 to MOSS 2007 Live Migrator‖ options. 3 Press ―Confirm‖ and restart the Client services. This will remove the Migration tool capabilities from this agent. © 2001-2008 AvePoint, Inc. All rights reserved. Page 313 7.3.3 Backup Migration The DocAve Backup Migrator requires that a SP 2003 item level backup is executed prior to running a MOSS 2007 migration. For information on this, please refer to the Item Level Backup information located in this guide. 7.3.3.1 Running SetFieldSchemaOM.exe for 2003 Item Level Backups It is recommended to run ―SetFieldSchemaOM.exe‖ before running a SP 2003 backup for migration to raise the backup level of the SP 2003 item level backup. In order to run this utility follow the steps below: *Note: If you are running DocAve 4.5.1.0 and above, the ―SetFieldSchemaOM‖ option is now a checkbox in the SP 2003 Item Level Backup Builder. The following steps are not required. Step Action On the machine where the SP 2003 agent is installed navigate to the following location: 1 ―C:\Program Files\AvePoint\DocAve4\VaultClient\bin‖ *Note: This location may be different depending on where you installed the DocAve Client. 2 In this folder look for a file called ―SetFieldSchemaOM.exe‖ and run that file. A DOS window will quickly flash. This means the program has successfully run. In order to verify the program has run successfully, navigate to this location: 3 ―C:\Program Files\AvePoint\DocAve4\VaultClient\data\SP2003‖ *Note: This location may be different depending on where you installed the DocAve Client. 4 In this folder look for a file called ―env.cfg‖ and open it. This file can be opened in Notepad. © 2001-2008 AvePoint, Inc. All rights reserved. Page 314 Look for an entry that says: toBackupSchema= ―2‖ 5 *Note: The value ―2‖ means this option is turned on. SetFieldSchemaOM is recommended for Backup Migration only. If you would like to run further backups on your SharePoint 2003 environment, please change this value back to ―0.‖ 7.3.3.2 Running a Backup Migration To run a backup migration, follow the steps below: Step Action 1 On the DocAve GUI navigate to the ―Backup Migration‖ tab under the ―SharePoint 2003 to 2007‖ section of the ―Migration‖ module. 2 On the top of this screen you will see the ―Item Level Backup Job Browser.‖ 3 Select the appropriate Media server that contains your SP 2003 backup data and drill down through the folders. 4 Select the appropriate backup data by clicking on the radio button next to it. 5 On the Item Level Backup Data Browser, the 2003 backup information should load up. Select the items, sites, subsites, etc. you would like to migrate over to 2007 by clicking on the radio button next to the item. You can also open up the file browser using the arrow in the center column, and check off the appropriate items from there. 6 Once you have selected what you would like to Migrate, select a SharePoint 2007 agent from the ―Destination Agent Drop‖ down menu. The structure should appear beneath it. 7 Select your destination location by clicking on the radio button. You can also create a destination location by selecting the blank destination option and typing in the appropriate location. © 2001-2008 AvePoint, Inc. All rights reserved. Page 315 8 There are some final options that complete the Migration process configuration at the bottom of the GUI. ―Schedule‖ – This will open a pop-up allowing you to set the date and time to run the migration. ―Restore Option‖ – allows the user to select either Not Overwrite, Overwrite, or Append. ―Description‖ – allows the user to enter a description for the migration job (helps distinguish jobs from others in the Job Monitor). When you are ready to run or set your scheduled job, press the ―Go‖ button. Backup Migration Config Step 1 Action Click on the ―Config‖ button to open a pop-up. The file ―SP2003To2007MigrationConfiguration.xml‖ can be configured and used as follows: If … Then … Using default XML file to migrate Click the radio button next to ―SP2003To2007MigrationConfiguration.xml‖ and click ―OK‖. 1. Click the radio button next to the title ―SP2003To2007MigrationConfiguration.xml‖. Click ―Download‖ button and save it to any location. 2 Using user-defined XML to migrate 2. Modify the value in XML file with the information you wish to use. This step is described in detail below. 3. After completing the configuration, upload the file using the ―Upload‖ button. *Note: If the file name was changed in the customization process, the new file will be © 2001-2008 AvePoint, Inc. All rights reserved. Page 316 added in the pop-up. If the file name is still ―SP2003To2007MigrationConfiguration.xml‖, it will overwrite the previous one. 4. Select the customized XML file and click the ―OK‖ button on the bottom of the window. *Note: If you do not want save the changes, you can click default button to restore the original file. You can also delete this file using the appropriate button. 7.3.3.3 Migration Configurations This configuration file includes one ―option‖, nine ―flags‖, and thirteen ―mapping nodes‖. Please refer to the following sections for more details. ―Options‖ : o ―toMigratePerms‖; Values: 7 (default): Restore all permissions using permission mapping 2: Only restore web permissions without permission mapping 1: Only restore list permissions without permission mapping 0: Do not restore list and web permissions ―Flags‖ : o ―toPromoteWeb‖; Default Value: True True: Web structure is retained False: Web structure is not kept o ―toRemoveCFlag‖; Default Value: True True: It removes the ‖C‖ path when performing an Area restore False: It keeps the ―C‖ path. o ―onTopLinkBar‖; Default Value: True True: It adds this web to the Top Link Bar of the Parent Web when creating a new web. False: This is not added o ―onQuickLaunch‖; Default Value: True True: It adds this web to QuickLaunch of the Parent Web when creating a web. False: It does not. o ―navigationInheritance‖; Default Value: False True: The created web inherits the Top Link Bar of Parent Web. False: It does not inherit this. o ―restoreSecurity‖; Default Value: False © 2001-2008 AvePoint, Inc. All rights reserved. Page 317 o o o o True: The securities of the Web and List are restored when selecting ―Non-Overwrite‖ False: Securities cannot be restored ―unRestoreAlert‖; Default Value: False True: Alerts of the List, Library, Folder, Item and Document levels cannot be restored. False: These can be restored ―unRestoreDefaultView‖; Default Value: False True: It does not overwrite the Default View of the List when selecting ―Overwrite‖ False: This overwrites the view ―unRestoreEmptyGroup‖; Default Value:False True: This does not restore empty user groups. False: Empty groups are restored ―sendEmailForAlert‖; Default Value:True True: It will send an email during the Alert restore. False: Only the restore Alert setting is restored, but no email is sent. The following flags can be added by applying the corresponding lines in the config files: o ―sortSourceField‖; Default Value: False True: It sorts the field of list in the source by name when performing a restore. False: It does not sort the field of list in the source when performing a restore. o ―pinpointPermission‖; Default Value: False True: It matches the permission in exact mode when performing permission restore. False: It matches the permission in fuzzy mode when performing permission restore. *Note: This flag only supports list level permission. Exact Mode: The permission in the source is the same as the one in the destination. Fuzzy Mode: This mapping is based on the following logic: If the permission in the source includes the ―Manage Lists‖, it will be assigned ―Design‖ in the destination If the permission in the source only includes ―View List Items‖, it will be assigned ―Read‖ in the destination. If the permission in the source includes other permissions as follows: ―Add List Items‖, ―Manage List Permissions‖, ―Edit List Items‖, ―Delete List Items‖, or ―Manage Personal Views‖, it will be assigned ―Contribute‖ in the destination. o ―cleanSecurity‖; Default Value: False True: Remove the existed user and group permission from the destination. False: Does not remove the existed user and group permission from the destination. o ―createWebGroup‖; Default Value: True True: It maps the site group in the source to the corresponding existed permission level and site group. If no corresponding permission level or site group exists in the destination, it will create new one in the destination. False: It only restores the site group in the source to the permission level in the destination. It does not create new site group. o ―cutFileName‖; Default Value: True © 2001-2008 AvePoint, Inc. All rights reserved. Page 318 True: During the document restore, if the total length of both full file name of the document and the relative path of parent folder in the destination exceeds 260 characters, the file name will be truncated to meet the limitation. False: The document will not be restored if the total length of both full file name of the document and the relative path of parent folder in the destination exceeds 260 characters. *Note:All the information about the truncated files will be recorded in the Event log. Example: Options and flags settings <MigrationConfiguration unRestoreAlert="true" sendEmailForAlert="false"> … (Mappings settings) </ MigrationConfiguration > Note: You can set one or multiple options or flags as you need. Otherwise, you can use these default settings without any changes. Mapping If you want to shut off a certain node in the following mapping options, you should set the attribute (open=‖off‖). If you want to apply this node again, just delete this attribute (open=‖off‖). For example: <DomainMappings open=‖off‖> <DomainMapping SourceDomain=‖domain1‖ DestinationDomain=‖domain2‖ /> </DomainMappings> 1) Domain Mapping: Map the domain name from the source to the destination: The following can be written between ―<DomainMappings>‖ and ―</ DomainMappings >‖: <DomainMapping SourceDomain="domain1 " DestinationDomain="domain2 " /> 2) DstWebOfLists Mapping: For this process, a list under the source web will be migrated to a different destination web. The destination web must support multi-level paths. The user could write the following line: < DstWebOfListsMappings> <WebofListsMapping SourceWeb="."> <Mapping srcListTitle="Shared Work" desWebRURL="public" /> <Mapping srcListTitle="My Work" desWebRURL= "public1/public2/public3" /> </WebofListsMapping> < /DstWebOfListsMappings> © 2001-2008 AvePoint, Inc. All rights reserved. Page 319 Using the attributes: ―srcListTitle](*)‖ : the source list‘s title. ―desWebRURL](*)‖ : the destination web server‘s relative URL. 3) Field Mapping: Map the Field in the List in the source to the specified Field in the destination. Several field mapping examples are shown below: Mapping a field: <FieldMappings> <Scope srcTemplateId="101"> <List title="TestFieldMapping_DL"> <Field srcName="" srcDisplayName="a" dstName="" dstDisplayName="b" /> <Field srcName="" srcDisplayName="c" dstName="‖ dstDisplayName="d" /> </List> </Scope> </FieldMappings> Mapping fields by ―ignore field type‖: <FieldMappings> <Scope srcTemplateId="101"> <List title="TestFieldMapping_DL"> <Field srcName="" srcDisplayName="a" dstName="" dstDisplayName="b" ignoreType="true" /> <Field srcName="" srcDisplayName="c" dstName="" dstDisplayName="d" ignoreType="true" /> </List> </Scope> </FieldMappings> Mapping a value when the value must be a choice: <FieldMappings> <Scope srcTemplateId="101"> <List title="TestFieldMapping_DL"> <Field srcName="" srcDisplayName="a" dstName="" dstDisplayName="b" > <Value srcValue="Enter Choice #1" dstValue="Enter Choice #4" /> <Value srcValue="Enter Choice #2" dstValue="Enter Choice #3" /> © 2001-2008 AvePoint, Inc. All rights reserved. Page 320 </Field> <Field srcName="" srcDisplayName="Single line" dstName="" dstDisplayName="Single line"> <Value srcValue="aaa" dstValue="bbb" /> </Field> </List> </Scope> </FieldMappings> Do not migrate a field: <FieldMappings> <Scope srcTemplateId="101"> <List title="TestFieldMapping_DL"> <Field srcName="" srcDisplayName="multiple lines" dstName="" dstDisplayName="" /> </List> </Scope> </FieldMappings> Attributes listed in this file are: ―Scope‖ : Define the scope of the mapping, ―*‖ means all kinds of the source lists. ―srcTemplateId‖ : source list template id, for example ―101‖ is Document Library Lists ―List‖ : matched list, the list which the column belongs to ―Title‖ : the source list title, ―*‖ means all lists ―Field‖ : the mapping column ―srcName‖ : source column internal name ―dstName‖ : destination list column internal name ―srcDisplayName‖ : source list column display name ―dstDisplayName‖ : destination list column display name *Note: if both dstName and dstDisplayName, we will not restore this column to the destination list. ―Value‖ : the value mapping ―srcValue‖ : source side value ―dstValue‖ : map to the destination value ―ignoreType‖ : ignore the field type *Note: When dstName and dstDisplayName is empty, the source column will not be migrated. Common list templates: 100 Generic list 101 Document library © 2001-2008 AvePoint, Inc. All rights reserved. Page 321 102 Survey 103 Links list 104 Announcements list 105 Contacts list 106 Events list 107 Tasks list 108 Discussion board 109 Picture library 1100 Issue tracking 4) FormTemplateUrl Mapping: This configuration file is used to map the source form template URL to the destination. Step Action 1 The user could write the following line in the position between ―<FormTemplateUrlMappings>‖ and ―</FormTemplateUrlMappings>‖. 2 Attributes listed in this file are: Title: list title in destination srcPatch: form template URL in source library(absolute URL) dstPatch: form template URL in destination library(absolute URL) 3 An example of how to perform this mapping is as follows: <FormTemplateUrlMappings> <Library title="FL01"> <Template srcPath="http://avepoint03/sites/site01/FL01/Forms/template.xsn" dstPath="http://avepoint07/sites/site02/FL01/Forms/template.xsn" /> </Library> </FormTemplateUrlMappings> 5) List Mapping Step 1 Action The user could write the following line in the position between ―<ListMappings>‖ and ―</ListMappings>‖. You will see the configure information by default as follows: 2 ―[srcTemplateId](*)‖ : List template ID you want to migrate in the source © 2001-2008 AvePoint, Inc. All rights reserved. Page 322 ―[desTemplateId]‖ : The template you want to use to build the list in the destination ―[srcListTitle]‖ : The title of the list you want to change in the source ―[desListTitle]‖ : The list title you want to change in the destination. Examples: 1. If the user wants to change the list template ID 997 in the Source into 100 in the Destination: <ListMapping srcTemplateId="997" desTemplateId="100" /> // 2. If the user wants to change the list title ―Favourites‖ in the Source into ―My Links‖ in the Destination: 3 <ListMapping srcTemplateId="103" desTemplateId="103" srcListTitle="Favourites" desListTitle="My Links" /> // 3. If the user want to change the list template ID 998 into 101, and change the list title ―Pages‖ into ―UK Pages.‖ <ListMapping srcTemplateId="998" desTemplateId="101" srcListTitle="Pages" desListTitle="UK Pages" /> 6) ListView Mapping: Add the specified field to the view in the destination. Step Action 1 The user could write the following line in the position between ―<ListViewMappings>‖ and ―</ListViewMappings>‖. 2 Attributes listed in this file are: ―List‖:The list the user wants to map. ―Title‖:The title of the list. When the users rename the list name manually in the destination, or restore a list to other list whose name is different, the list title in the destination should be used. ―View‖:The view the user wants to map. ―Name‖:The name of the view ―Option‖: The update method for view. When option="0", the method should be appending; when option="1", the method should be all updating. If there is no option, the method should be the same as option="0". ―Field‖:The field the users want to map © 2001-2008 AvePoint, Inc. All rights reserved. Page 323 ―Name‖ : The display name of the field ―Order‖: The order value for the field. This field value can be number that is more than 0 and less than 1000. When the order attribute is null or order="", it will be applied the method of appending. Base View ID Mapping: ―srcId‖: The BaseViewID of the source. ―DstId‖: The BaseViewID of the destination. 3 An example of how to perform this mapping is as follows: <ListViewMappings > <List title="Issue List"> <BaseViewId srcId="10" DstId="1" /> <View name="All Issues"> <Field name="Category" order="6" /> </View> <View name="My Issue" option="1"> <Field name="Attachments" /> <Field name="Issue ID" /> <Field name="Title" /> <Field name="Assigned To" /> <Field name="Priority" /> <Field name="Category" /> <Field name="Due Date" /> </View> <View name="My View" option="1"> <Field name="Attachments" order="1" /> <Field name="Issue ID" order="2" /> <Field name="Title" order="3" /> <Field name="Assigned To" order="4" /> <Field name="Priority" order="5" /> <Field name="Category" order="6" /> <Field name="Due Date" order="7" /> </View> </List> </ListViewMappings> 7) Permission Mapping: For this process, the user should want to change a group name, or set the destination group‘s Permission Level. Step © 2001-2008 AvePoint, Inc. All rights reserved. Page 324 Action 1 The user could write the following line in the position between ―<PermissionMappings>‖ and ―</PermissionMappings>‖. 2 Attributes listed in this file are: ―[ SourceGroup](*)‖ : source group‘s name ―[ DestinationGroup](*)‖ : destination group‘s name ―[ Mask](*)‖ : numeric form of right collection ―[ MaskStr]‖ : string form of right collection ―[ AddWebTitle]‖ : after migration, decision whether to add a web title in the group name or not ―[ PermissionLevel]‖ : designate permission level to the group 3 Examples of how to perform this mapping are as follows: Administrator group in sharepoint 2003 mapping to owners group in MOSS 2007. <PermissionMappings> <Mapping SourceGroup="Administrator" DestinationGroup="Owners" Mask="-1" MaskStr="FullMask" AddWebTitle="True" Description=""/> </PermissionMappings> The ―Design‖ permission level should be applied on Web Designer group. <PermissionMappings> <Mapping SourceGroup="Web Designer" DestinationGroup="Web Designer" Mask="1856436900591" MaskStr="" AddWebTitle="True" Description="" PermissionLevel="Design"/> </PermissionMappings> 4 Default Mapping: <Mapping SourceGroup="Administrator" DestinationGroup="Owners" Mask="-1" MaskStr="FullMask" AddWebTitle="True" Description="" /> <Mapping SourceGroup="Contributor" DestinationGroup="Members" Mask="1856436900591" MaskStr="" AddWebTitle="True" Description="" PermissionLevel="Contribute" /> <Mapping SourceGroup="Web Designer" DestinationGroup="Web Designer" Mask="1856436900591" MaskStr="" AddWebTitle="True" Description="" PermissionLevel="Design" /> <Mapping SourceGroup="Reader" DestinationGroup="Visitors" Mask="756052856929" MaskStr="" AddWebTitle="True" Description="" PermissionLevel="Read" /> <Mapping SourceGroup="Guest" DestinationGroup="Guest" Mask="206292717568" MaskStr="" AddWebTitle="True" Description="" PermissionLevel="Limited Access" /> © 2001-2008 AvePoint, Inc. All rights reserved. Page 325 <Mapping SourceGroup="Content Manager" DestinationGroup="Content Manager" Mask="1856436900591" MaskStr="" AddWebTitle="True" Description="" PermissionLevel="Design" /> <Mapping SourceGroup="Member" DestinationGroup="Member" Mask="1856436900591" MaskStr="" AddWebTitle="True" Description="" PermissionLevel="Contribute" /> 8) QuickLaunch Mapping: This process sets whether to display lists on the quick launch bar or not. Step Action 1 The user could write the following line in the position between ―<QuickLaunchMappings>‖ and ―</QuickLaunchMappings>‖. 2 Attributes listed in this file are: ―[Web](*)‖ : the source web scope ―[ Title](*)‖ : the source List(s) title ―[Action](*)‖ : the action to add or remove the quick launch bar 3 Examples of how to perform this mapping are as follows: The ‖Shared Documents‖ library in all webs will be removed from the quick launch bar. <QuickLaunchMappings> <QuickLaunchBar Web="*"> <List Title="Shared Documents" Action="Remove" /> </QuickLaunchBar> </QuickLaunchMappings> The ―Picture Library ― library in root web will be removed from the quick launch bar, and the "Shared Work" library will be added on the quick launch bar. <QuickLaunchMappings> <QuickLaunchBar Web="."> <List Title="Picture Library" Action="Remove" /> <List Title="Shared Work" Action="Add" /> </QuickLaunchBar> </QuickLaunchMappings> 9) RedundantWebParts Mapping: This process will filter out redundant web pages and web parts. © 2001-2008 AvePoint, Inc. All rights reserved. Page 326 Step Action 1 The user could write the following line in the position between ―<RedundantWebPartsMappings>‖and―</RedundantWebPartsMapping s>‖. 2 Attributes listed in this file are: ―[Page]‖ : this web page will be filter out ―[ ListTemplateId]‖ : the source list scope ―[ Web partTypeId]‖ ―[ Web partTypeName]‖ Examples of how to perform this mapping are as follows: The page named ―DeletedFolders.aspx‖ will not be migrated. <RedundantWebPartsMappings> <Web part Page="DeletedFolders.aspx" /> </RedundantWebPartsMappings> 3 The calendar.aspx file in the list which template id is 106 will not be migrated. <RedundantWebPartsMappings> <Web part Page="calendar.aspx" ListTemplateId="106"/> </RedundantWebPartsMappings> This type web part will not be migrated. <RedundantWebPartsMappings> <Web part Page="" Web partTypeId= "2375A4E0-FBDC-FA0B-BE3E-5C03655A66F8" /> <Web part Page="" Web partTypeId="" Web partTypeName= "RM.SharePoint.Web parts.ImageUpload" /> </RedundantWebPartsMappings> 10) ManagePath Mapping Step Action 1 The user could write the following line in the position between ―<ManagePathMappings>‖and―< /ManagePathMappings>‖. © 2001-2008 AvePoint, Inc. All rights reserved. Page 327 2 3 Attributes listed in this file are: ―srcPath‖ : The source‘s managed path (i.e. ―http://sharepoint03/sites/site01/default.aspx‖) ―dstPath‖ : The destination‘s managed path (i.e. ―http://sharepoint07/avepoint/site01/default.aspx‖) The file can be edited as follows: <ManagePaths> <Path srcPath="sites" dstPath="avepoint" /> </ManagePaths> *Note: The managed path must already exist in the Source. The site cannot be created during the migration. 11) Url Mapping: This will replace the source virtual server‘s URL according to the managed path. Step Action 1 The user could write the following line in the position between ―<UrlMappings>‖and―</UrlMappings>‖. 2 Attributes listed in this file are: ―[ Condition](*)‖ : source managed path ―[ Result](*)‖ : use this url to replace the source virtual server url An example of how to perform this mapping is as follows: 3 <Item Condition="personal" Result="http://personal.example.com" /> 12) User Mapping: When users want to migrate SP2003 to SP2007 within different domains, config files can be used. This allows users to convert from DomainA\user1 to DomainB\user1 or DomainA\user1 to DomainB\user2. Step 1 2 Action Write in the position between ―<UserMappings>‖ and ―</UserMappings>‖. <UserMapping SourceUser="domain1\user1" DestinationUser="domain2\user2" /> Put the correct domain and user info in the position © 2001-2008 AvePoint, Inc. All rights reserved. Page 328 ―domain1\user1‖ and ―domain2\user1‖. In the line: UserMapping SourceUser="domain1\user1" the domain and user info is that in SPS2003. In the line: DestinationUser="domain2\user2" the domain and user info is that to be migrated in SPS2007. 3 In the line: UserMappings defaultUser=‖domain\tempUser‖ This will restore the user information to the destination if it does not already exist, but it will not add the user to the Active Directory. The users must already exist in the destination. *Note: The number of users to be migrated decides the number of the sentences to be written in. If you want to migrate 3 domain users, you must write 3 integrated sentences with each domain and user info in it. 13) Web Mapping: For this process a different site/web template can be used to create the destination site/web. Step 1 2 Action Write in the position ―</WebMappings>‖. between ―<WebMappings>‖ Attributes listed in this file are: ―[ source](*)‖ : source site template ―[ destination](*)‖ : destination site template An example of how to perform this mapping is as follows: 3 4 <TemplateMap source="STS#0" destination="STS#1" /> Template: The default template for site collection. ManagePath: The manage path for site collection. Example: <WebMappings Template=‖STS#0‖ ManagePath=‖Sites‖> …… © 2001-2008 AvePoint, Inc. All rights reserved. Page 329 and </WebMappings> 7.3.3.4 Portal Listing and Portal Area Migration This section describes how to perform migration of portal listings and areas. The steps are the same for each. Step Action 1 Using DocAve, navigate to the ―SP 2003 / WSS v2‖ tab and select ―Item Level Backup.‖ 2 Choose the portal listings or areas you desire from the tree. 3 Check the box under the backup settings labeled ―Enable Backup Migration‖ and run the plan. 4 Navigate to the ―SharePoint 2003 to 2007‖ tab of the ―Migration‖ module for MOSS 2007 / WSS v3. 5 Choose ―Backup Migration‖ and select the appropriate backup data from the ―Item Level Backup Job Browser.‖ 6 Expand the item level backup data browser to the portal areas or listings that you desire (i.e., ―Home‖). 7 For the destination select a site, subsite, or any web path (using the blank space) which starts all services in the site collection features and site features. Typically, this is the ―.‖ directory of the top level site. 8 Run the migration. You should be able to view in SharePoint a section called ―Portal Listings‖ under the top-level site you designated during the migration. *Note: The area structure can be migrated when the destination is a site. When migrating to a web, the area structure cannot be migrated. © 2001-2008 AvePoint, Inc. All rights reserved. Page 330 7.3.3.5 Migrator User Scan Tools Included in DocAve are tools for scanning for users belonging to the various versions of SharePoint: CollectSP2003Users.exe This program will retrieve a list of all users for a specific site in SP2003 (or for the entire environment). Enter in the command prompt: ―CollectSP2003Users.exe <CSVFile> [VSurl]‖ Where <CSVFile> represents the output file and [VSurl] represents the site to search under. Examples of possible searches are: ―collectSP2003Users.exe c:\testfile.csv http://avepoint.com:7777‖ This will find all users under the site http://avepoint.com:7777 ―collectSP2003Users.exe c:\testfile.csv‖ This will return all users in the SP2003 environment. CollectADObject.exe This program retrieves all users from the SP2007 domain. *Note: You must have .Net Framework v2.0.50727 installed on this machine. Step 1 Action Run the ―CollectADObject.exe.‖ Select the ―Browse‖ button and provide a location to save the result. 2 3 Click the ―Run‖ button and all users in Active Directories (AD) will be written to the selected result file. © 2001-2008 AvePoint, Inc. All rights reserved. Page 331 MigratorUserScan.exe This tool is intended to find out whether the former users in SP2003 still exist in the SP2007 domain. *Note: You must have .Net Framework v2.0.50727 installed on this machine. Step Action Run ―MigratorUserScan.exe‖ to open the tool shown below: 1 Slect the ―Load‖ button next to ―User Mapping.‖ If no User Mapping is desired, select ―Clear.‖ 2 *Note: If DocAve has been installed on the machine and UserMapping.cfg has been configured, this tool can load this file. If you have another UserMapping file scheme, please select it here. 3 Use the same process above to load the ―Domain Mapping‖ configuration. 4 Use the ―SP2003 AD Users‖ line to load the file created by the ―CollectSP2003Users.exe‖ tool. 5 Use the ―SP2007 Domain AD Users‖ line to load the file created by the ―CollectADObject.exe‖ 6 Select the ―Match‖ button to generate the results saved in the ―Matched User File‖ and ―Unmatched User File‖ separately. © 2001-2008 AvePoint, Inc. All rights reserved. Page 332 7.3.3.6 Currently Supported and Unsupported Elements for Backup Migration: Source Libraries Type Document Library Supported Form Library Supported Wiki Page Library Supported Picture Library Supported Translation Management Library Supported Data Connection Library Supported Slide Library Supported Report Library Supported Communications Announcements List Tracking Lists Custom Lists Supported Contacts Supported Discussion Board Supported Links Supported Calendar Supported Tasks Supported Project Tasks Supported Issue Tracking Supported Survey Supported Custom List Supported Custom List in Datasheet View Supported Languages and Translators Supported KPI Lists Web Pages Status Unsupported Import Spreadsheet Supported Basic Page Supported Web part Page Supported Sites and Workspaces Supported Workflow unsupported RSS unsupported Alerts Supported My Alerts My Alerts in SP 2003 Personal Site Supported Metadata Single line of text Supported Multiple lines of text Supported Choice(menu to choose from) Supported Number Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 333 Currency Supported Date and Time Supported Look up Supported Yes/No Supported Person or Group Supported Hyperlink or Picture Supported Calculated Supported Business Data Supported Security & Version settings Supported Properties Column Settings Supported Permissions Supported Version Histories Documents Supported Site template Lists Supported Team site Supported Blank site Supported Document workspace Supported Basic meeting workspace Supported Blank meeting workspace Supported Decision Meeting workspace Supported Social Meeting workspace Supported Multipage Meeting workspace Supported My Links Supported Personal site Supported Area (03side) Supported Portal listing Supported My Profile Supported Archiver All archived stubs (03 side) Supported 7.3.4 Live Migration The Live Migration process is a seamless transfer of data from SPS 2003 to MOSS 2007. Although this offers a quicker, one step process for migrating, it is not as secure as Backup Migration due to the fact that it is ―On-the-Fly‖ and relies heavily on constant network connectivity. To run a Live Migration, follow the steps below: © 2001-2008 AvePoint, Inc. All rights reserved. Page 334 Step Action 1 On the DocAve GUI navigate to DocAve for MOSS2007 > SP 2003 > Live Migrator Tab 2 Select your source SP2003 agent from the drop-down list in the middle of this screen. 3 Underneath this drop-down list, enter in the SQL information related to this agent. You can choose to enter in all of the information manually or enter in the SQL server name and check off SQL Default. This will open up another page where you can enter in your SQL information here. Many times only entering in the Server name is enough. 4 Select the appropriate content database of the site you wish to migrate from the Database drop-down list. Once this is selected, your SharePoint sites will populate underneath this section. Select the content you wish to migrate over by selecting the radio button next to the site, subsite, or library. You can select specific items by opening up the file browser and selecting those items. 5 6 *Note: If any of the contents in the SharePoint 2003 environment have changed since creating this plan, use the ―Sync with SP‖ button to re-load the tree. This will add new content and remove the content that no longer exists on the source. Once you have selected what you would like to Migrate, select a SharePoint 2007 agent from the Destination Agent Drop-down list. The structure should pop-up underneath it. Select your destination location by clicking on the radio button. You can also create a destination location by selecting the blank destination option and typing in the appropriate location. Lastly, at the bottom there are some final options that complete the Migration process configuration. 7 a. Schedule – Schedule when the migration job should be run b. Restore Option – allows the user to select either Not Overwrite, Overwrite. c. Full–A full migration of the selected file system. d. Incremental–a partial migration where only data that has been added or edited since the last full migration is migrated. Skip the © 2001-2008 AvePoint, Inc. All rights reserved. Page 335 data without any change. e. Interval –allows the user to specify the interval at which the migration will occur. Choices are: Only Once, Hour, Day, Week, and Month. f. Description – allows the user to enter a description to the Migration job (helps distinguish jobs) *Note: Setting the SharePoint Installation Network Path is optional. However if the source contents include SharePoint lists with customized columns, you must enter the path as follows: ―\\Server\c$\Program Files\Common Files\Microsoft Shared\web server extensions\60\TEMPLATE‖ in order to allow DocAve to find the templates of the customized lists. Please see the picture below for further details: Once all of your options are set, you can save all of this information as a plan. Once the plan is saved you can run the plan now by pressing the Run Now button or setting up a schedule for it to be executed at a later point in time. *Note: When browsing large environments, the tree may split across multiple pages. Please select the ―paging‖ icon and choose the page number from the bottom of the display. 7.3.4.1 Currently Supported and Unsupported Elements for Live Migration: Source Libraries Type Status Document Library Supported Form Library Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 336 Known Issues* Wiki Page Library Supported Picture Library Supported Translation Management Library Supported Data Connection Library Supported Slide Library Supported Report Library Supported Communications Announcements Supported List Contacts Supported Discussion Board Supported Links Supported Calendar Supported Tasks Supported Project Tasks Supported Issue Tracking Supported Survey Supported Custom List Supported Custom List in Datasheet View Supported Languages and Translators Supported Tracking Lists Custom Lists KPI Lists Web Pages Unsupported Import Spreadsheet Supported Basic Page Supported Web part Page Supported Sites and Workspaces Supported Workflow Unsupported RSS Unsupported Alerts Unsupported MetaData When the job is executed, please remember Single line of text Supported to fill in the path. When the job is executed, please remember Multiple lines of text © 2001-2008 AvePoint, Inc. All rights reserved. Page 337 Supported to fill in the path. When the job is executed, please remember Choice(menu to choose from) Supported to fill in the path. When the job is executed, please remember Number Supported to fill in the path. When the job is executed, please remember Currency Supported to fill in the path. When the job is executed, please remember Date and Time Supported to fill in the path. When the job is executed, please remember Lookup Supported to fill in the path. When the job is executed, please remember Yes/No Supported to fill in the path. When the job is executed, please remember Person or Group Supported to fill in the path. When the job is executed, please remember Hyperlink or Picture Supported to fill in the path. When the job is executed, please remember Calculated Supported to fill in the path. When the job is executed, please remember Business Data Supported Security Version settings Supported Properties Column Settings Supported Permissions Supported Version Histories Documents Supported Site template Lists Supported Team site Supported Blank site Supported Document workspace Supported Basic meeting workspace Supported Blank meeting workspace Supported Decision Meeting workspace Supported Social Meeting workspace Supported Multipage Meeting workspace Supported My Links Supported Personal site Supported Area(03side) Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 338 to fill in the path. 7.4 Exchange Public Folder Migrator 7.4.1 Installation To make sure the Public Folder Migrator module is installed, follow the steps below: Step Action 1 Navigate to the Client Configuration Tool 2 Under the Migration tab verify that the ―Public Folder to MOSS 2007 Migrator‖ option is checked off 3 Press Confirm and restart the Client services This will allow that front-end machine to appear on the GUI as a destination agent. 7.4.2 Un-installation To uninstall the Public Folder Migrator module, follow the steps below: Step Action 1 Navigate to the Client Configuration Tool 2 Under the Migration tab, uncheck the ―Public Folder to MOSS 2007 Migrator‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 339 3 Press Confirm and restart the Client services This will remove the Migration capabilities from this agent. 7.4.3 Using Exchange Public Folder Migrator The basic requirement for PF Migrator is remote access to the source Exchange server and local destination SharePoint server. *Please note that the source Exchange server and target SharePoint server on the same machine is not supported in production. This is due to Microsoft‘s limitation that Outlook cannot be installed on a production Exchange server. Outlook Web Access (OWA) Compatibility PF Migrator is programmed to pull data out of Exchange, so OWA is desired but not required. However, an Exchange IIS Virtual directory would need to be set up as our tool requires a URL for reference. If OWA is not going to be used, it is possible to set up the IIS Virtual directory without exposing that information to end users. As an added security measure, the HTTPS protocol can be utilized to IP restriction can be added so that the DocAve migration agent can solely access the Virtual directory. Please refer to your Microsoft Exchange documentation for details. Before migrating content from Exchange into SharePoint, please note the destination types for your exchange content. Below is a table showing a few examples: Source Exchange Folder Mail Folder Contact Folder Calendar Folder Task Folder Journal Folder Note Folder Destination SharePoint List / DocLib Document library (MSG files), Generic list (Items with attachments) and Discussion board (Keeps message threading) Contacts List Events List Tasks List Generic List Generic List In order to migrate information from Microsoft Exchange to SharePoint follow the steps below: © 2001-2008 AvePoint, Inc. All rights reserved. Page 340 Step Action 1 On the DocAve GUI navigate to Exchange Public Folder migrator 2 First, choose your destination agent from the drop-down list For MOSS 2007: Press the Management button to bring up the Exchange Connection Profile window. 3 4 For MOSS 2007 and SPS 2003: Enter in the appropriate Microsoft Exchange information. You can save this profile for future use. Once the information is entered and the GUI connects to the Exchange server, you will see the public folder contents. Choose the appropriate items from the public folder by clicking on the radio button next to the folder. You can choose to select individual files from the second column in this window as well. Once your content has been selected, choose where you would like to migrate the information into your SharePoint environment. 5 6 Exchange folder structure will be maintained for mail folders if moved to a document library. If the subfolder type is different from the parent folder, a new list or document library will be created for the subfolder and a link item will be created in the parent list or document library pointing to the new list. To make it easier, it‘s best to organize the public folder structure to be consistent before the migration. Lastly, at the bottom there are some final options that complete the Migration process configuration. a. Schedule – Schedule when the migration job should be ran b. Restore Option – allows the user to select either Not Overwrite, Overwrite. c. Full–A full migration of the selected file system. d. Incremental–a partial migration where only data that has been added or edited since the last full migration is migrated. Skip the data without any change. e. Interval –allows the user to specify the interval at which the migration will occur. Choices are: Only Once, Hour, Day, Week, and Month. © 2001-2008 AvePoint, Inc. All rights reserved. Page 341 f. Description – allows the user to enter a description to the Migration job (helps distinguish jobs) Once all of your options are set, you can save all of this information as a plan. Once the plan is saved you can run the plan now by pressing the Run Now button or setting up a schedule for it to be executed at a later point in time. 7.4.3.1 Advanced Settings This section will describe how to set up the ―Advanced‖ pop-up under the Exchange Public Folder tab. If a Web/ Subsite is selected as the destination: ―Create Root Folder‖ : After migration, the content selected from the source will be located in a root folder under the destination List in SharePoint. ―Treat Level 1 Folders as Root Folders‖ : After migration, all folders located on the source will be created as a root folder in the destination list, with any items (not already under a folder) listed in a separate folder. ―Use Full Path as Target Name‖ : Each individual folder / subfolder in the source will be migrated to the new list in the destination as separate folders. The names of each separated folder will contain the original path name from the source. ―Use Unicode MSG File‖ : The default format for messages is ANSI MSG, which is readable for all Outlook versions, but non-ANSI characters may be changed to ―?‖ in unsupported versions. Unicode MSG is readable from Outlook versions 2003 and above, and can support non-ANSI characters. ―Set Outlook Home Page URL‖ : See ―Enabling outlook Redirection‖ below. ―Clean Up Files After Migration‖ : After migration, the selected content in the Exchange Public Folder on the source will be deleted. If a List is selected as the destination, the following option will also be enabled: ―Enforce Source Type Compatibility Check‖ : If this option is selected, before the migration is run a type compatability check will be performed between the source and the destination. © 2001-2008 AvePoint, Inc. All rights reserved. Page 342 7.4.3.2 Enabling Outlook Redirection Enabling outlook to redirect to a migrated site using Outlook Web Access can be set during the migration. Step Action 1 Under the ―Exchange Public Folder‖ tab, select the ―Advanced‖ button. 2 Select the ―Set Outlook Home Page URL‖ option. This will add the appropriate SharePoint URL to Outlook, redirecting the Exchange content to the corresponding SharePoint location. 3 If this option is not selected during the initial migration, the migration plan can be opened at a later time and an incremental migration can be performed with this option selected. Doing such a migration will both update the SharePoint content with any changes that have occurred within Exchange since the original migration. It will also enable redirection of the Exchange content to the corresponding SharePoint location. 7.4.4 Exchange Public Folder Mapping File This section will discuss the public folder mapping file structure as defined by the customizable .xml configuration file. 7.4.4.1 Mapping File Contents The mapping configuration .xml can be found in the following location: …\Avepoint\DocAve4\VaultClient\data\MappingConfiguration2007.xml Various properties and definitions can be set in this file. The <ItemMapping> field is the combination of the <SharePointContentTypes> and <ExchangePropertyMapping> fields, and corresponds to the mapping during migration. It selects a property in exchange using <ExchangePropertyMapping> first, then maps this property to a field in <SharePointContentTypes>. This field will display its Exchange value in the corresponding SharePoint field. © 2001-2008 AvePoint, Inc. All rights reserved. Page 343 For detailed information about each element, reference the sections below. Content Types You can configure the content type mapping in the section <SharePointContentTypes>. This section will describe how to define the new content types in SharePoint: ―name‖ : This field indicates the name that will be used for this new content type in SharePoint (i.e. ExchangeDocument, ExchangeEvent, etc.). ―baseType‖ : Entries to this field should be a defined content type in SharePoint already (i.e. Document, Message, Task, Event, etc.). ―targetType‖ : This identifies the type of content, either an Item or File. Example: <ContentType name=‖ExchangeDocument‖ baseType=‖Document‖ targetType=‖File‖ /> You can also set properties of the elements defined in the <ContentType> fields, using the <Property> entry. Please see the explanation below: ―name‖ : This will indicate the name of the property. ―type‖ : Configuring the type will specify the type of field this will be converted to after importing to SharePoint (i.e. Text, Note, User, DateTime, etc.). ―displayName‖ : This will be the name displayed by SharePoint for this property. ―isBuildIn‖ : This will specify whether the property is a standard SharePoint property, or a custom specification. Example: <ContentType name=‖ExchangeDocument‖ baseType=‖Document‖ targetType=‖File‖> <Property name=‖MessageClass‖ type=‖Text‖ displayName=‖MessageClass‖ isBuildIn=‖false‖ /> </ContentType> Exchange Property Mapping This configuration file will also allow you to set the relationship between the alias name and internal name of the various Exchange properties. The <ExchangePropertyMapping> section is explained below: ―name‖ : This field is the alias name given to the property. This name will come up again in the Item Mapping section. ―exchangeName‖ : This field is the internal property name given in Exchange. Example: For a detailed example of this section and its syntax, please view the original file. © 2001-2008 AvePoint, Inc. All rights reserved. Page 344 Item Mapping The <ItemMapping> fields is an essential part of this configuration file. This will specify the mapping relationship between the Exchange Public Folder and the SharePoint environment: ―name‖ : This will list the item type in exchange. You cannot modify this name. ―targetList‖ : This will specify the target list to hold these items in SharePoint. ―targetContentType‖ : A content type entered here must be defined in the <SharePointContentTypes> section above (i.e. ExchangeDocument). Example: <ItemType name=‖urn:content-classes:message‖ targetList=‖DocumentLibrary‖ targetContentType=‖ExchangeDocument‖ /> You can also define properties of these item types: ―name‖ : This is the alias name given in the <ExchangePropertyMapping> field. ―targetField‖ : This is the item‘s attribute, defined in the content type section above as ―targetContentType.‖ Example: <ItemType name=‖urn:content-classes:message‖ targetList=‖DocumentLibrary‖ targetContentType=‖ExchangeDocument‖ > <Property name=‖subject‖ targetFiled=‖Title‖ /> <Property name=‖to‖ targetField=‖To‖ /> …. </ItemType> 7.4.4.2 Example Tasks Using the configuration file outlined above, you can perform several common tasks. A few are listed below: Adding a Field in SharePoint For this example task, a field named ―test‖ will be added to SharePoint in order to show the ―author‖ of a message. The information required for the flow is as follows: The content type is the message or subtype of the message The field to be added is called ―test‖ and should display the same title in SharePoint The value is the author of the message, so the property in SharePoint would be ―user.‖ Please follow the steps below to add this mapping field: Step © 2001-2008 AvePoint, Inc. All rights reserved. Page 345 Action 1 2 In the <SharePointContentTypes> category, navigate to enter a new property below <ContentType name=‖ExchangeMessage‖…>. For this new property, specify ―isBuildIn‖ attribute to ―false,‖ since this property is not defined by SharePoint. The property line should look like the following text: <Property name=‖test‖ type=‖User‖ displayName=‖test‖ isBuildIn=‖false‖/> Mapped info must be added to <ItemMapping>. Place the pointer beneath the <ItemType name=‖urn:content-classes:message‖…> section. 3 *Note: There are two locations to add this for each type of destination (document libraries and generic lists). Make sure you perform this step twice. Add the property line below to the locations in the previous step: 4 <Property name=‖//schemas.microsoft.com/exchange/security/ creator‖ targetField=‖test‖ /> This property name can only map because of the line in <ExchangePropertyMapping>. Confirm that it is located in this section: 5 <Property name=‖//schemas.microsoft.com/exchange/security/creator‖ exchangeName=‖http://schemas.microsoft.com/exchange/security/ creator‖ /> This file should now perform the field mapping listed above. Configuring Permission Mapping Permissions are defined under the <PermissionMapping> heading in the configuration file. There are two nodes that define permissions: <Permission name=‖…‖> : This function will define the permission given in Exchange. <TargetPermission> : Several of these nodes can be added beneath the <Permission> node above, listing the SharePoint permissions after migration. Although the permission names cannot be modified, the permissions given can be re-arranged to map in various ways by adding or deleting <TargetPermission> items beneath each parent <Permission>. Permissions available in Exchange: ReadItems, CreateItems, EditOwnItems, DeleteOwnItems, EditAllItems, DeleteAllItems, CreateSubfolders, FolderOwner, FolderContact, FolderVisible © 2001-2008 AvePoint, Inc. All rights reserved. Page 346 Permissions available in SharePoint: addandcustomizepages, adddelprivatewebparts, addlistitems, applystylesheets, applythemeandborder, approveitems, browsedirectories, browseuserinfo, cancelcheckout, createalerts, creategroups, createsscsite, deletelistitems, deleteversions, editlistitems, editmyuserinfo, enumeratepermissions, managealerts, managelists, managepermission, managepersonalviews, managesubwebs, manageweb, open, openitems, updatepersonalwebparts, useclientintegration, useremoteapis, viewformpages, viewlistitems, viewpages, viewusagedata, viewversions, fullrights. *Note: It is recommended that you do not change the permissions set in this file. Please be certain of the permissions you are granting before making any changes. Macro Usage in Public Folders Format: [the alias name of the property in Exchange] , this alias name must be appeared in ExchangePropertyMapping. If you want to display ―[‖ or ―]‖ in this field, please use the ―[[‖ or ―]]‖ instead of that. But the property name inputted in the ―[]‖ will be processed, it means this name will be replaced by its value in Exchange. If this property name or the value will not be found in the Exchange, it will display the original property name in the ―[]‖. The Steps to Edit this Configuration File: 1. To make sure the field you wish to map in the ―ContentType‖ in ―SharePointContentTypes‖. If the field is not existed, you should add a new one. Example: <Property name=‖testMacro‖ type=‖Text‖ displayName=‖testMacro‖ isBuildIn=‖false‖/> 2. Add <Macro name=‖[the alias name in Exchange]‖ targetType=‖testMacro‖/> in the mapped item. Please refer to the screenshot below: © 2001-2008 AvePoint, Inc. All rights reserved. Page 347 7.4.4 Currently Supported and Unsupported Elements for Public Folder Migration 2007 Public Folder Migration Source Note Items Journal Items Calendar Items Contact Items Destination Type Root web Sub site Task Calendar Contacts Custom(Matching Type) Discuss Board Share Documents Root web Sub site Task Calendar Contacts Custom(Matching Type) Discuss Board Share Documents Root web Sub site Task Calendar(Matching Type) Contacts Custom Discuss Board Share Documents Root web Sub site Task Calendar Contacts(Matching Type) Custom © 2001-2008 AvePoint, Inc. All rights reserved. Page 348 Status Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Known Issues Mail Items Discuss Board Share Documents Root web Sub site Task Calendar Contacts Custom(Matching Type) Supported Supported Supported Supported Supported Supported Supported Supported Discuss Board(Matching Type) Share Documents (Matching Type) Supported Supported 2003 Public Folder Migration Source Note Items Journal Items Calendar Items Destination Type Root web Sub site Task Calendar Contacts Custom(Matching Type) Discuss Board Share Documents Root web Sub site Task Calendar Contacts Custom(Matching Type) Discuss Board Share Documents Root web Sub site Task Calendar(Matching Type) Contacts © 2001-2008 AvePoint, Inc. All rights reserved. Page 349 Status Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Known Issues Contact Items Mail Items Custom Discuss Board Share Documents Root web Sub site Task Calendar Contacts(Matching Type) Custom Discuss Board Share Documents Root web Sub site Task Calendar Contacts Custom(Matching Type) Discuss Board (Matching Type) Share Documents (Matching Type) © 2001-2008 AvePoint, Inc. All rights reserved. Page 350 Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported Supported 7.5 eRoom Migrator DocAve‘s eRoom Migrator allows you to migrate content from your eRoom environment to SharePoint 2007. In order to perform this migration, you must be running eRoom version 7.3 or above. 7.5.1 Installation To perform a migration from eRoom to MOSS 2007, a DocAve agent must be installed on both the eRoom and SharePoint machine. To make sure the eRoom Migrator module is installed on both, follow the steps below: Step Action After performing all installation steps on both the eRoom and MOSS 2007 machines for the DocAve Client, navigate to the Client Configuration Tool in each environment. 1 If … Then … eRoom Machine Under the ―Migration‖ tab, check ―eRoom Migration for eRoom agent.‖ MOSS 2007 Machine Under the ―Migration‖ tab, check ―eRoom Migration for MOSS agent.‖ 2 Press Confirm and restart the Client services. 3 Start the DocAve Server application and navigate to ―Control Panel.‖ 4 Open the ―Agent Monitor‖ under ―Control Services‖ and select the new agents from the column on the left. Enter the SharePoint Domain, Username, and Password in the given input fields. 5 *Note: If the eRoom machine has no domain, use ―.‖ In this field instead. © 2001-2008 AvePoint, Inc. All rights reserved. Page 351 6 Click the ―Save‖ button (for each agent). This will allow that front-end machine to appear on the GUI as a destination agent. 7.5.2 Un-installation To uninstall the eRoom Migrator module, follow the steps below: Step Action 1 Navigate to the Client Configuration Tool on the MOSS agent 2 Under the Migration tab, uncheck the ―eRoom Migration for MOSS Agent‖ option 3 Press Confirm and restart the Client services This will remove the Migration tool capabilities from this agent. 7.5.3 Using eRoom Migrator The eRoom migration tool will allow you to import content from your eRoom agent to your MOSS 2007 environments. When importing items from eRoom, the following mapping will occur: Notes -> Announcements Calendar -> Calendar Poll -> Survey Project Plan -> Task Link -> Link Database -> Custom List Discussion -> Discussion Board File/Folder -> Folder/Document Library © 2001-2008 AvePoint, Inc. All rights reserved. Page 352 There Inbox-> Document Library are three options: Normal, Stage, and Restore. ―Normal‖ : You can migrate the data from eRoom to SharePoint directly. ―Stage‖ : Export the data from eRoom. ―Restore‖ : Use the exported eRoom data. 7.5.3.1 Normal Mode Migration To perform the migration, follow the steps provided below: Step Action 1 Navigate to the ―Migration‖ -> ―eRoom‖ tab. 2 In the area above, you can set settings for ―Email Notification‖ for this migration job. These profiles are set up in the ―Control Panel.‖ 3 Click Common Config. Select a configuration file you want to use during this migration. Click OK. This is a mandatory option. Default button: click this button; the selected congfiguration file will be set as the default. Delete button: click this button; the selected configuration file will be deleted. 4 Click Mapping Config, you can use it to map the columns from eRoom to SharePoint. This is optional. 5 Select the source agent from the drop-down box. 6 Click on the agent name to expand the tree in the center of the GUI. All of the communities found in eRoom will be listed. 7 Browse the tree structure to find the folder you are looking to import content from. © 2001-2008 AvePoint, Inc. All rights reserved. Page 353 8 9 10 In order to see the files inside the folder, open the file browser by clicking on the arrow button in the middle of the two columns. Once you have found the content you would like to migrate, select it by checking off the appropriate files on the file browser, or by selecting the folder from the tree browser by clicking the radio button next to it. You can select one of the following three options for ―Global Securities‖: ―Migrate all security‖ : All the securities in the selected folders will be migrated to the specific SharePoint environments. ―According to the tree selection‖ : All the securities for the nodes you have selected in the tree will be migrated to the SharePoint environment. ―Migrate no security‖ : It will not restore any securities. *Note: If you set the <RestoreUser RestoreFlag=‖false‖ /> flag in the eRoomConfigurations.xml, the above settings will not take effect. 11 On the right side of the screen, select your Destination Agent from the drop-down box. Navigate through the tree structure of the SharePoint environment to find your destination for the files. Click on the corresponding radio button next to the document library to select it. If you select a list, you can click Load button to load the content type of this list. Please note that migrated content will map according to the behaviors below: If… 12 List Then… All contents will be migrated to the destination Site, Subsite, or List. *Note: You cannot migrate to the Web Application level. Room © 2001-2008 AvePoint, Inc. All rights reserved. Page 354 When Migrating to: Web Application: It will create a new site using the same name as the room. Site: It will create a new subsite with the same name as the room. Subsite: All of the room‘s content will be migrated to the destination. 13 Facility When Migrating to: Web Application: It will create a new site using the same name as the room. Site: It will create a new subsite with the same name as the room. Community When Migrating to: Web Application: It will create a new site using the same name as the room. Site: It will create a new subsite with the same name as the room. If you do not plan on running this job now, you can set it to run on a schedule by un-checking the ―No Schedule‖ checkbox. Using the calendar icon next to the ―Start Time‖ field, select a date and time for the archive job to run. Also, set an interval for recurring rules based on an hourly, daily, weekly, or monthly schedule. (This feature can only be used in ―Standard Migration.‖) Select a Migration Type (this only applies to ―Standard Migration,‖ configured below). 14 If… Then… Full A full migration of the selected source will be performed. Incremental A partial migration where only data that has been added since the last incremental or full migration is backed up. Choose from the list of ―Migrate Options‖ (this option only applies to ―Standard Migration‖ and ―Migrate with Metadata File‖). If… Then… DocAve will not migrate the content if it already exists on the destination. 15 Not Overwrite © 2001-2008 AvePoint, Inc. All rights reserved. Page 355 For example, if an entire folder‘s content is selected for migration, but only one document is missing from the destination folder, only the missing document will be migrated. Overwrite DocAve will migrate the content over whatever exists on the destination. This will delete the content on the destination and replace it with the content selected. This option will allow DocAve to update the destination with the selected data to be migrated. Data that already exists will not be deleted; data that is not already present will be added. Append Overwrite on modified time If there a file with the same name existed in Destination, its File name will be changed to filename"+"_1, 2, 3...‖ And this conflict for the file name will be recorded in the zip package in the job report. The URL and Name for this file in eRoom and MOSS will be included in this report. If the file exists in the destination with the same created time, the conflict resolution will then refer to ―modified time.‖ Using the ―Mapping Options‖ drop down, you can specify which form of migration will be run. 16 17 If… Then… Standard Migration This will run the migration in the standard mode, where the source content is simply transferred to the destination. Create Metadata ―Create Metadata‖ will run the plan by creating a new metdata.xml file. This will not migrate any data, it will only provide a master file for future migration. Migrate with Metadata This option will allow you to migrate based on the metadata.xml mapping file created using the ―Create Metadata‖ option. Once completed, save the plan. Once the plan is saved, press the Run Now button to start your job, or to set a scheduled plan. *Note: 1. When migrating eRoom files, if a file‘s status is marked as ―Open,‖ it will be migrated as ―Checked Out‖ in MOSS. All files whose statuses are ―Check Out‖ can be found in the .zip package of job report. You can find the file information: source path, destination path, check out user and the user email. 2. Upload and Download: Upload and Download buttons in the Mapping Config and Common Config page is for the users to download, edit, upload the custom file. If there a file with the same name © 2001-2008 AvePoint, Inc. All rights reserved. Page 356 existed in DocAve server, this file will be overwritten after uploading. 3. When browsing extremely large communities, the tree may split across multiple pages. To browse multiple pages, click on the ―Paging‖ icon at the top of the tree, then select the page number from the popup displayed. 4. For conflicts with the files and folders during migration, DocAve will write the file name change, folder name changes, and any other URL changes in the JobReport.zip file. 5. DocAve will restore the owner (only in files and folders) to a new column in SharePoint titled ―Owner‖. 7.5.3.2 Common Configuration Please configure the configuration file before running an eRoom migration job. The default configuration file is ‗eRoomConfigurations.cfg‘. Click Common Config, you can view a list which includes all configured files. You can select a file to download and edit, then upload this file. Each plan should have only one file. The format of the configuration file is as followed: <Configurations> <UserMapping> <MappingeRoomUserLoginName="siteadmin" MOSSUserLoginName="domainName\administrator" /> </UserMapping> <MailMapping> <Mapping eRoomUserEmail="user1@mail.com" MOSSUserLoginName="domainName\user001" /> </MailMapping> <RoleMapping> <Mapping eRoomRole="Coordinators" MOSSRole="Full Control" /> <Mapping eRoomRole="Participants" MOSSRole="Design" /> <Mapping eRoomRole="Observers" MOSSRole="Read" /> </RoleMapping> <UsingTemplateWhenCreateSite Template="STS#0" ManagedPath="sites" /> <LimitedLengthOfFolder HasLimitFlag="true" Characters="60" /> <LimitedLengthOfFile HasLimitFlag="true" Characters="80" /> <MaxNumberOfVersionsToBeMigrate HasFlag="false" Number="10" RestoreVersionToFile="false"/> <WebOrSiteLanguageID LanguageID="1033" /> <DataIntegrityCheck HasFlag="false" /> <BreakRoleInheritance BreakFlag="true"/> <InboxMailAttachment RestoreAsEMLAttachment="true"/> <RestoreUser RestoreFlag="true" /> <Characters> <FolderCharacter> © 2001-2008 AvePoint, Inc. All rights reserved. Page 357 <character sourceCharacter="&amp;" destinationCharacter="_" /> …… <character sourceCharacter="*" destinationCharacter="_" /> </FolderCharacter> <FileCharacter> <character sourceCharacter="&gt;" destinationCharacter="_" /> …… <character sourceCharacter="*" destinationCharacter="_" /> </FileCharacter> <GroupCharacter> <character sourceCharacter="&gt;" destinationCharacter="_" /> …… <character sourceCharacter="@" destinationCharacter="_" /> </GroupCharacter> </Characters> </Configurations> ―UserMapping‖ : This is for mapping of eRoom users to SharePoint users. The username in this configuration file must be Login name, not Display name. The SharePoint username you typed must be in Active Directory, or else SharePoint cannot find the user. *Note: If the eRoom username is the same as that for SharePoint, these users will map automatically. ―MailMapping‖ : This maps eRoom users who have specific email addresses. ―RoleMapping‖ : This is for mapping eRoom Roles to SharePoint Roles. By default, we map the ‗Coordinator‘ to ‗Full Control‘, map the ‗Participant‘ to ‗Design‘ and ‗Observer‘ to ‗Read‘. It is strongly recommended that you don‘t change the default role mapping. If the MOSS permission Level exists, we directly use the existing Pemission Level. For example, for <Mapping eRoomRole="Coordinators" MOSSRole="Full Control" />, we will directly use Full Control to replace the Coordinators. It is strongly recommended that you don‘t change the default role mapping. *Note: If the user‘s SharePoint is German. Role mapping should be as the following, <RoleMapping> <Mapping eRoomRole="Coordinators" MOSSRole="Vollzugriff" /> <Mapping eRoomRole="Participants" MOSSRole="Entwerfen" /> <Mapping eRoomRole="Observers" MOSSRole="Lesen" /> </RoleMapping> ―UsingTemplateWhenCreateSite‖ : This entry lets you choose the site template you would like © 2001-2008 AvePoint, Inc. All rights reserved. Page 358 to use when creating new sites for a room. By default, the template is ―STS#0‖—Team Site. You can specify other templates. These templates can be found as comments in this configuration file. *Note: Managed paths can also be set in this field by specifying the new URL. However, we recommend using ―sites‖ as default. ―LimitedLengthOfFileOrFolder‖ : The SharePoint 2007 requires the file name and folder name no longer than 128 characters and the full URL no longer than 260 characters. <LimitedLengthOfFolder HasLimitFlag="true" Characters="80"> <LimitedLengthOfFile HasLimitFlag="true" Characters="60"> This will control the maximum length of file name and folder name. If it is over the limit, we will truncate it to the maximum length. If HasLimitFlag is false, then this control is disable. If the length of the full URL is over 260, we move the file and its parent folder to one folder level up keep moving until the length is not over 260. If it is still over 260 when we move to the root folder of the list, we will throw the exception and write this in the job report. ―MaxNumberOfVersionsToBeMigrate‖ : This will allow the user to specify how many versions of each file will be migrated. Set the flag to ―true‖ and enter the number of versions desired. Set the ―RestoreVersionToFile‖ value as True, the Version can be restored to Document. <WebOrSiteLanguageID LanguageID="1033" />: This will allow the user to set the SharePoint language in destination. If the languageID is different from the SharePoint Language in destination, it will cause the restore failed. These languageID can be found as comments in this configuration file. For example, the country code for Germany is ―1031.‖ A complete list of country codes can be seen here: http://msdn.microsoft.com/en-us/library/ms776294(VS.85).aspx <DataIntegrityCheck HasFlag="false" /> Set this option to true to verify that the data was properly migrated to the MOSS 2007 environment. If the content of the file differs from the source, a warning will be displayed in ―event viewer.‖ <BreakRoleInheritance BreakFlag="true"> In order to make the permission setting same to the setting in the source after restore, we break the inherited relationship of the permission in web/list/listitem. If set Breakflag value is false, it will not break this inherited permission. <Characters> <FolderCharacter> <FileCharacter> </GroupCharacter> corresponded with the special characters in the file, folder and group in eRoom respectively. After this setting, the special © 2001-2008 AvePoint, Inc. All rights reserved. Page 359 characters in eRoom will be transformed in SharePoint according to this configuration file. If the user does not configure in the file, all illegal characters will be transformed into ‖_‖. User can still add the rows; transform the specific characters into the default characters. <InboxMailAttachment RestoreAsEXLAttachment=‖true‖/> This will allow the user to migrate inbox to the Document Library and restore mailpage to eml file. If RestoreAsEMLAttachment is "true", we will migrate the attachments as the attachment in the EML file. Otherwise, we will migrate it as a separated file in the document library with the name as MailPageTitle_AttachmentFileName.extension. *Note: &amp; &gt; = &lt; = &quot; &apos; = > < = = & " ' 7.5.3.3 Pre-Scan Users You can click ―Pre-scan users‖ button to check the User which have not been matched in eRoom after saving Plan. It might cost much time, you can do the other operations after pressing this button. You can load this plan at any moment and click this button. Once it completed, you can click ―Download‖ to download all non-matching user or click ―Start‖ button to run Pre-Scan User operation again. If it did not complete, it will prompt the operation process. You can copy the content of this report according to your need and paste this information in selected ―eRoomConfigurations.cfg‖ in this plan. This file is located in: ―…\AvePoint\DocAve4\VaultClient\data\Migrator‖ 7.5.3.4 Check-out Tool DocAve has included a tool named ―eRoomFileCheckOutTool.exe.‖ You can use it to find all ―Checked out‖ files of your eRoom site. The location is: ―…\AvePoint\DocAve4\VaultClient\bin\‖ To run the tool, double click on the icon. A report will be generated to the same folder labeled: ―eRoomFileCheckOut.txt.‖ All checked out files will be included in a list. *Note: This tool cannot work without ―eRoom.eRoomAPI.dll.‖ If you copy this file to a different location, please make sure that these two files are located in the same folder. This tool also cannot be run from remote desktop. © 2001-2008 AvePoint, Inc. All rights reserved. Page 360 7.5.3.5 Configuring Column Mapping Files In order to map the column in eRoom to SharePoint, please follow the steps below: Step Action 1 From the top of the eRoom GUI, click the ―Mapping Config‖ button. A popup should open with a list of sample .xml mapping files. 2 Select a mapping file corresponding to the content you would like to map and select ―download‖. This will allow you to save the corresponding file to your local computer for editing. Open the XML file using Excel. When prompted, choose to open this as an ―XML table‖. You should see two columns, representing the Source and Destination respectively. 3 *Note: You can also edit this file using word pad, or any other XML editing software. Excel is recommended to illustrate the relationship more clearly. In the first row below the ―source‖ and ―destination‖ headers, select the ―Source Type‖ from the list below (case sensitive), and enter the corresponding destination number in the second column: 4 Document -> 100 Database -> 101 Calendar -> 106 Link -> 103 Discussion -> 108 Poll -> 150 ProjectPlan -> 102 Note -> 104 Compare these lists with the ones found in eRoom. You can also input a ―*‖ in the destination column if the same type exists in SharePoint. Please consult the list at the top the eRoom section to verify this. *Note: You can also specify custom inputs. For instance, to migrate ―Home Folders‖ to a Picture Library, you could enter ―{Home Folder}‖ and ―My Pictures‖ in the source and destination columns respectively. © 2001-2008 AvePoint, Inc. All rights reserved. Page 361 The second row, first column, allows you to specify the name of the ―Source Name.‖ To migrate several lists of the same type, separate these names using a semicolon (;). You can also enter a ―*‖ in this field to map all future lists using this file. In the second row, second column, you may change the name of the list in the destination by entering a name in this cell. Using a ―*‖ will keep the name of the source, while multiple name changes can be entered using a semicolon (;). *Note: If you have entered multiple names in the source, make sure that there are a matching number of new names (or *‘s) in the destination. Example: 5 1. The following setting means you specify calendarA and calendarB as their names in SharePoint. 2. The following setting will keep their original names after restore. 3. The following setting means all calendars will keep their original names and follow the column mapping you set for the calendar in this file during the migration. 6 The remaining rows represent column mapping for this content type. The original columns (for the eRoom content type) are on the left, while the MOSS 2007 translations appear on the right. For instance, to change column ―CreateDate‖ to ―Created‖, simply enter the columns in the respective source and destination columns. © 2001-2008 AvePoint, Inc. All rights reserved. Page 362 7 After modifying these files (or creating custom ones), use the ―Upload‖ button from the Mapping Config popup in the eRoom migrator GUI. *Note: If you do not configure the custom mapping tables above, DocAve will use the default settings found in these files for migration. 7.5.3.6 Creating and Using “metadata.xml” After setting up the individual mapping files in the section above, use the eRoom migrator GUI to create the master ―Metadata.xml‖ file. Step Action 1 Using DocAve‘s eRoom migrator GUI, select the content you wish to migrate from the source and the destination. 2 Using the drop-down menu under the destination agent, select the content type you desire and press the ―Load‖ button. 3 Open the ―Mapping Config‖ pop-up using the button at the top of the GUI. 4 Select the ―*.xml‖ file (or files) you have created in the previous section. 5 Use the ―Save As‖ button to create a new plan. You cannot apply a schedule to this plan. 6 Click the ―Run Now‖ button, and select the mapping option to ―Create Metadata.‖ 7 After running this job, you will find a new file called ―metadata.xml‖ according to the generated path in the job report. 8 Open Microsoft Excel 2007. Under ―Excel Options,‖ check the ―Show Developer tab in the Ribbon‖ option. Please refer to your Microsoft Excel guide for details. © 2001-2008 AvePoint, Inc. All rights reserved. Page 363 9 Open Microsoft Excel 2007. Under ―Excel Options,‖ check the ―Show Developer tab in the Ribbon‖ option. Please refer to your Microsoft Excel guide for details. 10 Under the ―Developer‖ tab, press the ―Import‖ button under the ―XML‖ group. Choose the ―metadata.xml‖ file. 11 The first two columns will show the eRoom source URL and the destination URL (configured in DocAve). To modify the destination, simply edit this cell. *Note: You cannot edit the source field. 12 The third column shows the content type, which can be changed to any type available in the destination. Proceed to the next step. If… Then… 1. Export the XML file in Excel. 2. Using the ―Run‖ tool under the ―Start Menu,‖ open a command prompt by typing ―cmd.‖ 3. Enter the tool location, followed by the metadata.xml location separated by a space: 13 Any changes were made ―…\AvePoint\DocAve4\VaultClient\bin\ eRoomMappingTool.exe‖ ―…\VaultClient\data\ Migrator\eRoomMigrator\<*PLAN ID*>\metadata.xml‖ *Note: Fill in the ―…‖ with your installation directory and <*PLAN ID*> with the appropriate information. 4. Run the command and wait several minutes. After ―report.txt‖ has been created in the metadata.xml path, the update has completed. 5. Open the metadata.xml file again. No changes © 2001-2008 AvePoint, Inc. All rights reserved. Page 364 Proceed to step 14. 14 The ―ServerFilePath‖ column net share path can be modified using the following syntax: \\ IP Address\ disk driver $\ file path 15 The ―MOSS Field‖ column is generated by the customized column mapping. This cannot be modified. 16 Entries to the ―Value‖ columns can be modified. They are obtained from the eRoom directly. 17 After configuring these settings, you can now choose to run a plan using ―Migrate with Metadata File‖ under the ―Mapping Options‖ screen. *Note: If you delete some rows in metadata.xml, DocAve will not restore the deleted rows. You can also run multiple plans using the same ―metadata.xml‖ file, or choose to create a new one. 7.5.3.7 Stage Mode Migration 1. Export the data from eRoom Step Action Go to DocAve ServerControl panelAgent Monitor, select the eRoom agent, and set a location to save the exported data from eRoom in Data Location Setting. 1 2 If… Then… If you selected ―Local‖ in Location Type You should input the local path. For example: X:\FolderA\FolderB… If you selected ―Network‖ in Location Type You should input network domain, user, password and the path information. For example: \\IP Address\disk driver$\path Click Save. © 2001-2008 AvePoint, Inc. All rights reserved. Page 365 3 Go to DocAve ServerMigrationeRoom, select Stage. 4 Load eRoom Site structure to select the content you wish to migrate. *Note: If you selected ―Stage Data File‖ checkbox, the files which are stored in the eRoom file server will exported together. Otherwise, you should export these files manually. It is not recommended when there are many files in the data you wish to export. It will cost much time to export. 5 Click Save, and provide a name for this plan. 6 Run this job, the selected content will be exported to the location below: (Data Location Setting)\eRoom Stage Data\PlanName *Note: If you want to select ―Create Metadata‖ option when you click Run now. You should configure the destination information firstly. Click ―Destination Config‖ button, enter the destination information in the pop-up. If you did not configure here, you should enter destinationURL and content type in metadata.xml manually. The Metadata.xml will be generated in the following location: (Data Location Setting)\eRoom Stage Data\PlanName\JobID\ Metadata_JobID.xml The format of JobId: EM+job time 2. Restore the exported data Step Action Go to DocAve ServerControl panelAgent Monitor, select the SharePoint agent, and set a location to save the exported data from eRoom in Data Location Setting. 1 If… Then… If you selected ―Local‖ in Location Type You should input the local path. For example: X:\FolderA\FolderB… If you selected ―Network‖ in Location Type You should input network domain, user, password and the path information. For example: \\IP Address\disk driver$\path © 2001-2008 AvePoint, Inc. All rights reserved. Page 366 2 Click Save. 3 Copy the exported the data (eRoom Stage Data folder and the content) to the path which is set in the Data Location Setting in SharePoint Agent. *Note: If you did not select the Stage Data File option when you exported the data, you should copy the files in eRoom file server (Path: eRoom file server path\facilityName\roomName) to the following location: (Data Location Setting)\eRoom Stage Data\PlanName\Data\FacilityName\roomName. 4 Click Detail button next to Restore, all exported data be listed on the pop-up. Select the data you want to restore. You can select multiple data to restore. 5 Select a destination. If you have already configured ―Destination Config‖, you must select the same destination web application as the web application you entered in ―Destination Config‖. 6 Click Save and provide a name for this plan. 7 Run this job. *Note: If you select ―Create Metadata‖ when you export the data, you should configure the Metadata.xml as the following: Copy (Data Location Setting)\eRoom Stage Data\PlanName\JobID\matadata_JobID.xml to the machine which installed SharePoint on. If there are several job folders, you should configure each matadata_JobID.xml. You can use Excel 2007 to import it. If you did not configure the ―Destination Config‖, you should enter DestinationURL and content type manually. More details for configuration please refer to 7.5.3.5 ―Creating and Using ―metadata.xml‖. After your configuration, copy matadata_JobID.xml to the original path. 7.5.4 Currently Supported and Unsupported Elements for eRoom Migration Source Destination © 2001-2008 AvePoint, Inc. All rights reserved. Page 367 Status Known Issues* Discussion Discussion Supported All Notes Announcements Supported All Links Links Supported Calendar Calendar Supported Project Plan Project Tasks Supported Poll Survey Supported Database Custom List in Datasheet View Supported Inbox Document Library Supported Home Folder Document Library Supported Security & Version settings Supported Properties Column Settings Supported Permissions Supported The vote in the list Contact us for any known issues Unsupported The version in the list attachment Unsupported Manual inserted picture in the list Unsupported DashBoard Unsupported The replied title in Discussion368 Unsupported Team site Supported Besides team site Blank site Supported in, the meeting site the source content must be manually Site template added to the web Document workspace Supported Basic meeting workspace Supported Blank meeting workspace Supported Decision Meeting workspace Supported Social Meeting workspace Supported Multipage Meeting workspace Supported © 2001-2008 AvePoint, Inc. All rights reserved. Page 368 GUI. 8. Appendix Jump to Table of Contents 8.1 FDCC Compatibility DocAve recognizes that many of our customers adhere to FDCC standards for security (including the environments ―Specialized Security Limited Functionality,‖ ―Enterprise,‖ ―SOHO,‖ and ―Legacy‖). However, in order to access DocAve and ensure its full functionality in Windows XP, several steps must be taken. Please see the appropriate section below for details. For more information on FDCC, please visit the website: http://fdcc.nist.gov *Note: The following sections only apply to the Windows XP environment. 8.1.1 Configuring the DocAve Server for FDCC By default, an FDCC compliant environment will block all standard ports that DocAve uses to communicate. Before applying the solution below, make sure that you are running the latest version of .NET Framework (3.0 or higher). Step Action 1 Go to ―Start Menu‖ -> ―Run‖ and enter the command ―gpedit.msc‖ in the popup. 2 In the ―Group Policy‖ popup, use the tree view on the left hand side to navigate to ―Computer Configuration‖ -> ―Administrative Templates‖ -> ―Network‖ -> ―Network Connections‖ -> ―Windows Firewall.‖ 3 Under this level, you will see ―Domain Profile‖ and ―Standard Profile.‖ Please perform the next steps for both levels. 4 After selecting a profile, locate the setting ―Windows Firewall: Allow local port exceptions.‖ Double click this field to open the properties. *Note: This field is typically the last one on the list. © 2001-2008 AvePoint, Inc. All rights reserved. Page 369 5 In the pop-up, select ―Enabled‖ from the ―Settings‖ tab. 6 Verify that the state under the settings list has changed to ―Enabled‖ for this field and restart the computer. 7 After the system restart, navigate to ―Start Menu‖ -> ―Control Panel‖ -> ―Windows Firewall.‖ 8 Navigate to the ―Exceptions‖ tab and select the ―Add Port…‖ button. In the pop-up, select the ―TCP‖ option. Enter the name of the port and port number from the list below: 9 Network Service Port: 11000 Media Service Control Port: 11002 Media Service Data Port: 11003 WasCE / Web Service Port: 8080 WasCE / Web Service Https Port: 8090 (if https is enabled) DocAve Log Port: 11001 Patch Service Port: 11004 Please repeat these steps to add all ports listed above. *Note: The ports given above are all the default settings. If you have made any changes to this list during the install, please reference the numbers in the DocAve Server Configuration Tool. DocAve will now be able to run on your environment. 8.1.2 For End-User Access Using Https If a client is running Windows XP, the Group Policy must be changed in order to allow https access to DocAve. Step © 2001-2008 AvePoint, Inc. All rights reserved. Page 370 Action 1 Go to ―Start Menu‖ -> ―Run‖ and enter the command ―gpedit.msc‖ in the popup. 2 In the ―Group Policy‖ popup, use the tree view on the left hand side to navigate to ―Computer Configuration‖ -> ―Administrative Templates‖ -> ―Windows Components‖ -> ―Internet Explorer‖ -> ―Internet Control Panel‖ 3 Under this directory, locate the setting ―Prevent ignoring certificate errors‖ in the left of the display. Double click on this setting to open the properties. *Note: This field is typically the last one on the list. 4 In the pop-up, select ―Enabled‖ from the ―Settings‖ tab. 5 Verify that the state under the settings list has changed to ―Enabled‖ for this field and restart the computer. The client should now be able to follow the steps to enable https access in Internet Explorer, listed in the installation section at the beginning of this document. *Note: If you plan on accessing the DocAve remote server using the Server Name and not the IP address you must edit the host file manually. Open the following file in notepad, adding a line with the IP address and Server Name: c:\windows \system32\drivers\ETC\hosts © 2001-2008 AvePoint, Inc. All rights reserved. Page 371 8.2 Compatibility with 3rd-Party SQL Tools DocAve‘s SQL backup solutions (Platform level backup and High Availability) can coexist with other SQL 3rd Party backup tools. 8.2.1 Background Database backup types for SQL can be separated into three types: ―Full,‖ ―Differential,‖ and ―Log (Incremental).‖ Most SharePoint databases automatically run full backups by default. In order to perform on these three levels of backup, differential will need a full backup, and a log backup will require both the previous full/differential backup and a complete sequence of logs. 8.2.1.1 Possible Conflicts There are several possible conflicts that may occur. The SQL server only allows one backup chain (Full -> Differential -> Log) per database. Having multiple tools backing up the same server may conflict with the SQL Server: If multiple tools attempt to backup with logs, neither will have a complete chain to use for restore. If multiple tools attempt to perform a full backup, followed by a differential, only the last tool to have run a full backup will have the correct differential information available. SQL servers also allow only one mirroring session to another database. This will only require one full backup. However, log shipping will require full and log backups. Therefore, having multiple tools mirroring the same database may result in the following conflicts: Log shipping will require a full set of logs, but since other tools will also be performing log backups, this complete set will not be available. Mirroring also cannot work with other tools that require multiple full backups. 8.2.1.2 HA Standby Environments High Availability will only replicate the most important data to the standby site. This usually includes the databases (content databases, SSO, SSP). High Availability will work on a standby environment using the following setup: SharePoint software must be installed on the standby front end server. The same customizations must be installed on the standby front end server. An empty standby farm should be created to serve as the container of the replicated data. © 2001-2008 AvePoint, Inc. All rights reserved. Page 372 8.2.2 Coexistence Considerations There are two programs to consider coexistence conflicts with: Platform Level Backup and Restore, and High Availability. 8.2.2.1 Platform Level Backup Platform Level Backup (formerly Platform Level Backup) can conflict with third party tools: Backing up SQL on the platform level using full, differential, and logs means that other tools cannot be used for backing up the SharePoint database. Backing up SQL on the platform level using full and differential only could possibly coexist with other products, but ever full backup from a 3rd party tool must be followed by a platform level full backup. If other SQL tools are using full, differential, or log backups, platform level backup can use a ―Copy Only‖ mode, where only full backups are used. Platform Level Backup can coexist with High Availability using these implementations: Platform level backup and High Availability cannot simultaneously perform backup using log shipping for the reasons previously listed. However, High Availability can use the logs created during a Platform Level backup. HA will only use backup data generated by platform level backup. Platform level backup can coexist with High Availability if it is in mirroring mode. However, platform level backup must perform a full backup after mirroring has been set up. 8.2.2.2 High Availability High availability can conflict with other third party tools: If the database is already being mirrored, High Availability‘s mirroring method cannot be used. If other tools have been implemented after HA‘s mirroring has been set up, a full backup for that tool will be required. If other tools have been implemented on the full, differential, and log level, HA cannot use log shipping. However, a work around for this conflict would be: Run a platform level backup of the SQL database, and use the ―log shipping from Platform Level Backup‖ option. Sacrifice recovering flexibility of those tools by restricting them to full and differential only. However, the full backups must be performed after log shipping, the backup sizes may be large due to the lack of incremental backups, and that all logs not covered by HA will continue to fill up the disk. (The last problem can be remedied by manually running a log backup of the items that are not covered by HA). © 2001-2008 AvePoint, Inc. All rights reserved. Page 373 8.3 Farm Level Backup & Restore DocAve‘s Platform Level Backup and Restore solution in the Data Protection module allows people to backup their entire SharePoint farm, including all of the contents listed below (with corresponding limitations on ―out-of-place restore‖) : Function Configuration Database SharePoint Web Service Central Admin Web Application Admin Content Database Web Applications Content Databases Shared Services Provider (SSP) SSP Osearch Index SSP Project Server Application Global Search Settings SharePoint Help Search In-Place Out-of-Place Yes Yes Windows SharePoint Service Web Application and WSS Administration Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes InfoPath Form Services Single Sign On (SSO) Yes FBA Databases SharePoint Learning Kit (SLK) Notes Yes © 2001-2008 AvePoint, Inc. All rights reserved. Page 374 SSP Properties and Shared Service Database This can only be backed-up and restored together with the SSP PWA Site is backed-up and restored with the web application to which it belongs Farm-level search settings and Crawler impact rules InfoPath Forms Services Settings and InfoPath Forms Services From templates SSO database and some configurations in Manage Settings for Single Sign On The FBA database and some configurations in the Web. Configurations under Web Application IIS Setting (i.e., Connection Strings, MemberShipProvider, RoleManagerProvider) SLK Database Windows SharePoint Solutions Yes Yes Yes Yes Front End Web Yes Item level Restore (after Platform Level backup) The uploaded Solution and its configuration in the Solution Management ①IIS Settings, which can be set individually in the FEW server and not saved in SharePoint such as Form Authentication, SSL certification and so on. ②SharePoint Template directory, it is the most important directory to record the IIS extension. Most useful files just like feature files and site definition files in the FEW all can be saved in this directory. ③In addition, SPDR-PR also help backup and restore the file system in the front-end server. This feature has been implemented in 4.5.2 or above. If you want to do item level restore, you should generate index when you backup it. However, it will affect the backup performance. It is optional. *Note: Platform Level Backup cannot support other SharePoint applications which have not been included in the chart above. For example, custom web parts and MOSS applications based on ADFS are not supported. Platform Level Backup is not intended to be used to create ―Hot-Standby‖ environments in the event of a fail-over situation. For more information on creating fail-over environments using SQL mirroring, please see the section on DocAve‘s High Availability solution listed above. 8.3.1 Full Farm Backup & Restore In order to use Platform Level Backup and Restore to backup data, the following items should be noted: A full farm restore should include at least the SharePoint Configuration database and the Central Administration database. The full farm backup data should be saved to a location outside of the current farm. You will still have access should your environment go down. For SSO, navigate to ―DocAve‖ -> ―Control Panel‖ -> ―Control Services‖ -> ―Agent Monitor‖ © 2001-2008 AvePoint, Inc. All rights reserved. Page 375 and specify a user account to the SSO Service Log-on User. Backup and restore the ―Front-End Web‖ (listed below) if the following issues apply to you: o IIS Settings : An IIS tool was used to update the IIS settings after either using SharePoint to create a basic site or editing the file information under the IIS path. (i.e.: After using web.config to configure Form Authentication). Some solutions and features will change the file information under the IIS Path and therefore the IIS settings in the FEW will need to be backed up as well. o SharePoint Template : Templates will need to be backed up in the event that custom features and site definitions change files in the path ―c:\program files\common files\microsoft shared\web server\extensions\12\template‖. o Features and Site Definitions : If custom operations were created for features and site definitions, these two nodes should be backed up. o File System : If necessary, any files can be backed up in the FEW file system. 8.3.1.1 Full Farm Backup In order to perform a full farm backup, Platform Level Data Protection must be enabled. Please reference the corresponding section (4.2) of the User Guide for any details regarding this product. Be sure to check the box next to the farm‘s name from the data tree when creating a plan. 8.3.1.2 Full Farm Restore Before restoring content to a new farm, please make sure the server name and topology are identical to the ones used before, and all of the pre-requisites listed below are met: Windows Server 2003 with Service Packs 1 and 2 IIS with ASP.net enabled SQL 2000 or 2005 (the server disk layouts should be identical to original farm) .NET Framework 3.0 MOSS 2007 installed (no configurations should be present; the version number and patch level should be identical to the original farm) DocAve 4.5 Agent Installed The domain account used should be the same as the original farm *Note: If the ―DB Only‖ option is selected, you will only be able to restore the Configuration database and the Administration Content database. Other content like web applications will not be selected. Step © 2001-2008 AvePoint, Inc. All rights reserved. Page 376 Action Since this restore using the Platform Level Restore Controller must be performed as an ―in place‖ restore (same farm), evaluate the status of the farm below: 1 If… Then… Previously Deployed Farm If the farm being restored is either currently or recently deployed (including re-installed environments), disconnect all front-end servers using the SharePoint Products and Technologies Configuration Wizard. See your SharePoint user guide for more details. Fresh Installation Proceed to the next step. 2 Using the Platform Level Restore Controller (described in the user guide above), load the backup plan and data for this farm. Using the tree, choose the ―Configuration DB‖ and ―Admin Content DB‖. 3 Next to the restore options, select ―Advanced‖ and choose the ―Restore Databases Only‖ option. Make sure that ―In Place‖ restore is checked. 4 Press ―Go‖ to start the restore process. Connect all SharePoint front-end servers to the Config DB restored in the previous step. You can use the SharePoint Products and Technologies Configuration Wizard mentioned above to perform this action. 5 6 7 *Note: At least one front-end server should be used to host the Central Admin Web Application. When using the wizard above, select the ―Use this machine to host the web site‖ option under Advanced Settings: Host Central Administration Web Application. After connecting all front-end servers to the Config Database using the steps above, complete all additional steps below to finish the restore. If any IIS settings have changed before performing this in place restore, they must be restored to their original values. Please confirm this before continuing. *Note: You can perform the restore using Platform Level Restore Controller, under the Front End Web. The section below describes this © 2001-2008 AvePoint, Inc. All rights reserved. Page 377 process in greater detail. 8 In order to ensure that all solutions have been properly deployed, select the ―Windows SharePoint Solutions‖ node in the restore tree and run a restore. *Note: The Database Only option should not be used in this case. For the features that apply to your environment, check that the following services are running in ―Start‖ -> ―Administration Tools‖ -> ―Services‖. 9 Single Sign-On (SSO) Restart the ―Microsoft Single Sign-on Service‖ under the ―Services‖ popup. SPHelpSearch Restart the ―Windows SharePoint Services Search‖ in the ―Services‖ popup. Shared Services Provider (SSP) All features except the search index are already available. In order to restore this, make sure the ―Office SharePoint Server Search‖ (OSearch) has been restarted in the ―Services‖ popup. You will also need to restart this service in the SharePoint ―Central Administration‖ -> ―Operations‖ -> ―Services on Server‖ list. To complete the restore of the index data for the SSP, select the corresponding nodes and children in the tree of the Platform Level Restore Controller tree and perform an in-place restore. Make sure you are not using the ―Database Only‖ restore option. 10 If this SSP is the parent of an inter-farm deployment, all children will take 5-10 minutes to establish a connection after the restore is complete. This will happen automatically. *Note: You can also manually re-crawl the SharePoint index. From Central Administration, choose to edit the properties and specify an index server for the SSP. Navigate to SSP admin site and choose ―Search Setting‖ -> ―Restart Crawl Index Files. © 2001-2008 AvePoint, Inc. All rights reserved. Page 378 11 If any customizations have been installed using a 3rd party install wizard, re-run those installations to complete this. 8.3.1.3 FEW Restore Settings Restoring customizations to your front-end web server for your farm can be performed using the Platform Level Recovery Controller as well. This can be used to restore: IIS Settings SharePoint Templates Custom Features SharePoint Site Definitions File system folders Miscellaneous other features Step Action 1 Perform a backup of these settings using Platform Level Backup, including any of the nodes found under the ―Front End Web Servers‖ level of the tree. 2 Using the restore controller, perform an in-place restore of any of the nodes listed under this level. For instance, if you only wish to restore IIS settings for a single web app (the only one with customizations), you could restore a single item from this tree. You could also take all customizations and return this all to the original settings. 8.3.2 Troubleshooting Tips A few of the most common problems found when performing a full farm backup and restore are detailed in the sections as follows. For more detailed help, please contact our tech support line. 8.3.2.1 SharePoint Central Admin cannot be accessed after restore You can recover the Central Admin by using one of the steps below: Make sure that the front-end servers were used to host the Admin web (described above). If © 2001-2008 AvePoint, Inc. All rights reserved. Page 379 not, disconnect a front end server, and reconnect it using the ―Use to host Admin Web‖ option. Reset the application pool for the central admin. 8.3.2.2 If Index data is not accurate or corrupted You can use one of the following methods to restore the index data: Use the Platform Level Restore Controller (without using the ―Database Only‖ option) to restore the index records from the last available backup. Restart the Office SharePoint Server Search Services, set the Index server for the SSP, and Re-crawl the environment. 8.3.2.3 If a Web Application cannot be accessed after restore If you wish to fix this issue, make sure the following is done first: If you customized features or Site-Definitions were used, please verify that all prerequisite steps for the front end web server were taken before performing the restore. Make sure that Web Site Status is started in the IIS Manager with the proper settings. Reset the password for the application pool and perform an IIS reset. 8.3.2.4 If there are problems with user profiles and properties or search settings in SSP Perform the following steps if you are having trouble with the SSP: Restore the SSP using Platform Level Recovery Controller. Restart the Office SharePoint Server Search Services, set the Index server for the SSP, and Re-crawl the environment. © 2001-2008 AvePoint, Inc. All rights reserved. Page 380 8.4 DocAve 4.5 Solution for Microsoft Office Project Server 2007 8.4.1 About Project Server 2007 Microsoft Office Project Server 2007 was designed by Microsoft to integrate easily to SharePoint. Databases The following four Project Server databases are included in their design: Draft The ―Draft‖ database contains tables for saving unpublished projects from Office Project Professional 2007. Project data in the ―Draft‖ database is not accessible from the Office Project Web Access. All unpublished projects are stored in the ―Draft‖ database and backed up to the ―Archive‖ database. Published The ―Published‖ database contains all of the published projects. Published projects are viewable in Office Project Web Access. The ―Published‖ database also contains tables that are specific to Office Project Web Access (i.e. timesheets, views, etc.) and global data tables (i.e. outline codes, security, and metadata). Settings corresponding to views, custom fields and lookup tables, calendars, groups and categories, and system settings are stored in the ―Published‖ database. These settings are also backed up to the ―Archive‖ database. Archive The ―Archive‖ database saves backup data and older versions of projects. Reporting The ―Reporting‖ database is the staging area for generating reports and OLAP cubes. Data in the ―Reporting‖ database is comprehensive, optimized for read-only report generation, and is updated in near real-time. Items in Project Server and Project Web Access There are many items that pertain to the Project Server and Project Web Access (PWA): View In PWA, view has many types, such as: project center, project, resource center, etc. Each view can be shared by different tables, fields and security categories. These views are stored in the ―Published‖ database and backup to ―Archive‖ database. © 2001-2008 AvePoint, Inc. All rights reserved. Page 381 In Project Server 2007, views use several different display formats. It is different from the views in PWA. These views are stored in the ―Draft‖ database and are backed up to the ―Archive‖ db. Category Categories define common sets of data access needs and are shared by user and group. When creating a category, the permissions need to be set in order to manage the users‘ access to projects (activity, proposal and project). Resource You can create the Enterprise Resource Pool that project managers will use when assigning resources to tasks in projects. When resources are created, the group, category and custom fields must also be set. The resource can be used in Project Server. Calendar Calendars are shared between PWA and the Project Server. Custom Field When a Custom Field is created, an entity (project, resource, or task) and lookup table must be created. In the Project Server, custom fields can be chosen based on the entity user. They are shared between PWA and the Project Server. Description of Item Level Objects Below are the various items included in the Project Server 2007 which can be backed up on the Item Level: Projects Includes Project Resources, Assignments, Tasks, Custom field values, and Baseline data Enterprise Resource Pool / Calendars Includes Enterprise Resources and Enterprise Calendars Enterprise Custom Fields Includes Enterprise Custom Field metadata, Enterprise Lookup Table Metadata, and Enterprise Lookup Table values Enterprise Global Template Includes all Project Professional table, macro, and view definitions View Definitions Includes Statusing, Project Center, Portfolio Analyzer, and Resource Center view definitions © 2001-2008 AvePoint, Inc. All rights reserved. Page 382 System Settings Includes the Web settings table. These are all of your system settings choices but do not include OLAP cube options. Category and Group Settings Includes settings for all Project Server categories and groups. 8.4.2 Backup and Restore for Project Server 2007 In DocAve, there are three ways to backup and restore the Project Server and Project Web Access: Data Protection: Platform Level Backup and Recovery DocAve‘s Platform Level Backup module can be implemented to perform the backup and restore of the four project server databases listed above (Draft, Published, Archive, Reporting). Platform Recovery can perform a full-fidelity, complete backup of an entire project server database, or of the four content databases individually. Also, if you are running DocAve version 4.5.2.0 or above, you also have access to item level restore abilities. Data Protection: Item Level Backup Using DocAve‘s Item Level Backup solution, a backup and restore of Project Web Access (PWA) instances can be performed. DocAve‘s current Project Server item level backup is confined to the item related to the SharePoint PWA sites (i.e. the site contents created in PWA for the single project, such as announcements, calendars, etc). Administrator: STSADM GUI Interface Using ―stsadm.exe‖ (implemented as a graphical interface within DocAve), the backup and restore of Project Server databases and Project Web Access sites can be performed. However, this cannot change the path of the backup and restore, and we can only backup or restore all items at once. *Note: This method of backup/restore data does not require SQL Server 2000 or 2005 tools. The backup and restore functionality is summarized in the table below: Project Server Database Project Web Access sites DocAve Platform-Level Yes Yes DocAve Item-Level No Yes STSADM.exe Yes Yes © 2001-2008 AvePoint, Inc. All rights reserved. Page 383