symantec enterprise vault - veritas to a lotus notes database. ... to run a command-line utility...

208
Symantec Enterprise VaultUtilities 8.0 Symantec Information Foundation

Upload: hanhan

Post on 18-May-2018

258 views

Category:

Documents


3 download

TRANSCRIPT

Symantec Enterprise Vault™

Utilities

8.0

Symantec Information Foundation™

Symantec Enterprise Vault: UtilitiesThe software described in this book is furnished under a license agreement andmay be usedonly in accordance with the terms of the agreement.

Last updated: August 30, 2010.

Legal NoticeCopyright © 2010 Symantec Corporation. All rights reserved.

Symantec, the Symantec Logo, Veritas, Enterprise Vault, Compliance Accelerator, andDiscovery Accelerator are trademarks or registered trademarks of Symantec Corporationor its affiliates in the U.S. and other countries. Other names may be trademarks of theirrespective owners.

This Symantec product may contain third party software for which Symantec is requiredto provide attribution to the third party (“Third Party Programs”). Some of the Third PartyPrograms are available under open source or free software licenses. The LicenseAgreementaccompanying the Software does not alter any rights or obligations you may have underthose open source or free software licenses. Please see the Third Party Software fileaccompanying this Symantec product for more information on the Third Party Programs.

The product described in this document is distributed under licenses restricting its use,copying, distribution, and decompilation/reverse engineering. No part of this documentmay be reproduced in any form by any means without prior written authorization ofSymantec Corporation and its licensors, if any.

THEDOCUMENTATIONISPROVIDED"ASIS"ANDALLEXPRESSORIMPLIEDCONDITIONS,REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT,ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TOBELEGALLYINVALID.SYMANTECCORPORATIONSHALLNOTBELIABLEFORINCIDENTALOR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE FURNISHING,PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE INFORMATION CONTAINEDIN THIS DOCUMENTATION IS SUBJECT TO CHANGE WITHOUT NOTICE.

The Licensed Software andDocumentation are deemed to be commercial computer softwareas defined in FAR12.212 and subject to restricted rights as defined in FARSection 52.227-19"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, "Rights inCommercial Computer Software or Commercial Computer Software Documentation", asapplicable, and any successor regulations. Any use, modification, reproduction release,performance, display or disclosure of the Licensed Software andDocumentation by theU.S.Government shall be solely in accordance with the terms of this Agreement.

Symantec Corporation350 Ellis Street, Mountain View, CA 94043

http://www.symantec.com

Technical SupportSymantec Technical Support maintains support centers globally. TechnicalSupport’s primary role is to respond to specific queries about product featuresand functionality. TheTechnical Support group also creates content for our onlineKnowledge Base. The Technical Support group works collaboratively with theother functional areas within Symantec to answer your questions in a timelyfashion. For example, theTechnical Support groupworkswithProductEngineeringand Symantec Security Response to provide alerting services and virus definitionupdates.

Symantec’s support offerings include the following:

■ A range of support options that give you the flexibility to select the rightamount of service for any size organization

■ Telephone and/or Web-based support that provides rapid response andup-to-the-minute information

■ Upgrade assurance that delivers software upgrades

■ Global support purchased on a regional business hours or 24 hours a day, 7days a week basis

■ Premium service offerings that include Account Management Services

For information about Symantec’s support offerings, you can visit our Web siteat the following URL:

www.symantec.com/business/support/

All support services will be delivered in accordance with your support agreementand the then-current enterprise technical support policy.

Contacting Technical SupportCustomers with a current support agreement may access Technical Supportinformation at the following URL:

www.symantec.com/business/support/

Before contacting Technical Support, make sure you have satisfied the systemrequirements that are listed in your product documentation. Also, you should beat the computer onwhich theproblemoccurred, in case it is necessary to replicatethe problem.

When you contact Technical Support, please have the following informationavailable:

■ Product release level

■ Hardware information

■ Available memory, disk space, and NIC information

■ Operating system

■ Version and patch level

■ Network topology

■ Router, gateway, and IP address information

■ Problem description:

■ Error messages and log files

■ Troubleshooting that was performed before contacting Symantec

■ Recent software configuration changes and network changes

Licensing and registrationIf yourSymantecproduct requires registrationor a licensekey, access our technicalsupport Web page at the following URL:

www.symantec.com/business/support/

Customer serviceCustomer service information is available at the following URL:

www.symantec.com/business/support/

Customer Service is available to assist with non-technical questions, such as thefollowing types of issues:

■ Questions regarding product licensing or serialization

■ Product registration updates, such as address or name changes

■ General product information (features, language availability, local dealers)

■ Latest information about product updates and upgrades

■ Information about upgrade assurance and support contracts

■ Information about the Symantec Buying Programs

■ Advice about Symantec's technical support options

■ Nontechnical presales questions

■ Issues that are related to CD-ROMs or manuals

Support agreement resourcesIf youwant to contact Symantec regarding an existing support agreement, pleasecontact the support agreement administration team for your region as follows:

[email protected] and Japan

[email protected], Middle-East, and Africa

[email protected] America and Latin America

Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 1 About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Introducing this guide .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Running the command-line utilities with Administrator

privileges ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Where to get more information about Enterprise Vault ... . . . . . . . . . . . . . . . . . . . . 15Comment on the documentation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 2 ArchivePoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

About ArchivePoints ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19ArchivePoints syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19ArchivePoints examples ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Creating archive points manually ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Chapter 3 Audit Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

About Audit Viewer .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Running a report on audit data ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Copying the search results ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Changing Audit Viewer settings ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Chapter 4 CenteraPing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

About CenteraPing .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29CenteraPing syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Chapter 5 Domino Archive Exporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

About Domino Archive Exporter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Domino Archive Exporter syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Domino Archive Exporter example ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Chapter 6 Domino Profile Document Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

About Domino Profile Document Tool ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Domino Profile Document Tool syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Contents

Examples ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Chapter 7 Domino Retention Plan Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

About Domino retention plans .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Permissions required .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Defining a retention plan .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38EVDominoRetentionPlans.exe syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Chapter 8 DTrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

About DTrace .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Starting and stopping DTrace .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43DTrace commands .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44How to read a DTrace log .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46How to troubleshoot DTrace .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Chapter 9 EVDominoExchangeMigration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

About the EVDominoExchangeMigration tool ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Client requirements ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Windows Server 2008 firewall requirements ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Using Binary Tree .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Using Quest Notes Migrator for Exchange .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Requirements for other migration software .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Running EVDominoExchangeMigration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Usage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Log files ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Limitations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Chapter 10 EVrights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

About EVrights ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57EVrights syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Chapter 11 EVservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

About EVService ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61EVservice prerequisites ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62How to install EVservice ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62EVservice syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Format of the list file ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Contents8

Chapter 12 EVSVR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

About EVSVR .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Note on performing EVSVR operations on CIFS and NTFS

partitions ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Starting EVSVR .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67EVSVR commands .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68EVSVR application states ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Creating an EVSVR operation file ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Running an EVSVR operation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74About the EVSVR operation settings ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Report operations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Verify operations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Repair operations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Viewing the EVSVR output log file ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Additional log file information when you run certain Repair

operations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Running EVSVR in interactive mode .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

DumpSaveset command .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95DumpSISPart command .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99ExtractSavesets command .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102ListSavesetLocations command .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104About reviewing the messages in the log files ... . . . . . . . . . . . . . . . . . . . . . . . . . 105

Chapter 13 FSARunNow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

About FSARunNow .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Running FSARunNow .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107FSARunNow syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Examples ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Chapter 14 FSAUtility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

About FSAUtility ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111FSAUtility requirements and recommendations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . 112FSAUtility options .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Recreate archive points ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Recreate placeholders ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Move placeholders and corresponding files ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Delete orphaned placeholders ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Restore archived files ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

9Contents

Chapter 15 IndexCheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

About IndexCheck .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121IndexCheck syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Chapter 16 NTFS to Centera Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

About NTFS to Centera Migration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Managing migrator jobs ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Creating migrator jobs ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Deleting active jobs ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Deleting source files after migration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Log files ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Chapter 17 OWA 2003 Control Files Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

About OWA 2003 Control Files Tool ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Running OWA Control Files Tool ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Examples ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Chapter 18 Permission Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

About Permission Browser ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Running Permission Browser ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Chapter 19 Policy Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

About Policy Manager ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Policy Manager syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Initialization file format ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Initialization file syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Initialization file sections and keynames .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

[Directory] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142[Archive] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143[ArchivePermissions] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144[Filter] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146[Mailbox] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152[Folder] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154[PublicFolder] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160[PSTdefaults] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162[PST] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167[PSTcheckpoint] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173[NSFDefaults] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175[NSF] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Contents10

[NSFCheckPoint] section .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Initialization file examples ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Example 1 .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187Example 2 .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Example 3 .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Example 4: PST migration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190Example 5: NSF migration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Example 6: folder permissions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Using the Provisioning API to run Policy Manager scripts ... . . . . . . . . . . . . . . . 193Scripting properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Advanced settings ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Interface methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Error handling .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Chapter 20 ResetEVClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

About ResetEVClient ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203ResetEVClient syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

Chapter 21 Vault Store Usage Reporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

About Vault Store Usage Reporter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Starting Vault Store Usage Reporter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Setting up a shortcut link to Vault Store Usage Reporter ... . . . . . . . . . . . . . . . . 206Understanding the usage summary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Troubleshooting .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

11Contents

Contents12

About this guide

This chapter includes the following topics:

■ Introducing this guide

■ Running the command-line utilities with Administrator privileges

■ Where to get more information about Enterprise Vault

■ Comment on the documentation

Introducing this guideThis guide describes a number of utilities with which you can test and log theperformance of EnterpriseVault, run scripts to performcommon tasks, andmore.

Table 1-1 lists the utilities that are available when you install Enterprise Vault.

Table 1-1 Available Enterprise Vault utilities

To do thisUse this utility

Create and manage "archive points"—the pointsmarking the top of each folder structure that FileSystem Archiving is to store in a single archive.

ArchivePoints

View and filter the data that is logged in anEnterprise Vault auditing database.

Audit Viewer

Test the connection to an EMC Centera cluster.CenteraPing

Export items from an Enterprise Vault Dominoarchive to a Lotus Notes database.

Domino Archive Exporter

View the contents of the profile document thatEnterpriseVault adds to a LotusDominomailbox.

Domino Profile Document Tool

1Chapter

Table 1-1 Available Enterprise Vault utilities (continued)

To do thisUse this utility

Upload to Enterprise Vault any new retentionplans that you create.

Domino Retention Plan Tool

Run Enterprise Vault in debug mode by loggingwhat processes are doing at the code level.

DTrace

Modify shortcuts in Exchange Server mailboxesthat have been migrated from Domino toExchange Server.

EVDominoExchangeMigration

Grant user rights to users and groups from acommand line or batch file.

EVrights

Start and stop Windows services and EnterpriseVault tasks on local or remote computers.

EVservice

Report on, verify, and repair Enterprise Vaultstorage. You can also perform a number ofspecialized activities such as retrieving thesavesets of an archived item and extractingsavesets from an EMC Centera data blob.

EVSVR

Start archiving from a specified file server,synchronize permissions, and prune earlierversions of archived files.

FSARunNow

Recreate archive points and placeholders, moveand delete placeholders, and restore archivedfiles.

FSAUtility

Verify the integrity of the AltaVista indexes thatEnterprise Vault uses.

IndexCheck

Copy Enterprise Vault savesets from an NTFSsource partition to an EMC Centera destinationpartition.

NTFS to Centera Migration

Apply Enterprise Vault changes to supportedMicrosoft hotfixes for Exchange Server 2003.

OWA 2003 Control Files Tool

View the security identifiers (SIDs) and accesspermissions for the archives and archive foldersin an Enterprise Vault directory database.

Permission Browser

About this guideIntroducing this guide

14

Table 1-1 Available Enterprise Vault utilities (continued)

To do thisUse this utility

Use scripts to modify and control mailboxes andarchives so that they conform to your EnterpriseVault archiving policies. Additionally, you canuse Policy Manager to migrate the contents ofPST files to Enterprise Vault.

Policy Manager

Fix a number of problems with the EnterpriseVault add-in to Microsoft Outlook.

ResetEVClient

Obtain reports on current vault store usage.Vault Store Usage Reporter

Running the command-line utilities withAdministrator privileges

Many of the utilities that this guide describes are command-line utilities. Oncomputers where User Account Control (UAC) is enabled, you must always runthese utilities with Administrator privileges. The Enterprise Vault utilities maynot run properly without these elevated privileges.

To run a command-line utility with Administrator privileges

1 Right-click theCommandPrompt shortcut on theWindows Startmenu, andthen click Run as Administrator.

2 Change to the folder that contains the utility that you want to run (typically,c:\Program Files (x86)\Enterprise Vault).

3 Type the command to start the utility.

Where to getmore information about EnterpriseVaultTable 1-2 lists the documentation that accompanies Enterprise Vault.

15About this guideRunning the command-line utilities with Administrator privileges

Table 1-2 Enterprise Vault documentation set

CommentsDocument

Includes all the following documentation so thatyou can search across all files. You can access thisfile by doing either of the following:

■ On the Windows Start menu, click Start >Programs > Enterprise Vault >Documentation.

■ In the Administration Console, click Help >Help on Enterprise Vault.

Symantec Enterprise Vault Help

Provides an overview of Enterprise Vaultfunctionality.

Introduction and Planning

Describes how to check the prerequisite softwareand settings before you install Enterprise Vault.

Deployment Scanner

Provides detailed information on setting upEnterprise Vault.

Installing and Configuring

Describes how to upgrade an existing EnterpriseVault installation to the latest version.

Upgrade Instructions

Describes how to archive items from MicrosoftExchangeusermailboxes, journalmailboxes, andpublic folders.

Setting up Exchange Server Archiving

Describes how to archive items fromDominomailfiles and journal databases.

Setting up Domino Server Archiving

Describes how to archive the files that are heldon network file servers.

Setting up File System Archiving

Describes how to archive the documents that areheld on Microsoft SharePoint servers.

Setting up SharePoint Server Archiving

Describes how to archive SMTP messages fromother messaging servers.

Setting up SMTP Archiving

Describes how to perform day-to-dayadministration, backup, and recoveryprocedures.

Administrator’s Guide

About this guideWhere to get more information about Enterprise Vault

16

Table 1-2 Enterprise Vault documentation set (continued)

CommentsDocument

Describes how to implement Enterprise VaultReporting, which provides reports on the statusofEnterpriseVault servers, archives, andarchiveditems. If you configure FSAReporting, additionalreports are available for file servers and theirvolumes.

Reporting

Describes the Enterprise Vault tools and utilities.Utilities

A reference document that lists the registryvalues with which you can modify many aspectsof Enterprise Vault behavior.

Registry Values

The online Help for the Enterprise VaultAdministration Console.

Help for Administration Console

The online Help for Enterprise Vault OperationsManager.

Help for Enterprise Vault OperationsManager

For the latest information on supported devices and versions of software, see theEnterprise Vault Compatibility Charts book, which is available from this address:

http://entsupport.symantec.com/docs/276547

Comment on the documentationLet us know what you like and dislike about the documentation. Were you able tofind the information youneededquickly?Was the information clearly presented?Report errors and omissions, or tell us what you would find useful in futureversions of our guides and online help.

Please include the following information with your comment:

■ The title and product version of the guide on which you want to comment.

■ The topic (if relevant) on which you want to comment.

■ Your name.

Email your comment to [email protected]. Please only use this address tocomment on product documentation.

We appreciate your feedback.

17About this guideComment on the documentation

About this guideComment on the documentation

18

ArchivePoints

This chapter includes the following topics:

■ About ArchivePoints

■ ArchivePoints syntax

■ ArchivePoints examples

■ Creating archive points manually

About ArchivePointsThe ArchivePoints utility provides a convenient means to create and manage"archive points". These points mark the top of each folder structure that FileSystem Archiving is to store in a single archive.

If you do notwant to runArchivePoints for any reason, you can create the archivepoints manually.

ArchivePoints syntaxArchivePoints action archive_point_path_share_name

[subfolders|nosubfolders] [template_XML_file_path_name]

[folder_to_autoenable <on|off [subfolderdelete]>]

where:

2Chapter

Specifies the action to perform.This action canbe one of the following:

■ autoenable. Makes the archiving task create an archive pointfor each new, immediate subfolder of the nominated folder.Whennew subfolders are added, the archiving task automatically createsa new archive point for each subfolder.

This can be useful when you have a folder that contains onesubfolder for each of a number of users. When you select thisoption, anewarchive is created automatically for eachuser's folder.

■ create. Creates the archive points.

■ delete. Deletes the archive points.

■ find. Lists all the archive points beneath the specified networkshare.

■ read. Displays the contents of the archive points.

■ update. Updates the archive points on the specified folders withthe contents of template_XML_file. template_XML_file is amandatory parameter when you use Update.

action

Specifies the UNC path to the network share to which the commandapplies.

archive_point_

path_share_name

For create actions only, specifies whether the action applies to eachsubfolder in the specified network share. The default isnosubfolders.

subfolders|

nosubfolders

ArchivePointsArchivePoints syntax

20

Specifies the full path to an XML template file with which you canoverride the following attributes when you create an archive point:

■ name. Specifies the archive name.

■ description. Specifies the archive description.

■ owner. Specifies the account to use when billing archive usage.

■ indexDisabled. Specifies whether to disable (True) or enable(False) indexing for the files in the network share. By default,indexing is enabled.

■ indexingLevel. Specifies the indexing level.

■ deleteExpiredItems. Specifieswhether automatically to deleteexpired items from the archive.

■ prefix. Specifies a prefix to add to the start of the archive name.The remainder of the archive name is taken either from the Nameattribute, if present, or the folder name.

For example, the following file overrides all the default attributeswhen you create an archive point:

<archivePointxmlns="urn:kvsplc-com:FileSystemFolderArchivePoint">

<name>Newton archive</name><description>Isaac Newton's User Archive</description><owner>astronomy\newtoni</owner><indexDisabled>False</indexDisabled><indexingLevel>brief</indexingLevel><deleteExpiredItems>false</deleteExpiredItems><prefix>User

</prefix></archivePoint>

template_XML_file

_path_name

Specifies the full path to the folder for whose immediate subfoldersyou want to auto-enable archive points.

folder_to_

autoenable

Specifies whether to switch the auto-enable property of a folder onor off . If you choose to switch off this property then, with thesubfolderdelete option, you can also choose to delete the archivepoints from all the immediate subfolders.

<on|off

[subfolderdelete]>

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

21ArchivePointsArchivePoints syntax

ArchivePoints examplesThe following are examples of how to run ArchivePoints.

■ To create an archive point on folder \\myserver\users\jones, type thefollowing:

ArchivePoints create \\myserver\users\jones

■ To list all archive points on share \\myserver\users, type the following:

ArchivePoints find \\myserver\users

■ To specify an XML template file with which you can override the attributeswhen you create archive points, type the following:

archivepoints create \\myserver\users subfolders

"c:\Program Files\Enterprise

Vault\EvArchivePoint.xml"

■ To auto-enable archive points for all new, immediate subfolders of the folder\\myserver\development, type the following:

ArchivePoints autoenable \\myserver\development on

■ To switch off the auto-enable property for the folder \\myserver\developmentand delete the archive points from all its immediate subfolders, type thefollowing:

ArchivePoints autoenable \\myserver\development off

subfolderdelete

Creating archive points manuallyIf youdonotwant to create archive points using either theAdministrationConsoleor the ArchivePoints command-line utility, you can follow the instructions belowto create them manually.

ArchivePointsArchivePoints examples

22

To create a stream archive point manually

1 Create a template file that contains the following:

<archivePoint> </archivePoint>

2 In a Command Prompt window, type the following command to add thecontents of the template file as a named stream to the folder that you areturning into an archive point:

type TemplateName > TargetFolder:EVArchivePoint.xml

where:

■ TemplateName is the name of the file that contains the archive pointinformation.

■ TargetFolder is the full path of the folder to which you are adding anarchive point.

■ EVArchivePoint.xml is the nameyoumust use for the hidden file stream.

For example, if you have a template called archivepoint.xml and a user'sshare called i:\users\Isaac Newton, the command would be as follows:

type archivepoint.xml > "i:\users\Isaac Newton:EVArchivePoint.xml"

This adds the contents of archivepoint.xml as a data stream attribute ofthe folder.

You can override the default attributes if required.

To create a file archive point manually

1 Create a template file called EVArchivePoint.xml that contains the followingtext:

<archivePoint> </archivePoint>

2 Copy EVArchivePoint.xml to each folder that youwant to be an archive point.

23ArchivePointsCreating archive points manually

ArchivePointsCreating archive points manually

24

Audit Viewer

This chapter includes the following topics:

■ About Audit Viewer

■ Running a report on audit data

■ Copying the search results

■ Changing Audit Viewer settings

About Audit ViewerAudit Viewer lets you view and filter the data that is logged in an Enterprise Vaultauditing database. The function of this database is to keep a record of EnterpriseVault activities such as archiving items and viewing and restoring archived items.You can specify the data that you want to view, sort the data, and copy it to theWindows Clipboard.

Running a report on audit dataFollow the instructions in this section to openAudit Viewer and generate a reporton the data in the auditing database.

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

3Chapter

To run a report on audit data

1 InWindowsExplorer, browse to theEnterpriseVault programfolder (normallyC:\Program Files\Enterprise Vault).

2 Double-click AuditViewer.exe.

3 In the Audit Viewer window, type or select the search criteria for the recordsthat you want to view.

The following table provides information on each search term.

Specify the required user in the form domain\username.User Name

You can use the Enterprise Vault Administration Console todetermine the ID of the archive. Right-click the required archive,and then click Properties. The Advanced tab in the propertiessheet shows the archive ID.

Archive

Select a category of audit entries to search from the list. AuditViewer lists only those categories that exist in the captured data.

Category

After youhave selected a category, select a subcategory from thelist.

■ Item returns the summary information for a category.

■ If you selectDetailed as a category, the additional informationis held in Information records.

■ All returns both the summary and detailed records forselected categories.

Subcategory

Define a date range and time range to search the audit records.Date (From), Date(To)

Type a keyword for which to search in the audit records.Informationcontains

Select a status from the list for the records that youwant to view.Status

Select the EnterpriseVault server that is the target of this search.Server

Type a range of numbers to indicate the audit records that youwant to view.

Audit ID

Select the attribute by which to order the results and whetheryou want Audit Viewer to list the results in ascending order ordescending order.

Order By

Audit ViewerRunning a report on audit data

26

Select whether to view all the results that the search finds or aportion of those results.

Maximum Results

4 Click Search to generate the report.

Copying the search resultsAudit Viewer displays the records that match your search criteria in the SearchResults window.

Click a columnheading to sort the records according to the entries in that column.

You can copy the contents of this window to another application, such as aspreadsheet application.

To copy the records to another application

1 In the Search Results window, highlight the records that you want to copy.

2 Right-click the records, and then click Copy.

You can also press Ctrl+A and Ctrl+C to copy all the search results to theClipboard.

3 Paste the records into the destination document.

Changing Audit Viewer settingsYou can change the auditing database that you want to search. Audit Viewer alsoprovides the option to hide or show selected fields in the Search Results window.

To change Audit Viewer settings

1 In the main Audit Viewer window, click Settings.

2 In the Settingswindow, change the auditing database that youwant to search.You can also check or uncheck the return fields that you want to show orhide.

27Audit ViewerCopying the search results

Audit ViewerChanging Audit Viewer settings

28

CenteraPing

This chapter includes the following topics:

■ About CenteraPing

■ CenteraPing syntax

About CenteraPingUse CenteraPing to test the connection to an EMC Centera™ cluster.

CenteraPing syntaxCenteraPing -address IP_address [-version|-help]

where IP_address is the address of one of the access nodes in the cluster that youwant to examine.

CenteraPing tries to make a connection to the specified IP address. If thisconnection is successful, CenteraPing returns the following message:

IP_address is accessible

Otherwise, CenteraPing returns the following message:

IP_address Open Error: -10020 No connection with pool

The -help option returns the same information, togetherwith the versionnumberof the utility, and a usage statement. The -version option returns the versionnumber, as well as the usage statement.

4Chapter

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

CenteraPingCenteraPing syntax

30

Domino Archive Exporter

This chapter includes the following topics:

■ About Domino Archive Exporter

■ Domino Archive Exporter syntax

■ Domino Archive Exporter example

About Domino Archive ExporterDomino Archive Exporter is a command-line utility with which you can exportitems from an Enterprise Vault Domino archive to a Lotus Notes database.

You can choose to export items as follows:

■ To a specified local or remote Lotus Notes database

■ With a specified retention category

■ That were archived within a specified date range

You can stop the export process at any time by pressing Ctrl+C.

Domino Archive Exporter syntaxEVDominoExporter.exe /A archive /O destination database/I ID file /P

ID file password [/T database template] [/R retention category] [/SD

start date] [/ED end date]

Table 5-1 lists the available parameters.

5Chapter

Table 5-1 EVDominoExporter.exe parameters

DescriptionParameter

Identifies the Enterprise Vault Domino archive from which to exportitems.

/A

Specifies the end date and time for a range of items to archive, in theformdd /mm /yyyy hh :mm :ss . If you omit the time, the defaulttime that is used is 00:00:00.

/ED

Specifies the full path to a Lotus Notes authentication ID file./I

Specifies the Lotus Notes database to open or create. If you want toopen or create a local database, specify it as in this example:

/O "c:\Program files\Enterprise Vault\dest.nsf"

If you omit the path to the database file, Domino Archive Exporterstores the file in the\Data folder of the LotusNotes client. Theutilitycreates the specified directory if it does not exist.

To open or create a remote database on a Domino server, specify it asin this example:

/O Server1/Sales/ACME!!Restore\dest.nsf

This parameter instructsDominoArchiveExporter to export the itemsto thedatabasedest.nsf in the folder\Data\Restoreon the serverServer1/Sales/ACME.

/O

Specifies the password that is associated with the Lotus Notesauthentication ID file.

/P

Filters the archive contents by retention category./R

Specifies the start date and time for a range of items to archive, in theformdd /mm /yyyy hh :mm :ss . If you omit the time, the defaulttime that is used is 00:00:00.

/SD

Specifies the mail template to use when you create the Lotus Notesdatabase. For example, you can type the following to use a localtemplate file:

/T mailbox.ntf

Touse a template file on aDomino server, specify it as in this example:

/T Server1/Sales/ACME!!mailjrn.ntf

If youomit the/Tparameter,DominoArchiveExporter uses the routermail template (mailbox.ntf).

/T

Domino Archive ExporterDomino Archive Exporter syntax

32

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

Domino Archive Exporter exampleThe following command exports the archive L14 to the database sample.nsf,using the Lotus Notes authentication ID file local_admin.id and the associatedpassword W3lcome. The only items that are exported are those marked with theretention category Business and archived between 10A.M. onDecember 16 2005and 4.56 P.M on December 17 2005.

EVDominoExporter.exe /A L14 /O sample.nsf

/I "d:\local_admin.id" /P W3lcome /R Business

/SD "16/12/2005 10:00:00" /ED "17/12/2005 16:56:00"

33Domino Archive ExporterDomino Archive Exporter example

Domino Archive ExporterDomino Archive Exporter example

34

Domino Profile DocumentTool

This chapter includes the following topics:

■ About Domino Profile Document Tool

■ Domino Profile Document Tool syntax

■ Examples

About Domino Profile Document ToolThis tool lets you view the contents of the profile document that Enterprise Vaultadds to a Lotus Domino mailbox. If you suspect that the profile document iscorrupt, you can also use this tool to delete it.

Domino Profile Document Tool syntaxEvLotusDominoProfileDocTool.exe server database id password

<zap|view|clearlist>

where the parameters are as follows:

Specifies the server on which the appropriate Lotus Notesdatabase resides.

server

Specifies the Lotus Notes database for the desired mailbox.database

Specifies the location of the LotusNotes authentication ID file,relative to the \Data folder.

id

6Chapter

Specifies the password that is associated with the Lotus Notesauthentication ID file.

password

Deletes the specified profile document.zap

Lists the contents of the specified profile document.view

Clears the list of items that Enterprise Vault has blacklisted.These itemshavebeenarchivedbut the archiving task is unableto modify the original notes because their notes summarybuffers are full. When you clear this list the archiving taskarchives the items again. Any items that cannot be modifiedat that time are blacklisted again.

clearblacklist

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

ExamplesThe following are examples of how to run Domino Profile Document Tool.

■ The following command lists the contents of the profile document in thedatabase mdavis.nsf. The Lotus Notes authentication ID file is admin.id, andthe associated password is W3lcome.

EvLotusDominoProfileDocTool.exe DomServer1/EU/Symantec

mail\mdavis.nsf admin.id W3lcome view

■ The following command deletes the profile document from the databasemdavis.nsf.

EvLotusDominoProfileDocTool.exe DomServer1/EU/Symantec

mail\mdavis.nsf admin.id W3lcome zap

Domino Profile Document ToolExamples

36

Domino Retention Plan Tool

This chapter includes the following topics:

■ About Domino retention plans

■ Permissions required

■ Defining a retention plan

■ EVDominoRetentionPlans.exe syntax

About Domino retention plansThe Retention Folder feature enables you to create a single folder or a hierarchyof folders automatically in users'mail files. EnterpriseVault archives these foldersaccording to policies that you assign. If a user deletes any folders in the retentionfolder hierarchy, Enterprise Vault automatically recreates them.

You specify the retention folders and their retention categories in retention plans.You can create as many retention plans as you require.

You use Enterprise Vault provisioning groups to apply retention plans to mailfiles. Thus, different users canhavedifferent retention folderswith the appropriateretention categories. You can also define a default retention plan that EnterpriseVault applies to all users for whom a specific plan is not defined.

You create anXML file inwhichyoudefine the retentionplans andassign retentionplans to provisioning groups. You then use the EVDominoRetentionPlans.execommand line tool to upload the XML file to Enterprise Vault.

7Chapter

The process to create and apply a retention plan is as follows:

1 If you have existing retention plans you can use theEVDominoRetentionPlans.exe command line tool to extract the definitionof the existing plans from Enterprise Vault. You extract the plans as a singleXML file.

2 Edit the existing XML file or create new XML file as required to create thenew retention plan.

3 Use EVDominoRetentionPlans.exe to load theXML file into EnterpriseVault.Enterprise Vault automatically validates the XML and does not accept aninvalid file.

4 Enterprise Vault applies the plan on the next run of the provisioning task orthe mailbox archiving task.

Permissions requiredThe retention folders are created in users' mail files by the Domino provisioningtask or mailbox archiving task.

The ID that the provisioning task or mailbox archiving task uses must have thepermission 'Access to current Database' in the Execution Control List on everyusers' computer.

The account you use to run EVDominoRetentionPlans.exemust have theEnterprise Vault roles-based administration permission 'DominoAdministrator'.

For information about roles-based administration, see theAdministrator'sGuide.

Defining a retention planIf you have previously created a retention plan XML file you can modify that file.If necessary, you can use the EVDominoRetentionPlans.exe tool to extract theexisting retention plans from Enterprise Vault to a file that you can edit.

To extract the existing retention plans from Enterprise Vault and save them inthe file MyPlans.xml:

EVDominoRetentionPlans.exe -save MyPlans.xml

In the Enterprise Vault program folder there is an example retention plans XMLfile that you can copy and modify as required. The file is ExampleRetentionPlans.xml in .

The example file defines retention plans 'All Users' and 'Projects'.

Domino Retention Plan ToolPermissions required

38

The 'All Users' retention plan does the following:

■ Creates the retention folder 'Retention Folders' with the following subfolders:

■ 'Business Records' with a retention category of 'Business'.

■ 'Customer Mails' with a retention category of 'Customers'.

The 'Projects' retention plan does the following:

■ Creates a retention folder that is called Retention Folders' and that has thefollowing subfolders:

■ 'Business Records' with a retention category of 'Business'.

■ 'Customer Mails' with a retention category of 'Customers'.

■ 'Projects' under 'Retention Folders' with a setting of ARCHIVENOW="true". Theplan also creates the following folders under 'Projects':

■ 'Project X'

■ 'Project Y'

■ Deletes the retention folder 'Test'.

The XML file assigns retention plans to provisioning groups as follows:

■ The 'Projects' retention plan is assigned to the provisioning group 'Projectmembers'.

<?xml version="1.0"?>

<RETENTIONPLANCONFIG>

<!-- Start of defining retention plans -->

<RETENTIONPLANS>

<!-- Start of 'All Users' retention plan -->

<RETENTIONPLAN NAME="All Users">

<FOLDER NAME="Retention Folders">

<FOLDER NAME="Business Records" RETCAT="Business"/>

<FOLDER NAME="Customer Mails" RETCAT="Customers"/>

</FOLDER>

</RETENTIONPLAN>

<!-- End of 'All users' retention plan -->

<!-- Start of 'Projects' retention plan -->

<RETENTIONPLAN NAME="Projects">

39Domino Retention Plan ToolDefining a retention plan

<FOLDER NAME="Retention Folders">

<FOLDER NAME="Business Records" RETCAT="Business"/>

<FOLDER NAME="Customer Mails" RETCAT="Customers"/>

<FOLDER NAME="Projects" ARCHIVENOW="true">

<FOLDER NAME="Project X" RETCAT="Project X"/>

<FOLDER NAME="Project Y" RETCAT="Project Y"/>

</FOLDER>

<!-- Delete temporary folder 'Test' -->

<FOLDER NAME="Test" DELETE="true"/>

</FOLDER>

</RETENTIONPLAN>

<!-- End of 'Projects' retention plan -->

</RETENTIONPLANS>

<!-- End of defining retention plans -->

<!-- Assign retention plans to provisioning groups -->

<PROVISIONINGGROUPS>

<DOMAIN NAME="ACME">

<GROUP NAME="Project members" RETENTIONPLAN="Projects"/>

<DEFAULT RETENTIONPLAN="All Users"/>

</DOMAIN>

</PROVISIONINGGROUPS>

<!-- End of assigning retention plans to provisioning groups -->

</RETENTIONPLANCONFIG>

Note the following:

■ To specify a standard folder or view, use the real name, not the displayedname.For example:

■ Use "($Inbox)" to specify the Inbox folder.

■ Use "($ToDo" to specify the Tasks view.

■ Use "($Calendar)" to specify the Calendar.

■ Use the FOLDER element to define both folders and views.

■ FOLDER elements can contain other FOLDER elements. This feature enables youto define a hierarchy of folders or views.

Domino Retention Plan ToolDefining a retention plan

40

■ A parent folder's retention category applies to all its subfolders, unlessspecifically overridden for a particular folder.

■ If the ARCHIVENOW attribute is set to true, documents present in the folder arearchived on the next run of the archive task.

■ If the ARCHIVENOW attribute is specified on a parent folder, it automaticallyapplies to all subfolders, unless overridden at the subfolder level.

■ If the DELETE attribute is set to True, Enterprise Vault deletes the folder andall its subfolders provided that Enterprise Vault created the folder originally.The DELETE attribute removes all subfolders, even those that a user created.DELETE does not remove notes; the folder contents are still available in the AllDocuments view.

■ Optionally, you can specify a default plan for each domain. The default planis applied if there is no plan for a provisioning group.

■ A retention plan cannot contain multiple entries for the same folder or view.

■ A provisioning group can have only one retention plan.

■ In the DOMAIN section, provisioning group names must be unique.

■ You can define some folder hierarchies that do not have retention categoriesassigned.

EVDominoRetentionPlans.exe syntaxYou can use EVDominoRetentionPlans.exe as follows:

■ To load a retention plan definition file into Enterprise Vault, enter thefollowing:EVDominoRetentionPlans.exe -set pathToUploadXmlFile

pathToUploadXmlFile is the path to the file that contains the retention plandefinitions you want to load into Enterprise Vault.This action overwrites all existing retention plans that are in the currentEnterprise Vaultsite.The change to new retention plans appears in the Enterprise Vault event logas event ID 41238 and event category 'Domino Retention Plan Tool'.

■ To save the current retention plan definitions in a file, enter the following:EVDominoRetentionPlans.exe -save pathToDownloadXmlFile

pathToDownloadXmlFile is the path to the file in which you wantEVDominoRetentionPlans.exe to save a copy of the current retention plans.

■ To delete all retention plans from Enterprise Vault, enter the following:

41Domino Retention Plan ToolEVDominoRetentionPlans.exe syntax

EVDominoRetentionPlans.exe -clear

This action deletes all retention plans in the current Enterprise Vault site butdoes not affect retention folders. If you want to delete a retention folder youmust create a retention plan that specifies the DELETE attribute.

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

Domino Retention Plan ToolEVDominoRetentionPlans.exe syntax

42

DTrace

This chapter includes the following topics:

■ About DTrace

■ Starting and stopping DTrace

■ DTrace commands

■ How to read a DTrace log

■ How to troubleshoot DTrace

About DTraceWhen a service, task, or process fails, it is important to diagnose what is goingwrong. The DTrace utility logs what a process is doing at the code level, andtherefore provides a way to run Enterprise Vault in debug mode. DTrace lets youmonitormultiple services simultaneously,write the trace to a file, filter for specificwords, and trigger tracing based on filters.

Starting and stopping DTraceFollow the instructions below to start or stop DTrace.

8Chapter

To start DTrace

1 Log on as the Vault Service account.

2 On the Windows Start menu, click Programs > Enterprise Vault > DTrace.

The DTrace prompt (DT>) indicates that DTrace has loaded. Some commandschange the prompt. For example, if you type filter, the prompt changes toDT FILTER>. To return to the DT> prompt, type Quit or Exit.

3 To view a list of the available commands, type ?.

To stop DTrace

1 Press Ctrl+C to stop monitoring.

2 Type Quit or Exit.

DTrace commandsClears the console.cls

Lets you type a comment to add to the trace output.comment

Displays the selected trace entries. You can specify the start entries andend entries in a range, and choosewhether to apply a filter to those entries.

display

Lets you filter the contents of the trace by specifying the text strings thatthe entries eithermust contain (includes) or cannot contain (excludes). Youcan type the following commands at the DT Filter> prompt:

filter

Adds the nominated strings to the filterinclude list. These strings arecase-sensitive.

+ string [;string] orInclude string [;string]

Adds the nominated strings to the filterexclude list. These strings arecase-sensitive.

- string [;string] orexclude string [;string]

Deletes all the include strings from thefilter, all the exclude strings, or both.

clear

[Includes|Excludes|Both]

Deletes the nominated string from thefilter.

delete string

Exits filter management.exit or quit

Resets the filter to the default settings.reset

Displays the current filter settings.view

DTraceDTrace commands

44

Specifies the name (and optionally the full path) of the file towhichDTracelogs the trace. The default file is C:\Program Files\Enterprise

Vault\DTrace.log.

log

Displays the trace live in the console but does not write it to disk. PressCtrl+C to stop the console output.

monitor

Lists the available log files and lets you open them in a text editor.open

Pauses tracing for the specified period or until the currentwatch commandhas completed.

pause

Displays the entries under the following key in the Windows registry:

HKEY_LOCAL_MACHINE\SOFTWARE\KVS\Enterprise Vault

registry

Resets the trace options.reset

Specifies the name (and optionally the full path) of the file towhichDTracesaves the selected trace entries. You can specify the start entries and endentries in a range, and choose whether to apply a filter to those entries.

save

Sets the monitoring level for a service or component. The available levelsare Off (o), Brief (b), Medium (m), and Verbose (v). Specify the monitoringlevel as follows:

set servicename_or_ID level

For example:

set ArchiveTask v

set 59 m

All lines of code have a minimum monitoring level, and these are viewablewithin the DTrace log files. For example, if you set the logging level toMedium, only code lines that are marked for Brief and Medium loggingshow in the log file.

set

Starts logging after a particular string appears in the trace. You set uptriggers using the same syntax as for filters.

trigger

Displays version information on the executable files in the EnterpriseVaultprogram folder (normally C:\Program Files\Enterprise Vault).

version

Lists all the available processes and services against which you can runDTrace.

This list may change slightly depending on what is loaded or installed. Itis always a good idea to use view first to see a current list of processes andtheir IDs. This is particularly important if you want to set a monitoringlevel with an ID rather than using the name of the process.

view

45DTraceDTrace commands

Records the specified number of trace entries in the log after a trigger filterthat you have defined with the trigger command has taken effect.

watch

How to read a DTrace logTable 8-1 describes the columns in the log.

Table 8-1 Columns in DTrace log

To do thisUse this column

Determine whether any entries have been missed.

See “How to troubleshoot DTrace” on page 46.

Sequence number

Pinpoint slow processes.Time

Identify the processes.Process ID

Identify the processes.Process name

Follow multithread processes (such as the Archiving Task).Thread ID

Determine the correct logging levels.Highest logginglevel

Determine the names of function and the results of those functions.Function name

How to troubleshoot DTraceIn theunlikely event that you experienceproblemswhenyou runDTrace, Table 8-2gives instructions on how to resolve them.

Table 8-2 Potential DTrace problems

What to doProblem

The first figure on each trace line is the sequence numberas it was captured. If there is insufficient CPU time availableto process andwrite entries to the log file, DTracemay skipsome lines. If you are tracing an agent task, try to lower thenumber of threads for the task and monitor a single threadonly.

If there are multiple tasks of the same type (for example,Archiving), stop all but one of them. DTrace does notdifferentiate between the different services.

Lines being skipped.

DTraceHow to read a DTrace log

46

Table 8-2 Potential DTrace problems (continued)

What to doProblem

Ensure that you have selected the correct processes forDTracing. If you are runningDTrace overTerminal Servicesor another remote control application that does not use theprimary operating system console, note thatDTrace eventsare written to the primary console and so may not appearwhen using Terminal Services. In Enterprise Vault, amessage is posted in the log file to say that TerminalServices was used.

Nooutput on the screen aftermonitor command, or notrace in log file.

You can filter and trigger DTrace content based on specificwords or events. If you need to focus on the root cause of aproblem, you can also limit the number of processes andthreads that you monitor.

Toomuch information in thelog file.

47DTraceHow to troubleshoot DTrace

DTraceHow to troubleshoot DTrace

48

EVDominoExchangeMigrationTool

This chapter includes the following topics:

■ About the EVDominoExchangeMigration tool

■ Client requirements

■ Windows Server 2008 firewall requirements

■ Using Binary Tree

■ Using Quest Notes Migrator for Exchange

■ Requirements for other migration software

■ Running EVDominoExchangeMigration

About the EVDominoExchangeMigration toolThe Enterprise Vault EVDominoExchangeMigration tool modifies shortcuts inExchange Server mailboxes that have been migrated from Domino to ExchangeServer.

EVDominoExchangeMigration does the following:

■ Copies explicit mailbox permissions from the Exchange Servermailbox to theDomino archive. Typically these are just the permissions of themailbox owner.No inheritedpermissions are copied and, in the case ofmailboxes onExchange2007, no Active Directory permissions are copied to the Domino archive.

■ Changes themessage class of shortcuts to IPM.Note.EnterpriseVault.Shortcut.

■ Corrects links in the shortcuts to items in the Domino archive.

9Chapter

■ If the archived itemhas an attachment, adds the Outlook paperclip icon to theshortcut.

Note that you will need to install an updated Outlook Add-In for each user whosemailbox has been migrated from Domino.

EVDominoExchangeMigration has been tested with Enterprise Vault shortcutsthat had been migrated with the following:

■ Binary Tree CMT Universal™ 2.7 (also known as CMT for Exchange™).

■ Quest Notes Migrator for Exchange from Quest Software.

You canuse a differentmigration tool, but youmust ensure that the tool correctlymaps the Enterprise Vault Notes document properties to the correspondingEnterprise Vault Exchange named properties.

See “Requirements for other migration software” on page 51.

Client requirementsAll client computers onwhichOutlookwill be used to access items in theEnterpriseVault Domino archivesmust have the Enterprise Vault 2007 SP2Outlook Add-In,or later. You can install the Outlook Add-In before or after runningEVDominoExchangeMigration, but note that some items retrieved from Dominoarchives may appear corrupt when using earlier versions of the Outlook Add-In.

Windows Server 2008 firewall requirementsBy default, the Windows Server 2008 firewall blocks theEVDominoExchangeMigration tool.

If you are using the Windows Server 2008 firewall, you must addEVDominoExchangeMigration.exe to the list of firewall exceptions.

To add EVDominoExchangeMigration.exe to the firewall exceptions list

1 Click the Windows Start menu, and then click Control Panel.

2 Click Security, and then click Windows Firewall.

3 ClickChangesettings and then, in theWindows Firewall Settings dialog box,click the Exceptions tab.

4 Click Add program.

5 Click Browse, and then browse to the Enterprise Vault program folder(typically, C:\Program Files\Enterprise Vault).

EVDominoExchangeMigration ToolClient requirements

50

6 Click EVDominoExchangeMigration.exe, and then click Open.

7 Click OK.

Using Binary TreeSupport for Enterprise Vault shortcuts is included in Binary Tree CMT Universal2.7 and later.

CMT Universal automatically recognizes Enterprise Vault shortcuts, so no extraconfiguration is required when you use CMT Universal.

Using Quest Notes Migrator for ExchangeBefore youmigrate the users fromDomino to Exchange Server, youmust add thesupplied custom attributes definitions to the Quest program folder. The settingsin this file enableQuest tomigrateEnterpriseVault shortcut attributes toExchangeServer mailboxes.

To define Quest custom attributes

1 Copy the supplied example_customattrs.tsv file from the Enterprise Vaultprogram folder to the Quest Notes Migrator for Exchange program folder(normally C:\Program Files\Quest Software Notes Migrator for

Exchange).

2 Rename the new copy of example_customattrs.tsv to customattrs.tsv.

You can now use Quest Notes Migrator to migrate mailboxes to Exchange Server.See the Quest Notes Migrator documentation for details of the process.

Warning:Donot run theEnterpriseVaultmailboxarchiving taskonnewly-migratedmailboxes.Doing somayarchive the shortcuts that EVDominoExchangeMigrationis needed to fix. Consider disabling the mailbox archiving task untilEVDominoExchangeMigration has corrected the shortcuts.

Requirements for other migration softwareEVDominoExchangeMigrationhas been testedwith items that hadbeenmigratedusing Binary Tree Universal and with Quest Notes Migrator for Exchange. If youwant to use a different mailbox migration tool, you must ensure that theappropriateEnterpriseVaultmessageattributes aremapped to their correspondingMAPI attributes.

51EVDominoExchangeMigration ToolUsing Binary Tree

Table 9-1 lists the mappings required for message attributes.

Exchange named properties must all have a GUID ofD0F41A15-9E91-D111-84E6-0000F877D428 and be of kind MNID_STRING.

Table 9-1 Enterprise Vault message attributes

Named property typeEnterprise VaultExchange documentnamed property

EnterpriseVaultNotesdocumentproperty

PT_STRING8Archive IDEV26C5E2CCF2B9267C.ArchiveId

One of the following:

■ PT_SYSTIME

■ PT_STRING8 in theformatyyyyddmmhhmmss.For example,20071910141249represents2007/19/10 14:12.49.

Archived DateEV26C5E2CCF2B9267C.ArchivedDate

PT_STRING8Saveset IDEV26C5E2CCF2B9267C.SaveSetId

PT_STRING8Retention CategoryEV26C5E2CCF2B9267C.RetentionCategory

PT_STRING8EVLotus_HasAttachmentsEV26C5E2CCF2B9267C.HasAttachments

Running EVDominoExchangeMigrationThis section describes how to run EVDominoExchangeMigration.

EVDominoExchangeMigration processes the shortcuts in a singlemailbox. If youwant to process the shortcuts in multiple mailboxes you must runEVDominoExchangeMigration once for eachmailbox. If you have a large numberofmailboxes toprocess theyeasiestmethod is to runEVDominoExchangeMigrationfrom a script or batch file.

UsageEVDominoExchangeMigration [-?] -ex ExchangeServer -sm SystemMailbox

-eu ExchangeSMTPAddress -du DominoUserName -po ExchangeMailboxPolicy

-lf LogFileFolder

EVDominoExchangeMigration ToolRunning EVDominoExchangeMigration

52

where the parameters are as follows:

The name of the Exchange Server computer that hosts the mailbox you want toprocess.

-ex

The primary Exchange Server SMTP address of the user whose mailbox youwant to process.

-eu

The Domino user name of the migrated user (for example, User1/MyOrgName)or the archive IDof theEnterpriseVault archive for theDominouser (for example1C5D73ABD3B80474396FD566AB2A894031110000myServer.myCorp.com)

-du

The Enterprise Vault ExchangeMailbox policy to apply. Must be one of Default,the name of a policy, or None.

■ Default: The ExchangeMailbox policy to applywhenupdating the shortcuts.If the user has been provisioned, this is the Mailbox Policy specified in theprovisioning group. If the user has not been provisioned, this is the DefaultExchange Mailbox Policy.

■ Policy Name: The name of the Exchange mailbox policy to use.

■ None: Do not apply a policy. This option does not correct links in shortcutsbut does improve performance. Do not use this option if shortcuts containlinks to the archived items.

-po

The absolute path of the folder that will contain the log files. The folder will becreated if it does not exist. For example: C:\Migration\Logs. Note that onlya single folder can be created automatically. In the example, the Logs folderwould not be created unless C:\Migration already existed.

-lf

For example, the following command runs EVDominoExchangeMigration withthe following settings:

User12Exchange Server provisioned mailbox

myExchangeExchange Server

[email protected] SMTP address of User12

The mailbox policy from the user's provisioninggroup

Exchange Mailbox policy

User12/myCorpDomino user name

C:\log filesLog file folder

EVDominoExchangeMigration -ex myExchange -eu [email protected] -po

default -du User12/myCorp -lf "C:\log files"

53EVDominoExchangeMigration ToolRunning EVDominoExchangeMigration

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

Log filesEVDominoExchangeMigration creates the following log files:

■ A log file for each mailbox that is processed. The file name is a combinationof the SMTP address of the user, the date, and the time. For example,[email protected] 2007-09-27 09-17-08.log.

■ A log file called EVDominoExchangeMigrationSummary.log, which contains asummary of all migrations. EVDominoExchangeMigration writes a one-linesummary to this file for each mailbox that it processes. The information inthe file is tab-separated, so can you can easily open it with a spreadsheetprogram.EVDominoExchangeMigration never overwrites this log file, so you can usethe same summary log file formultiple runs of EVDominoExchangeMigration.

LimitationsTable 9-2 describes someknown limitations in the EVDominoExchangeMigrationtool that you need to be aware of.

EVDominoExchangeMigration ToolRunning EVDominoExchangeMigration

54

Table 9-2 EVDominoExchangeMigration tool limitations

DescriptionLimitation

When there aremanymailboxes to process, it can be convenientto runEVDominoExchangeMigration in a script. Note that, if theDomino mailbox name contains characters that are outside theUS-ASCII character set, pasting the mailbox names into aWindows text editor is likely to result in failures because thecharacters are not interpreted correctly.

There are various possible solutions to this problem, includingthe following:

■ Create a Windows PowerShell script to process a list ofmailbox names.

■ Use the MS-DOS Editor to create a batch file, as this lets youpaste non-US-ASCII text. To do this, perform the followingsteps:

■ Open a Command Prompt window.

■ Type edit, and then press Enter.■ Right-click the title bar of the Command Prompt window

and then, on the shortcut menu, click Edit > Paste.

Non-US-ASCIIcharacters in Dominomailbox names maybreak scriptedmigrations.

By design, Archive Explorer does not show items in Dominoarchives. Archive Explorer users who have been migrated fromDomino toExchangeServerwill see items thathavebeenarchivedsince migration, because these items are stored in ExchangeServer archives. However, items that were archived beforemigration will not be shown in Archive Explorer.

Archive Explorer doesnot show items inDomino archives

These items are retrieved as normal mail messages (IPM.Note)rather than as Calendar (IPM.Appointment) or To Do items(IPM.Task).

We recommend that, if possible, you do not archive DominoCalendar and To Do items from Domino mailboxes but insteadwait until they have been migrated to Microsoft Exchange andthen archive themusing theMicrosoft ExchangeArchiving task.They are then retrieved correctly.

Appearance ofshortcuts to DominoCalendar and To Doitems.

EVDominoExchangeMigration does not process messages thathave any of the following Exchange Server message classes:

■ IPM.Appointment

■ IPM.Contact

■ IPM.Task

■ IPM.Stickynote

Message classrestrictions

55EVDominoExchangeMigration ToolRunning EVDominoExchangeMigration

EVDominoExchangeMigration ToolRunning EVDominoExchangeMigration

56

EVrights

This chapter includes the following topics:

■ About EVrights

■ EVrights syntax

About EVrightsUse EVrights to grant rights to users and groups from a command line or batchfile. You require Administrator privileges to set user rights.

EVrights syntaxEVrights name right

The name identifies the user or group whose rights you want to modify. Enclosethe name in quotation marks if it contains space characters.

Table 10-1 describes the rights that you can grant. These rights are case-sensitiveand must be typed exactly as they appear.

Table 10-1 Available rights

DescriptionRight

Replace a process level token.SeAssignPrimaryTokenPrivilege

Generate security audits.SeAuditPrivilege

Back up files and directories.SeBackupPrivilege

Log on as a batch job.SeBatchLogonRight

Bypass traverse checking.SeChangeNotifyPrivilege

10Chapter

Table 10-1 Available rights (continued)

DescriptionRight

Create a page file.SeCreatePagefilePrivilege

Create permanent shared objects.SeCreatePermanentPrivilege

Create a token object.SeCreateTokenPrivilege

Debug programs.SeDebugPrivilege

Increase scheduling priority.SeIncreaseBasePriorityPrivilege

Increase quotas.SeIncreaseQuotaPrivilege

Log on locally.SeInteractiveLogonRight

Load and unload device drivers.SeLoadDriverPrivilege

Lock pages in memory.SeLockMemoryPrivilege

Add workstations to domain.SeMachineAccountPrivilege

Access this computer from the network.SeNetworkLogonRight

Profile single process.SeProfileSingleProcessPrivilege

Force shutdown from a remote system.SeRemoteShutdownPrivilege

Restore files and directories.SeRestorePrivilege

Manage auditing and security log.SeSecurityPrivilege

Log on as a service.SeServiceLogonRight

Turn off the system.SeShutdownPrivilege

Modify firmware environment values.SeSystemEnvironmentPrivilege

Profile system performance.SeSystemProfilePrivilege

Change the system time.SeSystemtimePrivilege

Take ownership of files or other objects.SeTakeOwnershipPrivilege

Read unsolicited input from a terminal device.SeUnsolicitedInputPrivilege

EVrightsEVrights syntax

58

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

59EVrightsEVrights syntax

EVrightsEVrights syntax

60

EVservice

This chapter includes the following topics:

■ About EVService

■ EVservice prerequisites

■ How to install EVservice

■ EVservice syntax

■ Format of the list file

About EVServiceEVservice is a command-line utility that lets you start and stopWindows servicesandEnterpriseVault tasks on local or remote computers. EVservice can also pauseand resume services and Enterprise Vault tasks that accept pause and resumerequests.

EVservice is useful if you have a backup procedure that you want to automate.Before you can back up an Enterprise Vault system, you must shut down theEnterprise Vault services and tasks. You can then restart them when the backuphas completed.

Most backup packages let you run a program file or batch file before and after abackup job. If your backup package provides this facility, you can use EVserviceto start and stop Enterprise Vault as required.

Note the following:

■ If you are running Enterprise Vault in a clustering environment, you cancontrol tasks with EVservice but you cannot control services. To controlservices in a VCS cluster, use the hares command that is described in theVeritas Cluster Server Administrator’s Guide.

11Chapter

■ You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.See “Running the command-line utilities with Administrator privileges”on page 15.

EVservice prerequisitesTo run EVservice, you require a computer on which Microsoft Windows 2003 orlater is running.

If you intend to use EVservice to manage Enterprise Vault tasks on remotecomputers, ensure that the Enterprise Vault Administration Console is installedon the same computer as EVservice.

If you want to start or stop a service or Enterprise Vault task that is on a remotecomputer, the account that you use to run EVservice must be a member of thelocal administrator's group on the same computer as the service or task. If youadd an account to the local administrator’s group on the remote computer, youmay find that you need to restart the computer before you can use EVservice.

How to install EVserviceCopy the following files from the Enterprise Vault program folder (normallyC:\Program Files\Enterprise Vault) to a folder on your path, such asC:\WINDOWS\SYSTEM32.

■ EVservice.exe

■ EVRT.dll

■ msvcp71.dll and msvcr71.dll

EVservice syntaxEVservice start|stop|pause|resume computer service

[service...]

Starts, stops, pauses, or resumes the specified services on the named computer.If a service name contains spaces, enclose it in quotationmarks. For example, thefollowing command starts the Enterprise Vault Shopping Service on computerGAMMA:

EVService start GAMMA "Enterprise Vault Shopping

Service"

EVserviceEVservice prerequisites

62

EVservice start|stop|pause|resume computer task [task...]

Starts, stops, pauses, or resumes the specified EnterpriseVault tasks on thenamedDirectory Service computer. If a task name contains spaces, enclose it in quotationmarks. For example, the followingcommandstarts "Public Folder task forGAMMA"when the Directory Service computer is called OMEGA:

EVservice start OMEGA "Public Folder task for GAMMA"

EVservice start|stop|pause|resume computer listfile

Starts, stops, pauses, or resumes the services and Enterprise Vault tasks that arelisted in the named text file, which can be local or remote. For example, thefollowing command starts the services and tasks that are listed in the fileevservices_and_tasks.txt:

EVservice start GAMMA evservices_and_tasks.txt

The file can contain entries for many computers. However, the command acts onthe services that are running on the computer that you specify on the commandline.

See “Format of the list file” on page 63.

EVservice start|stop|pause|resume listfile

Starts, stops, pauses, or resumes all the services and Enterprise Vault tasks thatare listed in the named text file.

EVservice starts the services and tasks in the order in which they are listed in thelist file, and stops them in reverse order.

Format of the list fileThe format of the list file is as follows:

computer:service

EVservice ignores any line that does not contain a colon (:), so you can addcomments if required. For example:

Enterprise Vault Service Startup List (comment line)

GAMMA:Enterprise Vault Directory Service

GAMMA:Enterprise Vault Indexing Service

GAMMA:Enterprise Vault Shopping Service

GAMMA:Enterprise Vault Storage Service

63EVserviceFormat of the list file

GAMMA:Mailbox Archiving Task for EXCH1

DELTA:Mailbox Archiving Task for EXCH2

Notes:

■ The easiest way to stop all tasks is to stop the Task Controller Service. Youcan edit each task’s properties to set its Startup type to Automatic, so that thetasks start automatically when you restart the Task Controller Service. Seethe Administrator's Guide for more information.

■ If you were to use the sample file above with the following command, theservices on computerDELTAwouldbeunaffected (becauseGAMMAis specifiedon the command line):

EVservice start GAMMA evservices_and_tasks.txt

EVserviceFormat of the list file

64

EVSVR

This chapter includes the following topics:

■ About EVSVR

■ Starting EVSVR

■ EVSVR commands

■ EVSVR application states

■ Creating an EVSVR operation file

■ Running an EVSVR operation

■ About the EVSVR operation settings

■ Viewing the EVSVR output log file

■ Running EVSVR in interactive mode

About EVSVREVSVR is a command-line utility with which you can report on, verify, and repairEnterprise Vault storage.

Table 12-1 summarizes the types of operations that EVSVR can perform.

12Chapter

Table 12-1 EVSVR operation types

DescriptionOperation type

This operation provides a count or listing of the items in vault storepartitions, or the records in vault store databases or fingerprintdatabases. For example, a report operation can provide the following:

■ A count of all the files in the site's vault stores that were archivedwithin the last two days.

■ The details of each saveset record in a vault store database.

Report

This operation does one or more of the following:

■ Verifies the vault store database and fingerprint database recordsagainst the vault store objects that they reference.

■ Verifies that vault store objects have valid records in the vaultstore databases and fingerprint databases.

■ Verifies the vault store database records against the equivalentfingerprint database records.

Verify

This operation does one or more of the following:

■ Uses the vault store objects to repair the records within the vaultstore databases and between the vault store databases andfingerprint databases.

■ Blacklists any SIS parts that do not verify correctly. After youblacklist a SIS part, archiving a new item with the same SIS partcauses Enterprise Vault to create a new SIS part file on disk.

■ Deletes the vault store and fingerprint database records that areassociated with missing items.

■ Recreates any missing saveset and SIS part records in the vaultstore and fingerprint databases.

Repair

EVSVR can perform operations on CIFS, NTFS, and Centera partitions, and onboth collected anduncollected items. Before you canperformanEVSVRoperation,you must define it in an operation file.

See “Creating an EVSVR operation file” on page 70.

Note on performing EVSVR operations on CIFS and NTFS partitionsIf you migrate archived data to secondary storage by using a migrator other thanthe Enterprise Vault migrator, you may find that running EVSVR leads to thetemporary recall of largenumbers ofmigratedCAB files. The recalled files occupya large amount of partition space and can potentially cause a partition to becomefull. This issue does not arise if you use the Enterprise Vault migrator. EnterpriseVault deletes these temporary files according to how you set the Recalled file

EVSVRAbout EVSVR

66

cache period property of the partition. This setting has a default value of sevendays.

Before you run EVSVR, ensure that there is sufficient free space on the device onwhich the related Enterprise Vault partitions are located. To reduce the amountof time that Enterprise Vault retains the recalled files, you can lower the value ofthe Recalled file cache period property.

The collection process deletes the recalled fileswhen the cache period has elapsed.You can trigger the collection process manually by using the Run Now option onthe Collections tab of the partition properties.

Starting EVSVRYou must run EVSVR as the Vault Service account on an Enterprise Vault server.The servermust be located in the Enterprise Vault site that contains the data thatyou want to process.

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

To start EVSVR

1 Log on to the Enterprise Vault server as the Vault Service account.

2 Do one of the following:

■ In Windows Explorer, navigate to the Enterprise Vault program folder(typically, C:\Program Files\Enterprise Vault) and double-clickevsvr.exe.

■ Open a command prompt window and change to the Enterprise Vaultprogram folder. Then type the following command:EVSVR

EVSVR displays some startup information, which includes the following:

■ If theMAPI (Exchange) andDomino runtime components arenot available,that this is the case. You must ensure that the appropriate runtimecomponents are installed if you want to perform any EVSVR operationthat requires the retrieval of savesets.

■ The name of the user account under which you are running EVSVR (thatis, the Vault Service account).

67EVSVRStarting EVSVR

■ The name of the Enterprise Vault site.

■ The version number of EVSVR.

3 Type a command at the EVSVR> prompt.

See “EVSVR commands” on page 68.

EVSVR commandsTable 12-2 lists the commands that you can type at the EVSVR> prompt.

Table 12-2 EVSVR commands

EffectCommand

Opens the EVSVR Operations dialog box so that you can editthe currently loaded operation file or create a new one.

See “Creating an EVSVR operation file” on page 70.

edit

Loads an operation file. If you do not specify a file, EVSVRprompts you to select one. Youmust load anoperation file beforeyou can run it.

If an operation file is already loaded, EVSVRunloads it and loadsthe one that you specify.

load [file]

Unloads the current operation filewithout performinganyotheractions.

unload

Starts the execution of the current operation file.start

Stops the execution of the current operation file. EVSVRcompletes any actions that it is performing before it stops, andit generates a report file for the performed actions.

stop

Pauses the execution of the current operation file.pause

Resumes the execution of the current operation file.resume

Stops the execution of the current operation file and then startsit again.

restart

Displays the current status of EVSVR, including its applicationstate.

See “EVSVR application states” on page 69.

status

Clears the EVSVR window.cls

EVSVREVSVR commands

68

Table 12-2 EVSVR commands (continued)

EffectCommand

Quits EVSVR.exit or quit

Runs EVSVR in interactive mode. This mode lets you performa number of specialized activities, including the following:

■ Retrieving the saveset and associated SIS parts of a specifiedarchived item.

■ Retrieving a specified SIS part.

■ Extractingmultiple savesets fromanEMCCentera data blob.

■ Listing the locations where Enterprise Vault has stored allthe parts of a specified saveset.

See “Running EVSVR in interactive mode” on page 95.

interactive

Displays on-screen Help about the EVSVR commands.help or ?

EVSVR application statesTable 12-3 lists the application states in which EVSVR can run.

Table 12-3 EVSVR application states

DescriptionState

EVSVR is executing an operation file.Active

EVSVR is displaying the EVSVR Operations dialog box.DialogueRunning

No operation file is loaded. This state is the initial state if youstart EVSVR without an argument list.

NotReady

EVSVR has paused while it is executing an operation file.Paused

An operation file is loaded.Ready

The application state determines which EVSVR commands you can enter. Forexample, the stop command is only valid when the EVSVR state is Active orPaused. If you enter a command that is invalid for the current state, EVSVRdisplays an error message to indicate this fact.

To determine the current state of EVSVR, type status at the EVSVR> prompt.

69EVSVREVSVR application states

Creating an EVSVR operation fileYou must create an operation file before you can perform an EVSVR operation.An operation file is an XML file that defines the actions that EVSVR is to perform,and on what data set.

You create an operation file by selecting the required options from the EVSVROperations dialog box.

Figure 12-1 The EVSVR Operations dialog box

This dialog box lets you define the following:

■ The storage data to process. EVSVR processes the data that is associated withone of the following:

■ All the partitions in all the vault stores in all the vault store groups in theEnterprise Vault site.

EVSVRCreating an EVSVR operation file

70

■ All the partitions in all the vault stores in a single vault store group.

■ All the partitions in a single vault store.

■ A single partition.

■ A specific archive to process. This applies only when EVSVR processes vaultstore databases.

■ The date range of archived items to process.

■ The operation to perform.

■ The location for the output log file. The log file contains the results of theoperation.

■ The number of threads to use, and the priority.

To create an operation file

1 At the EVSVR> prompt, type edit to open the EVSVR Operations dialog box.

Note the following:

■ Operations XML File shows the name of the current operation file.

■ Site shows the name of the Enterprise Vault site for which to process thedata. This is the site to which the Enterprise Vault server belongs. Youcannot change the site.

2 Specify the storage data that you want to process. By default, the operationfile specifies that EVSVR is to process the data for all partitions in all vaultstores in all vault store groups in the Enterprise Vault site. However, you canminimize the amount of data that you process as follows:

■ To process a single vault store group, uncheck Process All Vault StoreGroups and then select the required group.

■ Toprocess a single vault store, uncheckProcessallVaultStores and thenselect the required vault store.

■ To process a single partition, uncheck Process all Partitions and thenselect the required partition.

3 Select the required values for the other settings, as follows:

By default, EVSVR processes all the archives in the selectedstorage data set. To select an individual archive, uncheckProcessall archives and then select an archive.

If there are a large number of archives, the dialog box displaysa form so that you can filter by archive name.

Process allarchives

71EVSVRCreating an EVSVR operation file

Do one of the following:

■ Use the default setting, which does not impose a date range.

■ Select a timeunit in theUnitbox, and then specify thenumberof units in the Units box. For example, if you select Hour and2, EVSVR processes the items that were archived in the twohours before the time that you start the EVSVR operation.

■ Select Use date range in the Unit box, and then check SetDate Range and specify a date range in the Items archivedfrom boxes.

Note the following:

■ Whether you choose a date range depends on the severity ofthe issues that you want to address. If you want to repair asubstantial number of items as part of a recovery procedure,it is important not to set a date range. This allows EVSVR torepair as many items as possible. On the other hand, settinga date range is desirable if you want to process a handful ofitems or a known range of items.

For example, suppose that a Repair operation has failed torepair a number of items. By repeating the operation againsta date range that includes all the failed items, you may beable to identify the cause of the problem quickly. If you wereto repeat the operation without specifying a date range, itcould take days to complete.

For a non-critical operation, it is usually desirable to choosea small date range—especially if you select a data set with alarge number of archived items. For example, thismay be thecase if youwant to performadailyVerify operation to validatethe last week's archived items only.

■ When it performs an operation that scans a CIFS partition,EVSVRassumes that the original creation dates of the foldersare maintained. If this is not the case because, for example,you use backup software that does not restore the originaldates of the folders, date range selectionmaygive unexpectedresults.

Date Range toProcess

Select an operation type (Report, Verify, or Repair), and then setthe required options.

See “About the EVSVR operation settings” on page 74.

Operation toperform

EVSVRCreating an EVSVR operation file

72

Specify the following:

■ The folder in which to save the output log file. By default,EVSVR saves the file in theReports\EVSVR subfolder of theEnterprise Vault program folder.

■ The name of the log file. If you check Auto GenerateFilename, EVSVR uses the default file name, which is asfollows:

EVSVR_yyyymmddhhmmss.Log

Whereyyyymmddhhmmss specifies thedate and timeatwhichEVSVR created the log file.

If the log file already exists, EVSVR appends the newinformation to it.

Logfile

Specify the thread count for those EVSVR operations that canbenefit frommultithreading. Themaximum is 16. Youmaywantto try a thread count that is double the number of processorsthat the computer has.

Specify the thread priority as Normal, Low, or High.

If you set the thread priority to High for the Repair operationRecreateMissingDBReferences, EVSVR automatically resets thepriority level to Normal. This is designed to stop potentialproblems with resource scheduling and thread contention.Although intermittent, these problems can lead to errors whenEVSVR tries to repair certain database references.

Threads

4 Click one of the following to save the specified values in an operation file:

■ Save. Saves the selected settings and their values in an operation file. Ifyoupreviously saved the file, EVSVRoverwrites the file. Otherwise, EVSVRprompts you for a file name.

■ Save As. Saves the selected parameters and their values in an operationfile. EVSVR prompts you for a file name.

5 After you have defined the operation, click one of the following to exit fromedit mode and return to the EVSVR> prompt:

■ OK. Exits and loads the last saved operation file. Any changes that youhave made since your last save are lost.

■ Cancel. Exits without loading an operation file. Any changes that youhave made since your last save are lost.

73EVSVRCreating an EVSVR operation file

Running an EVSVR operationAfter you have created an operation file, you can run it in any of the followingways:

■ At the EVSVR> prompt, type load and then select the operation file that youwant to load.Type start to begin processing.

■ In the EVSVR Operations dialog box, click OK. EVSVR closes the EVSVROperations dialog box and loads the currently saved operation file, ready torun.Type start to begin processing.

■ At the MS-DOS command prompt >, type the following command:

evsvr -r operation_file_path

Where operation_file_path is the full path to the operation file. If the pathcontains spaces, enclose it in quotation marks. For example:evsvr -r "C:\myfolder\operation files\op1.xml"

This command line is equivalent to a load command at the EVSVR> prompt,followed by a start command and, when processing has stopped, an exit

command. You can use this command line in batch commands, if required.

Certain operations may take some time to complete, depending on factors suchas the size of the data set, the date range, and the type of operation. You can usethe stop, pause, resume, and restart commands to control a running operation,if required. Unless processing is interrupted, EVSVR continues processing untilit has finished the operation.

About the EVSVR operation settingsYou can select aReport, Verify, or Repair operation. All types of operation producea log file that contains the results of the operation.

Report operationsTheEVSVRReport operations provide a count or listing of the items in vault storepartitions, or the records in vault store databases or fingerprint databases. For aReport operation, you must specify an Option setting and a Contents setting.

The Option setting determines whether a report contains an item count or a listof items. It also determines the type of data that EVSVR counts or lists, if youselect Partition as the Contents setting.

EVSVRRunning an EVSVR operation

74

The Contents setting determines the type of data on which EVSVR reports.Table 12-4 describes the settings from which you can select.

Table 12-4 Contents settings for a Report operation

EffectContents setting

Reports onpartition data (savesets andSIS parts, or Centeraclips).

Note: If youwant to performaReport operation on anEMCCentera partition, youmust ensure that theQuery capabilityis enabled on the EMC Centera device.

Partition

Reports on vault store database records (savesetinformation).

VaultStoreDatabase

Reports on fingerprint database records (SIS part records).FingerprintCatalogue

Partition data reportTo obtain a report for the vault store partitions in the selected data silo, selectPartition as the Contents setting.

The following table lists the effects for each Option setting when you selectPartition as the Contents setting.

Table 12-5 Effect of the Option settings on a Partition report

EMC Centera partitionCIFS or NTFS partitionOption setting

Counts the number of clips, includingthose that applications other thanEnterprise Vault have created.

Counts the number of files in the partition.Folders are not included in the count.

All files are counted. If any non-Enterprise Vaultfiles are inadvertently present, these files areincluded in the count.

ContainerCount

75EVSVRAbout the EVSVR operation settings

Table 12-5 Effect of the Option settings on a Partition report (continued)

EMC Centera partitionCIFS or NTFS partitionOption setting

Counts the number of clips thatEnterprise Vault has created.

Counts the number of Enterprise Vault files inthe partition.

If anynon-EnterpriseVault files are inadvertentlypresent, these files are excluded from the count.

The count includes files with the followingextensions:

.ARCHCAB, .ARCHDVF, .ARCHDVFCC,

.ARCHDVFSP, .ARCHDVS, .ARCHDVSCC,

.ARCHDVSSP, .CAB, .DVF, .DVFCC, .DVFSP,

.DVS, .DVSCC, .DVSSP

EVContainerCount

Counts the number of Enterprise Vault savesetsand SIS parts. These files have the followingextensions:

.CAB, .DVF, .DVFCC, .DVFSP, .DVS, .DVSCC,

.DVSSP

EVObjectCount

Lists information about the clips thatall applications have created.

The report provides additionalinformationon the clips that EnterpriseVault has created.

Lists the full path of every file in a partition.Folders are not listed.

All files are listed, including the fileswithin.CABfiles and the savesets within saveset files.

If anynon-EnterpriseVault files are inadvertentlypresent, these files are included.

Containers

Lists information about the clips thatEnterprise Vault has created.

Lists the full path of each Enterprise Vault file inthe partition. Folders are not listed.

The fileswithin.CAB files and the savesetswithinsaveset files are included.

If anynon-EnterpriseVault files are inadvertentlypresent, these files are not included.

The list includes files with the followingextensions:

.ARCHCAB, .ARCHDVF, .ARCHDVFCC,

.ARCHDVFSP, .ARCHDVS, .ARCHDVSCC,

.ARCHDVSSP, .CAB, .DVF, .DVFCC, .DVFSP,

.DVS, .DVSCC, .DVSSP

EVContainers

EVSVRAbout the EVSVR operation settings

76

Table 12-5 Effect of the Option settings on a Partition report (continued)

EMC Centera partitionCIFS or NTFS partitionOption setting

Lists information about the clips thatEnterprise Vault has created.

Lists the full path of Enterprise Vault savesetsand SIS parts. These files have the followingextensions:

.CAB, .DVF, .DVFCC, .DVFSP, .DVS, .DVSCC,

.DVSSP

EVObjects

Lists information about the clips thatEnterprise Vault has created.

If the report coversmore thanone vaultstore, the clips are listed by vault store.

For collection clips, the report includesinformation about the savesets in theclip.

EVVaultStoreObjects

Note: The report provides a count or list of only those items that match thespecified criteria. For example, a ContainerCount report on a CIFS vault storeprovides a count of the files that were archived within the specified date range,for each selected partition.

Vault store database reportTo obtain a report on vault store database records, select VaultStoreDatabase asthe Contents setting.

Table 12-6 lists the effects for each Option setting when you selectVaultStoreDatabase as the Contents setting.

Table 12-6 Effect of the Option settings on a VaultStoreDatabase report

EffectOption setting

Counts the number of saveset records.ContainerCount

EVContainerCount

EVObjectCount

Lists the following information for each saveset record:

■ Saveset ID

■ Archive ID

■ Archive date

■ Item size (kilobytes)

Containers

EVContainers

EVObjects

EVVaultStoreObjects

77EVSVRAbout the EVSVR operation settings

Fingerprint database reportTo obtain a report on fingerprint database records, select FingerprintCatalogueas the Contents setting.

Table 12-7 lists the effects for each Option setting when you selectFingerprintCatalogue as the Contents setting.

Table 12-7 Effect of the Option settings on a FingerprintCatalogue report

EffectOption setting

Counts the number of unreferenced, unshared, and shared SIS partsacross all member tables.

ContainerCount

EVContainerCount

EVObjectCount

Lists the following information for each SIS part record across allmember tables:

■ SIS part ID

■ Archived date

■ Collection ID

■ Original size (bytes)

■ Stored size (bytes)

■ Reference count: The number of times that Enterprise Vaultshares this SIS part

■ Converted content store size (bytes)

■ Converted content disposition (bytes)

■ Blacklisted reason, where applicable

Containers

EVContainers

EVObjects

EVVaultStoreObjects

Verify operationsThe EVSVRVerify operations let you check the consistency of the information inyour vault store partitions, vault store databases, and fingerprint databases. AVerify operation has four Option settings from which you can select. The settingdetermines what data EVSVR verifies.

Table 12-8 lists the effects of the Option settings.

EVSVRAbout the EVSVR operation settings

78

Table 12-8 Option settings for a Verify operation

EffectOption setting

Verifies that the vault store database records and fingerprintdatabase records point to savesets and SIS parts in a partition:

■ Verifies that each saveset record points to a valid saveset.

■ Verifies that each SIS part record points to a valid SIS part.

You must select the required level of verification for this option.

See “Verification levels for an ArchiveObjects Verify operation”on page 80.

ArchiveObjects

Performs a DatabaseLinkages Verify operation, followed by anArchiveObjects Verify operation.

EVSVR performs the ArchiveObjects Verify operation at the mostdetailed level (SavesetValid).

Complete

Verifies the linkages between the vault store databases andfingerprint databases:

■ Verifies that for each archived item record in a vault storedatabase, a SIS part record exists in the fingerprint database.You can select by archive and date range.

■ Verifies that the reference count for each SIS part record in thefingerprint database matches the total number of references inthe vault store databases. You can select by date range but notby archive.

■ For each collection record, verifies that thenumber of referencedfiles in a CAB file or savesets in a clip matches the combinedtotal of the following:

■ The number of savesets in the collection as recorded in thevault store database.

■ The number of SIS parts in the collection as recorded in thefingerprint database.

You can select by date range but not by archive.

■ Reports on the number of unreferenced, unshared, and sharedSIS parts.

DatabaseLinkages

79EVSVRAbout the EVSVR operation settings

Table 12-8 Option settings for a Verify operation (continued)

EffectOption setting

Verifies that the savesets andSIS parts in a partition are referencedby database records:

■ Verifies that each saveset that is located in a partition is pointedto by a saveset record in a vault store database.

If the saveset is collected, also verifies that the collection recordis complete.

■ Verifies that each SIS part that is located in a partition is pointedto by a fingerprint database record.

If the SIS part is collected, also verifies that the collection recordis complete.

Note the following:

■ If you want to perform a DatabaseReferences Verify operationon an EMC Centera partition, you must ensure that the Querycapability is enabled on the EMC Centera device.

■ In rare cases, this operation may report the wrong results whenitems are archived to more than one Centera partition in thesame vault store.

DatabaseReferences

Verifies that the vault store databases contain CAB file collectionrecords whose collection identities match the file names of theassociated CAB files. For example, this operation verifies that, whena collection record has a collection identity of 1234, the name of theassociated CAB file is Collection1234.cab.

If you find any instances of mismatches between the collectionidentities and the CAB file names for certain partitions in a vaultstore database, run the RecreateMissingDBReferences Repairoperation for those partitions.

See “Repair operations” on page 83.

DetectCABCollectionIdMismatch

Verification levels for an ArchiveObjects Verify operationIf you select theArchiveObjects option for aVerify operation, youmust also selecta Level setting. This setting determines the level of verification that EVSVRperforms.

The following table lists the Level settings and their effects. The table lists thefirst three levels in order of the level of verification, with the lowest level ofverification listed first. For example, if you select theObjectExtractsFromContainerlevel, the verification also includes the ObjectContainerExists and

EVSVRAbout the EVSVR operation settings

80

ObjectInContainer levels. As the level of verification increases, so does the timeto perform the verification.

Table 12-9 Effects of the Level settings on an ArchiveObjects Verify operation

EMC Centera partitionCIFS partition withcollections

CIFS partition withoutcollections

Level setting

Verifies that the clipcontaining the saveset exists.

Verifies that the CAB fileexists and has no obviouserrors, such as a file size of 0bytes.

Verifies that the saveset orSIS part file exists and hasno obvious errors, such as afile size of 0 bytes.

Checks for converted contentfile, if appropriate.

ObjectContainerExists

Opens that clip and verifiesfrom the clip attributes thatit contains the saveset.

Verifies that the CAB filecontains the saveset or SISpart file, as defined by theCAB index.

ObjectInContainer

Verifies that the saveset orSIS part file can be extractedfrom the CAB file.

ObjectExtractsFromContainer

Not applicable.Verifies that the SIS part reference in the vault storedatabase and the SIS part fingerprint in the fingerprintdatabase match the SIS part map in a saveset file.

SISPartsMatch

Not applicable.For each SIS part, recomputes the fingerprint and verifiesthat it matches the value in the fingerprint database.

Decompresses compressed SIS parts and converted contentfiles, where applicable.

FingerprintValid

Retrieves the savesetincluding all of its separatelystored attachments andstreams into an EnterpriseVault 8.0 saveset, andperforms a full verification.

Retrieves the saveset including all its SIS parts into anEnterpriseVault 8.0 saveset, and performa full verification.

SavesetValid

Choosing a suitable Verify operationUse Figure 12-2 to help you choose a suitable Verify operation.

81EVSVRAbout the EVSVR operation settings

Figure 12-2 How to choose a suitable Verify operation

Fingerprintsand SIS parts

Source data.What do you want to

verify?

What do youwant to verify in the

partition?

Partition Database

Partition and database

Verify Complete(includesDatabase

Linkages andSavesetValid)

ObjectContainerExists(quick check)

ObjectInContainer(thorough check)

ObjectExtractsFromContainer

(very thorough check)

Objects

SavesetValid(extremely thorough

check)

Savesets

DatabaseLinkages

Database only

DatabaseReferences

SISPartsMatchFingerprintValid

What do youwant to verify in the

database?

Partition-driven

Example: verifying the savesets in a vault store databaseOne common operation that you may want to perform with EVSVR is to verifythe savesets in a vault store database.

To verify the savesets in a vault store database

1 At the EVSVR> prompt, type edit to open the EVSVR Operations dialog box.

2 Choose the vault store group, vault store, or partition that youwant to process.

In most cases, you may want to process all the vault stores.

3 In the Operation to perform list, select Verify.

In the Option list, select Complete.

4 In the DateRange toProcess box, specify the archived date of the items thatyou want to process. Alternatively, leave the date range blank to process allthe items.

EVSVRAbout the EVSVR operation settings

82

5 In the Threads box, keep the default thread number of 1.

6 Click Save to save the settings in an operation file.

7 ClickOK to close theEVSVROperations dialog box and load thenewoperationfile.

8 At the EVSVR> prompt, type start to begin processing.

9 When EVSVR has finished processing, check the contents of the output logfile.

Repair operationsNote the following important points before you perform any Repair operationwith EVSVR:

■ Only consider running a Repair operation if you encounter errors when yourun a Verify operation.

■ Before youundertake aRepair operation,make abackup copyof your databasesand place the vault stores that you want to repair in backup mode. This is thecase even if you have stopped the associated Storage service.

Caution: Starting the Storage service on a damaged system can damage itfurther. Do not start the Storage service before you have put the problematicvault stores in backup mode. Even then, only start the Storage service if itneeds to be running.

■ If you previously used the version of EVSVR in Enterprise Vault 8.0 SP2 orSP3 to repair any errors, youmayneed to perform theRepair operations againwith the latest version of EVSVR. This is necessary in cases where youperformed the repairs with a version of EVSVR to which you did not apply theavailable hotfix. However, it is unnecessary if you performed the repairs witha hotfixed version of EVSVR.

If EVSVR reports any errorswhen youperformaVerify operation, you can correctthem by performing a Repair operation. The function of the Repair operations isto recreate missing records in the vault store and fingerprint databases. In rareinstances, a Repair operation creates new SIS parts on disk for items that havebeen shared many times.

A Repair operation has several Option settings from which you can select.Table 12-10 describes the available settings.

83EVSVRAbout the EVSVR operation settings

Table 12-10 Option settings for a Repair operation

EffectOption setting

Blacklists anySIS part that does not verify correctly becauseit does not exist, has the wrong size, or does not match thevalue in the fingerprint database. After you blacklist a SISpart, archiving a new item with the same SIS part causesEnterprise Vault to create a new SIS part file on disk.

Symantec does not support this option in environmentswhere Symantec NetBackup is in use.

BlacklistBadSISParts

Does the following:

■ Verifies and corrects the reference counts of savesetsand SIS parts in the collection records in the vault storedatabases.

■ Recreates anymissing information on the SIS parts usedby savesets in the vault store databases.

■ Verifies the number of references to SIS parts in thefingerprint databases against the number of referencesin all vault store databases in the vault store group, andcorrects any that are wrong.

■ Reports on the number of unreferenced, unshared, andshared SIS parts, after the repair operation hascompleted.

DatabaseLinkages

EVSVRAbout the EVSVR operation settings

84

Table 12-10 Option settings for a Repair operation (continued)

EffectOption setting

Deletes the vault store and fingerprint database recordsthat are associated with missing items. When an itemconsists ofmultiple parts, this option also deletes fromdiskany remaining parts that are associated with the item.

You may find this option useful in exceptional cases, whenthe missing items are irretrievably lost, and you want tooptimize your Enterprise Vault system by deleting theassociated database records.

When you start a DeleteSurplusReferences operation, itfirst performs an internal DatabaseLinkages Verifyoperation. The DeleteSurplusReferences operation onlystarts to process when the DatabaseLinkages Verifyoperation reports that the environment is consistent anderror-free.

Before you perform a DeleteSurplusReferences operation,we recommend that you use theRecreateMissingDBReferencesRepair operation to recreateany missing database references and ensure that theenvironment is consistent.

Note the following:

■ The DeleteSurplusReferences operation does not takeany action unless it can conclusively determine that theitems in question aremissing. For example, suppose thatyou have migrated archived data to secondary storageby using a non-Enterprise Vault migrator, such asSymantec NetBackup. If the migrator returns genericerrors such as E_FAIL or E_UNEXPECTED, EVSVR doesnot take any action other than to report the errors.

■ When the DeleteSurplusReferences operation finds aCAB file or EMCCentera clip, it assumes that all the itemsthat should exist within the CAB file or clip do exist.

DeleteSurplusReferences

85EVSVRAbout the EVSVR operation settings

Table 12-10 Option settings for a Repair operation (continued)

EffectOption setting

Recreates any missing records in the fingerprint databasesand vault store databases. This option also updates anyrecords that are found to be incorrect from the viewpointof the partition. It also performs an internalDatabaseLinkages Repair operation.

The RecreateMissingDBReferences operation processes allSIS parts before it processes anything else. This can lead tothe situationwhere the operation recreates unusedSISpartsthat it finds inCAB files. After the operationhas completed,you can resolve this issue as follows:

1 Check the RecreateMissingDBReferences Repair logfile for any errors that the operation encountered. Usethe severity of any issues as a guide towhat to do next.For example, you may need to restore missing orcorrupt files in the partition from backup copies andthen rerun the RecreateMissingDBReferences Repairoperation.

2 After you have completed step 1 and judged the repairto be successful, run the Complete Verify operation toconfirm this.

3 After you have completed step 2 and judged yourenvironment to be consistent, run theDeleteSurplusReferences Repair operation to removethe unused SIS parts.

RecreateMissingDBReferences

TheDeleteSurplusReferencesandRecreateMissingDBReferencesRepairoperationsdo not work with savesets and SIS parts that you have migrated to secondarystorage. The reason for this is that each operationneeds to determine the locationsof the migrated files from the vault store and fingerprint databases. As theinformation in these databases may be incorrect, the operation cannot proceedeffectively.

If you want to perform a Repair operation on migrated files, we recommend thatyou first return them to their original store location.

Choosing a suitable Repair operationTable 12-11 identifies the repair procedure to followwhen you encounter specificerrors during a Verify operation. For instructions on how to carry out eachprocedure, see Repair procedures.

EVSVRAbout the EVSVR operation settings

86

Table 12-11 How to select the appropriate repair procedure

Use this repairprocedure

And the log file summarycontains these errors

If you run this Verify operation

Procedure 1"Verify failed count".ArchiveObjects >ObjectContainerExists

Procedure 1ArchiveObjects >ObjectInContainer

Procedure 1ArchiveObjects >ObjectExtractsFromContainer

Procedure 2ArchiveObjects > SISPartsMatch

Procedure 2ArchiveObjects > FingerprintValid

Procedure 2ArchiveObjects > SavesetValid

Procedure 2Both "Savesets Unreferenced" andone of the following:

■ "Converted Content filesunreferenced".

■ "Large files unreferenced".

■ "SISPart files unreferenced".

DatabaseReferences

Procedure 2Only "SISPart files unreferenced"or "Converted Content filesunreferenced" or "Large filesunreferenced".

Procedure 2Only "Savesets Unreferenced".

Procedure 2"CAB Collection records with aCollection Identity mismatch:number".

DetectCABCollectionIdMismatch

Procedure 3Any error.DatabaseLinkages

Table 12-12 identifies the repair procedure to use when you know ofinconsistencies in a vault store database, fingerprint database, or partition.

87EVSVRAbout the EVSVR operation settings

Table 12-12 Suitable repair procedures for known inconsistencies in databasesor partitions

Use this repairprocedure

PartitionFingerprintdatabaseVault store database

Procedure 1SIS part files aremissing

ConsistentConsistent

Procedure 2ConsistentInconsistentInconsistent

Procedure 2ConsistentInconsistentConsistent

Procedure 2ConsistentConsistentInconsistent

Procedure 3Not applicableInconsistentInconsistent

Repair procedures

Caution: If you perform any of the following procedures, do not take yourEnterprise Vault system out of backup mode until you have verified that theprocedure has resolved the issue. Otherwise, you may damage your system.

Procedure 1

1 Using the information in the Verify log file to guide you, try to recover eachmissing file and corrupt file.

2 Rerun the Verify operation that you previously ran until you have resolvedall the errors.

3 If you cannot recover all the SIS parts, run the BlacklistBadSISParts Repairoperation to blacklist the fingerprint database records for the missing files.

Note:This is unnecessary if youhave previously run anArchiveObjectsVerifyoperationwith a verification level of SavesetValid. This operationhas alreadyblacklisted the database records for the missing SIS parts.

EVSVRAbout the EVSVR operation settings

88

Procedure 2

1 Place the vault store groups that you want to repair in backup mode.

If none of the Enterprise Vault services is running then, to place a vault storegroup in backupmode, youmust start theAdmin andDirectory services only.Do not start the Storage service.

2 OneachEnterpriseVault server, stop all EnterpriseVault services and relatedprocesses. Take care to ensure that storage-related processes such asStorageServer.exe and StorageFileWatch.exe have stopped.

3 Restart the following Enterprise Vault services only:

■ Enterprise Vault Admin service.

■ Enterprise Vault Directory service.

■ Enterprise Vault Indexing service (and all Indexing services that areassociated with the vault store groups that you want to repair).

■ Storage service (only if needed). If youneed to start this service, the "initialdatabase and partition checks" section of the EVSVR log file reports thefact.

4 Run a RecreateMissingDBReferences Repair operation.

89EVSVRAbout the EVSVR operation settings

Caution:SIS parts can be shared between different partitions in a single vaultstore and between partitions in different vault stores. Depending on howyouhave configured sharing, it is possible that the recreation of savesets in onevault store partition is dependent on SIS parts that belong to a partition ofanother vault store. These SIS part records must be available before you canrecreate the savesets. So, the situation can arisewhereEVSVRcannot recreatesome saveset records in a vault store database because they are dependenton SIS part records that you have yet to recreate in the fingerprint database.

To avoid this issue, use the sharing level that you have set for the vault storegroups as a guide to what to repair. When the sharing level is "Share withingroup", you must repair the entire vault store group instead of repairing thevault stores and partitions one at a time. When the sharing level is "Sharewithin vault store", youmust repair the entire vault store instead of repairingthe partitions one at a time. When the sharing level is "No sharing", or thepartitions contain pre-8.0 savesets only, you can repair the partitionsindividually.

An additional consideration is the database that you need to repair. Whenthis database is the vault store database, all the partitions belonging to thatvault store are affected and require repair. However, if you need to repair afingerprint database then, regardless of the sharing level that you havechosen, the entire vault store group is affected and requires repair.

If anyof the following conditions applies, youmaywant touncheck theEVSVRoperation setting Require Index Entries:

■ You use deferred indexing (FSA).

■ You have a backlog of index operations outstanding on any archives.

■ An index rebuild is running.

TheRequireIndexEntries operation setting controlswhether EVSVRrepairsdatabase records based on the existence of index entries for the items.

5 After you have successfully completed the RecreateMissingDBReferencesRepair operation, runaCompleteVerify operationwithEVSVRand investigateany errors.

Depending on the nature of the errors, you may want to contact EnterpriseVault Support before you proceed.

EVSVRAbout the EVSVR operation settings

90

6 Consider removing some or all records from the WatchFile andWatchSISPartFile tables of the relevant vault store database.

Whether you remove the records depends on how old the restored copy ofthe vault store database is and whether you have enabled collections ormigrations. If some records in the restoredWatchFile table have subsequentlybeen collected, we recommend that you remove the WatchFile andWatchSISPartFile records. For more information, contact Enterprise VaultSupport.

7 Cancel all archive pending items inmailboxes and revert them to their normalstate.

8 When the databases are in an acceptable state, start the remaining EnterpriseVault services and take the system out of backup mode.

Procedure 3

1 Place the vault store groups that you want to repair in backup mode.

If none of the Enterprise Vault services is running then, to place a vault storegroup in backupmode, youmust start theAdmin andDirectory services only.Do not start the Storage service.

2 OneachEnterpriseVault server, stop all EnterpriseVault services and relatedprocesses. Take care to ensure that storage-related processes such asStorageServer.exe and StorageFileWatch.exe have stopped.

3 Restart the following Enterprise Vault services only:

■ Enterprise Vault Admin service

■ Enterprise Vault Directory service

■ Enterprise Vault Indexing service (and all Indexing services that areassociated with the vault store groups that you want to repair).

■ Storage service (only if needed). If youneed to start this service, the "initialdatabase and partition checks" section of the EVSVR log file reports thefact.

4 Run a DatabaseLinkages Repair operation.

5 Run a Complete Verify operation, and investigate any errors.

Depending on the nature of the errors, you may want to contact EnterpriseVault Support before you proceed.

6 If the vault store and fingerprint databases are still not consistent with eachother or with the storage data in the affected partitions, run aRecreateMissingDBReferences Repair operation.

91EVSVRAbout the EVSVR operation settings

7 Cancel all archive pending items inmailboxes and revert them to their normalstate.

8 When the databases are in an acceptable state, start the remaining EnterpriseVault services and take the system out of backup mode.

Viewing the EVSVR output log fileWhen EVSVR has finished processing, you can view the contents of the log filewith a text editor. Alternatively, you send the log file to your Enterprise VaultSupport representative.

The log file groups the information by vault store group, vault store, and partition.If EVSVR cannot find a vault store group, vault store, or partition, it reports thisfact. This situation can occur if you have deleted a vault store group, vault store,or partition since you created the operation file.

Figure 12-3 shows the start and end of an example log file.

EVSVRViewing the EVSVR output log file

92

Figure 12-3 Example log file excerpt for a Verify operation

Additional log file information when you run certain Repair operationsWhen you run a Repair operation to recreate any missing references in the vaultstore databases or fingerprint databases, a summary at the end of the log fileprovides a count of any references that EVSVR was unable to recreate.

If you have tried to recreate the saveset references in the vault store databases,the log file provides the following additional information:

This is the sum of the five counts below.Saveset records not recreated

93EVSVRViewing the EVSVR output log file

A saveset reference was not recreated because,for the archive inwhich the savesetwas originallyarchived, theArchive andArchive Folder recordsdid not exist in the Enterprise Vault directory.

No Directory Entry

A saveset reference was not recreated becauseyou selected the Require index entries option,and no index entry was found.

No Index Entry

A saveset reference was not recreated becausethe required SIS part information was notavailable.

Missing SIS Parts

A saveset reference was not recreated because itwas necessary to duplicate a SIS part, and therewas no open partition in which to do so. Open apartition in the vault store and repeat the Repairoperation.

No open CIFS partition

A saveset reference was not recreated because ofother directory or database errors.

Errors

If you have tried to recreate the SIS part references in the fingerprint databases,the log file provides the following additional information:

This is the sum of the four counts below.SIS Part records not recreated

The information that EVSVR needed to obtainfrom the vault store databases to recreate a SISpart was not available.

Saveset SIS Part not available

Errors occurred when recreating the valuesrequired to recreate a SIS part reference.

Error getting SIS Part information

Database errors occurred when recreating acollection record in a vault store database for aSIS part file that exists in a .CAB collection file.

Error creating Collection record

Database errors occurred when recreating a SISpart reference in the fingerprint database.

Error creating SIS Part record

For more information on specific savesets and SIS parts, and the errors that mayhave occurred, see the log file.

EVSVRViewing the EVSVR output log file

94

Running EVSVR in interactive modeAs well as performing EVSVR activities by creating and running an operation,you can perform a number of activities in interactive mode.

Table 12-13 describes the commands that you can enter in interactive mode.

Table 12-13 Interactive mode commands

EffectCommand

Retrieves the saveset and associated SIS parts of thespecified archived item.

DumpSaveset or DS

Retrieves the specified SIS part.DumpSISPart or DP

Extracts multiple savesets from an EMC Centera datablob.

ExtractSavesets or ES

Lists the locations where Enterprise Vault has storedall the parts of the specified saveset.

ListSavesetLocations or LS

Clears the EVSVR window.CLS

Displays on-screenHelp about the EVSVR commands.Help or ?

Quits EVSVR interactive mode.Exit or Quit

Displays detailed on-screen Help about the specifiedcommand.

? [command_name]

To put EVSVR in interactive mode, start the utility and then type interactiveat the EVSVR> prompt.

The following sections describe the syntax of the commands in detail.

DumpSaveset commandThe DumpSaveset command retrieves the saveset and associated SIS parts of thespecified archived item.

Syntax

DumpSaveset EntryId SavesetId [-o OutputFolder]

Where the parameters are as follows:

95EVSVRRunning EVSVR in interactive mode

Identifies the required vault store entry, archive entry, or archivefolder entry. EVSVR uses this to determine the location of thesaveset.

EntryId

Specifies the required saveset ID or transaction ID.SavesetId

Specifies the path to the folder in which to store the retrievedfiles and log file. By default, this is theReports\EVSVR subfolderof the Enterprise Vault program folder (typically C:\ProgramFiles\Enterprise Vault).

OutputFolder

Example

In the following example, the two parameters specify the vault store entry ID andsaveset transaction ID of the required saveset:

ds 1995C3ACBB9472646AB0F3A0FDC7066B91210000testsrv1.domain.local

713C88D67D80E8046FFF279AE27D46B1

This command does not specify an output folder with the -o parameter, soDumpSaveset outputs the files to the default location, which is typicallyC:\Program Files\Enterprise Vault\Reports\EVSVR. All DumpSaveset filesare output to a time-stamped folder under this output folder, such asEVSVR_DumpSaveset_20100714181917. So, in this example, the full output pathis as follows:

C:\Program Files\Enterprise

Vault\Reports\EVSVR\EVSVR_DumpSaveset_20100714181917

Expected outputs

Except where noted, DumpSaveset outputs all the files and folders that aredescribed below.

Table 12-14 Files and folders that are directly under the full output path

DescriptionOutput

This is the log file. In the example above, its file name isEVSVR_DumpSaveset_20100714181917.Log.

Always review the log file to determine how successful theoperation was. The file shows any errors that occurred.

See “About reviewing the messages in the log files”on page 105.

Log

This XML file contains the vault store database records forthe saveset that DumpSaveset has retrieved.

VSDBRecords.xml

EVSVRRunning EVSVR in interactive mode

96

Table 12-14 Files and folders that are directly under the full output path(continued)

DescriptionOutput

This folder contains the files that Enterprise Vaultreconstructs after the entire saveset has been retrieved. SeeTable 12-15.

Recombined folder

This folder contains the files that comprise the retrievedsaveset. See Table 12-16.

Parts folder

Table 12-15 Contents of the Recombined folder

DescriptionOutput

This file contains all the data related to the retrieved saveset,except where this is a large-file saveset. DumpSavesetoutputs large-file data to the Parts folder in the form of aDVF or DVFSP file, and it also outputs the data as a nativeitem (see below). Sample file name:

DS_201007078497509~201007071011490000~Z~

611F6F215A2134E015849E23A4D6D601.DVS

DVS

This file is an uncompressed structured storage version ofthe above recombinedDVS file. You can inspect its contentswith a structured storage viewer. Sample file name:

DS_201007078497509~201007071011490000~Z~

611F6F215A2134E015849E23A4D6D601.DocFile

DocFile

This is the original item that Enterprise Vault retrieved. ForExchangemessages, DumpSaveset generates aMSG file; forDominomessages, DumpSaveset generates aDVNS file; andfor large files, DumpSaveset generates the original largefile. Sample file names:

My Exchange message.msg

MyVeryLargeDocFile.doc

Native item

97EVSVRRunning EVSVR in interactive mode

Table 12-16 Contents of the Parts folder

DescriptionOutput

This file is either the entire saveset or, where sharing hasbeen enabled, one part of a multipart saveset. Sample filename:

DS_713C88D67D80E8046FFF279AE27D46B1.DVS

DVS/ARCHDVS (if CABcollected or migrated)

This file is an uncompressed structured storage version ofthe above DVS file. You can inspect its contents with astructured storage viewer. Sample file name:

DS_713C88D67D80E8046FFF279AE27D46B1.DocFile

DocFile

Only output for multipart savesets where sharing has beenenabled. The files are not generated for savesets that arestored on a Centera device. Sample file name:

DS_713C88D67D80E8046FFF279AE27D46B1~2B~

34D8CA20~00~1.DVSSP

DVSSP/ARCHDVSSP (if CABcollected or migrated)

Only output for multipart savesets where sharing has beenenabled and converted content has been generated. Thefiles are not generated for savesets that are stored on aCentera device. Sample file name:

DS_713C88D67D80E8046FFF279AE27D46B1~2B~

34D8CA20~00~1.DVSCC

DVSCC/ARCHDVSCC (if CABcollected or migrated)

Only output for large-filemultipart savesets where sharinghas been enabled. The files are not generated for savesetsthat are stored on a Centera device. Sample file name:

DS_9111FB9F5230E0D6AB99C2014DC51611~CE~

6E068DCC~00~1.DVFSP

DVFSP/ARCHDVFSP (ifmigrated)

Only output for large-file savesets where sharing has notbeen enabled. The files can also be generated for savesetsthat are stored on a Centera device. Sample file name:

DS_713C88D67D80E8046FFF279AE27D46B1.DVF

DVF/ARCHDVF (ifmigrated)

Only output for large-file savesets where sharing has notbeen enabled and where converted content has beengenerated. The files are not generated for savesets that arestored on a Centera device. Sample file name:

DS_713C88D67D80E8046FFF279AE27D46B1.DVFCC

DVFCC/ARCHDVFCC (ifmigrated)

EVSVRRunning EVSVR in interactive mode

98

Table 12-16 Contents of the Parts folder (continued)

DescriptionOutput

Only output when parts of the retrieved saveset are storedon CIFS partitions that have been configured for collectionusing CAB files. DumpSaveset outputs a CAB file for eachcollected part of the saveset. The name of the CAB file hasthe form DS_VaultStoreIdentity_CABfileName. Forexample:

DS_VS8_Collection100.CAB

CAB/ARCHCAB (ifmigrated)

Only output for savesets that are stored onCentera devices.TheXML file uses the Clip-Id related to the retrieved savesetas its file name. For example:

DS_8O58S6H8CJLGLeDF3SPTVDEKITTG4156M190N

G0Q98CDMO8MC3SPT.CDF.xml

CDF.xml

Only output for savesets that have parts that are stored onstreamer devices. DumpSaveset outputs an XML file foreach part of the saveset. Sample file name:

DS_9111FB9F5230E0D6AB99C2014DC51611~CE~

6E068DCC~00~1.DVSSP.MetaData.xml

MetaData.xml

DumpSISPart commandThe DumpSISPart command retrieves the specified SIS part.

Syntax

DumpSISPart EntryId SisPartId [-o OutputFolder]

Where the parameters are as follows:

Identifies the required vault store entry, archive entry, or archivefolder entry. EVSVR uses this to determine the location of theSIS part.

EntryId

Identifies the SIS part.SisPartId

Specifies the path to the folder in which to store the retrievedfiles and log file. By default, this is theReports\EVSVR subfolderof the Enterprise Vault program folder (typically C:\ProgramFiles\Enterprise Vault).

OutputFolder

Example

99EVSVRRunning EVSVR in interactive mode

In the following example, the two parameters specify the vault store entry ID andSIS part ID of the required SIS part:

dp 1995C3ACBB9472646AB0F3A0FDC7066B91210000testsrv1.domain.local

714003019523969A1D9431D0592CCE41~91~BAC3E35A~00~1

This command does not specify an output folder with the -o parameter, soDumpSISPart outputs the files to the default location, which is typicallyC:\Program Files\Enterprise Vault\Reports\EVSVR. All DumpSISPart filesare output to a time-stamped folder under this output folder, such asEVSVR_DumpSISPart_20100715114342. So, in this example, the full output pathis as follows:

C:\Program Files\Enterprise

Vault\Reports\EVSVR\EVSVR_DumpSISPart_20100715114342

Expected outputs

Except where noted, DumpSISPart outputs all the files that are described below.

Table 12-17 Files and folders that are directly under the full output path

DescriptionOutput

This is the log file. In the example above, its file name isEVSVR_DumpSISPart_20100715114342.Log.

Always review the log file to determine how successful theoperation was. The file shows any errors that occurred.

See “About reviewing the messages in the log files”on page 105.

Log

The XML files contain the vault store database records forthe vault stores that reference the SIS part. DumpSISPartgenerates oneXML file for each vault store in the vault storegroup in which the SIS part resides. Only the XML files forvault stores that reference the SIS part contain information;the others contain an empty EnterpriseVault XMLelement. Sample file names:

VSDBRecords - VS0101.xml

VSDBRecords - VS0102Collected.xml

xml

Only output for non-large-file SIS parts. Sample file name:

DP_714003019523969A1D9431D0592CCE41~91~

BAC3E35A~00~1.DVSSP

DVSSP/ARCHDVSSP (if CABcollected or migrated)

EVSVRRunning EVSVR in interactive mode

100

Table 12-17 Files and folders that are directly under the full output path(continued)

DescriptionOutput

Only output for non-large-file SIS parts where convertedcontent has been generated. Sample file name:

DP_714003019523969A1D9431D0592CCE41~91~

BAC3E35A~00~1.DVSCC

DVSCC/ARCHDVSCC (if CABcollected or migrated)

Only output for large-file SIS parts. Sample file name:

DP_714003019523969A1D9431D0592CCE41~91~

BAC3E35A~00~1.DVFSP

DVFSP/ARCHDVFSP (ifmigrated)

Only output for large-file SIS partswhere converted contenthas been generated. Sample file name:

DP_714003019523969A1D9431D0592CCE41~91~

BAC3E35A~00~1.DVFCC

DVFCC/ARCHDVFCC (ifmigrated)

If the SIS part or SIS part converted content file thatDumpSISPart has generatedwas compressed, the commandalso generates a decompressed version. Sample file names:

DP_714003019523969A1D9431D0592CCE41~91~

BAC3E35A~00~1.DVSSP.decompressed

DP_714003019523969A1D9431D0592CCE41~91~

BAC3E35A~00~1.DVSCC.decompressed

decompressed

Only outputwhen theSISparts are stored onCIFSpartitionsthat have been configured for collection using CAB files. ACAB file is expected when the SIS part has been collected.The name of the CAB file has the form DP_CABfileName.For example:

DP_Collection1.CAB

CAB/ARCHCAB (ifmigrated)

Only output for SIS parts that are stored on streamerdevices. DumpSISPart generates one XML file for the SISpart and another for the SIS part converted content that isstored on the streamer device. Sample file names:

DP_9111FB9F5230E0D6AB99C2014DC51611~CE~

6E068DCC~00~1.DVSSP.MetaData.xml

DP_9111FB9F5230E0D6AB99C2014DC51611~CE~

6E068DCC~00~1.DVSCC.MetaData.xml

MetaData.xml

101EVSVRRunning EVSVR in interactive mode

ExtractSavesets commandThe ExtractSavesets command extracts multiple savesets from an EMC Centeradata blob.

Syntax

ExtractSavesets BlobFile [-o OutputFolder] [-n FileNameTemplate] [-f

Offset -s Size]

Where the parameters are as follows:

Specifies the full path to the data file that contains the blob.BlobFile

Specifies the path to the folder in which to store the retrievedfiles and log file. By default, this is theReports\EVSVR subfolderof the Enterprise Vault program folder (typically C:\ProgramFiles\Enterprise Vault).

OutputFolder

Specifies the file naming convention to use for the extractedsavesets. If you do not specify a file name template, EVSVRapplies thenameof the input blob file to the savesets, butwithoutthe path or extension.

If you do not specify an offset and size, EVSVR extracts all thesavesets from the blob and sequentially names themFileNameTemplate_nnn.DVS. If you do specify the size andoffset, EVSVR extracts the size bytes starting from offset intoone saveset file that is named FileNameTemplate.DVS.

FileNameTemplate

Specifies the offset in bytes from the start of the blob file fromwhich to start extracting the required saveset. If you specify anoffset parameter, you must also specify a size parameter.

Offset

Specifies the size in bytes of the data to extract from the blobfile. If you specify a size parameter, you must also specify anoffset parameter.

Size

Example

In the following example, the two parameters specify the required Centera blobfile and output folder:

es "C:\Centera

Blobs\2RGPDMAIG8D51eAMOCBFS25BBK2G415357TU510G996D0BM2P833O.Blob126"

-o c:\MyOutputFolder

If the output folder does not exist, ExtractSavesets creates it. All ExtractSavesetsfiles are output to a time-stamped folder under this output folder, such as

EVSVRRunning EVSVR in interactive mode

102

EVSVR_ExtractSavesets_20100715131545. So, in this example, the full outputpath is as follows:

C:\MyOutputFolder\EVSVR_ExtractSavesets_20100715131545\

The sample command does not include a -f parameter to specify the offset or a-s parameter to specify the size, so it extracts all the savesets in the blob file.

Expected outputs

Except where noted, ExtractSavesets outputs all the files and folders that aredescribed below.

Table 12-18 Files and folders that are directly under the full output path

DescriptionOutput

This is the log file. In the example above, its file name isEVSVR_ExtractSavesets_20100715131545.Log.

Always review the log file to determine how successful theoperation was. The file shows any errors that occurred.

See “About reviewing the messages in the log files”on page 105.

Log

This folder contains the files that ExtractSavesets hasextracted from the Centera blob file. See Table 12-19.

Extracted Savesets folder

Table 12-19 Contents of the Extracted Savesets folder

DescriptionOutput

Given the specified inputparameters, if the blob file containsDVS data, the command extracts all the DVS files from it.The name of each DVS file has the formBlobFileName_IndexNumber.DVS. For example:

2RGPDMAIG8D51eAMOCBFS25BBK2G415357TU510G

996D0BM2P833O_001.DVS

DVS

This file is an uncompressed structured storage version ofthe above extracted DVS file. You can inspect its contentswith a structured storage viewer. Sample file name:

2RGPDMAIG8D51eAMOCBFS25BBK2G415357TU510

G996D0BM2P833O_001.DocFile

DocFile

103EVSVRRunning EVSVR in interactive mode

ListSavesetLocations commandThe ListSavesetLocations command lists the locations where Enterprise Vaulthas stored all the parts of the specified saveset.

Syntax

ListSavesetLocations EntryId SavesetId [-o OutputFolder]

Where the parameters are as follows:

Identifies the required vault store entry, archive entry, or archivefolder entry. EVSVR uses this to determine the location of thesaveset.

EntryId

Specifies the required saveset ID or transaction ID.SavesetId

Specifies the path to the folder in which to store the retrievedfiles and log file. By default, this is theReports\EVSVR subfolderof the Enterprise Vault program folder (typically C:\ProgramFiles\Enterprise Vault).

OutputFolder

Example

In the following example, the parameters specify the vault store entry ID andsaveset transaction ID of the required saveset, and the folder in which to outputthe results:

ls 1995C3ACBB9472646AB0F3A0FDC7066B91210000testsrv1.domain.local

713C88D67D80E8046FFF279AE27D46B1 -o c:\MyOutputFolder

If the output folder does not exist, ListSavesetLocations creates it. AllListSavesetLocations files are output to a time-stamped folder under this outputfolder, such as EVSVR_ListSavesetLocations_20100715112935. So, in thisexample, the full output path is as follows:

C:\MyOutputFolder\EVSVR_ListSavesetLocations_20100715112935

Expected outputs

EVSVRRunning EVSVR in interactive mode

104

Table 12-20 Files that are directly under the full output path

DescriptionOutput

This is the log file. In the example above, its file name isEVSVR_ListSavesetLocations_20100715112935.Log.

Always review the log file to determine how successful theoperation was. The file shows any errors that occurred.

See “About reviewing the messages in the log files”on page 105.

Log

About reviewing the messages in the log filesWhenan interactivemode operationhas finished, it displays amessage to indicatewhether it was successful. If the operation failed for any reason, check the log filefor more information.

Note that the underlying Enterprise Vault components may record a message inthe event log in certain caseswhen errors are encountered, but the operationmaystill be considered a success. The event log messages that the Enterprise Vaultcode generates when EVSVR calls it are redirected to the log file, and they do notappear in the event log. So, it is important to review the log file to determine ifanyerrors occurred. For example, the filemaycontainanevent log-relatedmessagelike the following, even though the overall status of the operationwas "Completedoperation with success":

2010-07-14 19:13:00 Event Output: Failed to recall a Saveset from

its Collection.

Reason: Failed to extract the file from the CAB file. The file name

is not in the CAB file index.

105EVSVRRunning EVSVR in interactive mode

EVSVRRunning EVSVR in interactive mode

106

FSARunNow

This chapter includes the following topics:

■ About FSARunNow

■ Running FSARunNow

■ FSARunNow syntax

■ Examples

About FSARunNowUse the FSARunNow utility to do the following:

■ Start to archive a specified file server.

■ Synchronize permissions for a specified file server.

■ Prune the earlier versions of archived files until only the required number ofversions remains.

Running FSARunNowNote that you can create a batch file that contains the required FSARunNowcommands and use Windows Task Scheduler to run the file when required.

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

13Chapter

To run FSARunNow

1 Log on to any Enterprise Vault server as an account with local administratorpermissions, such as the Vault Service account.

Caution: You must log on to the Enterprise Vault server locally. You cannotrun FSARunNow if you log on remotely.

2 Open a command prompt window.

3 Navigate to the Enterprise Vault program folder (normally C:\Program

Files\Enterprise Vault).

4 Run FSARunNow with the required options.

See “FSARunNow syntax” on page 108.

FSARunNow syntaxType the command in one of the following three forms:

■ To start archiving a specified file server:FSARunNow Archive FileServerEntryId [VolumeEntryId] [Report |

Normal]

■ To synchronize permissions for a specified file server:FSARunNow Synchronize FileServerEntryId

■ To prune the earlier versions of archived files:FSARunNow Prune FileServerEntryId [Report | Normal]

where the parameters are as follows:

FSARunNowFSARunNow syntax

108

Specifies the FileServerEntryId of the computer whosearchives you want to process. You can determine theFileServerEntryId as follows:

1 Start SQL Server Management Studio.

2 In the tree view at the left, select Databases >EnterpriseVaultDirectory.

3 In the toolbar, click New Query.

4 In the Query window, type the following:

select * from fileserverentry

5 Press F5 to execute the query.

6 Scan the query results for the FileServerEntryId of thecomputer to process.

FileServerEntryId

Generates a report that outlines the changes thatFSARunNow would make if you were to run it in Normalmode, but without making those changes.

Report

Specifies a Normal mode run.Normal

ExamplesThe following are examples of how to run FSARunNow.

■ To perform an archive run in Report mode, type the following:FSARunNow Archive 1D6D9206BFDBFB846B2E0F8135A1989331d100002example.

server.local report

■ To perform a synchronizing run in Normal mode, type the following:FSARunNow Synchronize

1D6D9206BFDBFB846B2E0F8135A1989331d100002example.server.local

normal

■ To perform a pruning run in Report mode, type the following:FSARunNow prune 1AD6297BC643DCC40A924CAB74D0BCDCE141000server.

example.net report

109FSARunNowExamples

FSARunNowExamples

110

FSAUtility

This chapter includes the following topics:

■ About FSAUtility

■ FSAUtility requirements and recommendations

■ FSAUtility options

About FSAUtilityFSAUtility is a command-line utility with which you can do the following:

■ Recreate archive points on the original path.See “Recreate archive points” on page 112.

■ Recreate the placeholders for archived files in their original location.See “Recreate placeholders” on page 113.

■ Moveplaceholders fromone location to another locationandmove the archivedfiles to the corresponding destination archive, which is represented by thearchive point on the path.See “Move placeholders and corresponding files” on page 115.

■ Delete orphaned placeholders for which no corresponding item exists in thearchive.See “Delete orphaned placeholders” on page 116.

■ Restore all archived files, or archived files of the specified file types, to theiroriginal location or a new location.See “Restore archived files” on page 117.

The utility works with archive points and placeholders on Windows file servers,NetApp Filers, and EMC Celerra devices.

14Chapter

FSAUtility requirements and recommendationsUse FSAUtility from an account that has local administrator permissions on thefile server that is running the Enterprise Vault File Placeholder Service.

Note the following:

■ We recommend that you do not run more than one instance of FSAUtility ata time. Issues can arisewhenyou specify the same source or target formultiple,concurrent instances of the utility.

■ We recommend that before you run FSAUtility you stop any File SystemArchiving tasks that process the target file server. This action ensures thatno manual or scheduled archiving occurs on the file server while FSAUtilityis processing files,which ensures better performance andprevents inconsistentbehavior. For example, if Enterprise Vault archives a volumewhile a file recallto that volume is in progress, Enterprise Vault may convert the recalled filesto placeholders.

■ You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.See “Running the command-line utilities with Administrator privileges”on page 15.

FSAUtility optionsFSAUtility enables you to recreate archive points or placeholders, to moveplaceholders, to delete orphaned placeholders, and to restore archived files.

Recreate archive pointsYou can use FSAUtility with the -a parameter to recreate archive points on theoriginal path.

FSAUtilityFSAUtility requirements and recommendations

112

FSAUtility -a -s UNC_path [-l log_level] [-r]

Where:

■ -s UNC_path specifies the path to the required folder, volume, orfile server.

■ -l log_level specifieswhether to log both successful operationsand failed operations (0) or failed operations only (1). By default,FSAUtility logs failed operations only.

■ -r specifies reportmode. FSAUtility generates a report that outlinesthe activities that it would perform if you were to run it in normalmode, but without performing those activities.

FSAUtility generates a report namedEV_FILESYSTEM_UTILITY_REPORT_DateTime.txt, in the folderinstallpath\Reports\FSAUtility.

If you run -a in normalmode, FSAUtility generates a report namedEV_FILESYSTEM_UTILITY_REPORT_DateTime.xml.

Syntax

The following command recreates the archive points for the folder\\myserver\users in reportmode. In addition, the command reportsall the archive points in subfolders of this folder.

FSAUtility -a -s \\myserver\users -r

The following command recreates the archive points for both the folder\\myserver\users and all its subfolders.

FSAUtility -a -s \\myserver\users -l 0

Examples

Recreate placeholdersYou can use FSAUtility with the -c parameter to recreate the placeholders forarchived files in their original location. This facility may prove useful if you needto restore a file server to its original state or synchronize the file server with theEnterprise Vault archive. If multiple versions of the same file exist in the archive,the utility creates a placeholder for the latest version only.

113FSAUtilityFSAUtility options

FSAUtility -c -s UNC_path [-D mm-dd-yyyy] [-f] [-l

log_level] [-r]

Where:

■ -s UNC_path specifies the path to the required folder, volume, orfile server.

■ -D mm-dd-yyyy specifies the date after which items must bearchived before you can recreate the placeholders for them.

■ -f forces FSAUtility to recreate the placeholderswhenplaceholdersof the same name already exist. The utility first deletes the existingplaceholders or files and then creates the new ones.

■ -l log_level specifieswhether to log both successful operationsand failed operations (0) or failed operations only (1). By default,FSAUtility logs failed operations only.

■ -r specifies reportmode. FSAUtility generates a report that outlinesthe activities that it would perform if you were to run it in normalmode, but without performing those activities.

FSAUtility generates a report namedEV_FILESYSTEM_UTILITY_REPORT_DateTime.txt, in the folderinstallpath\Reports\FSAUtility.

If you run -c in normalmode, FSAUtility generates a report namedEV_FILESYSTEM_UTILITY_REPORT_DateTime.xml.

Syntax

The following command recreates the placeholders for the folder\\myserver\users and generates a log file that lists both successfuloperations and failed operations. The command runs in report mode.

FSAUtility -c -s \\myserver\users -l 0 -r

The following command recreates the placeholders for those files thatwere archived after July 10 2005 from the folder\\myserver\users\user1. If any files or placeholders of the samename already exist, the command overwrites them with newplaceholders.

FSAUtility -c -f -s \\myserver\users\user1 -D

07-10-2005 -l 0

Examples

FSAUtilityFSAUtility options

114

■ FSAUtility does not support "hard link" files (directory referencesto files). You cannot recreate any existing placeholders for hard linkfiles. When you perform a recreate operation, FSAUtility recallsany placeholders that are hard link files.

■ When you recreate placeholders with FSAUtility, you may receivethe message "Internal Error Moving Placeholders: Archive ID nullfor folder folder_path" if you subsequently try to move them toanother location. To stop this message from appearing, recreatethe archive points and then archive the source folder before youtry to move the placeholders.

Notes

Move placeholders and corresponding filesYou can use FSAUtility with the -m parameter to move placeholders from onelocation to another location. The corresponding files in the archive are alsomovedto the destination folder. The destination archive can be in a different vault store.

FSAUtility -m -s UNC_path -d UNC_path [-l log_level]

[-r]

Where:

■ -s UNC_path specifies the path to the required folder, volume, orfile server.

■ -d UNC_path specifies the path to the destination folder.

■ -l log_level specifieswhether to log both successful operationsand failed operations (0) or failed operations only (1). By default,FSAUtility logs failed operations only.

■ -r specifies reportmode. FSAUtility generates a report that outlinesthe activities that it would perform if you were to run it in normalmode, but without performing those activities.

FSAUtility generates a report namedEV_FILESYSTEM_UTILITY_REPORT_DateTime.txt, in the folderinstallpath\Reports\FSAUtility.

If you run -m in normalmode, FSAUtility generates a report namedEV_FILESYSTEM_UTILITY_REPORT_DateTime.xml.

Syntax

The following command moves the placeholders from the first folderto the second folder. It also moves the archived files to thecorresponding archive location. The log file lists failed operations only.

FSAUtility -m -s \\myserver\users\user1 -d

\\sample\share\user1

Examples

115FSAUtilityFSAUtility options

■ You cannot move placeholders from the root folder of a volume,but you can move placeholders from the subfolders of the rootfolder.

■ FSAUtility does not delete a source folder from which you havemovedplaceholders after it has completed the operation. The foldermay contain other, unarchived files that it would be inappropriateto delete.

■ If you halt an FSAUtility operation to move placeholders before ithas finished then, when you next start the utility, it prompts youto resume the operation.

■ The volume policy or folder policy that applies to the destinationlocation determineswhether EnterpriseVault deletes archived fileswhen their placeholders are deleted. See “Deleting archived fileson placeholder deletion” in Setting up File System Archiving.

■ If the source vault store or destination vault store is in backupmodewhen you try to move placeholders, the utility exits withoutproceeding.

■ FSAUtility does not support "hard link" files (directory referencesto files). You cannot move any existing placeholders for hard linkfiles. When you perform a move operation, FSAUtility moves anyplaceholders that are hard link files.

■ If any of the following becomes unavailable while you moveplaceholders, FSAUtility does not try to process any outstandingplaceholders:

■ Enterprise Vault Directory Service

■ Enterprise Vault File Placeholder Service

■ Enterprise Vault Storage Service

■ The network connection between Enterprise Vault and the fileserver

Instead, the utility exits after recording an error message in theevent log, DTrace log, and FSAUtility log file.

Notes

Delete orphaned placeholdersYou can use FSAUtility with the -o parameter to delete orphaned placeholdersfor which no corresponding item exists in the archive. For example, this facilitymay prove useful if you have used the Enterprise Vault Web Access applicationto delete a vault store item. It may also be useful after you delete an entire vaultstore, vault store partition, or archive.

FSAUtilityFSAUtility options

116

FSAUtility -o -s UNC_path [-l log_level] [-r]

Where:

■ -s UNC_path specifies the path to the required folder, volume, orfile server.

■ -l log_level specifieswhether to log both successful operationsand failed operations (0) or failed operations only (1). By default,FSAUtility logs failed operations only.

■ -r specifies reportmode. FSAUtility generates a report that outlinesthe activities that it would perform if you were to run it in normalmode, but without performing those activities.

FSAUtility generates a report namedEV_FILESYSTEM_UTILITY_REPORT_DateTime.txt, in the folderinstallpath\Reports\FSAUtility.

If you run -o in normalmode, FSAUtility generates a report namedEV_FILESYSTEM_UTILITY_REPORT_DateTime.xml.

Syntax

The following command deletes the orphaned placeholders from anentire file server.

FSAUtility -o -s \\myserver

Examples

Restore archived filesYou canuse FSAUtilitywith the -tparameter to restore someor all of the archivedfiles to their original location or a new location.

If you intend to restore files with FSAUtility, youmust do the following to ensurethat multiple file recalls do not exceed the recall limits:

■ If the file server is a NetApp device, start the Administration Console, openthe properties of the file server, and then select "Ignore recall limits for localadministrators".

■ For other file servers, create a DWORD entry that is calledBypassRecallLimitsForAdmins under the following registry key on the fileserver that runs the Placeholder service:

HKEY_LOCAL_MACHINE

\SOFTWARE

\KVS

\Enterprise Vault

\FSA

\PlaceholderService

Give BypassRecallLimitsForAdmins a value of 1 to enable local administratoraccounts to bypass the recall limits.

117FSAUtilityFSAUtility options

FSAUtility -t -s UNC_path [-D mm-dd-yyyy] -d UNC_path

[-e ext_list] [-f] [-l log_level] [-r]

Where:

■ -s UNC_path specifies the path to the required folder, volume, orfile server.

■ -D mm-dd-yyyy specifies the date after which items must bearchived before you can restore them.

■ -d UNC_path specifies the path to the destination folder.

■ [-e ext_list] specifies the file types to restore as acomma-separated list of file name extensions. For example:

*.xls,*.doc,*.txt

By default, the utility restores all file types.

■ -f forces FSAUtility tomigrate the placeholderswhenplaceholdersof the same name already exist. The utility first deletes the existingplaceholders or files and then creates the new ones.

■ -l log_level specifieswhether to log both successful operationsand failed operations (0) or failed operations only (1). By default,FSAUtility logs failed operations only.

■ -r specifies reportmode. FSAUtility generates a report that outlinesthe activities that it would perform if you were to run it in normalmode, but without performing those activities.

FSAUtility generates a report namedEV_FILESYSTEM_UTILITY_REPORT_DateTime.txt, in the folderinstallpath\Reports\FSAUtility.

If you run -t in normalmode, FSAUtility generates a report namedEV_FILESYSTEM_UTILITY_REPORT_DateTime.xml.

Syntax

FSAUtilityFSAUtility options

118

The following command restores theWord and Excel files in the folder\\myserver\users. It also generates a log file that lists bothsuccessful operations and failed operations.

FSAUtility -t -s \\myserver\users -e *.doc,*.xls -l

0

The following command restores theWord andExcel files for an entirefile server.

FSAUtility -t -s \\myserver -e *.doc,*.xls -l 0

The following command restores all the files that were archived afterSeptember 26 2006 on the entire file server.

FSAUtility -t -s \\myserver -D 09-26-2006

The following command restores the files that were archived afterJanuary 2 2002 from \\myserver\users to \\newserver\users.

FSAUtility -t -s \\myserver\users -d \\newserver\users

-D 01-02-2002 -l 0

Examples

■ FSAUtility does not support "hard link" files (directory referencesto files). You cannot restore an archived file if that file has the samename as a hard link file in the destination folder.When youperforma restore operation, FSAUtility recalls any placeholders that arehard link files.

■ When you recall files to an EMC Celerra device, FSAUtility appliesonly the folder permissions to the files. If there are placeholderswith file-specific permissions, the file permissions are lost and youmust reapply them manually.

Notes

119FSAUtilityFSAUtility options

FSAUtilityFSAUtility options

120

IndexCheck

This chapter includes the following topics:

■ About IndexCheck

■ IndexCheck syntax

About IndexCheckIndexCheck is a command-line utility with which you can verify the integrity oftheAltaVista indexes that EnterpriseVault uses. You canverify a single, specifiedindex or all the indexes in a specified index location.

Note the following:

■ Only run IndexCheck on copies of indexes or while the Indexing service is notrunning. Otherwise, you may corrupt the indexes.

■ Running IndexCheck on large indexes can take a long time, so we recommendthat you run the utility at a quiet time.

IndexCheck syntaxindexcheck [-av days] [-c <exist|words|docs|stats|ChecksumValidate|

ChecksumCreate|MissingDocs|MissingContent|MissingItemsLogFile>] [-csv

filename] [-d] [-db server_name] [-diff number] [-f index_folder]

[-ignorewarnings] [-rebuild filename] [-s] [-t <0-6> filename] [-v

<0-3>] [-?|-h]

Table 15-1 describes the available parameters.

15Chapter

Table 15-1 IndexCheck parameters

To do thisUse this parameter

Checkwhether theavtrace.log file in the indexfolder of an archive has been updated within thespecified number of days.Updates to this filemayindicate that there is a problem with the index.

-av days

Specify the checks to perform, and inwhat order.The options are as follows:

■ exist verifies that all the required index filesare present.

You can use this option with the -csvparameter to create a comma-separated value(.csv) file that lists the invalid indexes. Thenyou can rebuild the indexes by rerunningIndexCheck with the -rebuild parameter.

■ words tries to list all the words in the index.

■ docs lists all the documents in the index.

■ stats compares the statistics from the indexof a given volume against those in thedatabase.

■ ChecksumValidate validates the indexchecksum file against the index volume.

■ ChecksumCreate generates a new indexchecksum file for the volume.

■ MissingDocswrites a list of documents thatare missing from the index to the fileIndexMissing.log.

■ MissingContent writes a list of documentswith missing content to the fileIndexMissing.log.

■ MissingItemsLogFile reports on thecontents of IndexMissing.log, if it exists.

If you omit the -c parameter, IndexCheckperforms all checks and automatically includesthe parameters -ignorewarnings and -av 3.

-c <exist|words|docs|stats|

ChecksumValidate|

ChecksumCreate|MissingDocs|

MissingContent|

MissingItemsLogFile>

Specify the name of an output .csv file. Use thisparameter with the -c exist or -c stats

parameter.

-csv filename

Send logging information to the DTrace utility.

See “About DTrace” on page 43.

-d

IndexCheckIndexCheck syntax

122

Table 15-1 IndexCheck parameters (continued)

To do thisUse this parameter

Identify the Directory database server.-db server_name

Instruct IndexCheck to report an error only if thedifference between the index statistics and thedatabase statistics exceeds or equals the specifiednumber. Use this parameter with the -c stats

parameter.

-diff number

Specify the folder that contains the indexes. Ifyou do not append any parameter to the utilityother than -f index_folder, IndexCheckautomatically includes the-c existparameter.

-f index_folder

Suppress the initial warnings about not runningthe utility on live indexes. This parameter isintended for expert users only.

-ignorewarnings

Rebuild the indexes that are listed in the specified.csv file. To create this file, use the parameters-c exist -csv filename.

-rebuild filename

Stop the utility when it encounters an error.-s

Enable tracing at the specified level and to thespecified file for any errors that AltaVista finds.

-t <0-6> filename

Set the output verbosity when reporting to theconsole. The options are 0 (no output), 1 (errorsonly), 2 (information), and 3 (verbose).

-v <0-3>

Display online help on this utility.-? or -h

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

123IndexCheckIndexCheck syntax

IndexCheckIndexCheck syntax

124

NTFS to Centera Migration

This chapter includes the following topics:

■ About NTFS to Centera Migration

■ Managing migrator jobs

■ Creating migrator jobs

■ Deleting active jobs

■ Deleting source files after migration

■ Log files

About NTFS to Centera MigrationThe NTFS to Centera Migration utility copies Enterprise Vault savesets from anNTFS source partition to an EMC Centera destination partition. The sourcepartition and destination partition are always in the same vault store, soperforming amigration does not affect existing archives and indexes. The sourcepartition files are not deleted.

To start a migration, you create a "migrator job". All jobs run continuously untilcompleted. If the Storage Service is restarted, the migrator jobs restartautomatically.

Managing migrator jobsTo manage migrator jobs you use a command-line utility,NTFSCenteraMigrator.Exe.

16Chapter

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

To manage migrator jobs

1 Open a Command Prompt window.

2 Change to the Enterprise Vault program folder (normally C:\Program

Files\Enterprise Vault).

NTFS to Centera MigrationManaging migrator jobs

126

3 Type the following command:

NTFSCenteraMigrator

The command presents you with the following options:

Closes theNTFSCenteraMigratormanagement programwithoutaffecting any existing jobs.

0 = Exit

Lists each of the current NTFS to Centera Migrator jobs, asfollows:

Job Id: NCM_20031203164814Storage Service computer: SSCOMPUTERVault Store:Name: MigratorTestDescription: Migrator TestSource Partition:Name: MigratorTest Ptn20Description: Partition of Vault StoreMigratorTestDestination Partition:Name: MigratorTest Ptn21Description: Partition of Vault StoreMigratorTestShare archived items: EnabledStart date range: 1999-11-25End date range: 2003-12-31Threads: 15Threads priority: Below NormalSaveset sharing: Partition propertyLog file: <Default>.

1 = List jobs

Displays a series of prompts with which you can specify thedetails of a new NTFS to Centera Migrator job.

See “Creating migrator jobs” on page 128.

2 = Create new

job

Deletes an unfinished job.3 = Delete

existing job

4 Select the option you require.

5 When the migration process has finished, delete the source partition files.

127NTFS to Centera MigrationManaging migrator jobs

Creating migrator jobsYou start a new NTFS to Centera migration by creating a new migrator job.

To create a migrator job

1 Run NTFSCenteraMigrator.

2 Select option 2, Create new job.

3 Type the number of the vault store to use as the source for the migration.

4 Type the number of the source partition to migrate.

5 Type the number of the Centera partition to use as the destination partition.

6 When the utility prompts you to type the start date and end date of a range,press Enter without specifying a date, or type the year, month, and day. (Usefour digits to specify the year; for example, 2006.) If you do not specify eitherdate, the utility migrates all the savesets in the partition.

7 When the utility prompts you for the number of worker threads to use, typea number between 1 and 25. The default is 15.

The number of threads affects the rate at which items can be stored in theCentera. Higher numbers increase the storage rate but use more resourceson the Storage Service computer.

8 Enter the worker thread priority to use. This priority can be either of thefollowing:

■ Below Normal. Windows gives priority to other threads, so migratoractivities have lower priority than applications on the computer.Setting the number of worker threads to 15 or more and selecting BelowNormal should give good performance when the computer is not busywith other tasks.

■ Normal. Windows gives equal priority to migrator activities and otherapplications.

9 Enter the saveset sharing option to use. This option can be one of thefollowing:

■ 0 — Use Partition property. Use the same setting as for the destinationpartition.

■ Force off. Saveset sharing is disabled. This increases performance at theexpense of space.

■ Force on. Saveset sharing is enabled. This maximizes the storage butreduces the migration performance.

NTFS to Centera MigrationCreating migrator jobs

128

10 When the utility prompts you for the name and location of the log file, eithertype the full path to the file or press Enter to use the default name andlocation. For example, you could try thepath E:\Reports\Migration001.log.Any folder that you specify must already exist.

By default, the NTFS to Centera Migrator creates a log file for each job in theEnterpriseVaultReports subfolder (normallyC:\Program Files\Enterprise

Vault\Reports). If you do not specify a log file name, the name that is usedis NCM_DateAndTime.log, where DateAndTime indicates the date and timethat the job was created.

See “Log files” on page 131.

11 Choose whether to remove all references to a saveset if the saveset file nolonger exists in the source partition.

12 If a saveset has twoormore sharers, choosewhether to remove the unselectedsharers and compact the saveset before storing it.

If you choose not to removeunselected sharers, the utility stores the completesaveset in the Centera clip, includingmultiple sharers, if present. This resultsin larger savesets on theCentera andhencemore occupied space. The requiredsharer is selected when the saveset is stored and retrieved.

13 Choose the required error handling options.

Specifies the number of seconds forwhich the utilitywaits beforeretrying the operation, if an error occurs. The default is 10.

Note that the utility does not perform a retry for the followingerror conditions:

■ STORAGE_E_EXTRACT_CAB_HR: Error extracting Savesetfile from Cab file

■ STORAGE_E_SAVESET_DECOMPRESSION: Errordecompressing Saveset

■ STORAGE_E_SAVESETNOTVALID: Invalid Saveset

For these error conditions, the utility immediately abandonsprocessing of the saveset. However, it tries to process the savesetagain when the Storage Service is restarted. (Restarting thisservice restarts the migration job.)

Error wait time

129NTFS to Centera MigrationCreating migrator jobs

Specifies the maximum number of times that the utility retriesprocessing a saveset. The default is five.

If the utility fails to process the saveset after the maximumnumber of retries, it performs one of the following actions:

■ If the error appears irrecoverable, the utility abandonsprocessing of the saveset. However, it tries to process thesaveset again when the Storage Service is restarted.

■ If the error is potentially recoverable, such as a networkproblem, the utility pauses the thread for the error pause time(see below), and then tries to process the saveset again.

Error count

Specifies the number of minutes for which to pause the threadbefore trying to process a saveset again, if the utility fails toprocess the saveset after the maximum number of tries, but theerror is potentially recoverable. The default is five.

Error pause time

14 Restart the Storage Service that manages the vault store. The new job startswhen the Storage Service has restarted.

Deleting active jobsThe NTFS to CenteraMigration utility automatically deletes jobs when they havecompleted. However, you can manually delete any jobs that are still in progress.

To delete an active job

1 Start NTFSCenteraMigrator.

2 Select option 3, Delete existing job.

NTFSCenteraMigrator lists the active jobs.

3 Type the number of the job that you want to delete.

The job is now marked for deletion and no longer appears in the list of jobs.

4 Restart the Storage Service that manages the vault store.

Deleting source files after migrationNTFSCenteraMigrator does not delete the source files after they have beenmigrated toCentera.Data in the source foldersmaybe sharedwith other partitionsand you must not delete the data while there are still references to it. You mustnot delete the source files unless it is safe to do so.

NTFS to Centera MigrationDeleting active jobs

130

If you have moved all NTFS partitions to Centera then you can delete the sourcedata.

To delete the source partition and data:

1 In the Administration Console, expand Vault Store Groups.

Expand the vault store that contains the partition you want to delete.

2 Right-click the partition and, on the shortcut menu, click Delete. TheAdministration Console prompts you to confirm that you want to delete thepartition.

3 Click Yes.

4 If the Administration Console lets you delete the partition then you can useWindows Explorer to delete the partition's files.

If the Administration Console does not let you delete the partition then it isnot safe to delete the partition's files.

Log filesThe NTFS to Centera Migration utility creates a log file for each job. The utilityprompts you for the name and location of the file to create.

The log file is locked while the job is running.

The following is an example of a log file.

2005-12-02 13:08:53 NTFS to Centera Migrator Log file created for

Job NCM_20031202130732

2005-12-02 13:08:53

2005-12-02 13:08:53 Starting migration from Test Ptn16 to Test Ptn17

in Test

2005-12-02 13:08:53 Savesets in NTFS partition: 368

2005-12-02 13:09:25 Migration stopped

2005-12-02 13:09:25 Savesets migrated: 368, Rate: 42735

Savesets/hour

2005-12-02 13:09:25 Savesets in NTFS partition: 0

2005-12-02 13:09:25 Migration completed - job entry has been deleted

131NTFS to Centera MigrationLog files

NTFS to Centera MigrationLog files

132

OWA 2003 Control FilesTool

This chapter includes the following topics:

■ About OWA 2003 Control Files Tool

■ Running OWA Control Files Tool

■ Syntax

About OWA 2003 Control Files ToolWhen you install the Enterprise Vault OWA 2003 extensions, the installationmodifies someof the files that are installed by Exchange Server 2003. IfMicrosoftissues a hotfix for Exchange Server 2003, the OWA 2003 Control Files Tool letsyou apply the same Enterprise Vault changes to the new, hotfix files.

By default, OWA 2003 Control Files Tool makes changes to the Exchange Serverfiles that have thehighest versionnumber, but you can specify a specific ExchangeServer hotfix or service pack version if required.

OWA 2003 Control Files Tool works with Exchange Server hotfixes that aresupported by Enterprise Vault. IfMicrosoft issues a newhotfix, you need to obtaina new version of OWA 2003 Control Files Tool in order to modify the hotfix files.

OWA 2003 Control Files Tool is supplied as a Windows script file,EVControlFilesTool.wsf.

17Chapter

Running OWA Control Files ToolTo run OWA Control Files Tool

1 Log on to the Exchange Server computer.

2 Open a Command Prompt window.

3 Navigate to theOWAsubfolder of theEnterpriseVault programfolder (usuallyC:\Program Files\Enterprise Vault\OWA).

4 Run EVControlFilesTool.wsf with the required options.

See “Syntax” on page 134.

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

SyntaxEVControlFilesTool.wsf [/ExchangeVersion:exchangeversion][/Remove]

Table 17-1 describes the parameters you can use with EVControlFilesTool.wsf.

Table 17-1 EVControlFilesTool.wsf parameters

DescriptionArgument

Specifies the version of the Exchange Server files tomodify.This is needed if, for example, you want to apply theEnterprise Vault changes tomore than one set ofMicrosofthotfix files on a front-end server.

If not specified, the Exchange Server files with the highestversion number are modfied.

ExchangeVersion

Replaces the modified Exchange Server files with thepreviously-created backup versions.

Remove

Examples■ To apply the Enterprise Vault changes to the latest Microsoft hotfix files on

the Exchange Server, type the following:

OWA 2003 Control Files ToolRunning OWA Control Files Tool

134

EVControlFilesTool.wsf

■ To apply the Enterprise Vault changes to the latest Microsoft hotfix files withversion 6.5.7226.0 on the Exchange Server, type the following:

EVControlFilesTool.wsf ExchangeVersion:6.5.7226.0

135OWA 2003 Control Files ToolSyntax

OWA 2003 Control Files ToolSyntax

136

Permission Browser

This chapter includes the following topics:

■ About Permission Browser

■ Running Permission Browser

About Permission BrowserPermission Browser lets you view the security identifiers (SIDs) and accesspermissions for the archives and archive folders in an Enterprise Vault directorydatabase.

Running Permission BrowserFollow the instructions below to openPermission Browser and select the archivesand folders that interest you.

To run Permission Browser

1 InWindowsExplorer, browse to theEnterpriseVault programfolder (normallyC:\Program Files\Enterprise Vault).

2 Double-click PermissionBrowser.exe.

3 Ensure that the ODBC DSN Name field shows the name of the EnterpriseVault directory database forwhose archives youwant to determine the accesspermissions.

4 Check Use NTLM to log on to the database using your current Windowscredentials, or uncheck it to submit a SQL user name and password.

5 In the Selectanarchive and Selecta folder boxes, click items to display theirsecurity descriptors in the box at the right.

18Chapter

Permission BrowserRunning Permission Browser

138

Policy Manager

This chapter includes the following topics:

■ About Policy Manager

■ Policy Manager syntax

■ Initialization file format

■ Initialization file syntax

■ Initialization file sections and keynames

■ Initialization file examples

■ Using the Provisioning API to run Policy Manager scripts

About Policy ManagerEnterprise Vault Policy Manager provides a scripted way to modify and controlExchange mailboxes and archives so that they conform to your Enterprise Vaultarchiving policies. You can apply settings to individualmailboxes in amuchmorespecific manner than you can when you use the Administration Console.

Additionally, you can use PolicyManager tomigrate the contents of PST files andNSF files to Enterprise Vault.

Note: You cannot use Policy Manager to modify or control Domino mail files orarchives.

You canalso apply settings to individualmailboxes in amuchmore specificmannerthan you can do when using the administration console.

19Chapter

The program runs from a command prompt window and uses an initializationfile of settings to apply to mailboxes or archives, or to control the migration ofPST and NSF files.

To ensure the correct permissions, run Policy Manager while you are logged onas the vault service account.

You cannot use Policy Manager to change permissions to Domino archives.

Policy Manager is installed in the Enterprise Vault program folder (normallyC:\Program Files\Enterprise Vault). Its file name is EVPM.EXE.

Policy Manager syntaxEVPM [-?] {[-e Exchange_server] [-m mailbox_alias] | [-d]} [-f

input_file]

where:

Displays help information on the utility.-?

Specifies the name of the Exchange server computer.

When you run EVPM with this parameter, it ignores anyDomino related settings in the initialization file.

It might be necessary to provide a fully qualified domainname if your Exchange server and the Enterprise Vaultserver are in separate Active Directory forests.

-e Exchange_server

Specifies the name of the Enterprise Vault systemmailbox.-m mailbox_alias

Run Domino tasks.

When you run EVPM with this parameter, it ignores anyExchange related settings in the initialization file.

-d

Specifies the name and location of the initialization file.-f input_file

For example:

■ EVPM -e ExchSvr1 -m EVSvceMbx -f c:\ExchSvr1.ini

This command processes the settings in c:\ExchSvr1.ini, against Exchangeserver ExchSvr1, using the Exchange system mailbox EVSvceMbx.

■ EVPM -d -f c:\DominoSvr1.ini

This command processes the NSF migration settings in c:\DominoSvr1.ini.

If you runPolicyManagerwithout anyparameters, it prompts you for them.Afterthe first time you run Policy Manager, it offers the values you set last time as the

Policy ManagerPolicy Manager syntax

140

default when it prompts. You can press Enter to accept the default, or enter a newvalue.

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

Initialization file formatThePolicyManager initialization filemust be aUnicode file. You canuseWindowsNotepad to create such files.

To save the file as Unicode from Notepad

1 On the Tools menu in Notepad, click Save As.

2 Type a name for the file.

3 Next to Encoding, select Unicode from the list.

4 Click Save.

Initialization file syntaxThePolicyManager initialization file is a standardWindows INI file that containssections, keynames, and values, as follows:

[SectionName]

KeyName1=Value1

KeyName2=Value2

...

Note the following:

■ The section names and keynames are not case-sensitive.

■ If a keyname can havemultiple values, separate themwith commas andmakesure that they are all on the same line.

■ You need only specify mandatory keynames and those optional keynameswhose value you want to set. Ignore the other keynames.

■ A line that starts with a semicolon (;) is a comment. The semicolon must bethe first non-whitespace character on the line.

See “Initialization file examples” on page 187.

141Policy ManagerInitialization file format

Initialization file sections and keynamesThe initialization file can contain the following sections:

■ [Directory] section

■ [Archive] section

■ [ArchivePermissions] section

■ [Filter] section

■ [Mailbox] section

■ [Folder] section

■ [PublicFolder] section

■ [PSTdefaults] section

■ [PST] section

■ [PSTcheckpoint] section

■ [NSFDefaults] section

■ [NSF] section

■ [NSFCheckPoint] section

[Directory] sectionThis section is mandatory and must be the first section in the file.

DirectoryComputerNameMandatory. Specifies the computer that hosts the Enterprise Vault directoryservice.

SiteNameMandatory.

For Exchangemailbox tasks andPSTmigrations, this keyname specifies the nameor ID of the Enterprise Vault site that manages the archives or the Exchangemailboxes you want to modify or migrate.

ForNSFmigrations, this keyname specifies the name or ID of the EnterpriseVaultsite that manages the archives into which you want to migrate NSF file content.

Policy ManagerInitialization file sections and keynames

142

StorageSvcComputerNameOptional.

ForNSFmigrations, this keynamespecifies the server that runs the storage service.EVPM runs the NSF migrator server on the computer you specify, to validate theNSF files. If you do not set a value for this keyname, EVPM runs the NSFmigratorserver on any Enterprise Vault server that has a storage service and has the LotusNotes client installed.

[Archive] sectionInclude this section if you want to modify the properties of one or more archives.

ArchiveNameMandatory. Identifies the archive to process. If the archive does not exist, PolicyManager creates a shared archive. (If youwant to createmailbox archives, enablethe mailboxes.)

BillingOwnerMandatory. Specifies a Windows account for billing purposes.

DeleteExpiredItemsOptional. Specifies whether items in the archive are automatically deleted whentheir retention periods expire. If not specified, existing archives are notmodified.

Possible values:

■ true (default, for new archives only)

■ false

DescriptionOptional. Sets the description that the user sees when selecting an archive inwhich to search. The description is also shown in the Administration Console.

If you do not specify a description, existing archives are unchanged, and the textthat is used for new archives is "Created by the Policy Manager".

IndexingLevelOptional. Specifies how detailed an index Enterprise Vault is to create for thearchive.

143Policy ManagerInitialization file sections and keynames

If you omit IndexingLevel, the site default setting is used for newarchives. Existingarchives are not modified.

Possible values:

■ Brief

■ Medium

■ Full

IndexingServiceComputerNameOptional. Identifies the Indexing Service computer that is to process the archive.

You can specify IndexingServiceComputerName=local to force Policy Managerto create an archive with an index that is on the same computer as the StorageService that hosts the archive's vault store. This is important if you use anEnterpriseVault building blocks configuration. Theremust be an Indexing Serviceavailable on the same computer as the Storage Service.

If you omit IndexingServiceComputerName, the site default setting is used fornew archives. Existing archives are not modified.

VaultStoreNameMandatory. The name of the vault store in which the archive exists or is to becreated.

[ArchivePermissions] sectionInclude this section if you want to make changes to the permissions on one or allarchives.

ArchiveNameMandatory. Identifies the archive to which the permission settings are applied.

If there are multiple folders with the same name and you specify a name, PolicyManagermodifies only the first one that it finds. In this case, youmust use archiveIDs to specify the archives.

Possible values:

■ The name of an archive

■ An archive ID

■ ALL (permissions are applied to all journal, shared, and mailbox archives inthe specified vault site)

Policy ManagerInitialization file sections and keynames

144

■ ALL_JOURNAL (permissions are applied to all journal archives)

■ ALL_SHARED (permissions are applied to all shared archives)

■ ALL_MAILBOX (permissions are applied to all mailbox archives)

DenyAccessOptional. Removes the access to the specified archive. If DenyAccess is specifiedwith GrantAccess, DenyAccess is used and GrantAccess is ignored. You can havemany occurrences of DenyAccess within the same [ArchivePermissions] section.

Possible values:

■ A list of the permissions, followed by a comma and then a comma-delimitedlist of groups or accounts that are denied the specified access. Permissionscan be any of read, write, and delete, followed by a comma. For example todeny ourdomain\smith read and write access:

DenyAccess = read write, ourdomain\smith

GrantAccessOptional. Grants to the specified Windows accounts the specified access to thearchive.

The new values supplement any existing access rights. You can have manyoccurrences of GrantAccess within the same [ArchivePermissions] section.

Possible values:

■ A list of permissions, followed by a comma and then a comma-delimited listof groups or accounts that are granted the specified permissions. Permissionscan be any of read, write, and delete, followed by a comma. For example, togrant read and write access to ourdomain\smith:

GrantAccess = read write, ourdomain\smith

ZapOptional. Clears all permissions on the archive. If you specify Zap, GrantAccessand DenyAccess are ignored.

Possible values:

■ true

■ false (default)

145Policy ManagerInitialization file sections and keynames

[Filter] sectionInclude this section to specify a group of settings to apply to folders withinmailboxes. You then apply this setting by specifying the filter name in the [Folder]section.

ALargeItemThresholdPeriodOptional. This setting is equivalent to thenumber that you select forNeverArchiveItems Younger Than on the Archiving Rules tab of the Exchange Mailbox Policydialog box.

This setting is for the filters that are associated with the mailbox, and it does notapply to other folders.

If you specify ALargeItemThresholdPeriod, you must also set values for all thefollowing:

■ UseInactivityPeriod (must be set to true)

■ APrioritizeLargeItems

■ APrioritizeItemsOver

■ ALargeItemThresholdUnits

Possible values:

■ A positive integer

ALargeItemThresholdUnitsOptional. This setting is equivalent to the units entry for Never Archive ItemsYounger Than on the Archiving Rules tab of the Exchange Mailbox Policy dialogbox.

This setting is for the filters that are associated with the mailbox, and it does notapply to other folders.

If you specify ALargeItemThresholdUnits, you must also set values for all thefollowing:

■ UseInactivityPeriod (must be set to true)

■ APrioritizeLargeItems

■ APrioritizeItemsOver

■ ALargeItemThresholdPeriod

Possible values:

■ Days

Policy ManagerInitialization file sections and keynames

146

■ Weeks

■ Months

■ Years

APrioritizeItemsOverOptional. This setting is equivalent to the size that you select for StartWith ItemsLarger Than on the Archiving Rules tab of the Exchange Mailbox Policy dialogbox.

This setting is for the filters that are associated with the mailbox, and it does notapply to other folders.

If you specifyAPrioritizeItemsOver, youmust also set values for all the following:

■ UseInactivityPeriod (must be set to true)

■ APrioritizeLargeItems

■ ALargeItemThresholdUnits

■ ALargeItemThresholdPeriod

Possible values:

■ An integer that specifies the size of items in KB to which you want to givepriority

APrioritizeLargeItemsOptional. This setting is equivalent to the Start With Items Larger Than checkbox on the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

This setting is for the filters that are associated with the mailbox, and it does notapply to other folders.

If you specifyAPrioritizeLargeItems, youmust also set values for all the following:

■ UseInactivityPeriod (must be set to true)

■ APrioritizeItemsOver

■ ALargeItemThresholdUnits

■ ALargeItemThresholdPeriod

Possible values:

■ true

■ false

147Policy ManagerInitialization file sections and keynames

CreateShortcutMandatory. Specifieswhether Enterprise Vault is to create shortcuts to items thatare archived from the folder to which this filter is applied.

Possible values:

■ true

■ false

DeleteOriginalMandatory. Specifieswhether EnterpriseVault is to delete the original itemswhenit archives from the folder to which this filter is applied.

Possible values:

■ true

■ false

InactivityPeriodOptional, butmandatorywhenyousetUseInactivityPeriod to true. InactivityPeriodis valid only when you specify UseInactivityPeriod. You must also specifyInactivityUnits to indicate how long an item can remain unmodified before it iseligible for archiving. This is the same as the Archive Items Older Than settingin the folder properties.

Possible values:

■ An integer between 0 and 500

InactivityUnitsOptional, but mandatory when you set UseInactivityPeriod to true. Valid onlywhenyou specifyUseInactivityPeriod.Whenyouuse this setting, youmust specifyitwith InactivityPeriod to indicate how long an itemcan remainunmodified beforeit is eligible for archiving. This is the same as theArchive ItemsOlder Than settingin the folder properties.

Possible values:

■ Days

■ Weeks

■ Months

■ Years

Policy ManagerInitialization file sections and keynames

148

NameMandatory. Identifies the filter. This name applies only within this initializationfile. You refer to this filter section by name in any [Folder] section in theinitialization file.

PercentageQuotaOptional, but mandatory when you set UsePercentageQuota to true. This settingapplies only when using quota-based archiving. Enterprise Vault archives fromthe mailbox until this percentage of mailbox storage limit is free.

PercentageQuota is not valid for public folders.

Possible values:

■ An integer between 0 and 99

QMinimumAgeThresholdPeriodOptional. This setting is equivalent to the value that you select for Never ArchiveItems Younger Than on the Archiving Rules tab of the Exchange Mailbox Policydialog box.

This setting is for the filters that are associated with the mailbox, and it does notapply to other folders.

If you specify QMinimumAgeThresholdPeriod, you must also set values for thefollowing:

■ UsePercentageQuota (must be set to true)

■ QMinimumAgeThresholdUnits.

QMinimumAgeThresholdPeriod is not valid for public folders.

Possible values:

■ An integer

QMinimumAgeThresholdUnitsOptional. This setting is equivalent to the units that you select for Never ArchiveItems Younger Than on the Archiving Rules tab of the Exchange Mailbox Policydialog box.

This setting is for the filters that are associated with the mailbox, and it does notapply to other folders.

If you specify QMinimumAgeThresholdUnits, you must also set values for thefollowing:

149Policy ManagerInitialization file sections and keynames

■ UsePercentageQuota (must be set to true)

■ QMinimumAgeThresholdPeriod.

QMinimumAgeThresholdUnits is not valid for public folders.

Possible values:

■ Days

■ Weeks

■ Months

■ Years

QPrioritizeItemsOverOptional. This setting is equivalent to the StartWith Items Larger Than size entryon the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

This setting is for the filters that are associated with the mailbox, and it does notapply to other folders.

If you specify QPrioritizeItemsOver, you must also set values for the following:

■ UsePercentageQuota (must be set to true)

■ QPrioritizeLargeItems

QPrioritizeItemsOver is not valid for public folders.

Possible values:

■ An integer that specifies the size of items in KB to which you want to givepriority.

QPrioritizeLargeItemsOptional. This setting is equivalent to the StartWith Items Larger Than size entryon the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

This setting is for the filters that are associated with the mailbox, and it does notapply to other folders.

If you specify QPrioritizeLargeItems, you must also set values for the following:

■ UsePercentageQuota (must be set to true)

■ QPrioritizeItemsOver

QPrioritizeLargeItems is not valid for public folders.

Possible values:

■ true

Policy ManagerInitialization file sections and keynames

150

■ false

UnreadMailMandatory. Specifies whether Enterprise Vault archives unread mail items fromthe folder to which you apply this filter.

Possible values:

■ true

■ false

UseInactivityPeriodMandatory, unless Filtername in the [Folder] section is set to SystemDefault orDoNotArchive.

WhenyouuseUseInactivityPeriod andUsePercentageQuota, youmust set at leastone of them to true.

UseInactivityPeriod specifies whether to use age-based archiving. This setting isfor the filters that are associated with the mailbox, and it does not apply to otherfolders.

Possible values:

■ true (use age-based archiving)

■ false (do not use age-based archiving)

UsePercentageQuotaOptional. When you use UseInactivityPeriod and UsePercentageQuota, youmustset at least one of them to true.

UsePercentageQuota specifieswhether to use quota-based archiving. This settingis for the filters that are associated with the mailbox, and it does not apply toother folders.

If you set UsePercentageQuota to true, you must also set a value forPercentageQuota.

UsePercentageQuota is not valid for public folders.

Possible values:

■ true (use quota-based archiving)

■ false (do not use quota-based archiving)

151Policy ManagerInitialization file sections and keynames

[Mailbox] sectionInclude this section if youwantPolicyManager to change settings for one ormoremailboxes.

DistinguishedNameOptional. Identifies a mailbox.

To apply attributes to all non-system mailboxes on the Exchange server, createa [Mailbox] section and set DistinguishedName to All.

A single [Mailbox] section can contain multiple DistinguishedName keywords,LDAPQuery keywords, or a mixture of the two.

You can run Exchange Mailbox Tasks in report mode to obtain a list of all themailboxes. You can then copy distinguished names from the report to theinitialization file.

LDAPqueryOptional. Lets you select mailboxes by using LDAP attributes. The value usesstandard LDAP query syntax:

LDAPquery = StandardQuery

A simple query looks like the following:

LDAPquery = (attribute operator value)

where:

■ attribute is the LDAP attribute, such as "department".

■ operator is a valid LDAP operator. This operator is normally one of thefollowing:

logical and&

logical or|

logical not!

equal to=

When an operator follows an attribute, there must be no space between theoperator and the attribute. For example, "company=" is correct,whereas "company=" is not.

Policy ManagerInitialization file sections and keynames

152

You can use the asterisk wildcard (*) in string values. For example, to select allmailboxes with a surname that starts with the letter J:

LDAPquery = sn= j*

Notes:

■ If you specify an incorrect LDAP attribute, Policy Manager does not find themailbox and so does not make any changes.

■ The following are useful attributes:

cn [common name]

sn [surname]

company

department

displayName

extensionAttribute1

extensionAttribute2

extensionAttribute3

extensionAttribute4

extensionAttribute5

extensionAttribute6

extensionAttribute7

extensionAttribute8

extensionAttribute9

extensionAttribute10

extensionAttribute11

extensionAttribute12

extensionAttribute13

extensionAttribute14

extensionAttribute15

memberof

Some example queries are as follows:

■ To select mailboxes with LDAP attribute "department" equal to "research":LDAPquery = department= research

■ To selectmailboxeswith LDAPattribute "department" equal to "research" and"Extension-Attribute-1" set to "10000":LDAPquery = (& (department= research)(extensionAttribute1= 10000))

■ To select mailboxes belonging to the users in the IT Guys security group inthe Texas organizational unit:LDAPquery = (memberof= CN=IT Guys,OU=texas,DC=evdemo,DC=local)

153Policy ManagerInitialization file sections and keynames

ProvisioningGroupOptional. Lets you select mailboxes that have been provisioned by a specificprovisioning target group.

For example, to select all the mailboxes that have been provisioned by a groupcalled “VIPs”:

ProvisioningGroup=VIPs

Note: In this example, EVPM selects only the mailboxes that have actually beenprovisioned by the provisioning target group. Other users may be eligible underthe same group, but not provisioned because they have already been provisionedby ahigher priority group. Youmust also run the provisioning task before runningEVPMscripts that use the ProvisioningGroup setting, to ensure that provisioningis up to date.

ResetArchiveFolderPermOptional. Lets you reset the permissions on archive folders to the user's defaultpermissions.

When itmigrates the contents of a PST file to an archive, EnterpriseVault assignsthe same access permissions to the imported PST folders as it does to their parentfolder. The access permissions on the PST file itself are not transferred to thenewly-created folders. This is in line with standard Exchange policy, but it maygive rise to a possible security issue: Using facilities such as Archive Explorer,any user who has read permissions to the parent folder in the Exchange mailboxcan access the migrated items in the PST import folders. You can address thisissue by resetting the permissions on the archive folders and thereby stoppingunqualified users from viewing the contents of PST import folders.

Possible values:

■ 1. (Reset the archive permissions on all folders to the user's defaultpermissions.)

■ 2. (As for 1, but also performs amailbox synchronizationwhenPolicyManagerhas reset the archive folder permissions.)

[Folder] sectionInclude this section if you want to modify the properties of individual folders orcomplete mailboxes.

Policy ManagerInitialization file sections and keynames

154

ArchiveNameOptional. Identifies the archive in which items from the folder are archived. Thedefault is the value that is set on the mailbox root.

Possible values:

■ An archive name or archive ID

DisassociateArchiveFromMailboxOptional. Disassociates a mailbox from its related archive. UseDisassociateArchiveFromMailbox in conjunction with Zap.

If you zap a mailbox and disassociate it from its archive, Enterprise Vault createsa new archive for the mailbox when it is later enabled instead of relinking themailbox to its old archive.

DisassociateArchiveFromMailbox is valid only if:

■ Name=mailboxroot

■ zap=true

Possible values:

■ true

■ false

EnabledOptional. Specifies that the mailbox is enabled or disabled. If not specified, themailbox setting remains unchanged. Can be applied to the mailbox root folderonly.

If you enable a mailbox that was once enabled but subsequently disabled, PolicyManager automatically reconnects it to the existing mailbox archive.

Possible values:

■ true

■ false

ExchangePermissionsOptional. Specifies the folder permissions that youwant to add, change, or remove.

You can specify one of the following:

■ Author

■ Contributor

155Policy ManagerInitialization file sections and keynames

■ Editor

■ NoneditingAuthor

■ Owner

■ PublishingAuthor

■ PublishingEditor

■ Reviewer

When you specify users, you can use either of the following forms:

■ Theuser’s display name from theGlobal Address List (GAL). For example, "SueSmith".

■ The mailbox Distinguished Name. For example, "/o=Org1/ou=AdminGroup/cn=Recipients/cn=smith". Use this format if there are likely to beduplicate display names in the GAL.

Possible values:

■ To grant access to a folder, use either of the following forms:

ExchangePermissions = ADD; UserA:RoleA;UserB:RoleB;...

ExchangePermissions = +; UserA:RoleA;UserB:RoleB;...

where UserA is the first user and RoleA is the permission that youwant to add.

■ To remove permissions, use either of the following forms:

ExchangePermissions = DEL; UserA;UserB;...

ExchangePermissions = –; UserA;UserB;...

where UserA is the first user to remove and UserB is the seconduser to remove.

■ To replace the permissions of users who already have access to the folder:

ExchangePermissions = UserA:RoleA;UserB:RoleB;...

where UserA is the first user and RoleA is the permission that you want to addor modify.

FilternameOptional. Specifies the name of one of the standard filters, or the name of a filterthat you have defined within the initialization file. The filter defines the settingsthat you want Policy Manager to apply to mailboxes.

Possible values:

Policy ManagerInitialization file sections and keynames

156

■ SystemDefault. (Default. Use the default mailbox settings, as defined in theAdministration Console.)

■ DoNotArchive. (Do not archive from the folder to which the filter is applied.)

■ Name of filter. (A filter that is defined within the initialization file.)

IndexingServiceComputerNameOptional. The Indexing Service computer that is to process the archive. Thissetting applies onlywhen enabling themailbox causes a newarchive to be created.

You can specify IndexingServiceComputerName=local to force Policy Managerto create an archive with an index that is on the same computer as the StorageService that hosts the archive’s vault store. This is important if you use anEnterpriseVault building blocks configuration. Theremust be an Indexing Serviceavailable on the same computer as the Storage Service.

If you omit IndexingServiceComputerName, the site default setting is used fornew archives. Existing archives are not modified.

MailboxDNOptional. Specifies a mailbox and restricts the [Folder] section so that it appliesonly to the specified mailbox.

NameMandatory. If the specified folder hierarchy does not exist, PolicyManager createsit and sets the specified properties.

Possible values:

■ mailboxroot (specifies the root folder).

■ folder path. You do not need to specify a path for the following special foldersthatOutlook creates: Inbox,Outbox, SentItems,DeletedItems,Drafts, Calendar,Contacts, Journal, Notes, and Tasks. In these cases, specify only the foldername without the leading backslash. These names work for all languages. Forexample, you can specify "Inbox" on a Japanese system.

Examples:

■ To create a folder that is called "xyz" in the root folder:

Name = \xyz

■ To specify the Deleted Items folder:

Name = DeletedItems

157Policy ManagerInitialization file sections and keynames

NonDeletableOptional. SpecifieswhetherOutlook andOWAusers can delete,move, or copy thefolder and all subfolders.

Possible values:

■ true

■ false

Caution: For information on knownproblemswith this setting, see articles 286799and 293758 on the Symantec Enterprise Support site.

OverrideArchiveLocksOptional. Overrides all Administration Console lock settings. This setting forcesPolicy Manager to modify folder settings even if the Administration Console hasForceUsersToUseSite Settings ForArchiving set on theMailboxActionspropertypage.

Note: The default is for Policy Manager to obey all lock settings. If you want tooverride lock settings, include OverrideArchiveLocks and set the value to true.

Possible values:

■ true

■ false (default)

ParentOptional. Specifies that the folder is to be given the same settings as the parentfolder.

RetentionCategoryOptional. Specifies the retention category to usewhenyou archive from the folder.If not specified, the site default retention category is used.

SiteNameOptional. Can be applied to the mailbox root folder only.

Policy ManagerInitialization file sections and keynames

158

SuspendedOptional. Specifieswhether themailbox is suspended. If not specified, the defaultof false is applied. Can be applied only to the mailbox root folder.

Possible values:

■ true

■ false (default)

URLOptional. Specifies the URL of the Web page that is displayed when a user opensthe folder in Outlook. For example, you can use this feature to create folders withlinks to Archive Explorer or Browser Search.

VaultStoreNameOptional. Identifies the vault store to use when you create a new archive. If themailbox is already enabled or disabled, VaultStoreName is ignored. IfVaultStoreName is not specified, Policy Manager uses the default vault store.

VaultStoreName is valid only if:

■ Name=mailboxroot

■ Enabled=true

■ VaultName is not specified

■ The mailbox has never been enabled

Possible values:

■ The name or ID of the vault store to use

ZapOptional, but mandatory when you set DisassociateArchiveFromMailbox to true.Removes all Enterprise Vault properties from the folder. If you apply this settingto the mailbox root, it makes the mailbox appear as though it has never beenenabled for archiving. If Zap is specified, it overrides all other [Folder] keynames.

Possible values:

■ true

■ false (default)

159Policy ManagerInitialization file sections and keynames

[PublicFolder] sectionInclude this section if you want to modify the properties of public folders. Thissection is optional.

ApplyToSubfoldersOptional. Causes Policy Manager to modify all subfolders beneath the folder thatis specified in Name, regardless of which Exchange Public Folder Task processesthose public folders.

ExchangePermissionsOptional. Specifies the folder permissions that youwant to add, change, or remove.

You can specify one of the following:

■ Author

■ Contributor

■ Editor

■ NoneditingAuthor

■ Owner

■ PublishingAuthor

■ PublishingEditor

■ Reviewer

When you specify users, you can use either of the following forms:

■ Theuser’s display name from theGlobal Address List (GAL). For example, "SueSmith".

■ The mailbox Distinguished Name. For example, "/o=Org1/ou=AdminGroup/cn=Recipients/cn=smith". Use this format if there are likely to beduplicate display names in the GAL.

Possible values:

■ To grant access to a folder, use either of the following forms:

ExchangePermissions = ADD; UserA:RoleA;UserB:RoleB;...

ExchangePermissions = +; UserA:RoleA;UserB:RoleB;...

where UserA is the first user and RoleA is the permission that youwant to add.

■ To remove permissions, use either of the following forms:

Policy ManagerInitialization file sections and keynames

160

ExchangePermissions = DEL; UserA;UserB;...

ExchangePermissions = –; UserA;UserB;...

where UserA is the first user to remove and UserB is the seconduser to remove.

■ To replace the permissions of users who already have access to the folder:

ExchangePermissions = UserA:RoleA;UserB:RoleB;...

where UserA is the first user and RoleA is the permission that you want to addor modify.

See “Initialization file examples” on page 187.

FilternameOptional. Specifies the name of one of the standard filters, or the name of a filterthat you have defined in the initialization file. The filter defines the settings forPolicy Manager to apply to public folders.

Possible values:

■ SystemDefault. (Default. Use the default public folder settings, as defined inthe Administration Console.)

■ DoNotArchive. (Do not archive from the folder to which the filter is applied.)

■ Name of filter. (A filter that you have defined within the initialization file.)

OverrideArchiveLocksOptional. Overrides all Administration Console lock settings. The default is forPolicyManager to obey all lock settings. Since you almost alwayswant to overridelock settings, you probably want to include OverrideArchiveLocks and set thevalue to true.

Possible values:

■ true

■ false (default)

NameMandatory.

RetentionCategoryMandatory. Specifies the retention category to apply to the folder. The retentioncategory must already exist.

161Policy ManagerInitialization file sections and keynames

[PSTdefaults] sectionThis section is mandatory when you use Policy Manager to migrate the contentsof PST files to Enterprise Vault.

This section specifies the default settings that apply to all PST migrations. Youcan override these default settings for individual PST files by specifying theappropriate option in the [PST] section for that file.

CancelMbxAutoArchiveOptional. Controls whether Policy Manager turns off Outlook AutoArchiving forall the folders in the target mailboxes. This stops Outlook from automaticallyarchiving items to PST files.

■ true

■ false (default)

CompactPSTOptional. Controls whether the PST file is compacted after successful migrationof its contents.

If you intend to use this PST compaction feature at the end of migrations, youmay need some spare disk capacity to provide room for the compaction to occur.You may require as much as the size of the largest PST file, plus approximately5% of its size.

Possible values:

■ true

■ false (default)

ConcurrentMigrationsOptional. Specifies the maximum number of concurrent PST migrations. Thissetting takes effect only if MigrationMode is set to Process.

See “MigrationMode” on page 164.

Possible values:

■ An integer in the range 1 to 25. The default is 10.

DeletePSTOptional. Controls whether the PST file is deleted after the successful migrationof its contents.

Policy ManagerInitialization file sections and keynames

162

Possible values:

■ true

■ false (default)

IncludeDeletedItemsOptional. Controls whether the PST Deleted Items folder is migrated.

Possible values:

■ true

■ false (default)

MailboxFolderOptional. Identifies the top-level mailbox folder in which Policy Manager placesshortcuts to migrated items. If the folder does not exist, Policy Manager createsit. Beneath this folder, PST Migrator duplicates the original folder structure andplaces shortcuts in the appropriate folders.

If not specified in either the [PST] or [PSTDefaults] sections, the original folderstructure is recreated at the top level of the mailbox.

Possible values:

■ A folder name. For example, PST items.

MergePSTFoldersOptional. Controls the placement ofmigrated folders in the targetmailbox.Whenset to true, migrating more than one PST file for the same user causes PolicyManager to merge the identically-named folders.

When set to false, Policy Manager appends a number to the folder names, ifnecessary, and thereby keeps the folders separate. For example, if two folders atthe same level are called "MyFolder", Policy Manager creates "MyFolder" and"MyFolder 1".

Possible values:

■ true (default)

■ false

Examples:

If MergePSTFolders is set to false and you migrate three PST files that have thedisplay name "Personal Folders", and all contain top-level folders "Inbox" and"Sent Items", then you get a structure like this:

163Policy ManagerInitialization file sections and keynames

PST Migration (specified by MailboxFolder)

Personal Folders

Inbox

Sent Items

Personal Folders 1

Inbox

Sent Items

Personal Folders 2

Inbox

Sent Items

MigrationModeMandatory. Specifies the modes in which to run.

The options are as follows.

■ Reportmode. PolicyManager checks each listed PST file to determinewhetherit is possible to migrate the file contents.Policy Manager creates a new initialization file that shows any problems withthe listed PST files, such as files that are inaccessible or password-protected.The new initialization file has the same name as the original, with a numberadded to make it unique. For example, if the original script was calledPSTMigration.ini then the new script would be called PSTMigration_1.ini.

Policy Manager also creates a log file with the same name as the originalinitialization file and a file type of .log. For example, if the original script wascalled PSTMigration.ini then the log would be called PSTMigration.log.

■ Process mode. Policy Manager processes PST files and migrates the contentsto the appropriate archives. Policy Manager migrates the file contents andwrites a log file with the same name as the initialization file and a file type of.log.

If any PST files fail the migration process, Policy Manager writes a newinitialization file with which you can process the failed files. Those files thatwere successfully processed are commented out in the new initialization file.

Possible values:

■ Report

■ Process

Policy ManagerInitialization file sections and keynames

164

PSTLanguageMandatory for Outlook 97 to Outlook 2002 PST files. Specifies the Windowscodepage thatwasusedwhen thePSTswere created.Youmust specify the languagehere, in the [PSTdefaults] section, or, for individual PST files, in the [PST] section.

Note the following if the language used was not Western European:

■ If the wrong codepage is used, limitations in Exchange Server mean that thefolder namesmay be corrupted.However, therewill be no problemswith itemswithin the folders.

■ If a folder name is corrupted, you may experience the following problems:

■ The corrupt folder name is used if a user ever chooses to restore an itemto its original folder.

■ Auserwhowants to search for an item, andwhoenters the original location,must enter the corrupt folder name.

To avoid these problems, specify the language that was used when the PSTswere created.

■ The language that you specify here must be available on the Storage Servicecomputer that archives the contents of the PST files. If you need to installextra languages, see the following article in the Microsoft Knowledge Base:How To Add and Enable Additional Languages in Windows

Possible values:

■ Arabic

■ Baltic

■ Central European

■ Cyrillic

■ Greek

■ Hebrew

■ Japanese

■ Korean

■ Simplified Chinese

■ Thai

■ Traditional Chinese

■ Turkish

■ Vietnamese

165Policy ManagerInitialization file sections and keynames

■ Western European (default)

ServerComputerNameOptional. Identifies the computer that is running the Storage Service. If you omitServerComputerName, Policy Manager uses the name of the computer on whichit is running.

Possible values:

■ A computer identification, which can be its LanMan name, DNS name, or IPaddress.

Examples:

■ LanMan: SERVER2

■ DNS: server2.Symantec.com

■ IP address: 18.94.12.3

SetPSTHiddenOptional. Controlswhether the PST file is set as hidden after successfulmigrationof its contents. If you have set your desktop so that it does not show hidden files,this hides PST files that you have migrated successfully. This option is providedfor compatibility with the PST Migrator wizard and is not likely to be used inscripted migrations.

Possible values:

■ true

■ false (default)

SetPSTReadOnlyOptional. Controls whether the PST file is set to be read-only after the successfulmigration of its contents. This prevents users fromopening the fileswithOutlook.

Possible values:

■ true

■ false (default)

ShortcutModeOptional. Defines the PSTmigrationmode,which determines howPolicyManagertreats the contents of the PST at the end of the migration.

Possible values:

Policy ManagerInitialization file sections and keynames

166

■ PSTShortcuts (default). Create shortcuts to the migrated items and leave theshortcuts in the PST files.

■ MailboxShortcuts. Create shortcuts to themigrated itemsandput the shortcutsinto the designated Exchange mailbox. Also copies to the mailbox any itemsthat were excluded from archiving.

■ NoShortcuts. Do not create any shortcuts to migrated items. Any items thatwere excluded from archiving remain in the PST files.

[PST] sectionInclude this section if you want to migrate the contents of PST files to EnterpriseVault.

The settings you provide in this section override any default settings that youmay have defined in the [PSTdefaults] section.

ArchiveNameOptional. Specifies the name or archive ID of the archive towhich PolicyManagermigrates the items in the PST files.

Notes:

■ You can make Policy Manager automatically determine the correct archive touse, in which case you do not need to specify ArchiveName.

■ Policy Manager uses the first archive that has a matching name. If you havearchives with duplicate names, the result may not be what you want. To avoidthis problem, use the archive ID, which you can copy from the Advanced tabof the archive’s properties in the Administration Console.

Possible values:

■ The name of the archive to process

■ The archive ID of the archive to process

CancelMbxAutoArchiveOptional. Controls whether Policy Manager turns off Outlook AutoArchiving forall the folders in the target mailboxes. This stops Outlook from automaticallyarchiving items to PST files.

■ true

■ false (default)

167Policy ManagerInitialization file sections and keynames

CompactPSTOptional. Controls whether the PST file is compacted after successful migrationof its contents.

If you intend to use this PST compaction feature at the end of migrations, youmay need some spare disk capacity to provide room for the compaction to takeplace. This capacity is typically the size of the largest PST file plus approximately5% of that size.

Possible values:

■ true

■ false (default)

DeletePSTOptional. Controls whether the PST file is deleted after the successful migrationof its contents.

Possible values:

■ true

■ false (default)

DoNotProcessOptional. Indicateswhether PolicyManager is to ignore this filewhen it processesPST files. In report mode, Policy Manager ignores this setting and checks thestatus of every PST file listed.

In the new initialization file that Policy Manager creates after a report mode run,[PST] sections that have caused errors contain the entry DoNotProcess = True.

Possible values:

■ true

■ false (default)

FileNameOptional. Specifies the path to the PST file that you want to process.

Examples:

\\central\share\test1.pst

e:\PSTfiles\test2.pst

Policy ManagerInitialization file sections and keynames

168

IncludeDeletedItemsOptional. Controls whether the PST Deleted Items folder is migrated.

Possible values:

■ true

■ false (default)

JobStatusOptional. Do not use. Policy Manager inserts JobStatus when you run in processmode. JobStatus indicates whether the file was successfully processed.

Possible values:

■ Processed. The file has been successfully processed. Its [PST] section iscommented out to prevent reprocessing.

■ Unprocessed. Policy Manager cannot begin processing this file.

■ Incomplete. Policy Manager was processing this file when a failure occurredthat stopped all processing, such as a power cut.

■ Partially_Processed. Some items in the PST file cannot be processed. All theseitems have been placed in a folder that is called PST Migration Failed Itemsin the PST file. Policy Manager cannot migrate these items.

■ Failed. The file cannot be processed for some reason. For example, the StorageService may not be running, or the user may have opened the file.

MailboxDNOptional. Specifies the distinguished name of the mailbox in which to placeshortcuts to the items that have been migrated.

The easiestway todetermine anumber ofMailboxDNvalues is to run theExchangeMailbox Task in report mode. For instructions on how to use report mode to testarchiving, see the Administration Console help file. The output file then containsthe MailboxDN of each mailbox on that Exchange Server computer.

Possible values:

■ A distinguished name, such as the following:

/o=acme/ou=developer/cn=Recipients/cn=smithj

169Policy ManagerInitialization file sections and keynames

MailboxFolderOptional. Identifies the top-level mailbox folder in which Policy Manager placesshortcuts to migrated items. If the folder does not exist, Policy Manager createsit. Beneath this folder, PST Migrator duplicates the original folder structure andplaces shortcuts in the appropriate folders.

If not specified in either the [PST] or [PSTDefaults] sections, the original folderstructure is recreated at the top level of the mailbox.

Possible values:

■ A folder name. For example, PST items.

MergePSTFoldersOptional. Controls the placement ofmigrated folders in the targetmailbox.Whenset to true, migrating more than one PST file for the same user causes PolicyManager to merge the identically-named folders.

When set to false, Policy Manager appends a number to the folder names, ifnecessary, and thereby keeps the folders separate. For example, if two folders atthe same level are called "MyFolder", Policy Manager creates "MyFolder" and"MyFolder 1".

Possible values:

■ true (default)

■ false

Examples:

If MergePSTFolders is set to false and you migrate three PST files that have thedisplay name "Personal Folders", and all contain top-level folders "Inbox" and"Sent Items", then you get a structure like the following:

PST Migration (specified by MailboxFolder)

Personal Folders

Inbox

Sent Items

Personal Folders 1

Inbox

Sent Items

Personal Folders 2

Inbox

Sent Items

Policy ManagerInitialization file sections and keynames

170

PSTLanguageMandatory for Outlook 97 to Outlook 2002 PST files. Specifies the Windowscodepage thatwasusedwhen thePSTswere created.Youmust specify the languagehere, in the [PSTdefaults] section, or, for individual PST files, in the [PST] section.

Note the following if the language used was not Western European:

■ If the wrong codepage is used, limitations in Exchange Server mean that thefolder names may be corrupted. However, there are no problems with itemswithin the folders.

■ If a folder name is corrupted, you may experience the following problems:

■ The corrupt folder name is used if a user ever chooses to restore an itemto its original folder.

■ Auserwhowants to search for an item, andwhoenters the original location,must enter the corrupt folder name.

To avoid these problems, specify the language that was used when the PSTswere created.

■ The language that you specify here must be available on the Storage Servicecomputer that archives the contents of the PST files. If you need to installextra languages, see the following article in the Microsoft Knowledge Base:How To Add and Enable Additional Languages in Windows

Possible values:

■ Arabic

■ Baltic

■ Central European

■ Cyrillic

■ Greek

■ Hebrew

■ Japanese

■ Korean

■ Simplified Chinese

■ Thai

■ Traditional Chinese

■ Turkish

■ Vietnamese

171Policy ManagerInitialization file sections and keynames

■ Western European (default)

RetentionCategoryOptional. Specifies the name or ID of the retention category to apply to themigrated PST items.

Although RetentionCategory is optional, Policy Manager must be able to obtaina retention category from somewhere.

Policy Manager takes the first retention category it finds in the following:

■ The file’s RetentionCategory setting in the [PST] section.

■ If MailboxDN is specified in the [PST] section, the default retention categoryfor that mailbox.See “MailboxDN” on page 157.

■ If ArchiveName is specified in the [PST] section, the default retention categoryfor the mailbox that is associated with that archive.See “ArchiveName” on page 155.

Possible values:

■ A retention category name

■ A retention category ID

ServerComputerNameOptional. Identifies the computer that is running the Storage Service. If you omitServerComputerName, Policy Manager uses the name of the computer on whichit is running.

Possible values:

A computer identification, which can be its LanMan name, DNS name, or IPaddress.

Examples:

■ LanMan: SERVER2

■ DNS: server2.Symantec.com

■ IP address: 18.94.12.3

ShortcutModeOptional. Defines the PSTmigrationmode,which determines howPolicyManagertreats the contents of the PST at the end of the migration.

Policy ManagerInitialization file sections and keynames

172

Possible values:

Create shortcuts to the migrated items and leave the shortcuts inthe PST files.

PSTShortcuts (default)

Create shortcuts to themigrated items and put the shortcuts intothe designated Exchange mailbox. Also copies to the mailbox anyitems that were excluded from archiving.

MailboxShortcuts

Do not create any shortcuts to migrated items. Any items thatwere excluded from archiving remain in the PST files.

NoShortcuts

SetPSTHiddenOptional. Controlswhether the PST file is set as hidden after successfulmigrationof its contents. If you have set your desktop so that it does not show hidden files,this hides thePST files that youhavemigrated successfully. This option is providedfor compatibility with the PST Migrator wizard and is not likely to be used inscripted migrations.

Possible values:

■ true

■ false (default)

SetPSTReadOnlyOptional. Controls whether the PST file is set to be read-only after the successfulmigration of its contents. This prevents users fromopening the fileswithOutlook.

Possible values:

■ true

■ false (default)

[PSTcheckpoint] sectionDo not include this section, which Policy Manager generates automatically.

CreatedSpecifies the creation date and time of the new initialization file generated byPolicy Manager.

173Policy ManagerInitialization file sections and keynames

GenerationProvides a number that indicates the restart sequence number. This number isincremented each time you run the initialization file. It is also appended to thename of the initialization file to make the name of the new initialization file.

For example, suppose that your original initialization file is calledmigrate-these.ini. If you run Policy Manager with this file, you produce a newfile that is called migrate-these_1.ini and that contains details of any problems.You can fix the problems that are indicated in this new file and then run it asbefore.

SourceSpecifies the path and file name of the original Policy Manager initialization file.

PSTFailedCountShows the total number of PST files that are listed in this initialization file andthat cannot be migrated. Each of these migrated files also has a JobStatus entryof Failed.

PSTIncompleteCountGenerated by a process mode run. Shows the number of PST files that were beingprocessedwhenPolicyManagerwas interrupted. This number is nevermore thanone.

Each of these migrated files also has a JobStatus entry of Incomplete.

PSTNotReadyCountGenerated by a report mode run. A problem with this PST file has preventedprocessing. Policy Manager has added a DONOTPROCESS = TRUE line to the [PST]section.

PSTPartialCountGenerated by a process mode run. Shows the number of PSTs that contain one ormore items that cannot be migrated. All these items have been placed in a folderthat is called PST Migration Failed Items in the PST file.

Each of these migrated files also has a JobStatus entry of Partially_Processed.

Policy ManagerInitialization file sections and keynames

174

PSTProcessedCountGenerated by a process mode run. Shows the number of PST files that weresuccessfully migrated on the previous run of the script. These files are still listedin the restart script, but their sections are commented out.

Each of these migrated files also has a JobStatus entry of Processed.

PSTUnprocessedCountGenerated by a process mode run. Shows the number of PST files that were listedin this file and that were ignored in the last run.

Each of these migrated files also has a JobStatus entry of Unprocessed.

PSTWarningCountGenerated by a report mode run. Shows the number of marked PST files whosemarked settings are being overridden in the initialization file. You can find thesefiles by searching for "Report_Status: Warning".

[NSFDefaults] sectionThis section is mandatory when you use Policy Manager to migrate the contentsof NSF files to Enterprise Vault.

Use this section to specify the default settings that apply to NSF migrations. Youcan override these default settings for individual NSF files in the [NSF] section ofthe initialization file.

See “[NSF] section” on page 180.

If you donot specify a value for an optional keyname in the [NSFDefaults] section,Policy Manager uses the value that is marked as "default" as the default setting.

ArchiveUnExpiredCalItemsOptional. Controlswhether PolicyManagermigrates theunexpired calendar itemsthat are contained in the NSF files. If you choose to migrate unexpired calendaritems, users must restore the items before they can modify them.

Possible values:

■ True

■ False (default)

175Policy ManagerInitialization file sections and keynames

CompactNSFOptional. Controlswhether theNSF files are compacted after successfulmigration.

Possible values:

■ True (default)

■ False

ConcurrentMigrationsOptional. Sets the maximum number of concurrent NSF migrations. This settingtakes effect only when MigrationMode is set to Process.

See “MigrationMode” on page 178.

Possible values:

■ An integer in the range 1 (default) to 5

DeleteNSFOptional. Controls whether the NSF files are deleted after successful migration.

Possible values:

■ True

■ False (default)

IgnoreInsufficientMailFileAccessOptional. By default, EVPM does not process an NSF file if the Domino archivinguser does not have sufficient access set the ACL of the corresponding mail file.Set this keyname to True to override this default behavior.

Possible values:

■ True

■ False (default)

IgnoreNoManagerAccessOptional. By default, EVPM does not process an NSF file if the Domino archivinguser does not have manager access set in the ACL of the corresponding mail file.Set this keyname to True to override this default behavior.

Possible values:

■ True

Policy ManagerInitialization file sections and keynames

176

■ False (default)

IgnoreNonExistentMailFileOptional. By default, EVPM does not migrate the contents of NSF files whoseassociated mail file is not available. Set this keyname to True to override thisdefault behavior.

Possible values:

■ True

■ False (default)

IgnoreNonStandardTemplateOptional. By default, EVPM does not process an NSF file that is based on anon-standard template. The list of standard templates is determined by a registrystring value which is called DominoMailTemplates under the following registrykey on all the storage servers:

HKEY_LOCAL_MACHINE

\SOFTWARE

\KVS

\Enterprise Vault

\Agents

Set this keyname toTrue to override this default behavior andmigrate the contentsof NSF files that are based on non-standard templates.

Possible values:

■ True

■ False (default)

IncludeTrashOptional. Controls whether Policy Manager migrates the deleted items from theTrash folders in the NSF files.

Possible values:

■ True

■ False (default)

177Policy ManagerInitialization file sections and keynames

MailFileFolderOptional. Sets the name of the migration target folder. Policy Manager createsthis folder beneath the Folders view in each user’s mail file, if it does not existalready. PolicyManager then places shortcuts andmigrated content in this folder.

Possible values:

■ A folder name. For example, NSF items. If you do not specify a folder name,Policy Manager uses the default name Notes Archive.

MergeNSFFoldersOptional. For users who have multiple NSF files, MergeNSFFolders controlswhether the NSF files’ folder structures are merged or kept separate in the users’mail files.

Possible values:

■ True (default). Merge the folder structures that are contained inmultiple NSFfiles. For example, two NSF files that belong to one user, both contain a foldercalled Personal. Policy Manager places the shortcuts to the contents of thesefolders in a merged Personal folder in the user’s mail file.

■ False. Keep separate the folder structures frommultipleNSF files. In the user’smail file, a new folder is created for each NSF file, and the shortcuts to itscontents are placed in the folders.

MigrationModeMandatory. Controls whether Policy Manager runs in report mode or in processmode.

Possible values:

■ Report. PolicyManager checks eachNSF file listed in the [NSF] sections of theinitialization file, to determine whether it can migrate the file’s contents.Policy Manager creates a new initialization file, which contains a count of allthe files that are not ready for migration. In the new initialization file, anyNSF file which cannot be migrated has the entry DoNotProcess=True addedto its [NSF] section. This setting prevents Policy Manager from attempting toprocess the file when it is next run in process mode.The new initialization file has the same name as the original, with a numberappended to make it unique. For example, if the original file was calledNSFMigration.ini, the new file is called NSFMigration_1.ini.

■ Process. Policy Manager migrates items from the NSF files that are listed inthe [NSF] section, andgenerates summaryanddetailed reports. PolicyManageralso writes a new initialization file. You can use the new file to migrate any

Policy ManagerInitialization file sections and keynames

178

failed files when you have corrected the problems that prevented theirmigration. Each NSF file has a JobStatus entry added to its [NSF] section ofthenew initialization file. For example, the files thatwere successfullymigratedhave JobStatus=Processed added to the [NSF] section. Policy Manager doesnot attempt to migrate these files again when you use the new initializationfile for the next migration run.The new initialization file has the same name as the original, with a numberappended to make it unique. For example, if the original file was calledNSFMigration.ini, the new file is called NSFMigration_1.ini.

RetentionCategoryMandatory. Specifies the name of the default retention category that is appliedto items during migration.

Possible values:

■ A retention category name

■ A retention category ID

SetNSFHiddenOptional. Controls whether PolicyManager sets the hidden attribute onNSF filesafter successfulmigration. This option is provided for compatibility with theNSFmigrator wizard and is not likely to be used in scripted migrations.

Possible values:

■ True

■ False (default)

SetNSFReadOnlyOptional. Controls whether Policy Manager sets the read-only attribute on NSFfiles after successful migration. This setting prevents users from adding newitems to the NSF files after migration.

Possible values:

■ True

■ False (default)

ShortcutModeOptional. Controls what Policy Manager does with the contents of the NSF filesafter migration.

179Policy ManagerInitialization file sections and keynames

Possible values:

■ MailFileShortcuts (default). Creates shortcuts to the migrated items and putsthem in the users’ mail files.

■ NSFShortcuts. Creates shortcuts to themigrated itemsand leaves the shortcutsin the NSF files.

■ NoShortcuts. Does not create any shortcuts tomigrated items. Any items thatwere excluded from archiving remain in the NSF files.

[NSF] sectionThe initialization filemust contain one [NSF] section for eachNSF file youmigrate.Each [NSF] section must contain at least a FileName setting to specify the nameand location of the NSF file. You can also make further migration settings in the[NSF] section to override thedefault settings that are specified in the [NSFDefaults]section.

See “[NSFDefaults] section” on page 175.

ArchiveNameOptional. Specifies the name or the ID of the archive to which Policy Managermigrates the items from the current the NSF file.

Note: In the [NSF] section, you can set either the ArchiveName or the UserCN.You cannot set both.

See “UserCN” on page 185.

Thiskeyname isoptional becausePolicyManager canautomaticallymatcharchivesto NSF files. However, it always uses the first archive that has a matching name.If there are archives with duplicate names, items can be migrated to the wrongarchives. To avoid this issue, use ArchiveName to specify the ID of an archive foreach NSF file.

You can find the ID of an archive on the Advanced tab of the archive’s propertiespage in the administration console.

Possible values:

■ The ID of the target archive

■ The name of the target archive

Policy ManagerInitialization file sections and keynames

180

ArchiveUnExpiredCalItemsOptional. Controls whether Policy Manager migrates unexpired calendar itemsfrom the current NSF file. If you choose to migrate unexpired calendar items,users must restore the items before they can modify them.

Possible values:

■ True

■ False

CompactNSFOptional. Controls whether the current NSF file is compacted after successfulmigration.

Possible values:

■ True

■ False

DeleteNSFOptional. Controls whether the current NSF file is deleted after successfulmigration.

Possible values:

■ True

■ False

DoNotProcessOptional. When Policy Manager runs in report mode (MigrationMode=Report), itwrites a new initialization file. In the new file, it sets DoNotProcess to True forany NSF file on which it encounters errors. This setting prevents Policy Managerfrom processing the NSF file when you run it again in process mode(MigrationMode=Process), using the new initialization file.

Policy Manager ignores this setting when it runs in report mode.

See “MigrationMode” on page 178.

Possible values:

■ True

■ False (default)

181Policy ManagerInitialization file sections and keynames

FileNameMandatory. Specifies the path and the file name of each NSF file.

Note:You should use UNC paths to specify the locations of the NSF files. The NSFmigrator server that processes the NSF files might be on a different computerfrom the one on which you run EVPM. Additionally, the NSF migrator servermight rununder a different user context from the oneunderwhich you runEVPM.In both these cases, only fullUNCpaths provide a reliableway for theNSFmigratorserver to access the files.

Examples:

■ \\Server1\home\JohnDoe\quarter1.nsf

■ E:\data\backup.nsf

IgnoreInsufficientMailFileAccessOptional. By default, EVPM does not process an NSF file if the Domino archivinguser does not have sufficient access set the ACL of the corresponding mail file.Set this keyname to True to override this default behavior for the current NSFfile.

Possible values:

■ True

■ False (default)

IgnoreNoManagerAccessOptional. By default, EVPM does not process an NSF file if the Domino archivinguser does not have manager access set in the ACL of the corresponding mail file.Set this keyname to True to override this default behavior for the current NSFfile.

Possible values:

■ True

■ False (default)

IgnoreNonExistentMailFileOptional. By default, EVPM does not migrate the contents of NSF files whoseassociated mail file is not available. Set this keyname to True to override thisdefault behavior for the current NSF file.

Policy ManagerInitialization file sections and keynames

182

Possible values:

■ True

■ False (default)

IgnoreNonStandardTemplateOptional. By default, EVPM does not process an NSF file that is based on anon-standard template. The list of standard templates is determined by a registrystring value which is called DominoMailTemplates under the following registrykey on all the storage servers:

HKEY_LOCAL_MACHINE

\SOFTWARE

\KVS

\Enterprise Vault

\Agents

Set this keyname toTrue to override this default behavior andmigrate the contentsof the current NSF files if it is not based on non-standard templates.

Possible values:

■ True

■ False (default)

IncludeTrashOptional. Controls whether Policy Manager migrates the deleted items from theTrash folder in the current NSF file.

Possible values:

■ True

■ False

JobStatusPolicy Manager writes a JobStatus in each [NSF] section of the new initializationfile when it runs in process mode. This value indicates the status of each NSF fileafter the last process run.

See “MigrationMode” on page 178.

Possible values:

■ Failed. The NSF file failed migration.

183Policy ManagerInitialization file sections and keynames

■ Partially_Processed. The NSF file contains items that Policy Manager wasunable to migrate.

■ Processed. Policy Manager migrated the NSF file successfully.

■ Unprocessed. Policy Manager ignored the NSF file.

MailFileFolderOptional. Sets the name of the migration target folder. Policy Manager createsthis folder beneath the Folders view in the user’s mail file, if it does not existalready. PolicyManager then places shortcuts andmigrated content in this folder.

Possible values:

■ A folder name. For example, NSF items. If you do not specify a folder name,Policy Manager uses the default name that the setting in the [NSFDefaults]section of the initialization file determines.

MergeNSFFoldersOptional. For auserwhohasmultipleNSF files,MergeNSFFolders controlswhetherthe folder structures they contain are merged or kept separate in the user’s mailfile.

Possible values:

■ True.Merge the folder structures that are contained inmultiple NSF files. Forexample, two NSF files that belong to one user, both contain a folder that iscalled Personal. The shortcuts to the contents of these folders are placed in amerged Personal folder in the user’s mail file.

■ False. Keep separate the folder structures from multiple NSF files. Beneaththe Folders view in the user’s mail file, a new folder is created for each NSFfile. The shortcuts to the contents of these NSF files are placed in thecorresponding folders.

RetentionCategoryOptional. Specifies the name of the retention category that is applied to itemsfrom the current NSF file during migration.

Possible values:

■ A retention category name

■ A retention category ID

Policy ManagerInitialization file sections and keynames

184

SetNSFHiddenOptional. ControlswhetherPolicyManager sets thehiddenattribute on the currentNSF file after successfulmigration. This option is provided for compatibility withthe NSF migrator wizard and is not likely to be used in scripted migrations.

Possible values:

■ True

■ False

SetNSFReadOnlyOptional. Controls whether Policy Manager sets the read-only attribute on thecurrent NSF file after successful migration. This prevents the user from addingnew items to the NSF file after migration.

Possible values:

■ True

■ False

ShortcutModeOptional. Controls what Policy Manager does with the contents of the currentNSF file after migration.

Possible values:

■ MailFileShortcuts. Create shortcuts to themigrated items and put them in theuser’s mail file. Also copies to the mail file any items that were excluded fromarchiving.

■ NSFShortcuts. Create shortcuts to themigrated items and leave the shortcutsin the NSF file.

■ NoShortcuts. Do not create any shortcuts to migrated items. Any items thatwere excluded from archiving remain in the NSF file.

UserCNOptional. Specifies the canonical name (CN) of the user whose archive and mailfile are the targets for the migration of the current NSF file.

Note: In the [NSF] section, you can set either the ArchiveName or the UserCN.You cannot set both.

See “ArchiveName” on page 180.

185Policy ManagerInitialization file sections and keynames

Possible values:

■ Canonical form of the user name in the user's person record. For example foruser John Doe/Acme, the canonical name form is cn=John Doe/o=Acme

[NSFCheckPoint] sectionDo not include this section, which Policy Manager generates automatically.

Policy Manager creates an [NSFCheckPoint] section when it writes a newinitialization file. This section contains information about the new initializationfile, and statistics about the run of Policy Manager that created the file.

In some cases the values that Policy Manager writes to the new initialization filedepend on the setting of MigrationMode on the [NSFDefaults] section.

See “MigrationMode” on page 178.

CreatedShows the creation date and time of the new initialization file.

GenerationShows the number that was appended to the name of the new initialization filethat Policy Manager generates. This number is incremented each time you runPolicy Manager.

SourceShows the path and the file name of the original initialization file.

NSFFailedCountThis value is generated when Policy Manager runs in Process mode.

Shows the number of NSF files that are listed in this initialization file, but cannotbe migrated. For each NSF file that cannot be migrated, Policy Manager writesJobStatus = Failed in the relevant [NSF] section of the new initialization file.

NSFNotReadyCountThis value is generated when Policy Manager runs in Report mode.

Shows the number of NSF files that are listed in this initialization file, but are notready. For each NSF file that is not ready, Policy Manager writes DoNotProcess =True in the relevant [NSF] section of the new initialization file.

Policy ManagerInitialization file sections and keynames

186

NSFPartialCountThis value is generated when Policy Manager runs in Process mode.

Shows the number of NSF files that are listed in the initialization file, and containone or more items that cannot be migrated. All these items have been placed in afolder that is called NSF Migration Failed Items in the NSF file. If Policy Manageris interrupted, NSFPartialCount also includes the number of NSF files that werebeing processed when the interruption took place.

For each NSF file that is partially processed, Policy Manager writes JobStatus =Partially_Processed in the relevant [NSF] section of the new initialization file.

NSFProcessedCountThis value is generated when Policy Manager runs in Process mode.

Shows the number of NSF files that are listed in the initialization file, and weresuccessfully migrated on the previous Policy Manager run. These files are stilllisted in the initialization file. However, for eachNSF file that is processed, PolicyManager writes JobStatus = Processed in the relevant [NSF] section of the newinitialization file. This setting prevents Policy Manager from processing the filesagain when you use the new initialization file.

NSFUnprocessedCountThis value is generated when Policy Manager runs in Process mode.

Shows the number of NSF files that were listed in this file but ignored in the lastPolicy Manager run. Policy Manager ignores any NSF files with the followingsettings:

■ JobStatus = Processed

■ DoNotProcess = True

For each NSF file that is ignored because DoNotProcess is set to True, PolicyManager writes JobStatus =Unprocessed in the relevant [NSF] section of the newinitialization file.

Initialization file examplesThe following sections provide examples of what to include in an initializationfile.

Example 1This initialization file does the following:

187Policy ManagerInitialization file examples

■ Enables a mailbox.

■ Creates a default archive for the mailbox.

■ Applies the system default filter and retention category to the mailbox.

[Directory]

DirectoryComputerName= myserver

SiteName = MattSite

[Mailbox]

DistinguishedName = /o=Org1/ou=Admin Group/cn=Recipients/cn=jones

[Folder]

Name = mailboxroot

Enabled = true

Example 2This initialization file does the following:

■ Defines a filter that archives all items older than one month.

■ Creates a "Personal Archive" folder in all mailboxes and applies the filter tothe folder.

■ Applies the Personal retention category to the new Personal Archive folder.

[Directory]

directorycomputername = myserver

sitename = MattSite

[Filter]

name = filter1

CreateShortcut = true

DeleteOriginal = true

unreadMAIL = false

UseInactivityPeriod = true

InactivityUnits = months

InactivityPeriod = 1

[Mailbox]

distinguishedname = all

[Folder]

name = \personal archive

filtername = filter1

retentioncategory = personal

Example 3This initialization file does the following:

Policy ManagerInitialization file examples

188

■ Defines a filter that archives all read items older than three weeks.

■ Creates an archive that is called "shared finance archive", with smithj as thebilling account and a description of "Shared archive for all finance users".

■ Grants all members of the group enterprise\financeusers write access to thenew archive.

■ Enables all users in department finance, and sets the system default filter atthe root of each mailbox and the Business retention category.

■ Creates a folder that is called "finance archive folder" and applies thenewly-created archive and the Business retention category to it.

[Directory]

directorycomputername = myserver

sitename = MattSite

[Filter]

name = filter1

CreateShortcut = true

DeleteOriginal = true

unreadMAIL = false

UseInactivityPeriod = true

InactivityUnits = weeks

InactivityPeriod = 3

[Archive]

ArchiveName = Shared Finance Archive

description = Shared archive for all finance users

billingOwner = enterprise\smithj

[ArchivePermissions]

ArchiveName = Shared Finance Archive

GrantAccess = write, enterprise\financeusers

[Mailbox]

ldapquery = (department= finance)

[Folder]

name = mailboxroot

enabled = true

suspended = false

filtername = systemdefault

RetentionCategory = business

[Folder]

name = \Finance Archive Folder

filtername = filter1

retentioncategory = Business

ArchiveName = Shared Finance Archive

189Policy ManagerInitialization file examples

Example 4: PST migrationThis initialization file does the following:

■ Defines the default PSTmigration settings that apply to all the PST files. Thesesettings are not overridden in any of the [PST] sections in the initializationfile.

■ Lists three PST files whose contents are to be migrated to Enterprise Vault.No destination mailboxes are specified because their owners have opened allthe PST files, and so they have been marked.

The default settings make Policy Manager do the following:

■ Migrates all the PST file contents to the appropriatemailboxes, including itemsthat are in the Deleted Items folder.

■ Place shortcuts to migrated items into the owning mailboxes. The shortcutsall go into a folder that is called "PST Migrations".

■ After successful migration, compact PST files and make them read-only.

■ Cancel OutlookAutoArchive. This stopsOutlook fromautomatically archivingitems to PST files.

[Directory]

directorycomputername = myserver

sitename = vs1

[PSTdefaults]

;

; Default option settings applicable to all PST migrations

;

PSTLanguage=Western European

servercomputername = myserver.kvsinc.com

MailboxFolder = PST Migrations

MigrationMode = PROCESS

IncludeDeletedItems = true

SetPSTHidden = false

SetPSTReadOnly = true

CompactPST = true

DeletePST = false

CancelMbxAutoArchive = true

;

; Individual PST migration settings

;

[PST]

fileName = \\myserver\share\test1.pst

[PST]

Policy ManagerInitialization file examples

190

fileName = \\myserver\share\test2.pst

[PST]

fileName = \\myserver\share\test3.pst

Example 5: NSF migrationThe [NSFDefaults] section in this initialization file does the following:

■ Turns on process mode

■ Allows two concurrent migrations

■ Sets Business as the default retention category

■ Turns on the migration of Trash items

■ Specifies that the read-only attributes on NSF files are set after successfulmigration

The subsequent [NSF] sections specify the locations and the names of individualNSF files. Some of these settings override the default migration settings.

[Directory]

DirectoryComputerName = DominoServer

sitename = EV1

; Default option settings applicable to all NSF migrations

[NSFDefaults]

MigrationMode = Process

ConcurrentMigrations = 2

RetentionCategory = Business

IncludeTrash = True

SetNSFReadOnly = True

; Individual NSF migration settings

[NSF]

FileName = \\FileServer\e$\Users\UserA\Archive.nsf

DeleteNSF = True

IncludeTrash = False

[NSF]

FileName = \\FileServer\e$\Users\UserB\Q1.nsf

ArchiveName = User B/Symantec

SetNSFReadOnly = False

191Policy ManagerInitialization file examples

[NSF]

FileName = \\FileServer\e$\Users\UserC\Personal.nsf

UserCN = CN=John Doe/O=Symantec

RetentionCategory = Personal

Example 6: folder permissionsThis initialization file does the following:

■ Applies the initial permissions to a new folder.

■ Modifies the existing user permissions on a folder.

■ Removes the existing user permissions from a folder.

■ Applies some permissions to the public folder.

[DIRECTORY]

DIRECTORYCOMPUTERNAME = OURSERVER

SITENAME = CC_Site1

[mailbox]

DISTINGUISHEDNAME = /O=ACME/OU=DEVELOPER/CN=RECIPIENTS/CN=SUES

;

;----------------------------------------------------------

; 1. Apply initial permissions to a new folder

;

[Folder]

Name = \New Folder

MailboxDN = /O=ACME/OU=DEVELOPER/CN=RECIPIENTS/CN=SUES

;

; User specified as Mailbox DN

;

ExchangePermissions

=/O=ACME/OU=DEVELOPER/CN=RECIPIENTS/CN=SUES:OWNER

;

; Add additional user specified by GAL user name

;

ExchangePermissions = Charles Parker:Contributor; John Gillespie:

Reviewer

;----------------------------------------------------------

; 2. Modify existing user permissions on an existing folder

;

[Folder]

Name = \Existing Folder

MailboxDN = /O=ACME/OU=DEVELOPER/CN=RECIPIENTS/CN=SUES

;

Policy ManagerInitialization file examples

192

; Modify existing user

;

ExchangePermissions = +; John Gillespie:Editor

;----------------------------------------------------------

; 3. Remove existing user permissions on an existing folder

;

[Folder]

Name = \Existing Folder

MailboxDN = /O=ACME/OU=DEVELOPER/CN=RECIPIENTS/CN=SUES

;

; Remove existing users

;

ExchangePermissions = -; Charles Parker; John Gillespie

;----------------------------------------------------------;

; 4. Apply permissions to public folder

;

[PUBLICFOLDER]

Name = \Our Public Folder

ExchangePermissions =Charles Parker:reviewer

APPLYTOSUBFOLDERS = false

Using the Provisioning API to run Policy Managerscripts

TheProvisioningAPI allows application service providers (ASPs) to automaticallyenable or disable mailboxes for new customers. For example, you could set up aWeb page that lets users sign up for the site, which in turn automatically enablesmailboxes for them.

Scripting propertiesTheAPI uses a scriptable object to allow enabling and disabling ofmailboxes. Youcan set set the following properties on the object before enabling or disabling amailbox:

Required properties:

■ Directory

■ SiteId

■ ExchangeServer

■ SystemMailbox (this mailbox must exist)

193Policy ManagerUsing the Provisioning API to run Policy Manager scripts

Either of the following properties is required. They are mutually exclusive, sosetting one clears the other:

■ MailboxDN

■ LDAPQuery (allows enabling and disabling of multiple mailboxes at the sametime)

If the following optional properties are not set, the script uses default settings:

■ VaultStore

■ RetentionCategory

■ IndexingService

■ Timeout (the time allowed for the script to run before it is aborted)

If you supply this standard set of properties, the code generates a script and runsit.

Methods are available on the object to enable anddisable amailbox. Thesemethodsuse the settings above to generate a script to enable or disable a mailbox or set ofmailboxes matching the DN or LDAP query.

Example provisioning script

\'

' Enable a mailbox

'

Dim Enabler

Set Enabler = CreateObject("EnterpriseVault.ExchangeArchivePoint")

Enabler.Directory = "MACHINE1"

Enabler.Site = "site1" '(Entry Id or Site Name)

Enabler.ExchangeServer = "DITTO" '(Entry Id or Exchange Name)

Enabler.SystemMailbox = "EnterpriseVault-DITTO"

Enabler.MailboxDN = "/o=Eng2000/ou=First Administrative

Group/cn=Recipients/cn=Bruiser"

Enabler.VaultStore = "VaultStoreMain" '(Entry Id or Vault Store

Name)

Enabler.RetentionCategory = "Business" '(Entry Id or Retention

Category Name)

Enabler.IndexingService = "MACHINE1"

Enabler.Enable

'

' Disable a mailbox

'

Policy ManagerUsing the Provisioning API to run Policy Manager scripts

194

Dim Enabler

Set Enabler = CreateObject("EnterpriseVault.ExchangeArchivePoint")

Enabler.Directory = "MACHINE1"

Enabler.Site = "site1" '(Entry Id or Site Name)

Enabler.ExchangeServer = "DITTO" '(Entry Id or Exchange Name)

Enabler.SystemMailbox = "EnterpriseVault-DITTO"

Enabler.MailboxDN = "/o=Eng2000/ou=First Administrative

Group/cn=Recipients/cn=Bruiser"

Enabler.Disable

After the script has been run, the read-only properties ReportText and LastScriptare available to return information on the script.

Advanced settingsThe basic scripting object covers the simple case in which a user wishes to enableor disable a mailbox using some basic settings. More advanced settings let youapply per-folder settings.

SetScript methodsThe SetScript methods let you provide a template as either a text string or a file.The API uses the template and replaces the values in it by a combination ofproperties set on the object and the values from the array passed into the followingmethods:

SetScriptText(Text, ArryOfParameters)

SetScriptFile(Filename, ArryOfParameters)

The SetScript methods allow a custom string or file to be passed in and used as atemplate. The array of parameters lets you use a list of substitutions on thetemplate, if required.

Sample script for advanced settings

Script1.ini

[Directory]

DirectoryComputerName= #DIRECTORY#

SiteName = #SITE#

[Mailbox]

DistinguishedName = #MAILBOX#

[Folder]

Name = mailboxroot

Enabled = #1#

195Policy ManagerUsing the Provisioning API to run Policy Manager scripts

The special values #DIRECTORY#, #SITE#, and #MAILBOX# are automaticallyreplaced by the properties Directory, Site, and MailboxDN set on the object.

Table 19-1 Special values

Object property nameSpecial value

Directory#DIRECTORY#

IndexingService#INDEXINGSERVICE#

LDAPQuery#LDAPQUERY#

MailboxDN#MAILBOX#

RetentionCategory#RETENTIONCATEGORY#

Site#SITE#

VaultStore#VAULTSTORE#

The value #1# is replaced by the first item in theArrayOfParameters array passedinto the SetScriptFile or SetScriptText method. If more items are added to thearray, the values #2#, #3#, and so on are replaced.

Example of enabling a mailbox using a script file

Dim ArrayOfParameters(0)

ArrayOfParameters(0) = "true"

Dim Enabler

Set Enabler = CreateObject("EnterpriseVault.ExchangeArchivePoint")

Enabler.Directory = "MACHINE1"

Enabler.Site = "site1" '(Entry Id or Site Name)

Enabler.ExchangeServer = "DITTO" '(Entry Id or Exchange Name)

Enabler.SystemMailbox = "EnterpriseVault-DITTO"

Enabler.MailboxDN = "/o=Eng2000/ou=First Administrative

Group/cn=Recipients/cn=Bruiser"

Enabler.SetScriptFile ("C:\MyScripts\Script1.ini", ArrayOfParameters)

Enabler.ExecuteScript ' runs the EVPM script against the script1.ini

file after making the substitutions in the strings.

Policy ManagerUsing the Provisioning API to run Policy Manager scripts

196

Interface methodsThe full set of methods follows.

Disable methodThe Disable method takes no arguments. The Directory, SiteId, ExchangeServer,SystemMailbox, and MailboxDN/LDAPQuery properties must be set before thismethod is called.

HRESULT Disable()

Enable methodThe Enable method takes no arguments. The Directory, SiteId, ExchangeServer,SystemMailbox, and MailboxDN/LDAPQuery properties must be set before thismethod is called.

HRESULT Enable()

ExecuteScript methodThe ExecuteScript method takes no arguments. Instead, it uses text or a file asspecifiedwith the SetScriptFile or SetScriptTextmethod and runs that script. TheDirectory, SiteId, ExchangeServer, SystemMailbox, and MailboxDN/LDAPQueryproperties must be set before this method is called.

HRESULT ExecuteScript()

SetScriptFile methodThe SetScriptFile method specifies the file name of a Policy Manager script thatyou want to run.

HRESULT SetScriptFile(BSTR newVal, VARIANT vArrayOfParams)

Table 19-2 Arguments on the SetScriptFile method

DescriptionArgument

A string containing the file name of the PolicyManager script to run.

newVal

An array of variants used to performsubstitutions.

VARIANT vArrayOfParams

197Policy ManagerUsing the Provisioning API to run Policy Manager scripts

SetScriptText methodThe SetScriptText method specifies a Policy Manager script to run.

HRESULT SetScriptText(BSTR newVal, VARIANT vArrayOfParams)

Table 19-3 Arguments on the SetScriptText method

DescriptionArgument

A string containing the Policy Manager script torun.

newVal

An array of variants used to performsubstitutions.

VARIANT vArrayOfParams

Error handlingWhen setting object properties, HRESULT errors are returned if the property isinvalid. If Policy Manager returns an error when calling EnableScript,DisableScript, or ExecuteScript, you can use the two properties available to helpwith tracing problems with the Provisioning API.

These properties are as follows:

Returns the report text from the previous run.ReportText

Returns the script from the previous run.LastScript

Table 19-4 describes the standard set of errors that the API returns.

Table 19-4 Provisioning API error codes

Message textError typeError code

The Directory Service nameis invalid or the DirectoryService is not running.

PROV_DIRECTORY_INVALID0xC004C000

TheDirectorypropertymustbe set first.

PROV_MUST_SET_DIRECTORY _FIRST0xC004C001

Could not create theEnterprise Vault DirectoryConnection object.

PROV_COULD_NOT_CREATE_DIRECTORYCONNECTION

0xC004C002L

The Entry Id is not valid.PROV_ENTRYID_INVALID0xC004C003

Invalid table ID.PROV_INVALID_TABLE_ID0xC004C004

Policy ManagerUsing the Provisioning API to run Policy Manager scripts

198

Table 19-4 Provisioning API error codes (continued)

Message textError typeError code

An error occurred replacingthe script parameters.

PROV_ERROR_INSERTING_PARAMETERS0xC004C005

One of the argumentssupplied in the argumentsarray could not be convertedto a string.

PROV_INVALID_ARG_ PARAMETER0xC004C006

The Site property must beset before this property.

PROV_MUST_SET_SITE_FIRST0xC004C007

Invalid property value.PROV_NAME_INVALID0xC004C008

The Indexing Service couldnot be found.

PROV_INDEXING_SVC_NOT_FOUND0xC004C009

The following propertiesmust be set beforeEnable/Disable canbe called:%n%nDirectory, Site,ExchangeServer,SystemMailbox, (MailboxDNor LDAPQuery).

PROV_NOT_ENOUGH_PROPERTIES_SET0xC004C00A

Failed to create a StdIn pipe.PROV_FAILED_CREATE_STDIN_PIPE0xC004C00B

Failed to create the StdOutpipe.

PROV_FAILED_CREATE_STDOUTERR_PIPE0xC004C00C

Failed to duplicate the stdhandle.

PROV_FAILED_DUPLICATE_HANDLE0xC004C00D

Failed to close the temporaryhandle.

PROV_FAILED_CLOSE_TEMP_HANDLE0xC004C00E

The password for the Logondetails was not set.

PROV_NO_PASSWORD_FOR_USER0xC004C00F

Failed to create the policymanager process.

PROV_CREATE_PROCESS_FAILED0xC004C010

Failed to create the policymanager process under thespecified account.

PROV_CREATE_PROCESS_AS_USER_FAILED0xC004C011

199Policy ManagerUsing the Provisioning API to run Policy Manager scripts

Table 19-4 Provisioning API error codes (continued)

Message textError typeError code

Could not log the user on forthe policy manager process.

PROV_LOGON_USER_FAILED0xC004C012

Failed towait for the processto complete.

PROV_WAIT_SINGLE_OBJECT_FAILED0xC004C013

Could not get the exit codefrom the policy managerprocess.

PROV_GETEXITPROCESS_FAILED0xC004C014

Could not get the temp filepath.

PROV_FAILED_GET_TEMP_PATH0xC004C015

Could not get the temp filename.

PROV_FAILED_GET_TEMP_FILE_NAME0xC004C016

Could not create theprovisioning initializationfile.

PROV_FAILED_CREATE_INI_FILE0xC004C017

Could not write theprovisioning initializationfile.

PROV_WRITE_WRITE_INI_FILE0xC004C018

Could not close theprovisioning initializationfile.

PROV_FAILED_CLOSE_INI_FILE0xC004C019

Failed to connect to theAdmin Service.

PROV_FAILED_COCREATE_POLICYINVOKER0xC004C01A

The second argument mustbe an array.

PROV_PARAMS_NOT_ARRAY0xC004C01B

The Script file could not befound.

PROV_SCRIPT_FILE_NOT_FOUND0xC004C01C

Script file is not unicode.PROV_INPUT_FILE_NOT_UNICODE0xC004C01D

Could not open theEnterprise Vault RegistryKey.

PROV_FAILED_OPEN_REGISTRY0xC004C01E

Could not read theInstallation directory fromthe registry.

PROV_FAILED_READ_REGISTRY0xC004C01F

Policy ManagerUsing the Provisioning API to run Policy Manager scripts

200

Table 19-4 Provisioning API error codes (continued)

Message textError typeError code

The script returned errors,check the report for details.

PROV_FAILED_EXECUTE0xC004C020

The script timed out.PROV_SCRIPT_TIMED_OUT0xC004C021

Failed to read the LogonDetails.

PROV_FAILED_READ_LOGON_DETAILS0xC004C022

201Policy ManagerUsing the Provisioning API to run Policy Manager scripts

Policy ManagerUsing the Provisioning API to run Policy Manager scripts

202

ResetEVClient

This chapter includes the following topics:

■ About ResetEVClient

■ ResetEVClient syntax

About ResetEVClientThe ResetEVClient utility fixes a number of problems with the Enterprise Vaultadd-in to Microsoft Outlook.

To do this, the utility does the following:

■ Deletes the Outlook data files extend.dat, frmcache.dat, and outcmd.dat.

The following table describes the function of these files.

Stores the registry entries for extensions to Outlook.Extend.dat

Stores the Outlook forms.frmcache.dat

Stores changes to the Outlook toolbar buttons.Outcmd.dat

The utility cannot delete these files while Outlook is running.

■ Checks the following registry key and sets the correct value for the EnterpriseVault add-in DLL:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Exchange\Client\

Extensions

The correct value for the Enterprise Vault add-in is as follows:

4.0;C:\WINDOWS\Downloaded Program

Files\Valkyrie.dll;1;01000000000100;1100010

20Chapter

■ Empties the user’s Temporary Internet Files folder. Users who cannot viewarchived items with any of the Enterprise Vault Web applications may findthat this fixes their problem.

ResetEVClient syntaxResetEVClient

Note: You must run this utility with Administrator privileges if the computer hasUser Account Control (UAC) enabled.

See “Running the command-line utilities with Administrator privileges”on page 15.

ResetEVClientResetEVClient syntax

204

Vault Store Usage Reporter

This chapter includes the following topics:

■ About Vault Store Usage Reporter

■ Starting Vault Store Usage Reporter

■ Setting up a shortcut link to Vault Store Usage Reporter

■ Understanding the usage summary

■ Troubleshooting

About Vault Store Usage ReporterVault Store Usage Reporter is a browser-based application that lets you obtainreports on current vault store usage. For a selected vault store, you can determineusage by archive or billing account.

You can use your Web browser to view the reports or download them astab-separated value files, suitable for use in your own analysis tools. Note thatthe reports may take some time to generate, depending on the size of the vaultstores and the performance of your system.

Starting Vault Store Usage ReporterYou can start Vault Store Usage Reporter from either a Web browser or theEnterprise Vault Administration Console.

21Chapter

To start Vault Store Usage Reporter from a Web browser

1 Log on as an administrator of Enterprise Vault.

If you want to see billing account details, the account you usemust also havepermissions within the Windows domain.

2 Open your Web browser.

3 Enter the Vault Store Usage Reporter address like this:

http://server/EnterpriseVault/usage.asp

For example:

http://vaultserver.company.com/EnterpriseVault/usage.asp

To start Vault Store Usage Reporter from the Administration Console

◆ In the left pane of the Administration Console, right-click the Vault StoreGroups container or a vault store and then click Reporting.

Note: If you have configured Enterprise Vault Reporting, Vault Store UsageReporter is only available from the shortcut menu of a vault store.

Setting up a shortcut link to Vault Store UsageReporter

By adding aVault StoreUsageReporter link to the left pane of theAdministrationConsole, you can quickly access usage reports from the console.

To set up a shortcut link to Vault Store Usage Reporter

1 Open the Administration Console.

2 On the File menu, click Add/Remove Snap-in.

3 On the Standalone tab of the Add/Remove Snap-in dialog box, click Add.

4 In the list of available standalone snap-ins, click Link to Web Address andthen click Add.

5 In the first page of the Link toWebAddress wizard, type the address of VaultStore Usage Reporter, and then click Next. The address is as follows:

http://server/EnterpriseVault/usage.asp

6 Type aname for the new link, such as "UsageReporter", and then clickFinish.

Vault Store Usage ReporterSetting up a shortcut link to Vault Store Usage Reporter

206

7 Click Close to close the Add Standalone Snap-in dialog box.

8 Click OK to close the Add/Remove Snap-in dialog box.

The new link appears in the left pane of the Administration Console.

Understanding the usage summaryTable 21-1 describes the information that the usage summary provides.

Table 21-1 Columns in the usage report.

DescriptionColumn

Identifies the vault stores. Click the name of a vault store to viewmoredetailed reports on it.

Vault Store

Provides some links with which you can save the reports intab-separated files. You can choose to sort the data by archive nameor billing account.

Save Report By

Shows the number of archives in the vault store that contain archiveditems.

Active Archives

Shows the total number of archived items in each vault store.Total Items

Shows the total size before archiving of all the items that are storedin the archive.

Total Size (MB)

Shows the number of archived items in the vault store that have notbeen backed up. This only applies if, when you configured the vaultstore to remove safety copies from mailboxes, you chose the AfterBackup or Never option on the General tab of the Vault StoreProperties dialog box.

Awaiting Backup

Identifies the SQL Server that hosts the vault store.SQL Server

The report also provides the following additional information:

■ The total number of vault stores

■ The total number of active archives in all vault stores

■ The total number of items in all vault stores

■ The total size of items in all vault stores

■ The average size of the archives in the vault store

■ The total number of items that are awaiting backup

207Vault Store Usage ReporterUnderstanding the usage summary

TroubleshootingIf you receive themessage Access Deniedwhen you try to run Vault Store UsageReporter, check that the IIS authenticationmethod is correctly set for the requiredfiles.

To check the IIS authentication method

1 Open Internet Information Services (IIS) Manager.

2 Expand the tree in the left pane until the EnterpriseVault virtual directoryis visible.

3 Click the EnterpriseVault virtual directory in the left pane to display itscontents in the right pane.

4 For the files listvaults.asp and usage.asp, perform the following steps inthe order listed:

■ Right-click the file in the right pane, and then click Properties.

■ In the properties sheet, click the File Security tab.

■ In the Authentication and access control box, click Edit.

■ In the Authenticated access box of the Authentication Methods dialogbox, ensure that only Basic authentication is checked.

■ Click OK to close the Authentication Methods dialog box, and then clickOK to close the properties sheet.

5 Restart IIS.

Vault Store Usage ReporterTroubleshooting

208