Setting up Exchange Server Archiving - Veritas · 2 ClickPolicies>Exchange>Mailbox. 3 Intherightpaneright-clickthepolicythatyouwanttosetasthedefaultpolicy, andselectSetasDefault

Veritas Enterprise Vault™

Setting up Exchange Server Archiving

12

Veritas Enterprise Vault: Setting up Exchange ServerArchiving

Last updated: 2015-12-09.

Legal NoticeCopyright © 2015 Veritas Technologies LLC. All rights reserved.

Veritas, the Veritas Logo, Enterprise Vault, Compliance Accelerator, and Discovery Acceleratorare trademarks or registered trademarks of Veritas Technologies LLC or its affiliates in theU.S. and other countries. Other names may be trademarks of their respective owners.

This product may contain third party software for which Veritas is required to provide attributionto the third party ("Third Party Programs"). Some of the Third Party Programs are availableunder open source or free software licenses. The License Agreement accompanying theSoftware does not alter any rights or obligations you may have under those open source orfree software licenses. For more information on the Third Party Programs, please see theThird Party Notice document for this Veritas product that is available athttp://www.veritas.com/about/legal/license-agreements#3rd-party.

The product described in this document is distributed under licenses restricting its use, copying,distribution, and decompilation/reverse engineering. No part of this document may bereproduced in any form by any means without prior written authorization of Veritas TechnologiesLLC and its licensors, if any.

THE DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIEDCONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIEDWARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE ORNON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCHDISCLAIMERS ARE HELD TO BE LEGALLY INVALID. VERITAS TECHNOLOGIES LLCSHALL NOT BE LIABLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES INCONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THISDOCUMENTATION. THE INFORMATION CONTAINED IN THIS DOCUMENTATION ISSUBJECT TO CHANGE WITHOUT NOTICE.

The Licensed Software and Documentation are deemed to be commercial computer softwareas defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq."Commercial Computer Software and Commercial Computer Software Documentation," asapplicable, and any successor regulations, whether delivered by Veritas as on premises orhosted services. Any use, modification, reproduction release, performance, display or disclosureof the Licensed Software and Documentation by the U.S. Government shall be solely inaccordance with the terms of this Agreement.

http://www.veritas.com/about/legal/license-agreements#3rd-party

Veritas Technologies LLC500 E Middlefield RoadMountain View, CA 94043

http://www.veritas.com

http://www.veritas.com

Technical SupportTechnical Support maintains support centers globally. Technical Support’s primaryrole is to respond to specific queries about product features and functionality. TheTechnical Support group also creates content for our online Knowledge Base. TheTechnical Support group works collaboratively with the other functional areas withinthe company to answer your questions in a timely fashion.

Our support offerings include the following:

■ A range of support options that give you the flexibility to select the right amountof 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 our support offerings, you can visit our website at the followingURL:

www.veritas.com/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:


Before contacting Technical Support, make sure you have satisfied the systemrequirements that are listed in your product documentation. Also, you should be atthe computer on which the problem occurred, 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 Technical Support

■ Recent software configuration changes and network changes

Licensing and registrationIf your product requires registration or a license key, access our technical supportwebpage at the following URL:


Customer serviceCustomer service information is available at the following URL:


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

■ Advice about technical support options

■ Nontechnical presales questions

■ Issues that are related to CD-ROMs, DVDs, or manuals



Support agreement resourcesIf you want to contact us regarding an existing support agreement, please contactthe support agreement administration team for your region as follows:

[email protected] (except Japan)

[email protected]

mailto:[email protected]

mailto:[email protected]

Technical Support ............................................................................................. 4

Chapter 1 About this guide ................................................................. 15

Introducing this guide .................................................................... 15Where to get more information about Enterprise Vault .......................... 15

“How To” articles on the Veritas Support website ........................... 17Enterprise Vault training modules ............................................... 18

Comment on the documentation ...................................................... 18

Chapter 2 Distributing Exchange Server Forms ........................... 19

About distributing the Microsoft Exchange forms when setting upExchange Server archiving ....................................................... 19Use of Personal Forms Libraries when setting up Exchange Server

archiving ........................................................................ 20About using the Organizational Forms Library when setting up

Exchange Server archiving ................................................. 20What next? ................................................................................. 23

Chapter 3 Setting up archiving from mailboxes ............................ 24

Points to note before you set up Enterprise Vault mailboxarchiving .............................................................................. 25Use of vault store groups, vault stores, and partitions with

Exchange Server mailbox archiving ...................................... 25Using Exchange Server database availability groups ..................... 25

Defining Exchange Server mailbox archiving policies ........................... 27Mailbox policy settings when setting up Exchange Server

archiving ........................................................................ 27Defining desktop policies in Exchange Server archiving ........................ 35

Desktop policy settings in Exchange Server archiving .................... 36Adding Exchange Server archiving targets ......................................... 45

Adding an Exchange server domain for archiving .......................... 45Adding an Exchange Server for archiving .................................... 46Adding a Provisioning Group for Exchange Server archiving ........... 46

Contents

Adding an Exchange Provisioning task for Exchange Serverarchiving .............................................................................. 49

Adding an Exchange Mailbox archiving task ....................................... 49Reviewing the default settings for the Enterprise Vault site .................... 50Using customized shortcuts with Exchange Server archiving ................. 52

Layout of ShortcutText.txt for customized shortcuts with ExchangeServer archiving ............................................................... 54

About editing automatic messages for Exchange Serverarchiving .............................................................................. 55Editing the Welcome message for Exchange Server

archiving ........................................................................ 55Editing Archive Usage Limit messages for Exchange Server

archiving ........................................................................ 56Starting the Task Controller service and archiving task when setting

up Exchange Server archiving ................................................... 57Enabling mailboxes for Exchange Server archiving .............................. 57

Creating shared archives for Exchange Server archiving ................ 58Installing the Outlook Add-In on a server for Exchange Server

archiving .............................................................................. 59Overriding PSTDisableGrow ........................................................... 59Users’ tasks for Exchange Server mailbox archiving ............................ 61

Chapter 4 Setting up users’ desktops ............................................. 62

About setting up users' desktops for Exchange Server archiving ............ 62Enterprise Vault Outlook Add-In for Exchange Server archiving .............. 63

Enabling Windows Desktop Search plug-in for Exchange Serverarchiving ........................................................................ 64

Publishing the Outlook Add-In in Active Directory for ExchangeServer archiving ............................................................... 65

Setting up manual installation of the Outlook Add-In ...................... 66Enterprise Vault Client for Mac OS X with Exchange Server

archiving .............................................................................. 68Setting up Kerberos authentication for the Enterprise Vault Client

for Mac OS X ................................................................... 69Forcing Outlook to synchronize forms when using Exchange Server

archiving .............................................................................. 70Getting users started with Exchange Server archiving .......................... 70

Configuring Windows Search for Exchange Server archiving ........... 71What next? ................................................................................. 71

8Contents

Chapter 5 Setting up Vault Cache and Virtual Vault .................... 72

About Vault Cache and Virtual Vault ................................................. 72Vault Cache content strategy .......................................................... 75Vault Cache synchronization ........................................................... 75

Vault Cache header synchronization and content download ............ 77Vault Cache and Virtual Vault status ........................................... 78Vault Cache initial synchronization ............................................. 79Control of concurrent content download requests by Vault

Cache ............................................................................ 79Enterprise Vault server cache location when using Vault

Cache ............................................................................ 79Retention category changes when using Virtual Vault .................... 79

Preemptive caching when using Vault Cache ..................................... 80The Vault Cache wizard ................................................................. 80Setting up Vault Cache and Virtual Vault ............................................ 81Vault Cache advanced settings ....................................................... 82

Download item age limit (Exchange Vault Cache setting) ................ 83Lock for download item age limit (Exchange Vault Cache

setting) ........................................................................... 83Manual archive inserts (Exchange Vault Cache setting) .................. 83Offline store required (Exchange Vault Cache setting) .................... 84Pause interval (Exchange Vault Cache setting) ............................. 84Per item sleep (Exchange Vault Cache setting) ............................. 84Preemptive archiving in advance (Exchange Vault Cache

setting) ........................................................................... 85Root folder (Exchange Vault Cache setting) ................................. 85Root folder search path (Exchange Vault Cache setting) ................. 86Show Setup Wizard (Exchange Vault Cache setting) ..................... 86Synchronize archive types (Exchange Vault Cache setting) ............. 87WDS search auto-enable (Exchange Vault Cache setting) .............. 87

Virtual Vault advanced settings ........................................................ 87Max archive requests per synchronization (Exchange Virtual Vault

setting) ........................................................................... 89Max attempts to archive an item (Exchange Virtual Vault

setting) ........................................................................... 90Max data archived per synchronization (Exchange Virtual Vault

setting) ........................................................................... 90Max delete requests per synchronization (Exchange Virtual Vault

setting) ........................................................................... 91Max item size to archive (Exchange Virtual Vault setting) ................ 91Max item updates per synchronization (Exchange Virtual Vault

setting) ........................................................................... 92

9Contents

Max total size of contentless operations (Exchange Virtual Vaultsetting) ........................................................................... 92

Max total size of items to archive (Exchange Virtual Vaultsetting) ........................................................................... 93

Show content in Reading Pane (Exchange Virtual Vaultsetting) ........................................................................... 93

Threshold number of items to trigger synchronization (ExchangeVirtual Vault setting) .......................................................... 94

Threshold total size of items to trigger synchronization (ExchangeVirtual Vault setting) .......................................................... 95

Users can archive items (Exchange Virtual Vault setting) ................ 96Users can copy items to another store (Exchange Virtual Vault

setting) ........................................................................... 96Users can copy items within their archive (Exchange Virtual Vault

setting) ........................................................................... 97Users can hard delete items (Exchange Virtual Vault setting) ........... 97Users can reorganize items (Exchange Virtual Vault setting) ........... 98

Chapter 6 Setting up archiving from public folders ...................... 99

About archiving from public folders ................................................... 99Note on vault store and partition when setting up archiving from public

folders ................................................................................ 100Creating a public folder archive ...................................................... 100Adding a Public Folder task .......................................................... 101About public folder policy settings .................................................. 101

Exchange Public Folder policy settings ...................................... 101Adding public folder archiving targets .............................................. 106

Manual (standard) method of adding public folder archivingtargets .......................................................................... 106

Automatic method of adding public folder archiving targets ............ 107Applying archiving settings to public folders ...................................... 108Scheduling the Public Folder task .................................................. 109Note on removing Public Folder targets ........................................... 109

Chapter 7 Setting up archiving of journaled messages ............ 111

Before you start setting up archiving of journaled messages ................ 111Vault store group, vault store, and partition when archiving journaled

messages ........................................................................... 112Creating a journal archive ............................................................. 112Adding permissions to the journal archive ........................................ 112Adding an Exchange Journaling task .............................................. 113Reviewing the journaling policy settings ........................................... 114

10Contents

Adding an Exchange Server journal mailbox as a target ...................... 114Starting the Journaling task ........................................................... 115What to do after setting up archiving of journaled messages ................ 116

Chapter 8 Envelope Journaling ....................................................... 117

About Enterprise Vault and Exchange Server journal reports ............... 117How Enterprise Vault handles Exchange journal reports ............... 118

Chapter 9 Setting up Enterprise Vault Office Mail App forExchange Server 2013 and later .......................... 120

About Microsoft Office Mail App ..................................................... 121About the Enterprise Vault Office Mail App ....................................... 121

Enterprise Vault Office Mail App features ................................... 122Enterprise Vault Office Mail App policy settings and options ................. 123Initial configuration of HTTPS for use of the Enterprise Vault Office

Mail App ............................................................................. 125Deploying the Enterprise Vault Office Mail App ................................. 125

About the PowerShell commands for Office Mail Apps .................. 126About deploying the Office Mail App with the New-App

command ...................................................................... 126About New-App command parameters for the Enterprise Vault

Office Mail App ............................................................... 128Deploying the Enterprise Vault Office Mail App for an individual

user ............................................................................. 129Deploying the Enterprise Vault Office Mail App for multiple

users ........................................................................... 130About the Enterprise Vault Office Mail App after deployment for

an individual user ........................................................... 132Deploying the Enterprise Vault Office Mail App for an

organization .................................................................. 132About the Enterprise Vault Office Mail App after deployment for

an organization .............................................................. 134Mailbox synchronization after upgrade to enable use of the Office

Mail App ....................................................................... 136Additional requirements on Enterprise Vault Office Mail App users'

computers ........................................................................... 136Disabling and re-enabling the Enterprise Vault Office Mail App for a

device type .......................................................................... 137Removing, disabling, and re-enabling the Enterprise Vault Office Mail

App for a user or an organization ............................................. 138Troubleshooting the Enterprise Vault Office Mail App ......................... 140

Enterprise Vault Office Mail App: client tracing ............................ 141

11Contents

Enterprise Vault Office Mail App: server tracing ........................... 141Checking deployment of the Enterprise Vault Office Mail

App .............................................................................. 141The Enterprise Vault Office Mail App manifest file is not

created ......................................................................... 142Unable to deploy the Enterprise Vault Office Mail App at

organization level ........................................................... 143The Enterprise Vault Office Mail App window is blank or contains

an error message ........................................................... 144An Enterprise Vault Office Mail App action fails with an error

message ....................................................................... 145

Chapter 10 Setting up Enterprise Vault access for OWAclients on Exchange Server 2010 ......................... 147

About Enterprise Vault functionality in OWA clients ............................ 148About OWA forms-based authentication for Enterprise Vault ....

1 4 9Enterprise Vault OWA Extensions in an Exchange Server 2010

environment ........................................................................ 149Clustered OWA configurations ................................................. 151

Steps to configure Enterprise Vault access for OWA users .................. 151Configuring Enterprise Vault for anonymous connections .................... 153Creating the ExchangeServers.txt file ............................................. 154Configuring the Data Access account .............................................. 154Restart the Admin Service and synchronize mailboxes for OWA

configuration ........................................................................ 155Configuring Enterprise Vault Exchange Desktop Policy for OWA ........... 156Installing Enterprise Vault OWA 2010 Extensions .............................. 160Additional configuration steps for Exchange Server 2010 CAS proxying

for use with OWA .................................................................. 161

Chapter 11 Configuring access to Enterprise Vault fromOutlook RPC over HTTP clients ............................ 163

About Outlook RPC over HTTP and Outlook Anywhereconfigurations ...................................................................... 163About Exchange Server Outlook Anywhere configurations ............ 164About Enterprise Vault proxy server configurations for access to

Outlook RPC over HTTP clients ......................................... 166Configuring Outlook Anywhere client access to Enterprise Vault ........... 168

Required tasks for configuring Outlook Anywhere access toEnterprise Vault .............................................................. 169

12Contents

Setting up an Enterprise Vault proxy server to manage connectionsfrom Outlook Anywhere clients ................................................ 169Configuring the Enterprise Vault proxy server to manage

connections from Outlook Anywhere clients ......................... 169Configuring Enterprise Vault servers for anonymous connections

from the Enterprise Vault proxy server ................................. 170Configuring RPC over HTTP settings in Enterprise Vault Exchange

Desktop policy ..................................................................... 173

Chapter 12 Using firewall software for external access toOWA and Outlook ...................................................... 176

About configuring Threat Management Gateway 2010 for Outlook 2013and OWA 2013 .................................................................... 176

Configuring ISA Server 2006 for OWA 2010 access to EnterpriseVault .................................................................................. 177

About configuring ISA Server 2006 for Outlook Anywhere client accessto Enterprise Vault ................................................................ 178

Chapter 13 Configuring filtering ......................................................... 179

About filtering ............................................................................. 179About journal filters with Envelope Journaling ............................. 180

Configuring selective journaling ..................................................... 181Creating the selective journaling rules file .................................. 181Selective journaling filter rules ................................................. 181Adding selective journaling registry settings ............................... 183Managing invalid distribution lists with selective journaling ............. 184

Configuring group journaling ......................................................... 185Creating the group journaling rules file ...................................... 186Group journaling filter rules ..................................................... 187Adding group journaling registry settings ................................... 188Testing the group journaling settings ......................................... 188

Configuring custom filtering ........................................................... 189About custom filtering in distributed Enterprise Vault

environments ................................................................. 191Configuring registry settings for Exchange Server journal custom

filtering ......................................................................... 191Configuring registry settings for Exchange Server mailbox custom

filtering ......................................................................... 192Configuring registry settings for Exchange Server public folder

custom filtering ............................................................... 194About custom filtering ruleset files ............................................ 195About controlling default custom filtering behavior ....................... 198

13Contents

About the general format of ruleset files for custom filtering ........... 202About rule actions for custom filtering ........................................ 205About message attribute filters for custom filtering ....................... 208Attachment attribute filters for custom filtering ............................. 222How message and attachment filters are applied for custom

filtering ......................................................................... 224Example ruleset file for custom filtering ..................................... 227Configuring custom properties and content categories .................. 231About the general format of Custom Properties.xml ..................... 234Defining additional MAPI properties in custom properties .............. 236About content categories ........................................................ 238Defining how custom properties are presented in third party

applications ................................................................... 242Summary of custom property elements and attributes .................. 246Custom properties example .................................................... 250

Index .................................................................................................................. 259

14Contents

About this guideThis chapter includes the following topics:

■ Introducing this guide

■ Where to get more information about Enterprise Vault

■ Comment on the documentation

Introducing this guideThis guide describes how to set up Enterprise Vault so that you can archive itemsfrom mailboxes and public folders on Microsoft Exchange Servers.

The guide assumes that you know how to administer the following Microsoftproducts:

■ Windows Server

■ Exchange Server

■ SQL Server

■ Message Queue Server

■ Internet Information Services (IIS)

Where to get more information about EnterpriseVault

Table 1-1 lists the documentation that accompanies Enterprise Vault.

1Chapter

Table 1-1 Enterprise Vault documentation set

CommentsDocument

Includes all the following documents in Windows Help (.chm)format so that you can search across them all. It also includeslinks to the guides in Acrobat (.pdf) format.

You can access the library in several ways, including thefollowing:

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

■ In Windows Explorer, browse to theDocumentation\language subfolder of the EnterpriseVault installation folder, and then open the EV_Help.chmfile.

■ On the Help menu in the Administration Console, clickHelp on Enterprise Vault.

Veritas Enterprise VaultDocumentation Library

Provides an overview of Enterprise Vault functionality.Introduction and Planning

Describes how to check the required software and settingsbefore you install Enterprise Vault.

Deployment Scanner

Provides detailed information on setting up Enterprise Vault.Installing and Configuring

Describes how to upgrade an existing Enterprise Vaultinstallation to the latest version.

Upgrade Instructions

Describes how to archive items from Domino mail files andjournal databases.

Setting up Domino ServerArchiving

Describes how to archive items from Microsoft Exchangeuser mailboxes, journal mailboxes, and public folders.

Setting up Exchange ServerArchiving

Describes how to archive the files that are held on networkfile servers.

Setting up File SystemArchiving

Describes how to configure IMAP client access to Exchangearchives and Internet mail archives.

Setting up IMAP

Describes how to archive SMTP messages from othermessaging servers.

Setting up SMTP Archiving

Describes how to archive content from Microsoft SharePointservers.

Setting up SharePoint ServerArchiving

Describes how to perform day-to-day administrationprocedures.

Administrator’s Guide

16About this guideWhere to get more information about Enterprise Vault

Table 1-1 Enterprise Vault documentation set (continued)

CommentsDocument

Describes how to implement an effective backup strategy toprevent data loss, and how to provide a means for recoveryin the event of a system failure.

Backup and Recovery

Describes how to assign classification values to the metadataproperties of all new and existing archived items. Users ofapplications such as Enterprise Vault Search and ComplianceAccelerator can then use the classification values to filter theitems when they conduct searches or reviews.

Classification

Describes how to migrate content from Domino and NotesNSF files into Enterprise Vault archives.

NSF Migration

Describes how to migrate content from Outlook PST files intoEnterprise Vault archives.

PST Migration

Describes how to implement Enterprise Vault Reporting,which provides reports on the status of Enterprise Vaultservers, archives, and archived items. If you configure FSAReporting, additional reports are available for file servers andtheir volumes.

Reporting

Describes the Enterprise Vault tools and utilities.Utilities

Describes how to perform various administrative tasks byrunning the Enterprise Vault PowerShell cmdlets.

PowerShell Cmdlets

A reference document that lists the registry values with whichyou can modify many aspects of Enterprise Vault behavior.

Registry Values

The online Help for the Enterprise Vault AdministrationConsole.

Help for AdministrationConsole

The online Help for Enterprise Vault Operations Manager.Help for Enterprise VaultOperations Manager

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

http://www.veritas.com/docs/000097605

“How To” articles on the Veritas Support websiteMost of the information in the Enterprise Vault administration guides is also availableonline as articles on the Veritas Support website. You can access these articles by

17About this guideWhere to get more information about Enterprise Vault


searching the Internet with any popular search engine, such as Google, or byfollowing the procedure below.

To access the “How To” articles on the Veritas Support website

1 Type the following in the address bar of your web browser, and then pressEnter:

http://www.veritas.com/support/en_US/products-a-z

2 In the Products A-Z page, choose the required product, such as EnterpriseVault for Microsoft Exchange.

3 Search for a word or phrase by using the Knowledge Base Search feature, orbrowse the list of most popular subjects.

Enterprise Vault training modulesThe Enterprise Vault and eDiscovery Tech Center (http://www.veritas.com/elibrary)is an eLibrary of self-paced learning modules developed around key features, bestpractices, and common technical support questions.

More advanced instructor-led training, virtual training, and on-demand classes arealso available. For information about them, seehttp://www.veritas.com/education-services/training-courses.

Comment on the documentationLet us know what you like and dislike about the documentation. Were you able tofind the information you needed quickly? Was the information clearly presented?Report errors and omissions, or tell us what you would find useful in future versionsof 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.

18About this guideComment on the documentation

http://www.veritas.com/support/en_US/products-a-z

http://www.veritas.com/elibrary

http://www.veritas.com/education-services/training-courses

mailto:[email protected]?subject=Comments on the Enterprise Vault documentation

Distributing ExchangeServer Forms

This chapter includes the following topics:

■ About distributing the Microsoft Exchange forms when setting up ExchangeServer archiving

■ What next?

About distributing the Microsoft Exchange formswhen setting up Exchange Server archiving

If you are implementing Exchange Server archiving, Microsoft Exchange formsneed to be distributed around your Microsoft Exchange Server organization. Differentlanguage versions of the forms are provided in the Enterprise Vault server kit andin the Outlook Add-In installer kit.

The forms can be distributed in the following ways:

■ Allow the Outlook Add-in to store forms in each user's Personal Forms Library.This is the default method.See “ Use of Personal Forms Libraries when setting up Exchange Serverarchiving” on page 20.

■ Install the forms in folders in the Organizational Forms Library on the ExchangeServer.See “About using the Organizational Forms Library when setting up ExchangeServer archiving” on page 20.

Note: The Exchange forms do not affect Enterprise Vault Client for Mac OS X users.

2Chapter

Use of Personal Forms Libraries when setting up Exchange Serverarchiving

By default, the Enterprise Vault Outlook Add-In automatically deploys forms to theuser's Personal Forms Library. This has the advantage of requiring no configurationby the administrator.

About using the Organizational Forms Library when setting upExchange Server archiving

If you wish, you can install the forms in the Organizational Forms Library, ratherthan deploying forms to users' Personal Forms Libraries. However, this requires acertain amount of configuration effort, especially on Exchange Server 2010 andlater versions, which do not provide an Organizational Forms Library by default.

This section describes how to create Organizational Forms folders and install theforms. You create one folder in the Organizational Forms Library for each languageversion of the forms that you want to install. This section also explains that to changethe deployment method you need to change a policy setting in your desktop policies.

See “Creating Organizational Forms folders when setting up Exchange Serverarchiving” on page 20.

See “Installing the Microsoft Exchange forms when setting up Exchange Serverarchiving” on page 22.

See “Updating desktop policies to change the deployment method when setting upExchange Server archiving” on page 23.

Creating Organizational Forms folders when setting upExchange Server archivingOn Exchange Server 2010 and later, the method used to create the OrganizationalForms Library and folders has changed; you cannot use the administrative tools.The method described in this section uses the Microsoft Exchange Server MAPIeditor, MfcMapi.exe, which you can obtain from the following page on the Microsoftwebsite:

http://go.microsoft.com/?linkid=5684182

To create Organizational Forms folders on Exchange Server 2010 and later

1 Create a new Organizational forms folder, as follows:

■ Open the Exchange Management Shell.

■ Run the following command at the Exchange Management Shell prompt:

20Distributing Exchange Server FormsAbout distributing the Microsoft Exchange forms when setting up Exchange Server archiving

http://go.microsoft.com/?linkid=5684182

New-PublicFolder -Path "\NON_IPM_SUBTREE\EFORMS REGISTRY" -Name

"Enterprise Vault Forms (English)"

The name given here is just an example. Repeat this command to createa folder for each language that you want to publish.

2 Check that public folders are displayed in Outlook:

■ Use an account that belongs to the Exchange Administrators Group to logon to an Enterprise Vault server that has Outlook installed.

■ Configure a new mail profile and start Outlook.

■ If the public folder store does not appear within a few seconds, you mayneed to wait for Exchange Server to update. Alternatively, restart theExchange Server information store to force an update.

3 Add the PR_EFORMS_LOCALE_ID property to set language of the formsfolder, as follows:

■ Start the Microsoft Exchange Server MAPI Editor (MfcMapi.exe).

■ On the Sessionmenu, click Logon and Display Store Table. Log on usingthe Outlook profile for an account that belongs to the ExchangeAdministrators Group.

■ On the MDB menu, click Open Public Folder Store, and then click OK.

■ Expand Public Root, expand NON_IPM_SUBTREE, and then expandEFORMS REGISTRY.

■ Click the public folder that you created in step 1. For example, click"Enterprise Vault Forms (English)".

■ On the Property pane menu, click Modify Extra Properties.

■ Click Add, and then click Select Property Tag.

■ Click PR_EFORMS_LOCALE_ID in the list, and then click OK.

■ Click OK twice. A red mark is displayed next to the newPR_EFORMS_LOCALE_ID property.

■ Double-click PR_EFORMS_LOCALE_ID.

■ In the Unsigned Decimal box, type the locale ID you require, and thenclick OK.For example, type 1033 for English, or 1040 for Italian.To determine the locale ID for other locales, visit the following Microsoftwebsite:http://msdn2.microsoft.com/library/aa579489.aspx


http://msdn2.microsoft.com/library/aa579489.aspx

■ Select PR_PUBLISH_IN_ADDRESS_BOOK, right click and select EditProperty, clear Boolean and then click OK.

■ Exit MAPI Editor.

Installing the Microsoft Exchange forms when setting upExchange Server archivingYou can install the forms from Microsoft Outlook using a mailbox that has Ownerpermissions for the folder in the Organization Forms Library. Do this on the computerwhere you have installed the Microsoft Exchange forms from the Enterprise Vaultkit, typically the Enterprise Vault server.

Note: When upgrading or reinstalling the Enterprise Vault forms, always uninstallthe existing copies first, rather than installing the new forms on top of the existingcopies.

Users can access the new forms when they have installed the Enterprise VaultOutlook Add-In.

To install the forms

1 On the Outlook Tools menu, click Options.

2 On the Other tab, click Advanced Options, click Custom Forms, and thenclick Manage Forms.

3 On the right-hand side of the dialog box, click Set.

4 Click Forms Library and select the name of your forms library. Click OK.

5 Click Install.

6 Select the Languages\Forms subfolder in the Enterprise Vault Program folder.

7 Select the language folder that is appropriate to the language of the forms youwant to install.

8 Change the file type filter to Form Message (*.fdm).

9 Double-click EVPendingArchive.fdm and review the displayed properties tocheck that this form is the Enterprise Vault Archive Pending Item form.

10 Click OK.

11 Repeat steps 5, 8, 9, and 10 for the following:

■ EVPendingArchiveHTTP.fdm: the Enterprise Vault Archive Pending ItemHTTP form

■ EVPendingDelete.fdm: the Enterprise Vault Delete Pending Item form


■ EVPendingRestore.fdm: the Enterprise Vault Restore Pending Item form

■ EVShortcut.fdm: the Enterprise Vault Archived Item form

12 Close the Forms Manager dialog box and the other open dialog boxes.

Updating desktop policies to change the deploymentmethod when setting up Exchange Server archivingIf you are using the Organizational Forms Library to distribute the forms then whenyou come to set up Exchange desktop policies in the Enterprise Vault AdministrationConsole you need to change the value of the Outlook advanced policy settingDeploy Forms Locally from its default value of Always.

See “Changing the default method for deploying Exchange forms in Advanced tabfor desktop policy in Exchange Server archiving” on page 44.

What next?You can now use the Enterprise Vault Administration Console to set up ExchangeServer mailbox, journal or public folder archiving, as required.

23Distributing Exchange Server FormsWhat next?

Setting up archiving frommailboxes


■ Points to note before you set up Enterprise Vault mailbox archiving

■ Defining Exchange Server mailbox archiving policies

■ Defining desktop policies in Exchange Server archiving

■ Adding Exchange Server archiving targets

■ Adding an Exchange Provisioning task for Exchange Server archiving

■ Adding an Exchange Mailbox archiving task

■ Reviewing the default settings for the Enterprise Vault site

■ Using customized shortcuts with Exchange Server archiving

■ About editing automatic messages for Exchange Server archiving

■ Starting the Task Controller service and archiving task when setting up ExchangeServer archiving

■ Enabling mailboxes for Exchange Server archiving

■ Installing the Outlook Add-In on a server for Exchange Server archiving

■ Overriding PSTDisableGrow

■ Users’ tasks for Exchange Server mailbox archiving

3Chapter

Points to note before you set up Enterprise Vaultmailbox archiving

Before you enable mailboxes for Enterprise Vault archiving, take a few momentsto review the requirements for the following:

■ Vault store groups, vault stores, and partitions.See “Use of vault store groups, vault stores, and partitions with Exchange Servermailbox archiving” on page 25.

■ Exchange Server database availability groups.See “Using Exchange Server database availability groups” on page 25.

Use of vault store groups, vault stores, and partitions with ExchangeServer mailbox archiving

A vault store group, vault store, and vault store partition must exist before youenable mailboxes for archiving. After you enable the target mailboxes for archiving,Enterprise Vault automatically creates an archive for each mailbox in the selectedvault store.

To control where Enterprise Vault creates new mailbox archives, you can set thedefault vault store at the following levels:

■ Enterprise Vault server properties

■ Exchange Server properties

■ Provisioning Group properties

When you create a Provisioning Group, the default vault store is inherited from theExchange Server properties. If an override vault store is not specified in theExchange Server properties, then the vault store that is specified in the EnterpriseVault server properties is used.

See the “Setting up storage” chapter in the Installing and Configuring manual.

Using Exchange Server database availability groupsRecent Exchange Server versions use database availability groups (DAGs) toprovide automatic database level recovery from failures of mailbox servers orindividual mailbox databases. When one database in a DAG fails, Exchange makesactive another passive copy of the database on a different mailbox server.

To ensure that the mailboxes you enable for archiving are always available toEnterprise Vault, you must set up archiving for all the DAG member servers. Youmust also target all the DAG member servers within one Enterprise Vault site.

25Setting up archiving from mailboxesPoints to note before you set up Enterprise Vault mailbox archiving

It is possible to add an Exchange mailbox archiving task for a server, only when ithosts an active Exchange database. Your environment might contain Exchangeservers that act only as disaster recovery (DR) servers, and do not normally hostactive DAG member databases. These servers must be set up for Exchange serverarchiving because active DAG member databases can fail over to them. However,while these servers are not hosting active databases, you cannot set them up forExchange mailbox archiving.

To set up Exchange mailbox archiving for a DR-only server

1 Fail over an active database to the DR-only server. This must be a databasethat contains an Enterprise Vault system mailbox.

2 Add the DR-only server as an Exchange mailbox archiving target.

3 Add an Exchange mailbox archiving task for the DR-only server.

4 Fail back the database to the original host server.

When all DAG member servers are set up for archiving, database and serverfailovers do not interrupt mailbox archiving.

Exchange mailbox archiving and database failovers withExchange Server mailbox archivingDuring Exchange mailbox archiving, a mailbox archiving task is associated witheach mailbox server. The mailbox archiving task processes only the active copiesof the mailbox databases that reside on the mailbox server. Enterprise Vault doesnot archive from passive database copies.

When one database in a DAG fails, Exchange makes another passive copy of thedatabase active. The mailbox archiving task that processed the failed copy continuesto process the new active copy of the database until the Enterprise Vault’sprovisioning task runs. When the provisioning task has run, the new active copy ofthe database is processed by the mailbox archiving task that is associated with thenew host Exchange server.

In practice, the failed database might be restored to its initial Exchange host beforethe provisioning task runs and updates the list of databases that are processed byeach mailbox archiving task.

You can determine which databases a mailbox archiving task is currently processingin the Administration Console, using the Exchange Mailbox Archiving TaskProperties: Targets tab.

26Setting up archiving from mailboxesPoints to note before you set up Enterprise Vault mailbox archiving

Defining Exchange Server mailbox archivingpolicies

Exchange mailbox policies define how Enterprise Vault archives target ExchangeServer mailboxes. You can create different policies for different groups of mailboxes.If you wish, you can create a custom mailbox policy for each provisioning group.

A default Exchange mailbox policy is created in the Administration Console by theconfiguration wizard.

To view and modify the properties of the default Exchange mailbox policy

1 In the Administration Console, expand your Enterprise Vault site.

2 Click Policies > Exchange > Mailbox.

3 Right-click Default Exchange Mailbox Policy in the right pane and selectProperties. You can modify the properties of this policy, as required, and alsocreate new policies.

To create a new Exchange mailbox policy



3 Right-click the Mailbox container and select New, Policy to launch the newpolicy wizard.

The new policy is displayed in the right pane.

4 To adjust the policy properties, right-click the policy and select Properties.

To set a different policy as the default Exchange mailbox policy



3 In the right pane right-click the policy that you want to set as the default policy,and select Set as Default.

Mailbox policy settings when setting up Exchange Server archivingThis section gives an overview of the various settings available in the Exchangemailbox policy. For more information on each setting, see the online help on themailbox policy property pages.

27Setting up archiving from mailboxesDefining Exchange Server mailbox archiving policies

General tab (Exchange Server archiving mailbox policysetting)Table 3-1 lists the settings on the General tab. These settings provide a name anddescription for the policy.

Table 3-1 Exchange mailbox policy General tab settings

Default valueDescriptionSetting

None.A name for the policy.Name

None.An optional description for thepolicy, which you can change asoften as you wish.

Description

Archiving Rules tab (Exchange Server archiving mailboxpolicy setting)Table 3-2 lists the settings on the Archiving Rules tab. These settings control theuse of age-based and mailbox storage quota-based archiving, and other archivingoptions.

Table 3-2 Exchange mailbox policy Archiving Rules tab settings


Archiving is based on the period oftime since an item was modified.The time period is six months.

Setting is locked.

You can choose to base archivingon one of the following:

■ Age: the age of an item■ Quota: the percentage of the

mailbox storage limit that isreleased

■ Age and quota: a combinationof the Age and Quota options

For information on configuration ofarchiving based on quota or ageand quota, see the Administrator'sGuide.

Archiving strategy

Six months.The period of time to use for Agebased archiving and Age and quotabased archiving.

Age based


Table 3-2 Exchange mailbox policy Archiving Rules tab settings (continued)


10%The percentage to use for Quotabased archiving and Age and quotabased archiving.

Quota based

Two weeks.An absolute limit on the age ofitems that are archived.

Never archiveitems younger than

Not set.The size above which theExchange Mailbox Tasks givepriority to items. Items larger thanthis size are archived first.

Start with itemslarger than

Not set.Archive an item only if it has anattachment, assuming all otherarchiving criteria are met.

Note that this is not the same asarchiving attachments only.

See the Administrator’s Guide formore details.

Archive onlymessages withattachments

Archiving Actions tab (Exchange Server archivingmailboxpolicy setting)Table 3-3 describes the settings on the Archiving Actions tab. These settings controlhow Enterprise Vault behaves when it archives an item.

Table 3-3 Exchange mailbox policy Archiving Actions tab settings

Default valueSetting

Original item is deleted from mailbox after archiving.

Setting is locked.

This option is only available for selection if Based on age is selectedas the archiving strategy on the Archiving Rules tab.

Delete original itemafter archiving

After it has been archived, the item in the mailbox is replaced with ashortcut.

Setting is locked.

Create shortcut toarchived item afterarchiving

Unread items in the mailbox are not archived.

Setting is locked.

Archive unreaditems


Table 3-3 Exchange mailbox policy Archiving Actions tab settings(continued)


Force users to use the policy settings for mailbox archiving. This locksthe settings in the Archiving Actions section and the Archiving Strategysetting on the Archiving Rules tab.

Overall lock

Shortcut Content tab (Exchange Server archivingmailboxpolicy setting)Table 3-4 describes the settings on the Shortcut Content tab. These settings controlthe size and behavior of Enterprise Vault shortcuts.

Table 3-4 Exchange mailbox policy Shortcut Content tab settings


Shortcuts include recipientinformation.

Whether to store recipientinformation (To: and Cc: details) inshortcuts.

Shortcuts always contain the Fromand Subject information.

Include recipientinformation

The first 1000 characters of themessage body are stored in theshortcut.

How much of the message body tostore in shortcuts. Regardless ofthe setting value, the full message,with attachments, are still stored inthe archive.

■ None. None of the messagetext is stored in the shortcut.

■ Use message body. Shortcutscontain all of the message bodytext, but no attachments.

■ Customize. Select the amountof text and links that you wantincluded in shortcuts.See “Using customizedshortcuts with Exchange Serverarchiving” on page 52.

Shortcut body

Show contents.Whether double-clicking a shortcutdisplays the contents of the originalitem or the properties of theshortcut.

When shortcut isopened


The file, ShortcutText.txt, is required if you configure customized shortcuts. Youcan also use this file to process standard shortcuts for untitled attachments.

See “Using customized shortcuts with Exchange Server archiving” on page 52.

Message Classes tab (Exchange Server archivingmailboxpolicy setting)The list on the Message Classes tab shows the classes of items that will be archivedwhen the policy is applied.

Select or clear message class check boxes, as required.

If you need to edit the list of available message classes, go to the Message Classestab of the Directory properties.

Shortcut Deletion tab (Exchange Server archivingmailboxpolicy setting)Shortcut deletion does the following:

■ Deletes shortcuts that are older than the age you specify on this tab. EnterpriseVault uses the modified date or archived date to determine the age of a shortcut.You can specify which date to use on the Storage Expiry tab of Site Properties.

■ Deletes orphaned shortcuts. These are shortcuts to items that have been deleted,typically by a user, from an archive.

Shortcut deletion is performed by the Exchange Mailbox Archiving task. When yourun the task using Run Now, you can choose a Run mode that includes shortcutprocessing.

Table 3-5 describes the available settings.

Table 3-5 Exchange mailbox policy Shortcut Deletion tab settings


Not selectedSetting this makes Enterprise Vaultdelete shortcuts that are older thanthe age you specify. This does notaffect the corresponding archiveditems. Users can still search for thearchived items.

For example, you could choose todelete all shortcuts older than 12months, but retain archived itemsfor several years.

Delete shortcuts infolders


Table 3-5 Exchange mailbox policy Shortcut Deletion tab settings(continued)


Not selectedThis setting makes Enterprise Vaultdelete shortcuts in mailboxes if thecorresponding archived item hasbeen deleted.

If you use shortcuts that containtext from the original message,those shortcuts might be useful tousers even though the archiveditems have been deleted. However,deleting large shortcuts will regainspace in the Exchange Serverstore.

Delete orphanedshortcuts

When certain items such as calendar, task, and meeting items are archived, theoriginal item is not replaced with a shortcut. By default, the archiving task does notdelete the original items when it performs shortcut deletion. To include such itemsin shortcut deletion, configure the registry setting, DeleteNonShortcutItems. Thesetting is described in the Registry Values manual.

Existing Items tab (Exchange Server archiving mailboxpolicy setting)Enterprise Vault can update the location and the retention category of archiveditems whose shortcuts have been moved or copied to a different folder. In addition,if the retention category for a folder changes, Enterprise Vault can apply the newretention category to archived items that have shortcuts in the folder.

The following permissions are required:

■ The owner of the mailbox where the copy is made must have read permissionon the archive folder where the item originated.

■ If the item originated in a shared archive, the owner of the mailbox where thecopy is made must have read permission on the shared archive.

If the new location is configured to use a shared archive, Enterprise Vault createsa copy of the item in that archive. It leaves a copy in the original archive even if theitem's shortcut was moved, rather than copied.

The Existing Items settings control whether these updates are made.

You can choose to update the location only, or both the location and the retentioncategory.


Table 3-6 describes the available settings.

Table 3-6 Exchange mailbox policy Moved Items tab settings


SelectedIf you select this option, thelocation of items whose shortcutshave been moved or copied to adifferent folder is updated.

Update archivelocation for itemsmoved in themailbox

AllYou can select one of the following:

■ None. Do not update theretention category of theaffected items.

■ All. Update the retentioncategory of the affected items.

Update retentioncategories afteritems are moved orafter the folderretention categoryis changed

Not selectedIf you select this option, theretention category of moved andcopied items is updated regardlessof how the items were archived.This option includes any itemwhose retention category waschanged when it was archivedmanually, or by a custom filter, orusing PST migration.

If this option is not selected, theretention category is not updatedon any items that were archivedmanually, by a custom filter, orusing PST migration.

Update retentioncategories selectedby a user, set by acustom filter, or setby PST migration

Indexing tab (Exchange Server archiving mailbox policysetting)Table 3-7 lists the settings on the Indexing tab. These settings control the amountof index detail that is available to users. The settings apply to the group of mailboxesto which the policy is assigned.


Table 3-7 Exchange mailbox policy Indexing tab settings


FullThe required indexing level for thegroup of mailboxes to which thepolicy is assigned.

The indexing level defines whatusers can filter on when searchingfor archived items. With briefindexing, only information aboutthe item, such as the subject andauthor, can be searched. With fullindexing you can also search onthe content of each item.

Brief indexes occupy approximately4% of the space of the originaldata. Full indexes with a 128character preview length occupyapproximately 12% of the space ofthe original data.

You can set a default indexing levelfor the entire site in site properties.You can override the site settingfor particular groups of mailboxesin the mailbox policies, or forparticular users in the archiveproperties.

Indexing Level

128 charactersThis setting enables you to controlthe amount of text that EnterpriseVault shows in a search results list.The size of an index increaseswhen you increase the previewlength.

Preview length

Do not create previewsThis setting makes Enterprise Vaultcreate previews of attachmentcontent. These previews cannot beviewed in this release of EnterpriseVault. The size of an indexincreases when you enable thisoption.

Create previews ofattachments


Advanced tab (Exchange Server archiving mailbox policysetting)The Advanced tab contains various settings controlling advanced archiving behavior.As with the settings on the other tabs, you can create another policy if you requiremore than one version of these settings.

Table 3-8 briefly describes the available settings. Information about each advancedsetting is given in the Administrator's Guide.

Table 3-8 Exchange mailbox policy Advanced tab settings

DescriptionSetting

Controls the category of settings that are shown in the list. There is onlyone category:

■ Archiving General. Settings that control archiving behavior.

Information about each advanced setting is given in the Administrator'sGuide.

List settings from

This returns all the settings in the list to their default values. There is aconfirmation prompt that asks if you are sure you want to reset all thevalues.

Reset All

Enables you to change the value for the selected setting. You can alsodouble-click the setting to modify it.

Modify

A brief description of what each setting controls.Description

Targets tab (Exchange Server archiving mailbox policysetting)Later, when you create provisioning groups to add mailboxes as archiving targets,you will assign the required Exchange mailbox policy to each provisioning group.The associated provisioning groups will then be displayed in the Targets tab of themailbox policy.

Defining desktop policies in Exchange Serverarchiving

An Exchange desktop policy defines the end user's experience when using theEnterprise Vault Outlook Add-In, OWA clients, Office Mail App, and Client for MacOS X. It contains the settings that control the Enterprise Vault features andfunctionality available on the users' desktop computers. You can create multiple

35Setting up archiving from mailboxesDefining desktop policies in Exchange Server archiving

policies if you want different provisioning groups to use different policy settings. Ifyou wish, you can create a custom desktop policy for each provisioning group.

A default Exchange desktop policy is created in the Administration Console by theconfiguration wizard.

If you modify a desktop policy after setting up Exchange mailbox archiving, thenwhen you have finished, synchronize the mailboxes using the button on theSynchronization tab in the Exchange Mailbox Archiving Task properties.

To view and modify the properties of the default Exchange desktop policy


2 Click Policies > Exchange > Desktop.

3 Right-click Default Exchange Desktop Policy in the right pane and selectProperties. You can modify the properties of this policy, as required, and alsocreate new policies.

To create a new Exchange desktop policy



3 Right-click the Desktop container and select New, Policy to launch the newpolicy wizard.

The new policy is displayed in the right pane.

4 To adjust the policy properties, right-click the policy and select Properties.

To set a different policy as default Exchange desktop policy



3 In the right pane right-click the policy that you want to set as the default policy,and select Set as Default.

Desktop policy settings in Exchange Server archivingThis section gives an overview of the various settings available in an Exchangedesktop policy. For more information on each setting, see the online help on thedesktop policy property pages.

General tab (Exchange Server archiving desktop policysetting)Table 3-9 lists the settings on the General tab. These settings provide a name anddescription for the policy.


Table 3-9 Exchange desktop policy General tab settings


None.A name for the policy.Name

None, except in the case of anupgrade from Enterprise Vault2007, in which case the descriptionindicates which mailbox policy thedesktop policy settings were copiedfrom.

An optional description for thepolicy, which you can change asoften as you wish.

Description

Options tab (Exchange Server archiving desktop policysetting)The Feature settings let you control the Enterprise Vault functions and toolbarbuttons in the Enterprise Vault clients for Exchange Server archiving.

The Outlook Behavior settings control whether the Outlook and OWA Deleteoptions delete shortcuts only or shortcuts and archived items, or whether the userdecides.

Feature settings in Options tab for desktop policy in Exchange ServerarchivingThese settings control which options and toolbar buttons are available in theEnterprise Vault clients for Exchange archiving.

The Enabled check box controls whether a feature is displayed as an option, or insome cases a button.

The On Toolbar check box becomes available if you select the Enabled checkbox.

Note the following:

■ In the Outlook client, if you check only the Enabled check box, the menu optionappears on the More Actions menu on the Enterprise Vault tab. If you checkboth the Enabled check box and the On Toolbar check box, the menu optiondoes not appear on the More Actions menu. Instead, a button appears directlyon the Enterprise Vault tab or, in the case of Expiry Report, in the EnterpriseVault Backstage view.

■ In Mac OS X, the menu options are provided on the Veritas Enterprise VaultClient menu on the menu bar.


■ In OWA 2010 clients, the menu options are provided on the shortcut menu thatappears when you right-click an item in the OWA Premium client. Buttons in theNavigation Pane provide access to facilities such as Search Vault.

■ In OWA 2013 and later, the Office Mail App provides Enterprise Vault features.For information about the Office Mail App, see Setting up Exchange ServerArchiving.

Table 3-10 lists the Feature settings. The effect of each setting depends on whichEnterprise Vault client is in use. For a more detailed description of these settings,see the Administration Console Help for the Exchange Desktop Policy: Options tab.

Table 3-10 Exchange desktop policy Options tab Feature settings

Controls users' ability toSetting

Perform manual archiving.Store in Vault

Use shortcuts to restore items from vaults.Restore from Vault

Search archives.Search Vault

Delete archived items and their correspondingshortcuts.

Delete from Vault

Cancel a pending archive, pending restore, orpending delete operation.

Cancel Operation

Run an expiry report from Outlook.Expiry Report (Outlook only)

Access Enterprise Vault Help.Help

The Cancel Operation setting is not currently supported for archive actions in theEnterprise Vault Client for Mac OS X.

Outlook Behavior settings in Options tab for desktop policy inExchange Server archivingThe Outlook Behavior settings on the Options tab control the effect on shortcutsand archived items of the normal Delete options in the following:

■ Outlook (all versions) with the Enterprise Vault Outlook Add-In installed

■ OWA 2010

(The settings have no effect in the Enterprise Vault Client for Mac OS X, or in OWAclients on Exchange Server 2013 and later with the Office Mail App enabled.)

Table 3-11 describes the Outlook Behavior settings.


Table 3-11 Exchange desktop policy Options tab Outlook Behavior settings


Shortcut onlyControls what happens when the user deletes ashortcut using one of the normal Outlook or OWADelete options; for example, by selecting a shortcutand pressing the Delete key.

This setting is ignored, and only the shortcut isdeleted, unless the site setting Users can deleteitems from their archives is selected.

■ Shortcut only. The shortcut is deleted. If usershold down the Shift key while they perform thedeletion, the shortcut is deleted without beingplaced in Deleted Items.

■ Both deleted. Enterprise Vault tells the userthat both the shortcut and the archived item willbe deleted. If the user chooses to continue,both the shortcut and the correspondingarchived item are deleted.

■ Ask user. Enterprise Vault asks the userwhether to delete the shortcut and the originalitem, or the shortcut only.

Shortcut deletion

WebApplications tab (Exchange Server archiving desktoppolicy setting)Table 3-12 describes the settings on the Web Applications tab. These settingscontrol aspects of end-user web-based searching.


Table 3-12 Exchange desktop policy Web Applications tab settings


Selected.

(Not selected ifupgrading from anearlier version ofEnterprise Vault.)

Select this setting to add all Enterprise Vaultservers to the local intranet zone of the user'sbrowser. The effect of this setting is that users arenot prompted for their logon details when theysearch their archives or view or restore archiveditems.

When you clear this setting, any existing EnterpriseVault servers remain in the local intranet zone. Nonew servers are added after you clear this setting.

To override this setting, use the Outlook settingsAdd server to intranet zone andRemove serverfrom intranet zone on the Advanced tab in theExchange desktop policy.

■ Bypass local proxy server. Select this settingto bypass the user's local proxy server.The effects of this setting are as follows:■ It selects Bypass proxy server for local

addresses in the Local Area Network (LAN)settings.

■ It adds Enterprise Vault servers to theExceptions list in the proxy settings.

When you clear this setting, Bypass proxyserver for local addresses is cleared. Anyexisting Enterprise Vault servers remain in theExceptions list.

Add all EnterpriseVault servers tointranet zone

You cannot use the setting Add all Enterprise Vault servers to intranet zone ifyou have applied United States Government Configuration Baseline (USGCB) grouppolicy objects (GPO) to Windows computers in your organization. For instructionson how to configure the users' browsers in these circumstances, see the section"Publishing Enterprise Vault server details to USGCB-compliant computers" in theInstalling and Configuring guide.

Vault Cache tab (ExchangeServer archiving desktop policysetting)Table 3-13 describes the settings on the Vault Cache tab. These settings controlthe availability of Vault Cache, its maximum size, and the available features. Thesettings include an option to make Virtual Vault available to users.


Note: In this release, the Vault Cache feature is not available to Enterprise VaultClient for Mac OS X users.

Table 3-13 Exchange desktop policy Vault Cache tab settings


Vault Cache is not available. No newVault Caches are created. Users haveaccess to existing Vault Caches, but nonew items are added.

If you make Vault Cache available, thedefault is to set up Vault Cacheautomatically on users' computers.

Select this setting to make the Vault Cache featureavailable in this Enterprise Vault site. If this settingis cleared, no new Vault Caches are created. Usershave access to existing Vault Caches, but no newitems are added.

If you make Vault Cache available, additionalsettings enable you to choose one of the following:

■ To set up the local Vault Cache automaticallyfor users.

■ To allow users to decide when to set up thelocal Vault Cache, by providing the optionEnable Vault Cache in Outlook.

Make Vault Cacheavailable for users


Table 3-13 Exchange desktop policy Vault Cache tab settings (continued)


The default size limit is 10% of theunused disk space when the VaultCache is created.

The default content strategy is Store allitems.

Use the settings to limit the size of the VaultCache.

Maximum use of initial free space specifies apercentage of unused disk space. The percentageis calculated at the time the Vault Cache is created.

Maximum size specifies a size in gigabytes.

If a Vault Cache reaches the specified size, theoldest items are automatically deleted to makeroom for new items.

Content strategy specifies the strategy for storageof the content of archived items in Vault Cache.The options are as follows:

■ Do not store any items in cache. Itemheaders are synchronized to Vault Cache, butthe content of archived items is not stored inVault Cache.

■ Store all items. Item headers are synchronizedto Vault Cache and the content of archiveditems is stored in Vault Cache.

■ Store only items that user opens. Itemheaders are synchronized to Vault Cache, butthe content of archived items is notautomatically stored in Vault Cache. With thisoption, the content of each item that a useropens in Virtual Vault is stored in Vault Cache.

Limit size of Vault Cache


Table 3-13 Exchange desktop policy Vault Cache tab settings (continued)


If you make Vault Cache available, allthese features are enabled.

■ The Synchronize Vault Cache option controlswhether users can update Vault Cachemanually.For Outlook 2010 and later:■ Select Enabled to show the Synchronize

Vault Cache option on the More Actionsmenu.

■ Select On Toolbar to show theSynchronize button in the Vault Cachegroup on the Enterprise Vault tab. If youselect On Toolbar, the Synchronize VaultCache option is not shown on the MoreActions menu.

■ Vault Cache properties controls whether userscan access the Vault Cache Properties dialogbox in Outlook.■ Vault Cache options enable the user to

configure the size of the local Vault Cacheand the grace period after Outlook startsbefore checking for the files that need to besynchronized to the Vault Cache. SelectEnabled to display the Options tab in theVault Cache Properties dialog box.

■ Vault Cache details enable the user to seedetailed information about the Vault Cache.Select Enabled to display the Details tabin the Vault Cache Properties dialog box.

■ Make Virtual Vault available to users. SelectEnabled to make Virtual Vault available toOutlook users.

Features

See “Vault Cache advanced settings” on page 82.

See “Virtual Vault advanced settings” on page 87.

Advanced tab (Exchange Server archiving desktop policysetting)The Advanced tab provides various advanced settings for the Enterprise VaultOffice Mail App, Outlook, OWA, Vault Cache, and Virtual Vault.


Table 3-14 briefly describes the available settings. As with the other settings in thepolicy, you can create another policy if you require more than one version of thesesettings.

Table 3-14 Exchange desktop policy Advanced tab settings

DescriptionSetting

Controls the type of settings that are displayed in the list. Select fromthe following categories:

■ Office Mail App■ Outlook■ OWA versions before 2013■ Vault Cache■ Virtual Vault

The Administrator’s Guide gives information about each advancedsetting.

List settings from

Returns all the settings in the list to their default values. A confirmationprompt asks if you are sure that you want to reset all the values.

Reset All

Enables you to change the value for the selected setting. You can alsodouble-click the setting to modify it.

Modify

Provides a brief description of what each setting controls.Description

Changing the default method for deploying Exchange forms inAdvanced tab for desktop policy in Exchange Server archivingOne of the advanced settings in the Outlook category is Deploy Forms Locally. Thedefault value of this setting is Always, which causes the Enterprise Vault forms tobe deployed automatically to the user's Personal Forms Library. If you do not intendto use this method, you must change the value of this setting.

The possible values for the Deploy Forms Locally setting are as follows:

■ Never: Never deploy forms locally.

■ When no Org Forms: Deploy forms only when there is no Organizational FormsLibrary available.

■ Always: Always deploy forms locally. This is the default value.

■ Delete: Always delete Enterprise Vault forms from the user's Personal FormsLibrary.

See “About distributing the Microsoft Exchange forms when setting up ExchangeServer archiving” on page 19.


Targets tab (Exchange Server archiving desktop policysetting)Later, when you create provisioning groups to add mailboxes as archiving targets,you will assign the required Exchange desktop policy to each provisioning group.The associated provisioning groups will then be displayed in the Targets page ofthe desktop policy.

Adding Exchange Server archiving targetsIn the Administration Console you need to add the domain (Exchange Organization)and Exchange Servers that you want to archive.

Note: If you use a database availability group (DAG) in your Exchange environment,you must set up archiving for all members of the DAG.

See “Using Exchange Server database availability groups” on page 25.

Adding an Exchange server domain for archivingBefore you can add the Exchange servers that you want to archive, you must addthe domains in which the Exchange servers reside.

To add a domain

1 In the left pane of the Administration Console, expand the Enterprise Vault sitehierarchy until Targets is visible.

2 Expand Targets

3 Right-click Exchange then click New > Domain.

The New Domain wizard starts.

4 The New Domain wizard requests the information needed to create a newdomain. You need to provide the following information:

■ The name of the domain that contains the Exchange servers you want toarchive.

■ Enterprise Vault automatically detects the domain’s global catalog server.However, you can provide a specific global catalog server if necessary.

■ Enterprise Vault automatically detects connection points for Exchange 2013servers. However, you can provide a specific proxy server and certificateprincipal if necessary.

45Setting up archiving from mailboxesAdding Exchange Server archiving targets

Adding an Exchange Server for archivingYou can now add your target Exchange Servers to the appropriate domain.

To add an Exchange Server

1 In the left pane of the Administration Console, expand Targets.

2 Expand the Exchange domain that you added.

3 Right-click Exchange Server and, on the shortcut menu, click New and thenExchange Server.

The New Exchange Server wizard starts.

4 Work through the wizard to add the Exchange Server.

You need the following information:

■ The name of the Exchange Server.

■ Optionally, the wizard enables you to create Exchange Server archivingtasks for user mailboxes, journal mailboxes and public folders. If you createan Exchange Mailbox task, there must also be an Exchange Provisioningtask for the domain. If one does not exist, an Exchange Provisioning taskfor the domain is created automatically when you select the ExchangeMailbox task check box.

■ The name of the Enterprise Vault server on which you want the taskscreated, if not the local computer.

■ The name of the system mailbox to be used to connect to the ExchangeServer.

■ Optionally, an override default vault store that Enterprise Vault is to usewhen creating the archives for mailboxes on this Exchange Server.If you do not explicitly set the vault store for the Exchange Server, the defaultvault store setting is inherited from the Enterprise Vault Server properties.

Adding a Provisioning Group for Exchange Server archivingA provisioning group enables you to apply an Exchange mailbox policy, an Exchangedesktop policy and a PST migration policy to individual users or to a group ofExchange Server users.

You can have a single provisioning group, comprising the whole Exchange Serverorganization, or multiple provisioning groups, if you want to assign different policiesto different groups of users.

You can select the mailboxes to be associated with a provisioning group using anyof the following:


■ Windows group

■ Windows user

■ Distribution Group (the Active Directory Group type, Distribution)

■ Organizational Unit

■ LDAP query

■ Whole Exchange Server organization

Note: A mailbox must be part of a provisioning group before you can enable thatmailbox for archiving.

The Exchange Provisioning Task processes provisioning groups and enablesmailboxes.

To add a Provisioning Group


2 Expand the Exchange domain that you added.

3 Right-click Provisioning Group and, on the shortcut menu, click New andthen Provisioning Group.

The New Provisioning Group wizard starts.

4 Work through the wizard to add a Provisioning Group.

You need the following information:

■ The name of the Provisioning Group.

■ The mailboxes to be included in the Provisioning Group. You can selectmailboxes using any of the following: Windows group or user, DistributionGroup, organizational unit, LDAP query, whole Exchange Organization.

■ The Exchange desktop, mailbox, and PST Migration policies to apply.

■ The default retention category or retention plan to apply, when archivingfrom the mailboxes. The wizard enables you to create a new retentioncategory or retention plan, if required.To apply a retention plan, you must run the Exchange Provisioning Taskand also synchronize the mailboxes, by using the button on theSynchronization tab of the Exchange Mailbox Archiving Task properties.

■ Optionally, an override default vault store that Enterprise Vault is to usewhen creating the archives for mailboxes in this Provisioning Group. Ifmailboxes in the Provisioning Group are automatically-enabled for archiving,


the vault store will be used for any future mailboxes that are added to theProvisioning Group.If you do not explicitly set the vault store for the Provisioning Group, thedefault vault store setting is inherited from the Exchange Server properties.If the vault store is not specified in the Exchange Server properties, thenthe setting in the Enterprise Vault server properties is used.

■ Whether you want Enterprise Vault to enable new mailboxes for archivingautomatically.A new mailbox is one that is new to Enterprise Vault. When you first startusing Enterprise Vault, all the mailboxes are new. With auto-enabling set,all existing mailboxes are enabled when the Exchange Mailbox Task nextruns. All mailboxes created in the future will also be enabled and theassociated archives automatically created.You can use the Disable Mailbox wizard to explicitly disable individualmailboxes. This prevents the mailbox being enabled automatically, so themailbox is never archived unless you choose to enable it.

■ If auto-enabling is selected, whether to initially suspend archiving. Thismeans that archiving of the mailbox does not start until the user enables it.This gives the users the opportunity to change archiving defaults, if required,before archiving begins.

Ordering Provisioning Groups for Exchange ServerarchivingIf you create multiple Provisioning Groups, the order in which they are listed issignificant; the groups are processed from the top of the list down. Mailboxes thatappear in more than one Provisioning Group use the settings from the first groupin which they appear.

Ensure that the most specific group is at the top of the list and the least specific isat the bottom.

To reorder Provisioning Groups

1 In Administration Console tree, right-click the Provisioning Group containerand select Properties.

2 Use Move Up and Move Down buttons to rearrange the groups.


Adding an Exchange Provisioning task forExchange Server archiving

An Exchange Provisioning task is required for each Exchange Server domain. Thistask enables mailboxes in the provisioning groups that you have created.

You can add an Exchange Provisioning task manually, as described in this section,or you can let Enterprise Vault add one automatically when you add the firstExchange Mailbox archiving task.

You are recommended to run the Exchange Provisioning task as the Vault Serviceaccount. If you want to use a different account, the account will need to be addedto the Messaging Administrator role.

To add an Exchange Provisioning task manually

1 In the left pane of the Administration Console, expand the Enterprise Vault sitehierarchy until the Enterprise Vault Servers container is visible.

2 Expand Enterprise Vault Servers.

3 Expand the name of the computer on which you want to create a provisioningtask.

4 Right-click Tasks and, on the shortcut menu, click New and then ExchangeProvisioning Task.

The new task wizard starts.

5 Work through the wizard. You will need the following information:

■ The name of the Exchange Provisioning task

■ The name of the Exchange Server domain to be processed

6 To review the property settings for the task, double-click the task in theright-hand pane. You can modify properties such as the task schedule, thelevel of reporting required and whether to run the task in report mode.

Whenever new mailboxes are added, they must be processed by the ExchangeProvisioning task before they can be enabled.

Adding an Exchange Mailbox archiving taskBefore you add an archiving task, ensure that the Enterprise Vault system mailboxis available. See the Installing and Configuring manual for instructions.

49Setting up archiving from mailboxesAdding an Exchange Provisioning task for Exchange Server archiving

Note: If you use a database availability group (DAG) in your Exchange environment,you must set up archiving for all members of the DAG.

See “Using Exchange Server database availability groups” on page 25.

To add an Exchange Mailbox archiving task

1 In the left pane of the Administration Console, expand the Enterprise Vault sitehierarchy until the Enterprise Vault Servers container is visible.

2 Expand Enterprise Vault Servers.

3 Expand the name of the computer on which you want to create an archivingtask.

4 Right-click Tasks and, on the shortcut menu, click New and then ExchangeMailbox Task.

The new task wizard starts.

5 Work through the wizard. You will need the following information:

■ The name of the Exchange Server to be archived

■ The Enterprise Vault system mailbox to use

If an Exchange Provisioning task does not exist for the domain, then one willbe created automatically.

Reviewing the default settings for the EnterpriseVault site

Check the default settings that are configured in the Enterprise Vault site properties.

Site properties include the following settings. Note that you can override some ofthese at a lower level. For example, you can override the site archiving schedulefor a particular task by setting the schedule in the task properties.

50Setting up archiving from mailboxesReviewing the default settings for the Enterprise Vault site

Table 3-15 Site properties

SettingsTab

■ The Vault site alias and description.■ The protocol and port to use for the Web Access application.■ A system message for users of the Web Access application, if

required.■ The following site properties settings apply only to Exchange Server

archiving: PST holding area details.■ A note for administrators, if required.

General

■ The default retention category.■ Whether the retention category of moved items is always updated,

or updated only when the retention period is increased orunchanged.

■ Whether users can delete items from their archives.■ Whether the items that users have deleted can be recovered.■ The length of time for which the deleted items remain available for

recovery.

Archive Settings

■ The schedule to run storage expiry to delete from archives any itemsthat are older than the retention period assigned.

■ Whether expiry is based on an item's modified date or its archiveddate.

Storage Expiry

■ The schedule to run automatic, background archiving.Site Schedule

■ If required, you can set limits on the size of archives.Archive UsageLimit

■ Indexing level: brief or full.■ Email content that should not be indexed, such as disclaimers.■ How long indexing subtasks are retained before they are deleted.

Indexing

■ Advanced settings that you can use to tune Enterprise Vault indexingwithin the Enterprise Vault site.

Note: Do not change the Indexing settings unless your technicalsupport provider advises you to do so.

Advanced

■ Performance counters for monitoring Enterprise Vault.Monitoring

51Setting up archiving from mailboxesReviewing the default settings for the Enterprise Vault site

To review the default settings for the Enterprise Vault site

1 In the Administration Console, expand the contents of the left pane until theEnterprise Vault site is visible.

2 Right-click the Enterprise Vault site and then, on the shortcut menu, clickProperties.

Alternatively, select the site and click the Review Site Properties button onthe toolbar.

3 Click Help on any of the site properties tabs for further information.

Using customized shortcutswith ExchangeServerarchiving

The standard Enterprise Vault shortcuts do not work well with IMAP or POP3 clients.If you have users with such clients, you can choose to use custom shortcuts. Youcan view these using any client that can render HTML content, such as OutlookExpress.

In a new installation of Enterprise Vault, a default shortcut contains the following:

■ From and Subject information

■ Recipient information: To, CC, and BCC

■ A banner containing a link to the complete archived item

■ The first 1000 characters from the message body

■ Links to attachments, if there are any

Figure 3-1 shows the structure of a default shortcut.

52Setting up archiving from mailboxesUsing customized shortcuts with Exchange Server archiving

Figure 3-1 Structure of a shortcut

Recipientinformation

Customizable banner text Link to view archived item

Banner

Start of messagebody

Attachment list

You can change the settings so that shortcuts contain as much information as yourequire. If you have users with IMAP or POP3 clients, you probably want tocustomize shortcuts so that they contain links to archived attachments. Users canclick the link to open an attachment.

Note that the changes you can make apply to shortcuts that are generated in thefuture, not to shortcuts that have already been created.

Details of custom shortcut content are held in the file ShortcutText.txt in theEnterprise Vault folder (for example, C:\Program Files (x86)\Enterprise

Vault). On a new installation, an English version of this file is placed in theEnterprise Vault folder. Language versions of the file are available in the languagefolders under Enterprise Vault\Languages\ShortcutText.

Note that this file may also be used to process untitled attachments in standardshortcuts.

To define custom shortcut content

1 Locate the required language version of the ShortcutText.txt file (underEnterprise Vault\Languages\ShortcutText).

2 Open ShortcutText.txt with Windows Notepad and make any requiredchanges.

See “Layout of ShortcutText.txt for customized shortcuts with Exchange Serverarchiving” on page 54.

3 Save the file as a Unicode file.


4 Copy the file to the Enterprise Vault program folder (for example, C:\ProgramFiles (x86)\Enterprise Vault).

5 Copy the file to the Enterprise Vault program folder on all other Enterprise Vaultservers in the Enterprise Vault site.

6 Restart the Exchange Server archiving tasks (for mailboxes or public foldersor both) to pick up the changes.

To apply the new content to new shortcuts

1 Start the Administration Console and go to the Shortcut Content tab in theExchange Mailbox Policy properties.

2 Select Customize for the content of the shortcut body, and then specify whichoptions you want. Click Help on the tab for more information.

3 Open the properties window for the Exchange mailbox archiving task and clickthe Synchronization tab.

4 Synchronize the Archiving settings for the required mailboxes.

Layout of ShortcutText.txt for customized shortcuts with ExchangeServer archiving

ShortcutText.txt is laid out using the standard Windows .ini file format:

[Section]

Item1="value1"

Item2="value2"

You can change any of the values within the file. Remember to enclose each valuein quotation marks. For example:

"IPM.Task=This task has been archived."

The sections within ShortcutText.txt are as follows:

The entries in this section are displayed in the banner at the topof the shortcut.

The entry that is used for the shortcut is the one that matchesthe archived item’s message class. For example, shortcuts toitems with message class IPM.Note contain the text "Thismessage has been archived".

Values in this section all have a space before the final quotationmark. This space separates the text from the link text.

[Archived text]


The entry in this section specifies the text in the banner that is alink to the archived item.

[Link]

The Title entry in this section specifies the text immediately beforethe list of attachments.

The DefaultItemTitle entry is used to label any attachments thathave no title of their own.

[Attachment table]

About editing automatic messages for ExchangeServer archiving

Enterprise Vault sends automatic messages to users when their mailbox is enabledfor archiving.

Optionally, you can configure Enterprise Vault to send an automatic warning whena user’s archive is reaching the maximum size, if you have set a limit.

Example messages are installed, but you need to customize the text for yourorganization.

Editing the Welcome message for Exchange Server archivingWhen Enterprise Vault enables a mailbox for archiving, it automatically sends aWelcome message to that mailbox. The Welcome message provides basicinformation for users on how to get help and what to expect. You must edit thismessage before it is sent to reflect how you have set up Enterprise Vault.

During the installation, the Welcome message is placed in a folder beneath theEnterprise Vault program folder:

Enterprise Vault\Languages\Mailbox Messages\lang

where lang indicates the language used.

The Welcome message is in a file called EnableMailboxMessage.msg.

To set up the Welcome message

1 Decide which language version of EnableMailboxMessage.msg you want touse and locate the file.

2 Using a computer that has Microsoft Outlook installed, double-click the fileEnableMailboxMessage.msg in Windows Explorer to edit the message.

55Setting up archiving from mailboxesAbout editing automatic messages for Exchange Server archiving

3 Review the text and make any changes that you require. If necessary, includeinstructions to users about how to install the Enterprise Vault Add-Ins on theircomputers.

See “Setting up manual installation of the Outlook Add-In” on page 66.

4 Save the message.

5 Copy EnableMailboxMessage.msg to the Enterprise Vault program folder(for example C:\Program Files (x86)\Enterprise Vault) on everyEnterprise Vault server in the site.

Editing Archive Usage Limit messages for Exchange Server archivingYou can set a maximum allowed size for users’ archives on the Archive Usage Limitpage of Site Properties. On the same page, you can specify if you want messagessent to users who are approaching or have reached their archive limit. For thoseapproaching their limit, you can also define the point at which you want the messagesent.

If you have selected either of the User Notification check boxes, you need to makethe appropriate messages available to all the Enterprise Vault servers in the site.

During the installation the archive limit warning messages are placed in a folderbeneath the Enterprise Vault Program folder:

Enterprise Vault\Languages\Mailbox Messages\lang

where lang indicates the language used.

The message files are called ApproachingArchiveQuotaLimit.msg andArchiveQuotaLimitReached.msg.

To set up the archive limit warning messages

1 Decide which language version of the messages you want to use and locatethe files, ApproachingArchiveQuotaLimit.msg andArchiveQuotaLimitReached.msg.

2 Using a computer that has Microsoft Outlook installed, double-click the files inWindows Explorer to open the messages.

3 Review the text and make any changes that you require.

4 Save the messages.

5 Copy the two message files to the Enterprise Vault program folder (for exampleC:\Program Files (x86)\Enterprise Vault) on every Enterprise Vaultserver in the site.

56Setting up archiving from mailboxesAbout editing automatic messages for Exchange Server archiving

Starting the Task Controller service and archivingtask when setting up Exchange Server archiving

The Task Controller service and archiving task that you created have not yet beenstarted. These must be started before you can enable mailboxes. The default is forarchiving tasks to start automatically when the Task Controller service starts.

To start the Task Controller service and archiving task

1 In the left pane of the Administration Console, expand the Enterprise VaultServers container.

2 Expand the computer to which you added the Task Controller service and thenclick Services.

3 In the right pane, right-click Enterprise Vault Task Controller Service and,on the shortcut menu, click Start.

4 In the left pane, click Tasks and ensure that the Exchange Mailbox archivingtask has started.

5 The task will run automatically at the times that you have scheduled. You canalso force an archiving run by using the Run Now option, which is availableon the Schedule properties page and on the menu when you right-click thetask.

Enablingmailboxes for ExchangeServer archivingBefore new mailboxes can be enabled, they must be processed by the ExchangeProvisioning task. On a default system, this task will run once a day. On the taskproperties, you can schedule the task to run twice a day at specific times. You canalso force a run to process new mailboxes that have been added to provisioninggroups.

Note: By default, Enterprise Vault processes only mailboxes that are listed in theExchange Global Address List. If you want to archive mailboxes that are not in theGlobal Address List, see the section Hidden mailboxes in the Administrator's Guide.

After Exchange Server mailboxes have been processed by the Provisioning task,they need to be enabled. This can be done automatically, when the ExchangeMailbox task runs, or manually.

Enterprise Vault menu options and buttons do not appear in Outlook until the user'smailbox has been enabled and the user has restarted Outlook. You can thereforeroll out the Enterprise Vault Outlook Add-In before users' mailboxes are enabled.

57Setting up archiving from mailboxesStarting the Task Controller service and archiving task when setting up Exchange Server archiving

When an Exchange Server mailbox is enabled, a new archive is created for themailbox in the vault store specified for the Provisioning Group.

An archive has an associated account that is used for billing purposes, and one ormore users who can access the information stored in it.

To force the Exchange Provisioning task to process mailboxes

1 In the left pane of the Administration Console, expand Enterprise VaultServers, and then your Enterprise Vault server.

2 Click Tasks.

3 In the right-hand pane, right-click the Exchange Provisioning task and selectProperties.

4 Check that the reporting level is as you require. Full reporting will list eachmailbox that is processed, the provisioning group, Mailbox and PST policiesassigned the username associated with the mailbox and the action taken.Summary statistics about the task run are included at the end of the report.

You can configure the task to generate reports when the task is run in bothreport or normal mode.

5 In the right-hand pane, right-click the Exchange Provisioning task and selectRun now.

6 Select whether you want the task to run in report or normal mode. The taskwill then start processing the mailboxes in the provisioning groups.

7 If you selected the option for mailboxes to be enabled for archivingautomatically, they will be enabled the next time the Exchange Mailbox taskruns.

If you did not select the option to enable new mailboxes automatically, youmust enable them manually.

To enable one or more mailboxes manually

1 In the Administration Console, click Enable Mailbox on the Tools menu orclick the Enable Mailboxes for Archiving icon on the toolbar.

The Enable Mailbox wizard starts.

2 Follow the instructions, and click Help on any of the wizard screens for furtherinformation.

Creating shared archives for Exchange Server archivingThere may be times when you want to create extra archives that can be shared bya number of users. For example, you may want to archive all documentationconcerning a particular project in the same archive.

58Setting up archiving from mailboxesEnabling mailboxes for Exchange Server archiving

You create the shared archive manually and then set permissions on the archiveto give each of the users access to it. You can add or remove users at any time.

Note that shared archives do not contain folders.

To create an archive manually

1 Start the Enterprise Vault Administration Console.

2 In the left pane of the Administration Console, expand the Enterprise Vault sitehierarchy until the Archives container is visible.

3 Expand the Archives container to display the various archive types.

4 Right-click Shared and then click New > Archive.

The New Archive wizard starts.

5 Answer the wizard's questions to create the archive. You will be asked toprovide the following information:

■ The vault store for the archive

■ Indexing service and indexing level to use

■ Billing account

To set access permissions on the shared archive

1 In the left pane, expand the Enterprise Vault site hierarchy until the Archivescontainer is visible.

2 Expand the Archives container, and click Shared.

3 In the right pane, double-click the name of the archive that you want to modify.

4 Right-click the archive you want to change and then click Properties.

5 Modify the permissions as required.

Installing the Outlook Add-In on a server forExchange Server archiving

There is no requirement for you to install the Enterprise Vault Outlook Add-In onan Enterprise Vault Server.

Overriding PSTDisableGrowIf the registry value PSTDisableGrow is enabled, you experience the followinglimitations in the use of Enterprise Vault:

59Setting up archiving from mailboxesInstalling the Outlook Add-In on a server for Exchange Server archiving

■ Users see a warning message about the Enterprise Vault Outlook Add-In whenthey open Outlook.

■ Users cannot open Enterprise Vault shortcuts in Outlook.

■ The Vault Cache feature does not work because synchronization fails.

■ Client-driven PST migration does not work. For information about client-drivenPST migration, see PST Migration guide.

■ Compliance Accelerator and Discovery Accelerator exports to PST files fail withevent ID 236.

To bypass the PSTDisableGrow policy, enable the registry valuePSTDisableGrowAllowAuthenticodeOverrides. You can set PSTDisableGrow inthe following registry locations:

■ HKEY_CURRENT_USER\Software\Microsoft\Office\Office

version\Outlook\PST. This location is the default location for PSTDisableGrow.

■ HKEY_CURRENT_USER\Software\Policies\Microsoft\Office\Office

version\Outlook\PST.

You can only set PSTDisableGrowAllowAuthenticodeOverrides in the followingregistry location:

■ HKEY_CURRENT_USER\Software\Policies\Microsoft\Office\Office

version\Outlook\PST

When you enable PSTDisableGrowAllowAuthenticodeOverrides, it does not meanthat users can create new PST files, or add items to existing PST files.PSTDisableGrowAllowAuthenticodeOverrides only enables the Outlook Add-In toperform these actions.

If PSTDisableGrow is enabled and PSTDisableGrowAllowAuthenticodeOverridesis not enabled, the Enterprise Vault Outlook Add-In displays a warning when it loadsin Outlook.

To configure users' computers withPSTDisableGrowAllowAuthenticodeOverrides

1 Install the latest Enterprise Vault Outlook Add-In on users' computers.

2 Enable the registry value PSTDisableGrowAllowAuthenticodeOverrides in oneof the following locations:

■ For Outlook 2010:HKEY_CURRENT_USER\Software\Policies\Microsoft\Office\14.0\Outlook\PST

■ For Outlook 2013:HKEY_CURRENT_USER\Software\Policies\Microsoft\Office\15.0\Outlook\PST

60Setting up archiving from mailboxesOverriding PSTDisableGrow

You must use one of the locations that are shown here. Note that, unlike thedefault PSTDisableGrow locations, these paths include the \Policies subkey.

Both PSTDisableGrow and PSTDisableGrowAllowAuthenticodeOverrides mustbe of type REG_DWORD, and have a value of 1.

Users’ tasks for Exchange Server mailboxarchiving

If you have set automatic enabling of mailboxes in the Provisioning Group, and youhave chosen to initially suspend archiving, Outlook users must manually enableautomatic archiving for their mailboxes.

Instructions on how to turn on archiving for a mailbox are given in the onlineEnterprise Vault help in Outlook and also included in the Welcome message.

How users turn on automatic archiving for their mailbox in Outlook

1 In Outlook, ensure that the Outlook Navigation Pane is open and make mailboxfolders visible. Right-click the mailbox.

2 On the shortcut menu, click Data File Properties.

3 Click the Enterprise Vault tab.

4 Click Change.

5 Clear Suspend Enterprise Vault archiving for this mailbox.

6 Click OK.

61Setting up archiving from mailboxesUsers’ tasks for Exchange Server mailbox archiving

Setting up users’ desktopsThis chapter includes the following topics:

■ About setting up users' desktops for Exchange Server archiving

■ Enterprise Vault Outlook Add-In for Exchange Server archiving

■ Enterprise Vault Client for Mac OS X with Exchange Server archiving

■ Forcing Outlook to synchronize forms when using Exchange Server archiving

■ Getting users started with Exchange Server archiving

■ What next?

About setting up users' desktops for ExchangeServer archiving

Desktop policies define the end user's experience when using the Enterprise VaultExchange clients. Setting up desktop policies is described as part of setting upmailbox archiving.

See “Defining desktop policies in Exchange Server archiving” on page 35.

Other sections cover the additional steps required to set up users' desktops to workwith Enterprise Vault. The steps include distributing the Outlook Add-In and enablingits installation, enabling searching of archives using Windows Desktop Search, andensuring Outlook is set up to synchronize forms.

4Chapter

Enterprise Vault Outlook Add-In for ExchangeServer archiving

The Enterprise Vault Outlook Add-In is available as an MSI installer package. Thepackage is in the folder Outlook Add-In on the Enterprise Vault distribution media.

The Exchange desktop policy Outlook advanced setting Outlook Add-In behaviorlets you configure the Outlook Add-In to work in either of the following modes:

■ Full mode. In full mode, there are no functional restrictions on the behavior ofthe Outlook Add-In.

■ Light mode. This mode is the default. In light mode, the following restrictionsapply:

■ Users have no access to the Enterprise Vault properties of folders.

■ When users archive items manually, they cannot specify the destinationarchive and retention category.

■ When users restore archived items, they cannot choose the destinationfolder. The Outlook Add-In only restores items to the folders where theshortcuts are.

For more information about the advanced setting Outlook Add-In behavior, seethe Administrator's Guide.

If Outlook users access Exchange Server 2010 using RPC over HTTP, you willalso need to enable the Enterprise Vault Outlook Add-In for RPC over HTTPconnections.

See “About Outlook RPC over HTTP and Outlook Anywhere configurations”on page 163.

Before users have access to Enterprise Vault features from within Outlook, theOutlook Add-In must be installed on each desktop computer.

Distributing the Outlook Add-InThere are various ways of distributing the Outlook Add-In. For example, you canuse one of the following methods:

■ Deploy the MSI kit to desktop computers using an Active Directory Group Policy.

Note: This distribution method is deprecated and will not be supported in futurereleases.

See “Publishing the Outlook Add-In in Active Directory for Exchange Serverarchiving” on page 65.

63Setting up users’ desktopsEnterprise Vault Outlook Add-In for Exchange Server archiving

■ Deploy the MSI kit to desktop computers using a software distribution application,such as Microsoft System Center Configuration Manager.

■ Set up manual installation.See “Setting up manual installation of the Outlook Add-In” on page 66.

Enterprise Vault buttons and menu options do not appear in Outlook until the user'smailbox has been enabled and the user has restarted Outlook. You can thereforeroll out the Enterprise Vault Outlook Add-In before users' mailboxes are enabled.

Enabling Windows Desktop Search plug-in for Exchange Serverarchiving

A plug-in for Windows Desktop Search is included in the Enterprise Vault OutlookAdd-In. Using advanced settings in the Exchange Desktop policy, you can enableusers to search their Vault Cache from Windows Desktop Search.

Note that Windows Desktop Search must be installed on the desktop computersbefore you install the Outlook Add-In.

The plug-in is not enabled by default when the Outlook Add-In is installed.

To enable Vault Cache users to search their Vault Caches

1 In the Administration Console, open the Advanced properties page of theExchange Desktop policy.

2 Select Vault Cache settings from the drop-down list.

3 Set WDS search auto-enable to Force on.

4 On the Synchronization page of the Exchange Mailbox task properties,synchronize the user mailboxes.

5 When users next start Outlook, the policy changes are implemented.

See “Configuring Windows Search for Exchange Server archiving” on page 71.

Note that to use Windows Desktop Search to search their Vault Cache, usersdo not require Administrator privileges on their desktop computer.

Command line activation of Windows Desktop Searchplug-in for Exchange Server archivingThe recommended way to enable Vault Cache searching is using the WDS SearchAuto-enable setting in the Exchange Desktop Policy. Alternatively, you can enablethe plug-in during installation by including the command line parameterACTIVATE_WDS_PLUGIN=1. Note that this command line switch is case-sensitive.

For example, the command line for a silent install would be the following:


msiexec /I path_to_installer ACTIVATE_WDS_PLUGIN=1 /qn

where path_to_installer is the path to the Enterprise Vault Outlook Add-In MSI file.


Publishing the Outlook Add-In in Active Directory for Exchange Serverarchiving

This section describes the steps to publish the Outlook Add-In using Active DirectoryGroup Policy.

Note: This distribution method is deprecated and will not be supported in futurereleases.

To publish the Outlook Add-In in Active Directory for Exchange Serverarchiving

1 Copy the MSI file from the Enterprise Vault distribution media to the networkshare from which you want it to be distributed.

2 In Windows, open the Group Policy Management administrative tool.

3 In the left pane, navigate to the Organizational Unit to which you want to makethe Outlook Add-In available.

4 Right-click the Organizational Unit and, on the shortcut menu, click Create aGPO in this domain, and Link it here.

5 Enter a name for the Group Policy Object (GPO), for example "EV DesktopRollout", and click OK.

6 Right-click the new GPO and, on the shortcut menu, click Edit. The GroupPolicy Management Editor appears.

7 In the left pane, under Computer Configuration, expand Policies andSoftware Settings.

8 Right-click Software installation and, on the shortcut menu, click New andthen Package.

9 Select the MSI file that you copied in step 1. In the File name box, ensure thatthe file name includes the UNC path of the file. For example:

\\mycomputer\distribute\Veritas Enterprise Vault Outlook

Add-in.msi

Then click Open. The Deploy Software dialog box opens.


10 Select Assigned and click OK.

The new package appears in the list of software installations.

11 Close the Group Policy Management Editor.

The new package is installed when each user’s computer is restarted.

Setting up manual installation of the Outlook Add-InThe usual way to install the Outlook Add-In is to deploy the MSI package to desktopcomputers using a software distribution application. However, you can allow usersto install the Outlook Add-In themselves. The users must have local administratorpermissions to install the Outlook Add-In.

In some cases the users can launch the MSI directly, but for some users you alsoneed to provide a setup.exe file. The users must run setup.exe to launch the MSI.The setup.exe file that you may need is included on the Enterprise Vault media,in the same folder as the MSI file.

You need to provide a setup.exe file if both of the following conditions apply:

■ The operating system on the client computer is Windows 7, Windows 8 orWindows 10.

■ Windows User Account Control (UAC) is turned on.

Launching the MSI with setup.exe ensures that the installation process is elevatedbefore the MSI is launched. This early elevation is necessary to enable theinstallation to complete all of its processes. If UAC is turned on and a user tries tolaunch the MSI directly, the installation process displays an error message.

Note: When a user runs setup.exe, it must be in the same folder as the MSI file.

To make the MSI file and setup.exe available to users

1 Place the MSI file in a shared folder, together with the setup.exe if required.

The files are in the Outlook Add-In folder on the Enterprise Vault media.

2 Do one of the following:

■ For a new installation of Enterprise Vault, add a link to the Welcomemessage from which users can access the shared folder. Edit the Welcomemessage to include suitable instructions. If you have provided setup.exe,tell users to run setup.exe, not the MSI file. If they download the files, tellthem that the files must be in the same folder.See “Editing the Welcome message for Exchange Server archiving”on page 55.


■ For an upgrade installation, users do not receive the Welcome message,so inform them by another method. If you have provided setup.exe, tellusers to run setup.exe, not the MSI file. If they download the files, tell themthat the files must be in the same folder.

See “Enterprise Vault Outlook Add-In for Exchange Server archiving” on page 63.

Managing FilesInUse dialog boxes in a manual upgradeor an uninstall of the Outlook Add-InThe information in this section is provided so that if necessary you can advise usersabout which option to choose in a FilesInUse dialog box. The section also outlineshow you can prevent FilesInUse dialog boxes from appearing.

When a user upgrades the Outlook Add-In manually on Windows 7, Windows 8 orWindows 10, the Windows Restart Manager may detect that one or more files arelocked. In this case, the Restart Manager displays a FilesInUse dialog box that saysthat the relevant application or applications should be closed. The dialog box mayalso appear during an uninstall of the Outlook Add-In. In a new installation of theOutlook Add-In, the dialog box is much less likely to appear, though it is still possible.

The user can choose one of the following options:

■ Close the applications automatically and attempt to restart them after setup iscomplete. This option is the default.

■ Do not close the applications, but a system restart may be required.

We recommend that users should choose the option to close and restart theapplications automatically.

Table 4-1 shows the applications that users are most likely to see in the dialog box.

Table 4-1 Applications in a FilesInUse dialog box

NotesApplication name

A file is locked because Windows Explorer has loaded it tosupport search functionality.

If the user chooses to close Windows Explorer automatically,all Explorer windows are closed. The Desktop also closes,which the user may not expect; that is, the Desktop iconsand the Taskbar disappear for a short time. The installationcontinues and Windows Explorer is restarted.

Windows Explorer


Table 4-1 Applications in a FilesInUse dialog box (continued)

NotesApplication name

Windows may have used this process to load an EnterpriseVault DLL to support integration with the Indexing Options inthe Windows Control Panel.

If the user chooses to close the process automatically, theinstallation continues and the process is restarted. However,users may not recognize the process name. They may notwant to close this application in case it closes Windows, andmay not know which option to choose.

Windows host process(Rundll32)

We recommend that users close Outlook before they installor upgrade the Outlook Add-In, but it is not essential. Theuser can choose to close Outlook automatically.

Outlook

If Restart Manager is disabled, the FilesInUse dialog box may provide differentoptions, as follows:

■ Cancel the installation. This option is the default.

■ Retry after the user has closed the application.

■ Ignore the locked file. With this option, a system restart may be required.

We recommend that users should choose the option to ignore the locked file.

To disable the Restart Manager, you can set MSIRESTARTMANAGERCONTROLto Disable in the msiexec command line.

Alternatively, you can apply a transform to the MSI package to disable the RestartManager. You can also use the transform to remove the FilesInUse dialog box fromthe installer.

See “Enterprise Vault Outlook Add-In for Exchange Server archiving” on page 63.


Enterprise Vault Client for Mac OS X withExchange Server archiving

The installer kit for the Enterprise Vault Client for Mac OS X is available as a diskimage (.dmg) file. The file is located under the folder Client for Mac OS X on theEnterprise Vault distribution media.

There are various ways to distribute the client. For example, you can do the following:

■ Send users a shortcut to the .dmg file.

68Setting up users’ desktopsEnterprise Vault Client for Mac OS X with Exchange Server archiving

See “Editing the Welcome message for Exchange Server archiving” on page 55.

■ Deploy the .dmg file to desktop computers using a software distributionapplication.

Setting up Kerberos authentication for the Enterprise Vault Client forMac OS X

To use Kerberos authentication between the Enterprise Vault Client for Mac OS Xand the Exchange and Enterprise Vault servers, you must do both of the following:

■ On each Exchange server and Enterprise Vault server in your site, configureInternet Information Services (IIS) to allow Windows authentication with theNegotiate setting enabled. This is necessary to ensure that users can log in tothe Enterprise Vault Client and select the facilities on its toolbar and menu.

■ Register with Active Directory a Service Principal Name (SPN) for eachEnterprise Vault server and its DNS alias.

To configure IIS to allow Windows authentication with the Negotiate settingenabled

1 Open Internet Information Services (IIS) Manager.

2 In the left pane, navigate to the level that you want to manage.

On Microsoft Exchange servers, this is the Exchange and EWS virtualdirectories. On Enterprise Vault servers, it is the EnterpriseVault virtual directory.

3 In Features View, double-click Authentication.

4 On the Authentication page, ensure that the status of WindowsAuthentication is Enabled.

If the status of Windows Authentication is Disabled, select WindowsAuthentication and then click Enable in the Actions pane.

5 With Windows Authentication selected, click Providers in the Actions pane.

6 Ensure that the list of enabled providers includes Negotiate.

To register with Active Directory an SPN for each Enterprise Vault server andits DNS alias

◆ See the following article on the Microsoft website for guidelines on how toregister the SPNs:

http://social.technet.microsoft.com/wiki/contents/articles/717.service-principal-names-spns-setspn-syntax-setspn-exe.aspx

69Setting up users’ desktopsEnterprise Vault Client for Mac OS X with Exchange Server archiving



ForcingOutlook to synchronize formswhen usingExchange Server archiving

If an Outlook user has enabled Use Cached Exchange Mode, then by default Outlookforms are not synchronized. This results in Enterprise Vault icons not being displayedfor archived items.

To make Outlook synchronize forms

1 Start Outlook.

2 Open the Send/Receive Groups dialog box:

■ In Outlook 2010 and later: click the File tab, then click Options, then clickAdvanced. Under Send and receive, click Send/Receive.

3 Select All Accounts Online and Offline and click Edit.

4 Select Synchronize Forms.

5 Exit from Outlook and then restart it.

6 Open an archived item. This automatically installs the forms.

Getting users started with Exchange Serverarchiving

You should ensure that users know how to install the Enterprise Vault OutlookAdd-In or Client for Mac OS X, as necessary, using one of the methods describedin other sections, and how to use Enterprise Vault.

JavaScript must be enabled in users' browsers.

If you want users to be able to launch facilities such as Enterprise Vault Search ina standalone browser, you will need to tell them the URL to use. You could includethis information in the Welcome message.

See “Editing the Welcome message for Exchange Server archiving” on page 55.

If you are making Microsoft Exchange Forms for Enterprise Vault available usingOrganizational Forms Library, ensure that the forms have been installed on allMicrosoft Exchange Server computers that are being processed by Enterprise Vault.

See “About distributing the Microsoft Exchange forms when setting up ExchangeServer archiving” on page 19.


70Setting up users’ desktopsForcing Outlook to synchronize forms when using Exchange Server archiving

Configuring Windows Search for Exchange Server archivingIf you have enabled the Enterprise Vault plug-in for Windows Search, users canuse Windows Search to search their local Vault Cache. Before they can do this,they need to start Outlook and the Windows Search.

They can use the following steps to check that the Vault Cache and Virtual Vaultare configured in Windows Search indexing, and force Windows Search to indexarchived items.

To check the Windows Search options

1 Open the Control Panel and then click Indexing Options.

2 In the Indexing Options dialog box, click Modify.

3 In the Change selected locations list, ensure that the entry for your VirtualVault is selected. In addition, if the Veritas Vault Cache location appears in thelist, ensure that it is selected.

4 Click OK.

5 Close the Indexing Options dialog box.

When your computer is idle, Windows Search updates its index to include the itemsin your Vault Cache.

What next?You should now have a fully functioning Enterprise Vault system. You may findover time that you need to change some of the properties of Enterprise Vault to suityour requirements. For details about these and any other features of EnterpriseVault, refer to the online Help.

71Setting up users’ desktopsWhat next?

Setting up Vault Cacheand Virtual Vault


■ About Vault Cache and Virtual Vault

■ Vault Cache content strategy

■ Vault Cache synchronization

■ Preemptive caching when using Vault Cache

■ The Vault Cache wizard

■ Setting up Vault Cache and Virtual Vault

■ Vault Cache advanced settings

■ Virtual Vault advanced settings

About Vault Cache and Virtual VaultA Vault Cache is a local copy of a user's Enterprise Vault archive. The Vault Cacheis maintained on the user's computer by the Enterprise Vault Outlook Add-In.

The main functions of Vault Cache are as follows:

■ It makes Virtual Vault available to users, if you choose to enable Virtual Vault.

■ It lets offline users open archived items from Enterprise Vault shortcuts.

Virtual Vault integrates a view of the user's archive into the Outlook NavigationPane. To users, a Virtual Vault looks like a mailbox or a personal folder, and itbehaves in much the same way. For example, users can open archived items anddrag and drop items to and from the Virtual Vault.

5Chapter

Figure 5-1 shows a mailbox and a Virtual Vault in the Outlook Navigation Pane.

Figure 5-1 Example of a Virtual Vault

Figure 5-2 shows the relationship between Vault Cache and Virtual Vault, and VaultCache synchronization with the online archive.

73Setting up Vault Cache and Virtual VaultAbout Vault Cache and Virtual Vault

Figure 5-2 Vault Cache and Virtual Vault

Enterprise Vault Storage serverUser’s computer

EnterpriseVaultarchives

Mailbox

Virtual Vault

Outlook UI Vault Cache Vault Store

Content

Headerinformation

ArchiveExplorer

Online:

open shortcut

open shortcut

Offline: IIS

Outlook actions

on items and folders

Online:

Con

tent

dow

nloa

d

Online

Offline

immediate access to archive ifitem content is not in Vault Cache

Hea

der

sync

hron

izat

ion

The user can synchronize archives other than their primary mailbox archive to theVault Cache, if they have the necessary permissions. Each archive that issynchronized to a Vault Cache has its own Virtual Vault, if Virtual Vault is enabled.In Virtual Vault, access to archives other than the user's primary mailbox archiveis read-only.

The actions that users can perform in Virtual Vault include the following:

■ View, forward, and reply to archived items

■ After opening an email to send from Outlook, drag and drop items from VirtualVault into the email to send them as attachments

■ Search the Virtual Vault with Outlook Instant Search, Outlook Advanced Find,or Windows Desktop Search

■ Delete items and folders

74Setting up Vault Cache and Virtual VaultAbout Vault Cache and Virtual Vault

■ Move items between folders, and reorganize folders

■ Archive items using drag and drop

■ Move items into Virtual Vault using Outlook rules

Note: The Vault Cache feature is not available to users of the Enterprise VaultClient for Mac OS X.

Vault Cache content strategyYou can specify a strategy for how the content of archived items is stored in VaultCache. The content strategy controls whether full items or just item headers arestored locally.

The content strategy options are on the Vault Cache tab in the Exchange Desktoppolicy, and are as follows:

■ Do not store any items in cache. Item headers are synchronized to VaultCache, but the content of archived items is not stored in Vault Cache. If a userwho is online opens an item in Virtual Vault, Enterprise Vault immediatelyretrieves the content from the online archive.

■ Store all items. This option is the default. Item headers are synchronized toVault Cache and the content of archived items is stored in Vault Cache.

■ Store only items that user opens. Item headers are synchronized to VaultCache. If a user who is online opens an item in Virtual Vault, or selects an itemwhen the Reading Pane is open, Enterprise Vault immediately retrieves thecontent from the online archive. The content of each item that a user opens inVirtual Vault is stored in Vault Cache.

See “Show content in Reading Pane (Exchange Virtual Vault setting)” on page 93.

See “Vault Cache header synchronization and content download” on page 77.

Vault Cache synchronizationVault Cache synchronization updates the Vault Cache with changes made to theonline archive, and updates the online archive with changes made to the VaultCache. The changes that are synchronized between Vault Cache and the onlinearchive include create, update, and delete actions on items and folders.

Whether the Vault Cache is fully up to date with the online archive depends onwhen Vault Cache synchronization and the Exchange Mailbox Archiving task lastran.

75Setting up Vault Cache and Virtual VaultVault Cache content strategy

After an initial synchronization when the Vault Cache is first enabled, synchronizationcan start in the following ways:

■ The Enterprise Vault Outlook Add-In automatically performs Vault Cachesynchronization once a day. If the Outlook Add-In cannot connect to EnterpriseVault, then it waits for a minimum of five minutes before it attempts to contactthe server again.If a scheduled synchronization time is missed, the Outlook Add-In attempts asynchronization when the user next opens Outlook. The first attempt is madeafter the period specified in the Exchange Desktop policy, in the Vault Cacheadvanced setting Pause interval.For example, users may miss their scheduled Vault Cache synchronizationtimes during a weekend, when they do not use Outlook. In this case, a largenumber of header synchronization requests may occur at around the same timeon Monday. To avoid an excessive load on the Enterprise Vault server, anEnterprise Vault mechanism limits the number of header synchronization requeststhat are accepted. When this mechanism operates, scheduled synchronizationsucceeds for some users. Other users have to wait until their headersynchronization request is processed. The mechanism is invisible to users, sothey do not see any error message. Their header synchronization request isrepeated, as usual, at minimum intervals of five minutes until it succeeds. Whenthe synchronization succeeds, the daily scheduled synchronization time is resetto the time of the successful synchronization.Alternatively, you can use the registry setting,OVAllowMissedMDCSyncOnStartup, to configure the Outlook Add-In to ignoremissed scheduled Vault Cache synchronizations when the user opens Outlook.If you enable this setting, a Vault Cache sychronization occurs at the nextscheduled sychronization time.

■ If Vault Cache synchronization is required at other times, the user can start thesynchronization in Outlook. A manual synchronization does not affect the nextscheduled time for automatic synchronization.Unlike a scheduled synchronization, a manual synchronization that fails is notretried.

■ You can use the Virtual Vault advanced settings Threshold number of itemsto trigger synchronization and Threshold total size of items to triggersynchronization to trigger an automatic Vault Cache synchronization. Thesettings specify thresholds for the number and total size of pending archiveitems in Virtual Vault.These threshold settings are important if your users move or copy items fromtheir mailboxes into Virtual Vault to archive them. When only scheduledsynchronization and manual synchronization are in use, items are probably notarchived until the scheduled time. Until then, moved and copied items exist only

76Setting up Vault Cache and Virtual VaultVault Cache synchronization

on the user's computer. The threshold settings let you control whensynchronization occurs, so you can minimize the risk of data loss.By default, the threshold settings are not active. You can optionally set one orboth of them. If you set both, the first threshold value that is reached or exceededtriggers a synchronization.If the user suspends Vault Cache synchronization and either of these thresholdsettings is active, the user cannot move or copy items into Virtual Vault.Unlike a scheduled synchronization, an automatically triggered synchronizationthat fails is not retried.See “Threshold number of items to trigger synchronization (Exchange VirtualVault setting)” on page 94.See “Threshold total size of items to trigger synchronization (Exchange VirtualVault setting)” on page 95.

The content download from the Enterprise Vault server to the Outlook client usesMicrosoft Background Intelligent Transfer Service (BITS) technology.

For information about troubleshooting Vault Cache synchronization problems, seethe appendix "Troubleshooting" in the Administrator's Guide. The section on VaultCache synchronization problems includes details of how to use the Vault CacheDiagnostics web page. This web page shows the last Vault Cache synchronizationattempt from each user, and for each archive that they synchronize. The reportinginformation that is displayed on the page is posted by client computers immediatelyafter they attempt a synchronization, and regardless of the outcome.

See “Vault Cache initial synchronization” on page 79.

Vault Cache header synchronization and content downloadVault Cache synchronization consists of the following processes:

■ Header synchronization

■ Content download

Vault Cache header synchronizationHeader synchronization is always part of Vault Cache synchronization. The itemheader contains enough information to enable the item to be represented in VirtualVault and elsewhere. It also contains information to associate the header with thecontent of the full item.

Where changes have occurred in the online archive, Vault Cache synchronizationdownloads header information from the Enterprise Vault server and applies thechanges to the Vault Cache.


Note that some changes within the mailbox do not take effect in the online archiveuntil the next run of the Mailbox Archiving task. For example, a run of the MailboxArchiving task is required when a user moves an archived item or creates a folderin the mailbox.

Changes to the online archive may potentially require Vault Cache synchronizationto include content download as well as header synchronization, for example whenan item is automatically archived. However, content download may not be necessaryif preemptive caching is in use.

See “Preemptive caching when using Vault Cache” on page 80.

Where changes have occurred in Virtual Vault and therefore in Vault Cache, thosechanges are synchronized to the online archive.

Header synchronization also synchronizes any changes that are made to the folderhierarchy, either in the online archive or in Virtual Vault. Users cannot move, delete,or rename a folder in Virtual Vault if the folder exists in the mailbox. Users mustperform the actions on these folders in the mailbox, in Outlook or OWA.

Vault Cache content downloadContent download is performed only when the content strategy is Store all items.Vault Cache synchronization downloads the content of items from the online archiveto the Vault Cache. After the initial Vault Cache synchronization, content downloadcan be minimized by preemptive caching. You can determine the age of items onwhich to perform preemptive caching, using the Vault Cache advanced settingPreemptive archiving in advance.

See “Preemptive caching when using Vault Cache” on page 80.

If the content strategy is Store only items that user opens, an item's content isdownloaded immediately when the user opens the item. The content is then storedin Vault Cache for later use.

Vault Cache and Virtual Vault statusYou can check the status and details of Vault Cache synchronization in the VaultCache Properties dialog box in Outlook on the user's computer.

If you have enabled users to archive items by moving them into Virtual Vault, theusers' Virtual Vaults include the following search folders:

■ Could Not Archive. This folder lists items that Vault Cache synchronizationcould not archive, after the number of attempts configured in the advancedsetting Max attempts to archive an item.


■ To Archive. This folder lists items that the user has moved or copied into VirtualVault and that are awaiting archiving. The folder does not include items thatVault Cache synchronization could not archive.

Vault Cache initial synchronizationWhen a mailbox is enabled for Vault Cache, header synchronization starts whenthe Vault Cache wizard finishes. Content download may also be performed, if thecontent strategy requires content download. If the archive contains a large numberof items, content download takes much longer than header synchronization.

You can control the maximum age of items in the initial content download using theVault Cache advanced settings Download item age limit and Lock for downloaditem age limit.

A Virtual Vault is automatically added to a user's profile when the following criteriaare met:

■ The Enterprise Vault archiving task has processed all the archives that the usercan access.

■ The initial header synchronization has completed.

■ The user has not previously removed the Virtual Vault from the profile.

If a Virtual Vault does not appear automatically in the Navigation Pane, the usercan select it on the Virtual Vault tab in the Vault Cache Properties dialog box.

Control of concurrent content download requests by Vault CacheTo control the amount of system resources used by Vault Cache content downloads,you can restrict the number of content download requests that the server managesat a time. To restrict the number of content download requests, use the settingMaximum number of concurrent updates on the Cache tab of the EnterpriseVault server properties.

Enterprise Vault server cache location when using Vault CacheIf new items have been added to the online archive, copies of these items are heldtemporarily in a cache on the Enterprise Vault server. The items are thendownloaded to the user's computer. The location of the server cache is specifiedon the Cache tab of the Enterprise Vault server properties.

Retention category changes when using Virtual VaultIn Virtual Vault, some changes may affect the retention categories of items andfolders. These changes are handled as follows:


■ If a user moves an item between folders with different retention categories, theitem's retention category is updated. But if the original retention category preventsdeletion and the destination folder's retention category allows deletion, theretention category is not updated.

■ The user may move a folder that inherits its retention category into a folder witha different effective retention category. (The effective retention category is theretention category that is either inherited or assigned specifically.) In this case,the moved folder and its contents inherit the new retention category. Anysubfolders and their contents that inherit the retention category are similarlyupdated.

■ The user may move a folder with a specific retention category into a folder witha different effective retention category. In this case, the moved folder’s retentioncategory does not change.

■ If the user creates a new folder in Virtual Vault, the folder inherits its parentfolder's retention category.

Note: The effects of these actions on retention categories also depend on theUpdate the category for items moved within an archive settings on the ArchiveSettings tab in the Enterprise Vault site properties. The settings control whetherthe retention category of moved items is always updated, or updated only whenthe retention period is increased or unchanged. These options apply only to itemsthat are moved between folders in the same archive; they do not apply to items thatare moved from one archive to another.

Preemptive caching when using Vault CacheTo minimize downloads to the Vault Cache, the Outlook Add-In regularly searchesthe mailbox for any items that are due to be archived soon. It automatically addsthese items to the Vault Cache. This feature is called preemptive caching.

The Vault Cache advanced setting Offline store required controls whether anoffline store is required in Outlook for Vault Cache to be enabled. If a user does nothave an OST file, Enterprise Vault cannot perform preemptive caching.

See “Offline store required (Exchange Vault Cache setting)” on page 84.

See “Preemptive archiving in advance (Exchange Vault Cache setting)” on page 85.

The Vault Cache wizardYou can choose to enable Vault Cache automatically for users' mailboxes, or allowusers to enable it by running the Vault Cache wizard in Outlook.

80Setting up Vault Cache and Virtual VaultPreemptive caching when using Vault Cache

The wizard enables Vault Cache for the user's primary mailbox only. If the user hasaccess to other archives, those archives are listed on the Vaults tab in the VaultCache Properties dialog box in Outlook. The additional archives are notsynchronized to the Vault Cache until the user selects them in the dialog box.

Setting up Vault Cache and Virtual VaultBefore you set up Virtual Vault, see the Virtual Vault Best Practice Guide. It isavailable from:

http://www.veritas.com/docs/TECH75381

To enable Vault Cache, you select Make Vault Cache available for users on theVault Cache tab in the Exchange Desktop policy. To enable Virtual Vault, youselect Make Virtual Vault available to users, as well as Make Vault Cacheavailable for users.

You can also do the following:

■ Change the default Vault Cache settings on the Vault Cache tab.

■ Configure Vault Cache and Virtual Vault advanced settings in the ExchangeDesktop policy. You should review the advanced settings, and change them ifnecessary, before you synchronize the updated policy to users’ mailboxes.

A Vault Cache is created for each Windows user's mailbox profile. A single usercan have several Vault Caches, if the user has access to several mailbox profiles.

To set up Vault Cache and Virtual Vault in the Exchange Desktop policy

1 In the Exchange Desktop policy, on the Vault Cache tab, select Make VaultCache available for users.

2 On the Vault Cache tab, select or clear other settings as required. If you wantto enable Virtual Vault, select Make Virtual Vault available to users.

For descriptions of the settings, click Help on the Vault Cache tab.

3 Click Apply.

4 On the Exchange Desktop policy Advanced tab, click Vault Cache on the Listsettings from menu and configure advanced settings for Vault Cache.

See “Vault Cache advanced settings” on page 82.

5 Click Apply.

6 If you have enabled Virtual Vault, click Virtual Vault on the List settings frommenu and configure advanced settings for Virtual Vault.

See “Virtual Vault advanced settings” on page 87.

81Setting up Vault Cache and Virtual VaultSetting up Vault Cache and Virtual Vault


7 Click OK.

8 If you have disabled the expansion of PST files on users' computers by settingthe registry entry PstDisableGrow, then you need to perform some additionalsetup tasks on users' computers.

See “Overriding PSTDisableGrow” on page 59.

Vault Cache advanced settingsThe Vault Cache advanced settings let you control the behavior of Vault Cache.

Table 5-1 lists the Vault Cache advanced settings.

Table 5-1 Vault Cache advanced settings

DescriptionAdvanced setting

Specifies the maximum age of items, in days,at which items are considered too old to beinitially downloaded to the Vault Cache.

Download item age limit (Exchange VaultCache setting)

Controls whether users can change thedownload age limit.

Lock for download item age limit (ExchangeVault Cache setting)

Controls whether an item that is manuallyarchived is also automatically added to theVault Cache.

Manual archive inserts (Exchange VaultCache setting)

Controls whether Vault Cache can be enabledwhen no offline store (OST) file is present.

Offline store required (Exchange Vault Cachesetting)

The number of minutes to wait beforeEnterprise Vault starts searching for itemsthat need to be added to the Vault Cache.

Pause interval (Exchange Vault Cachesetting)

The delay, in milliseconds, that will be usedbetween items when updating the VaultCache.

Per item sleep (Exchange Vault Cachesetting)

The Outlook Add-In uses this value when itdetermines the age of items on which toperform preemptive caching.

Preemptive archiving in advance (ExchangeVault Cache setting)

The location in which to place Vault Caches.Root folder (Exchange Vault Cache setting)

Enables you to supply a list of possiblelocations for the Vault Cache.

Root folder search path (Exchange VaultCache setting)

82Setting up Vault Cache and Virtual VaultVault Cache advanced settings

Table 5-1 Vault Cache advanced settings (continued)


Controls whether the client shows the VaultCache setup wizard.

Show Setup Wizard (Exchange Vault Cachesetting)

Controls what is synchronized by VaultCache.

Synchronize archive types (Exchange VaultCache setting)

Controls whether the Vault Cache searchplug-in for Windows Desktop Search isautomatically enabled for users.

WDS search auto-enable (Exchange VaultCache setting)

Download item age limit (Exchange Vault Cache setting)

Specifies the maximum age of items, in days, at which items areconsidered too old to be initially downloaded to the Vault Cache.

For example, if Download item age limit is set to 30 then items up to30 days old are downloaded. If Download item age limit is set to 0then all items are downloaded.

Description

■ 0. No age limit. All items are downloaded.■ Integer. The maximum age, in days, of items that will be downloaded.

All items up to this age will be downloaded.

Supported values

OVDownloadItemAgeLimitLegacy name

Lock for download item age limit (Exchange Vault Cache setting)

Controls whether users can change the download age limit.Description

■ On. Locked.■ Off. Not locked.

Supported values

OVLockDownloadItemAgeLimitLegacy name

Manual archive inserts (Exchange Vault Cache setting)

Controls whether an item that is manually archived is also automaticallyadded to the Vault Cache.

Description


■ On (default). Automatically add manually archived items to the VaultCache.

■ Off. Do not add to the Vault Cache.

Supported values

OVNoManualArchiveInserts.Legacy name

Offline store required (Exchange Vault Cache setting)

Controls whether Vault Cache can be enabled when no offline store ispresent.

Users have offline store (OST) files if Outlook Cached Exchange Modeis enabled. If a user does not have an OST file, Enterprise Vault cannotperform preemptive caching.

If there is no preemptive caching, there is an increased load on VaultCache content synchronization for newly archived items. The increasedload is only a consideration if the Vault Cache content strategy is Storeall items.

Description

■ Yes (default). An offline store is required for Vault Cache to beenabled.

■ No. An offline store is not required for Vault Cache to be enabled.

Supported values

OVRequireOfflineStoreLegacy name

Pause interval (Exchange Vault Cache setting)

The number of minutes to wait before Enterprise Vault starts searchingfor items that need to be added to the Vault Cache.

Description

■ An integer value. The default is 3 (minutes).Supported values

OVPauseIntervalLegacy name

Per item sleep (Exchange Vault Cache setting)

The delay, in milliseconds, that will be used between items whenupdating the Vault Cache.

Description

■ Integer. The number of milliseconds to use between items whenupdating the Vault Cache Default is 100 (milliseconds).

Supported values

OVPerItemSleepLegacy name


Preemptive archiving in advance (Exchange Vault Cache setting)

The Outlook Add-In copies items from the user's Outlook .OST file tothe Vault Cache before the items are due to be archived. The processis known as preemptive caching. Preemptive caching takes place onthe user's computer. It reduces the number of items that need to bedownloaded from the mailbox archive to the Vault Cache when the twoare synchronized.

Preemptive caching obeys the settings in the Exchange mailbox policy'sarchiving rules.

The Outlook Add-In uses the Preemptive archiving in advance valuewhen it determines the age of items on which to perform preemptivecaching. To determine the age, it deducts the Preemptive archivingin advance value from the Archive items when they are older thanvalue in the Exchange mailbox policy's archiving rules.

For example, you do not change Preemptive archiving in advancefrom its default value. You set the Archive items when they are olderthan mailbox policy setting to six weeks. The Outlook Add-In deductsthe Preemptive archiving in advance default value of seven daysfrom six weeks, and preemptively caches the items that are five weeksold or older.

Note that if you use an archiving strategy that includes quotas, it isdifficult to predict the age at which items are archived. It is then usuallyadvantageous to preemptively cache items as soon as possible.Enterprise Vault therefore uses 0 days as the age at which to performpreemptive caching if both of the following are true:

■ The mailbox policy uses an archiving strategy that is based on quotaor age and quota.

■ You do not change the Preemptive archiving in advance settingfrom its default value.

Description

■ An integer, specifying a number of days. The default is 7.Supported values

OVPreemptAdvanceLegacy name

Root folder (Exchange Vault Cache setting)

The location in which to place Vault Caches. This value is used whena user enables Vault Cache. Changing this value has no effect onexisting Vault Caches.

Description


■ Path. A path to a folder that Enterprise Vault can create on the user'slocal computer. If you do not specify Root Folder, Enterprise Vaultuses an Enterprise Vault subfolder in the user's Application Datafolder.

Supported values

OVRootDirectoryLegacy name

Root folder search path (Exchange Vault Cache setting)

Enables you to supply a list of possible locations for the Vault Cache.The first such location that is valid on a user's computer is the one thatwill be used at the time the Vault Cache is created. This enables youto specify a list that is likely to be suitable for computers with differentconfigurations.

For example, if you specify E:\vault;C:\vault then the Vault Cachewould be created in E:\vault if that was valid on the user's computerand, if it was not valid, then in C:\vault.

If none of the locations is valid, the one specified by Root folder is used,if possible.

See “Root folder (Exchange Vault Cache setting)” on page 85.

Description

■ A text string. A semicolon-separated list of possible locations for theVault Cache.

Supported values

OVRootDirectorySearchPathLegacy name

Show Setup Wizard (Exchange Vault Cache setting)

Controls whether the client shows the Vault Cache setup wizard.

The setup wizard does the following:

■ Summarizes what Vault Cache does and what is about to happen.■ Asks whether the user wants to start a download automatically after

the initial scan has finished. The default is to start the download.

If the wizard is turned off, Vault Cache waits for the amount of time thatis specified in Pause interval and then automatically begins lookingfor items to download.

See “Pause interval (Exchange Vault Cache setting)” on page 84.

Description

■ 0. Do not show the setup wizard.■ 1 (default). Show the setup wizard.

Supported values


OVSetupWizardLegacy name

Synchronize archive types (Exchange Vault Cache setting)

Controls what is synchronized by Vault Cache.Description

■ Default mailbox. Synchronize the primary mailbox only.■ All mailbox archives. Synchronize the primary mailbox archive, and

any delegate mailbox archives to which the user has access.■ All mailbox and shared archives. Synchronize the primary mailbox

archive, and any delegate or shared mailbox archives to which theuser has access.

Supported values

OVSyncArchiveTypesLegacy name

WDS search auto-enable (Exchange Vault Cache setting)

Controls whether the Vault Cache search plug-in for Windows DesktopSearch is automatically enabled for users.

This plug-in, which is installed with the Outlook Add-In, enables usersto search their Vault Cache using Windows Desktop Search.

Description

■ Force off. Disable this feature.■ Force on. Enable this feature.■ Keep user’s setting. Retain the user’s setting for this feature.

Supported values

OVWDSAutoEnableLegacy name

Virtual Vault advanced settingsThe Virtual Vault advanced settings let you control the behavior of Virtual Vault.

Table 5-2 shows the Virtual Vault advanced settings.

Table 5-2 Virtual Vault advanced settings


Controls the maximum number of archiverequests during a Vault Cachesynchronization.

Max archive requests per synchronization(Exchange Virtual Vault setting)

87Setting up Vault Cache and Virtual VaultVirtual Vault advanced settings

Table 5-2 Virtual Vault advanced settings (continued)


Specifies how many times Vault Cache triesto archive an item.

Max attempts to archive an item (ExchangeVirtual Vault setting)

Controls the maximum amount of data inmegabytes that can be uploaded during aVault Cache synchronization.

Max data archived per synchronization(Exchange Virtual Vault setting)

Controls the maximum number of deleterequests during a Vault Cachesynchronization. Any remaining requests aremade at the next synchronization.

Max delete requests per synchronization(Exchange Virtual Vault setting)

Controls the maximum size in megabytes ofan item that can be moved or copied intoVirtual Vault.

Max item size to archive (Exchange VirtualVault setting)

Controls the maximum number of propertychange requests during a Vault Cachesynchronization. Any remaining requests aremade at the next synchronization.

Max item updates per synchronization(Exchange Virtual Vault setting)

Controls the maximum total size in megabytesof copy and move operations when itemshave no content in Vault Cache. This settingonly applies to standard Outlook mail types,for example, mail items, calendar items,tasks, and contacts.

Max total size of contentless operations(Exchange Virtual Vault setting)

Controls the maximum total size in megabytesof pending archive data in Vault Cache.

Max total size of items to archive (ExchangeVirtual Vault setting)

Controls whether content is shown in theOutlook Reading Pane.

Show content in Reading Pane (ExchangeVirtual Vault setting)

Specifies the total number of pending archiveitems in Virtual Vault that triggers automaticVault Cache synchronization.

Threshold number of items to triggersynchronization (Exchange Virtual Vaultsetting)

Specifies the total size in megabytes ofpending archive items in Virtual Vault thattriggers automatic Vault Cachesynchronization.

Threshold total size of items to triggersynchronization (Exchange Virtual Vaultsetting)

Controls whether users can archive itemsmanually using Virtual Vault.

Users can archive items (Exchange VirtualVault setting)


Table 5-2 Virtual Vault advanced settings (continued)


Controls whether users can copy and moveitems from a Virtual Vault to another messagestore.

Users can copy items to another store(Exchange Virtual Vault setting)

Controls whether users can copy items withintheir archive.

Users can copy items within their archive(Exchange Virtual Vault setting)

Controls whether users can hard delete itemsfrom Virtual Vault.

Users can hard delete items (ExchangeVirtual Vault setting)

Controls whether users can reorganize itemsin Virtual Vault.

Users can reorganize items (Exchange VirtualVault setting)

Max archive requests per synchronization (Exchange Virtual Vaultsetting)

Controls the maximum number of archive requests during a Vault Cachesynchronization. Any remaining requests are made at the nextsynchronization.

When a user stores unarchived items in Virtual Vault, the archiveoperation does not take place until after the next Vault Cache headersynchronization.

No limit or a high value can increase the time that is required to completea Vault Cache synchronization. This effect is a consideration if theadditional load affects the Enterprise Vault server.

Also, until the items that a user has stored in Virtual Vault are archivedin the online archive, moved and copied items exist only on the user'scomputer. You can set two thresholds that trigger automatic Vault Cachesynchronization based on the number or total size of pending archiveitems in Virtual Vault.

See “Threshold number of items to trigger synchronization (ExchangeVirtual Vault setting)” on page 94.

See “Threshold total size of items to trigger synchronization (ExchangeVirtual Vault setting)” on page 95.

Description

■ An integer value. The default is 0 (no limit).Supported values

OVMaxItemArchivesPerSyncLegacy name


Max attempts to archive an item (Exchange Virtual Vault setting)

Specifies how many times Enterprise Vault tries to archive an item.

The archive operation is tried this number of times before the item islisted in the Virtual Vault Search folder named Could Not Archive.

Description

■ An integer value. The default is 3.Supported values

OVItemArchiveAttemptsLegacy name

Max data archived per synchronization (Exchange Virtual Vaultsetting)

Controls the maximum amount of data in megabytes that can beuploaded during a Vault Cache synchronization. Any remaining datais uploaded at the next synchronization.

No limit or a high value can increase the time that is required to completea Vault Cache synchronization. This effect is a consideration if theadditional load affects the Enterprise Vault server.

Also, until the items that the user stores in Virtual Vault have beenarchived in the online archive, moved and copied items exist only onthe user's computer. You can set two thresholds that trigger automaticVault Cache synchronization based on the number or total size ofpending archive items in Virtual Vault.



The value of this setting must be greater than or equal to the value ofMax item size to archive. If not, the value of Max item size to archiveis used.

Description

■ An integer value. The default is 512 (MB). The value 0 specifies nolimit.

Supported values

OVMaxToArchivePerSyncMBLegacy name


Max delete requests per synchronization (Exchange Virtual Vaultsetting)

Controls the maximum number of delete requests during a Vault Cachesynchronization. Any remaining requests are made at the nextsynchronization.

Deletion requests use relatively few resources on the Enterprise Vaultserver.

Description


OVMaxItemDeletesPerSyncLegacy name

Max item size to archive (Exchange Virtual Vault setting)

Controls the maximum size in megabytes of an item that can be movedor copied into Virtual Vault.

If this value is similar to the value of Max total size of items to archive,a full synchronization can consist of one item.

The Max item size to archive value may be used automatically forMax data archived per synchronization or Max total size of itemsto archive. It is used if the value of those settings is less than the Maxitem size to archive value.

You can set two thresholds that trigger automatic Vault Cachesynchronization based on the number or total size of pending archiveitems in Virtual Vault.



Description


Supported values

OVMaxMessageSizeToArchiveMBLegacy name


Max item updates per synchronization (Exchange Virtual Vaultsetting)

Controls the maximum number of property change requests during aVault Cache synchronization. Any remaining requests are made at thenext synchronization.

Update requests use relatively few resources on the Enterprise Vaultserver.

Description


OVMaxItemUpdatesPerSyncLegacy name

Max total size of contentless operations (Exchange Virtual Vaultsetting)

Controls the maximum total size in megabytes of copy and moveoperations when items have no content in Vault Cache. This settingdoes not apply to documents that are placed directly in the mailbox. Itonly applies to standard Outlook mail types, for example, mail items,calendar items, tasks, and contacts.

This setting only applies when two or more items with no content areinvolved in the operation. Retrieval of one item is allowed regardlessof its size.

Description


Supported values

VVDenyMultiContentlessOpsAboveMBLegacy name


Max total size of items to archive (Exchange Virtual Vault setting)

Controls the maximum total size in megabytes of pending archive datain Vault Cache.

Pending archive data consists of items that the user has moved orcopied into Virtual Vault. These items are pending archive until VaultCache synchronization has successfully uploaded and archived them.

The value of this setting must be greater than or equal to the value ofMax item size to archive. If not, the value of Max item size to archiveis used.

You can set two thresholds that trigger automatic Vault Cachesynchronization based on the number or total size of pending archiveitems in Virtual Vault.



Description


Supported values

OVMaxTotalToArchiveMBLegacy name

Show content in Reading Pane (Exchange Virtual Vault setting)

Controls whether the content of an item that is selected in Virtual Vaultis shown in the Outlook Reading Pane.

If the item itself is a document, it is not displayed in the Reading Pane.A message in the Reading Pane advises the user to open the item toread the item's contents.

Description


■ Never show content. The Reading Pane always shows only theselected item's header. A banner provides a link to open the originalitem.

■ When in Vault Cache (default). The Reading Pane shows theselected item's header. If the item is in Vault Cache, it also showsthe content. If the content is not shown, a banner provides a link toopen the original item. When the Vault Cache content strategy isStore only items that user opens, the effect of this value is thatthe Reading Pane only shows the content of previously openeditems.

■ Always show content. The Reading Pane always shows the headerand content of the item that is selected in Virtual Vault.

Show content in Reading Pane can only have the valueAlways showcontent if the following conditions apply:

■ You have upgraded from an earlier release.■ In the earlier release, Show content in Reading Pane had the

value Always show content.

Always show content is not available in the Modify Setting dialogbox. So if Always show content is the current value and you changeit, you cannot go back to it.

Supported values

VVReadingPaneContentLegacy name

Threshold number of items to trigger synchronization (ExchangeVirtual Vault setting)

Specifies the total number of pending archive items in Virtual Vault thattriggers automatic Vault Cache synchronization.


If you enable this setting, consider how it interacts with other settings,as follows:

■ Max item size to archive and Max total size of items to archivecan prevent the user from adding items to Virtual Vault, so that thethreshold is never reached.

■ Max archive requests per synchronizationmay have a value thatis lower than the value of Threshold number of items to triggersynchronization. In this case, automatic synchronization may occurbut not all the pending archive items are archived.

Description


■ 0 (default). The threshold is inactive.■ Non-zero integer. The total number of pending archive items in

Virtual Vault that triggers automatic Vault Cache synchronization.

Supported values

VVAutoSyncItemThresholdLegacy name

Threshold total size of items to trigger synchronization (ExchangeVirtual Vault setting)

Specifies the total size in megabytes of pending archive items in VirtualVault that triggers automatic Vault Cache synchronization.


If you enable this setting, consider how it interacts with other settings,as follows:

■ Max item size to archive and Max total size of items to archivecan prevent the user from adding items to Virtual Vault, so that thethreshold is never reached.

■ Max data archived per synchronization may have a value that islower than the value of Threshold total size of items to triggersynchronization. In this case, automatic synchronization may occurbut not all the pending archive items are archived.

Description

■ 0 (default). The threshold is inactive.■ Non-zero integer. The total size in megabytes of pending archive

items in Virtual Vault that triggers automatic Vault Cachesynchronization.

Supported values

VVAutoSyncItemsSizeThresholdMBLegacy name


Users can archive items (Exchange Virtual Vault setting)

Controls whether users can archive items manually by adding newitems to Virtual Vault using standard Outlook actions. Examples of thesestandard Outlook actions are drag and drop, move and copy, and Rules.

If you disable this setting, users can still create folders if Users canreorganize items is enabled.

If you enable this setting, consider setting the thresholds that triggerautomatic Vault Cache synchronization.



Note: By default there are no safety copies for those items that usersarchive from Virtual Vault. If you require safety copies you can configurethe vault stores that host the users' archives so that Enterprise Vaultkeeps safety copies in the Storage queue. This configuration changeaffects all archiving to those vault stores.

Description

■ Yes (default). Users can archive items manually in Virtual Vault.■ No. Users cannot archive items manually in Virtual Vault.

Supported values

VVAllowArchiveLegacy name

Users can copy items to another store (Exchange Virtual Vaultsetting)

Controls whether users can copy and move items from a Virtual Vaultto another message store.

If users can copy or move items out of Virtual Vault and the content isavailable in Vault Cache, the items are retrieved from Vault Cache.

If the Vault Cache content strategy is Do not store any items in cache,the items are retrieved from the online archive. In this case, use theVirtual Vault advanced setting Max total size of contentlessoperations to control the maximum total size of view, copy, and moveoperations.

Description

■ Yes (default). Users can copy and move items to another messagestore.

■ No. Users cannot copy and move items to another message store.

Supported values

VVAllowInterStoreCopyAndMoveLegacy name


Users can copy items within their archive (Exchange Virtual Vaultsetting)

Controls whether users can copy items within their archive.

If users can copy items within their archive and the content is availablein Vault Cache, the items are retrieved from Vault Cache.

If the Vault Cache content strategy is Do not store any items in cache,the items are retrieved from the online archive. In this case, use theVirtual Vault advanced setting Max total size of contentlessoperations to control the maximum total size of view, copy, and moveoperations.

If you enable this setting, consider setting the thresholds that triggerautomatic Vault Cache synchronization.



Description

■ Yes. Users can copy items within their archive.■ No (default). Users cannot copy items within their archive.

Supported values

VVAllowIntraStoreCopyLegacy name

Users can hard delete items (Exchange Virtual Vault setting)

Controls whether users can hard delete items from Virtual Vault.

For this setting to take effect, the option Users can delete items fromtheir archives must be enabled on the Archive Settings tab in theSite Properties dialog box.

If you disable this setting, users can still move items to the DeletedItems folder if Users can reorganize items is enabled.

Description

■ Yes (default). Users can hard delete items from Virtual Vault.■ No. Users cannot hard delete items from Virtual Vault.

Supported values

VVAllowHardDeleteLegacy name


Users can reorganize items (Exchange Virtual Vault setting)

Controls whether users can reorganize items in Virtual Vault.

This setting can enable users to move items between folders and tocreate, move, rename, or delete folders.

If folders still exist in the mailbox, users cannot move, rename, or deletethem.

Users can hard delete only empty folders, unless Users can harddelete items is enabled.

Description

■ Yes (default). Users can reorganize items in Virtual Vault.■ No. Users cannot reorganize items in Virtual Vault.

Supported values

VVAllowReOrgLegacy name


Setting up archiving frompublic folders


■ About archiving from public folders

■ Note on vault store and partition when setting up archiving from public folders

■ Creating a public folder archive

■ Adding a Public Folder task

■ About public folder policy settings

■ Adding public folder archiving targets

■ Applying archiving settings to public folders

■ Scheduling the Public Folder task

■ Note on removing Public Folder targets

About archiving from public foldersRead this section to find out how to set up archiving from public folders.

In summary, the process of setting up archiving from public folders is as follows:

■ Add the Exchange Server computer to your organization, create a vault store,and add a Task Controller service. You created these when setting up archivingfrom mailboxes.

■ Create a public folder archive, if required.

■ Create new retention categories, if required.

6Chapter

■ Review the public folder policy settings.

■ Add an Exchange Public Folder task.

■ Add Public Folder Archiving Targets.

■ Schedule the Exchange Public Folder task.

In order to set up Public Folder archiving, you must be logged in as an account thathas appropriate Exchange Server permissions. The Vault Service account has thecorrect permissions. Alternatively, set up the account you want to use so that it hasthe correct permissions. See the "Additional requirements for Exchange Serverarchiving" section of the Installing and Configuring guide for instructions.

Note on vault store and partition when setting uparchiving from public folders

A vault store and a vault store partition must exist before you enable public foldersfor archiving. If you want to use Enterprise Vault's optimized single instance storage,ensure that vault store groups, vault stores, and vault store partitions are correctlyconfigured for your requirements.

See the Chapter, Setting up storage, in the Installing and Configuring manual.

If you auto-enable the target public folders for archiving, Enterprise Vaultautomatically creates archives for the public folders in the vault store selected forthe public folder archiving target.

Creating a public folder archiveYou can configure Enterprise Vault to create archives automatically using theauto-enabler. If you are not going to use the auto-enabler, then you need to createthe required archives manually. You then assign the archives when configuring thepublic folder archiving targets. Multiple public folders can share an archive.

To create a public folder archive

1 In the left pane of the Administration Console, expand the Archives container.

2 Right-click Public Folder and then, on the shortcut menu, clickNew > Archive.

The New Public Folder Archive wizard starts.

3 Work through the wizard. You will need to provide the following information:

■ The Enterprise Vault Indexing service computer

■ The indexing level to use for any items stored in this archive

100Setting up archiving from public foldersNote on vault store and partition when setting up archiving from public folders

■ The billing address

Adding a Public Folder taskThis section describes the steps required to add a Public Folder task.

To add a Public Folder task

1 In the left pane of the Administration Console, expand the Site hierarchy untilthe Enterprise Vault Servers container is visible.

2 Expand the Enterprise Vault Servers container.

3 Expand the name of the computer to which you want to add the Public Foldertask.

4 Right-click Tasks and then, on the shortcut menu, click New > Public FolderTask.

The New Public Folder Task wizard starts.

5 Work through the wizard. You need to provide the following information:

■ The Exchange Server hosting the public folders.

■ The name for the task.

■ The Enterprise Vault system mailbox to use when connecting to ExchangeServer. This can be the same system mailbox used by the Exchange Mailboxtask.

About public folder policy settingsThe settings that are used during public folder archiving come from the public folderpolicy that is being used. There is a default public folder policy, Default ExchangePublic Folder Policy, which you can edit as required. Alternatively, you can createfurther policies as necessary, and set a different policy as the default policy.

Exchange Public Folder policy settingsThese settings fall into the following categories:

■ General tab (Exchange Public Folder policy setting)

■ Archiving Rules tab (Exchange Public Folder policy setting)

■ Archiving Actions tab (Exchange Public Folder policy setting)

■ Shortcuts tab (Exchange Public Folder policy setting)

101Setting up archiving from public foldersAdding a Public Folder task

■ Message Classes tab (Exchange Public Folder policy setting)

■ Advanced tab (Exchange Public Folder policy setting)

■ Targets tab (Exchange Public Folder policy setting)

■ Shortcut Deletion tab (Exchange Public Folder policy setting)

General tab (Exchange Public Folder policy setting)Table 6-1 describes the settings on this tab, which you can use to override theindexing level for the target public folders.

Table 6-1 General settings


The name and description of the policy. These can be changed later ifrequired.

Name andDescription

Whether to use Brief or Full indexing when archiving from the targetpublic folders. Phrase searching on content is only available with Fullindexing.

The indexing level can be set at site, policy and archive level. Thesetting on the archive will take precedence.

Indexing level

Archiving Rules tab (Exchange Public Folder policysetting)Table 6-2 describes the settings on this tab, which you can use to choose betweensize-based archiving and quota-based archiving.

Table 6-2 Archiving Rules settings


2 weeksThe minimum age limit at whichitems can be archived

Young items

Not set.Whether to archive larger itemsbefore smaller items and, if so, theminimum size of the items that aregiven priority.

Large items

Archiving is based on the period oftime since an item was modified.The time period is six months.

Setting is locked.

Archive items based on age ofitem.

Archiving strategy

102Setting up archiving from public foldersAbout public folder policy settings

Table 6-2 Archiving Rules settings (continued)


Not set.Archive an item only if it has anattachment, assuming all otherarchiving criteria are met.

Note that this is not the same asarchiving attachments only. Seethe Administrator’s Guide for moreinformation.

Archive messageswith attachmentsonly

Archiving Actions tab (Exchange Public Folder policysetting)Table 6-3 describes the settings on this tab, which you can use to control howEnterprise Vault behaves when it archives an item.

Table 6-3 Archiving Actions settings


Original item is deleted from public folder after archiving.

Setting is locked, which forces users to use policy setting.

Delete original itemafter archiving

After it has been archived, the item in the public folder is replaced witha shortcut.

Setting is locked, which forces users to use policy setting.

Create shortcut toarchived item afterarchiving

Shortcuts tab (Exchange Public Folder policy setting)Table 6-4 describes the settings on this tab, which you can use to control the sizeand behavior of Enterprise Vault shortcuts

Table 6-4 Shortcuts settings


Shortcuts include recipientinformation.

Whether to store recipientinformation (To: and Cc: details) inshortcuts.

Shortcuts always contain the Fromand Subject information.

Include recipientinformation inshortcut


Table 6-4 Shortcuts settings (continued)


NoneHow much of the message body tostore in shortcuts. Regardless ofthe setting value, the full message,with attachments, are still stored inthe archive.

■ None. None of the messagetext is stored in the shortcut.

■ Use message body. Shortcutscontain all of the message bodytext, but no attachments.

■ Customize. Select the amountof text and links that you wantincluded in shortcuts.

Shortcut body

Show contents.Whether double-clicking a shortcutdisplays the contents of the originalitem or the properties of theshortcut.

When shortcut isopened

The ShortcutText.txt file is required if you configure customized shortcuts. Youcan also use this file to process standard shortcuts for untitled attachments.

See “Using customized shortcuts with Exchange Server archiving” on page 52.

Message Classes tab (Exchange Public Folder policysetting)The list on this tab shows the classes of items that will be archived when the policyis applied. Select or clear message class check boxes, as required.

If you need to edit the list of available message classes, go to the Message Classestab of the Directory properties.

Advanced tab (Exchange Public Folder policy setting)The settings on this tab let you control aspects of public folder archiving, such ashow to process items that the task fails to archive. For details of these settings, seethe Administrator’s Guide.

Targets tab (Exchange Public Folder policy setting)This tab displays the archiving target public folders that will use this policy.


Shortcut Deletion tab (Exchange Public Folder policysetting)Shortcut deletion does the following:

■ Deletes shortcuts that are older than the age you specify on this page. EnterpriseVault uses the modified date or archived date to determine the age of a shortcut.You can specify which date to use on the Storage Expiry tab of Site Properties.

■ Deletes orphaned shortcuts. These are shortcuts to items that have been deleted,typically by a user, from an archive.

Shortcut deletion is performed by the Exchange Public Folder task. When you runthe task using Run Now, you can choose a Run mode that includes shortcutprocessing.

Table 6-5 Shortcut Deletion settings


Not selectedSetting this makes Enterprise Vaultdelete shortcuts that are older thanthe age you specify. This does notaffect the corresponding archiveditems. Users can still search for thearchived items.

For example, you could choose todelete all shortcuts older than 12months, but retain archived itemsfor several years.

Delete shortcuts infolders

Not selectedThis setting makes Enterprise Vaultdelete shortcuts in public folders ifthe corresponding archived itemhas been deleted.

If you use shortcuts that containtext from the original message,those shortcuts might be useful tousers even though the archiveditems have been deleted. However,deleting large shortcuts will regainspace in the Exchange Serverstore.

Delete orphanedshortcuts


Adding public folder archiving targetsAn Exchange Public Folder task archives public folder targets. A public folder targetis a single public folder hierarchy, starting from its root path and working down. Youcan have a few, or many Exchange Public Folder tasks, as required. Each ExchangePublic Folder task can process multiple public folder targets.

The Exchange Public Folder task processes all folders beneath each target’s rootpath, except for folders that are processed by another Exchange Public Folder taskand folders that have had their Enterprise Vault properties changed to stop thefolder from being archived.

You can add a public folder target with a root path that is higher up a public folderhierarchy than the root path of an existing public folder target. You cannot add onewith a lower root path.

If you use Outlook to view the properties of the public folder, you can copy the folderpath to the clipboard and then paste it in as the root path for the target public folder.

There are several ways to add public folders: manually or automatically.

■ Manual (standard) method. You select the public folder and the archive that isto be used for it. The same archive is used for the folder and its subfolders.

■ Automatic method. You add an Enterprise Vault "auto-enabler" that then enablesfolders that are immediately beneath the folder you specify. These folders andtheir subfolders are all enabled for archiving.By default, a separate archive is automatically created for each folder at thislevel.For example, if you add an auto-enabler to \myPublic Folder, then newarchives will be created for \myPublic Folder\Finance and \myPublic

Folder\Property. No archive will be created for \myPublicFolder\Property\Commercial because that folder will use the same archiveas its parent (\myPublic Folder\Property).Alternatively, you can select an existing archive to use.If new folders are added later, they are automatically archived too.

Manual (standard) method of adding public folder archiving targetsThis section describes the manual method of adding a public folder. You select thepublic folder and the archive that is to be used for it. The same archive is used forthe folder and its subfolders.

106Setting up archiving from public foldersAdding public folder archiving targets

To add a public folder archiving target

1 In the left pane of the Administration Console, expand the hierarchy untilTargets is visible.

2 Expand Targets.

3 Expand Exchange.

4 Expand the domain that contains the Exchange Server that hosts the folderyou want to add.

5 Expand Exchange Server.

6 Expand the Exchange Server that has the public folder you want to add.

7 Right-click Public Folder and, on the shortcut menu, clickNew and then PublicFolder.

The New Public Folder wizard starts.


■ The path to the top-level public folder to be archived

■ The Exchange Public Folder task to use

■ The Exchange Public Folder policy to assign

■ The retention category or retention plan to use

■ The archive to use

Automatic method of adding public folder archiving targetsThis section describes the automatic method of adding a public folder. You add anEnterprise Vault "auto-enabler" that then enables folders that are immediatelybeneath the folder you specify. These folders and their subfolders are all enabledfor archiving.

By default, a separate archive is automatically created for each folder at this level.

To add a public folder auto-enabler

1 In the left pane of the Administration Console, expand the hierarchy untilTargets is visible.

2 Expand Targets.

3 Expand Exchange.

4 Expand the domain that contains the Exchange Server that hosts the folderyou want to add.


107Setting up archiving from public foldersAdding public folder archiving targets

6 Expand the Exchange Server that has the public folder you want to add.

7 Right-click Public Folder and, on the shortcut menu, clickNew and then PublicFolder Auto-Enabler.

The New Public Folder Auto-Enabler wizard starts.


■ The path to the top-level public folder to be archived.

■ Whether to archive items in the root folder. If yes, you can specify the archiveto use.

■ The Exchange Public Folder policy to use.

■ The Exchange Public Folder task to use.

■ The retention category or retention plan to use.

■ The vault store to create the new archives in.

Applying archiving settings to public foldersThe default public folder archiving settings are set on each public folder. These arethe settings that you specified on the Archiving Rules and Archiving Actions pagesof Exchange Public Folder Policy properties.

Using the Enterprise Vault User Extensions for Outlook, only users with Owneraccess to public folders can customize these settings.

To apply archiving settings to a public folder

1 View the public folder using an Outlook client that has the Enterprise VaultUser Extensions installed.

2 Right-click the public folder and click Properties on the shortcut menu.

The properties for the public folder are displayed.

3 Click the Enterprise Vault tab.

The Enterprise Vault property page shows the folder currently has no settings.

4 Click Change.

The Change Enterprise Vault properties dialog box is displayed.

108Setting up archiving from public foldersApplying archiving settings to public folders

5 Select the settings you want to apply.

Users will be able to apply custom settings to a public folder only if the settingson the Archiving Actions page of the public folder policy’s properties are notlocked.

6 Once you have finished applying settings, click OK.

Scheduling the Public Folder taskAll Public Folder tasks run according to a schedule that you set.

Each Exchange Public Folder task can be set to run according to the following:

■ The schedule, which is defined on the Site Schedule page of site properties. Bydefault all archiving tasks run according to this schedule.

■ Its own schedule, defined on the task’s Schedule property page.

To modify the schedule for a single task

1 In the left pane of the Administration Console, expand the hierarchy until theEnterprise Vault Servers container is visible.


3 Expand the computer that is running the task that you want to modify.

4 Click Tasks.

5 In the right pane, double-click the task that you want to modify.

6 Click the Schedule tab.

7 Modify the schedule as required.

To modify the schedule for all archiving tasks

1 In the Administration Console, expand the contents of the scope (left) paneuntil the Enterprise Vault site is visible.

2 Right-click the Enterprise Vault site and select Properties. The site propertiesdialog is displayed.

3 Click the Site Schedule tab.

4 Modify the schedule as required.

Note on removing Public Folder targetsBe careful when removing lower-level public folder targets. When you remove apublic folder target that is below another public folder target, the folders are archived

109Setting up archiving from public foldersScheduling the Public Folder task

to the same archives as before. In this case, if you want to prevent public foldersfrom being archived, change the settings for the lower-level public folders so thatthey are not archived.

If you want to remove a public folder target, use the Administration Console to doso because this removes the marker that Enterprise Vault places on the root pathfolder.

For example, this is important if you are running a pilot installation of EnterpriseVault that has an Exchange Public Folder task on a computer that you later decideto remove. If you merely take away the Exchange Public Folder task computer, themarker is not removed and so you cannot add another public folder target with thatroot path.

110Setting up archiving from public foldersNote on removing Public Folder targets

Setting up archiving ofjournaled messages


■ Before you start setting up archiving of journaled messages

■ Vault store group, vault store, and partition when archiving journaled messages

■ Creating a journal archive

■ Adding permissions to the journal archive

■ Adding an Exchange Journaling task

■ Reviewing the journaling policy settings

■ Adding an Exchange Server journal mailbox as a target

■ Starting the Journaling task

■ What to do after setting up archiving of journaled messages

Before you start setting up archiving of journaledmessages

Before an Enterprise Vault Exchange Journaling task can be configured, you musthave configured the Exchange Server to direct all mail to one or many journalmailboxes.

7Chapter

Vault store group, vault store, and partition whenarchiving journaled messages

All items from a journal mailbox need to be archived. If you are configuring bothExchange journal archiving and Exchange mailbox archiving, you can takeadvantage of Enterprise Vault's optimized single instance storage. Ensure that vaultstore groups, vault stores, and vault store partitions are correctly configured foryour requirements.

See the Chapter, Setting up storage, in the Installing and Configuring manual.

Creating a journal archiveThis section describes how to create a Journal archive. You must have alreadycreated a journal vault store and partition before you can create a Journal archive.

To create a journal archive

1 In the left pane of the Administration Console, expand the hierarchy untilArchives is visible.

2 Expand Archives.

3 Right-click Journal and, on the shortcut menu, click New and then Archive.

The New Journal Archive wizard starts.

4 Work through the wizard. When prompted to select a vault store, choose theone that you just created.

You will need to provide the following information:

■ The vault store in which to create the archive

■ The required Indexing service

■ The indexing level

■ A billing account

Adding permissions to the journal archiveYou must add permissions for those users who need to be allowed access to itemsthat have been archived from the journal mailbox.

Users can have multiple different types of access to an archive:

112Setting up archiving of journaled messagesVault store group, vault store, and partition when archiving journaled messages

Users can view and retrieve items from the archive. Those who needto search items archived from the journal mailbox, such as auditors,must have at least read access to the archive.

Read

Users can archive items in the archive. The owner of the journal mailboxmust have at least write access to the archive. This enables items tobe archived from the journal mailbox.

Write

Users can delete items from the archive.

Note that, even though you grant the delete permission here, a usercannot delete from the archive unless you also select the option Userscan delete items from their archives on the Archive Settings tab ofthe Site Properties dialog box.

Delete

To add permissions to the journal archive

1 In the left pane of the Administration Console, expand the hierarchy untilArchives is visible.

2 Expand Archives.

3 Click Journal.

4 In the right pane, double-click the archive whose permission list you want tomodify.

The archives properties are shown.

5 Click the Permissions tab.

Adding an Exchange Journaling taskThis section describes how to add an Exchange Journaling task.

To add an Exchange Journaling task

1 In the left pane of the Administration Console, expand the site hierarchy untilEnterprise Vault Servers container is visible.


3 Expand the name of the computer to which you want to add an ExchangeJournaling Task.

4 Right-click Tasks and, on the shortcut menu, click New and then ExchangeJournaling Task.

The New Exchange Journaling Task wizard starts.


113Setting up archiving of journaled messagesAdding an Exchange Journaling task

■ The Exchange Server hosting the journal mailbox.

■ Name for the task.

■ Enterprise Vault system mailbox to use when connecting to ExchangeServer. This can be the same system mailbox used by the Exchange Mailboxtask.

Reviewing the journaling policy settingsThe settings that used during Exchange Server journal mailbox archiving comefrom the Exchange Journaling policy that is being used. There is a default ExchangeJournaling policy that you can edit as required. Alternatively, you can create furtherpolicies as necessary, and set a different policy as the default policy.

To review the default Exchange Journaling policy settings

1 In the left pane of the Administration Console, expand the Policies container.

2 Expand the Exchange container and click Journaling.

3 In the right pane, double-click Default Exchange Journaling Policy.

The properties of the policy appear.

4 Check the settings on the Advanced tab, and change them as necessary.

You can click each setting to see a description of what it controls. The settingsare described in the online help in the Administration Console and in theAdministrator’s Guide.

Adding an Exchange Server journal mailbox as atarget

This section describes how to add an Exchange Server journal mailbox as anarchiving target.

Note: When you have completed the configuration of Exchange Server journalarchiving, Enterprise Vault directly targets the journal mailbox. For this reason, ifyou need to move the journal mailbox to a different Exchange server in the sameExchange organization, there is no need to reconfigure journal archiving.

114Setting up archiving of journaled messagesReviewing the journaling policy settings

To add an Exchange Server journal mailbox as a target


2 Expand the domain that contains the Exchange Server with the journal mailboxyou are adding.


4 Expand the Exchange Server.

5 Right-click Journal Mailbox and, on the shortcut menu, click New > JournalMailbox.

The New Journal Mailbox wizard starts.


■ The name of the Exchange journal mailbox to archive

■ The Exchange Journaling task to use

■ The Exchange Journaling policy to apply

■ The retention category to apply to archived items

■ The archive to use

Starting the Journaling taskThis section describes how to start an Exchange Journaling task.

To start the Journaling task

1 In the left pane of the Administration Console, expand the Enterprise Vault sitehierarchy until Enterprise Vault Servers container is visible.


3 Expand the name of the computer that has the Exchange Journaling task youwant to start.

4 Click tasks.

5 In the right pane, right-click the task and, on the shortcut menu, click Start.

You do not normally need to start the Exchange Journaling task in this manner:by default, the task starts automatically when the Task Controller service isstarted.

6 The task runs continually, archiving items immediately from the ExchangeServer journal mailbox. Items are deleted from the mailbox as they are archivedand no shortcuts are created.

115Setting up archiving of journaled messagesStarting the Journaling task

What to do after setting up archiving of journaledmessages

It is important that you monitor journal mailboxes to make sure that items are beingarchived promptly. For details of how to monitor the mailboxes, see theAdministrator’s Guide.

You can customize the Exchange Server journal mailbox so that items are archivedto different archives and with different retention categories. See the Administrator’sGuide for details.

116Setting up archiving of journaled messagesWhat to do after setting up archiving of journaled messages

Envelope JournalingThis chapter includes the following topics:

■ About Enterprise Vault and Exchange Server journal reports

About Enterprise Vault and Exchange Serverjournal reports

Envelope Journaling is used by Exchange Server to capture the complete recipientlist of a message. The Enterprise Vault Exchange Journaling task automaticallyrecognizes an envelope message and processes it accordingly.

Each journaled message has two parts:

■ A journal report (P1 envelope message)

■ The original message (P2 message)

In the body of the journal report there may be uncategorized recipients, in additionto the TO, CC, and BCC recipients. This happens when there is no way ofdiscovering the original category of such recipients; for example, when a report issent over SMTP by Exchange Server 2007. Enterprise Vault classifies suchrecipients as undisclosed recipients.

You can search for undisclosed recipients by using the advanced facilities inapplications such as Enterprise Vault Search. The index property, RNDN, is usedfor undisclosed recipients.

Undisclosed recipients are recognized in Compliance and Discovery Acceleratorsearches.

The journal report is stored with the original message in the message saveset, butEnterprise Vault does not currently support the retrieval of journal reports from thearchive.

8Chapter

This section describes how Enterprise Vault Journaling task handles the differentExchange Server journal reports.

How Enterprise Vault handles Exchange journal reportsWhen the Enterprise Vault Journaling task receives an Exchange journal report:

■ The list of recipients is extracted from the journal report contents.

■ This list is not compared with recipients in the header of the attached message.

■ Uncategorized recipients found in the journal report body are classed asUndisclosed recipients.For example, recipients of messages that are sent over SMTP will be includedin the recipient list in the journal report body but will not be categorized.

■ A copy of the journal report, complete with original message attached, will bepassed to any external filters.

■ The journaling task cannot archive a message from the journal mailbox if itcannot find the message body or the Message-ID, Recipients, and Sender tagsin the journal report. For example, these can be stripped by antivirus applicationsthat find suspicious messages.

■ The journaling task copies any journal reports that it cannot archive to the folderEnterprise Vault Journaling Service/Failed To Copy.

About support for Exchange journal report decryptionIf journal report decryption is configured on Exchange, then two messages areattached to the journal report – the original RMS-protected message and a cleartext version. The advanced setting in the Enterprise Vault Exchange Journalingpolicy, ClearText copies of RMS Protected items, lets you select whetherEnterprise Vault uses the clear text message or the RMS-protected message asthe primary message during archiving. Note that after Enterprise Vault has archiveda message, you cannot change the message version used as the primary message.

Enterprise Vault stores both versions of the message and the journal report in themessage saveset. However, Enterprise Vault does not currently support the retrievalof the secondary message or the journal report from the archive.

By default, Enterprise Vault uses the clear text message as the primary message.The following action is taken when the clear text message is used as the primarymessage:

■ The clear text message is returned in response to retrieval requests fromEnterprise Vault clients and Veritas Discovery Accelerator.

118Envelope JournalingAbout Enterprise Vault and Exchange Server journal reports

■ Enterprise Vault indexes the content and properties of the clear text message,and any attachments that are not encrypted.

■ Standard Enterprise Vault Exchange journal filters work with clear text messages.

See the online help in the Administration Console and in the Administrator’s Guidefor a full description of this setting.

119Envelope JournalingAbout Enterprise Vault and Exchange Server journal reports

Setting up Enterprise VaultOffice Mail App forExchange Server 2013and later


■ About Microsoft Office Mail App

■ About the Enterprise Vault Office Mail App

■ Enterprise Vault Office Mail App policy settings and options

■ Initial configuration of HTTPS for use of the Enterprise Vault Office Mail App

■ Deploying the Enterprise Vault Office Mail App

■ Additional requirements on Enterprise Vault Office Mail App users' computers

■ Disabling and re-enabling the Enterprise Vault Office Mail App for a device type

■ Removing, disabling, and re-enabling the Enterprise Vault Office Mail App fora user or an organization

■ Troubleshooting the Enterprise Vault Office Mail App

9Chapter

About Microsoft Office Mail AppA Microsoft app for Office is a web page that is hosted inside an Office clientapplication. In addition to the capabilities of a web page, an app for Office caninteract with the Office application and with the user's content.

Microsoft Office Mail App requires Exchange Server 2013 or later. The web pagedisplays next to the currently selected item in Outlook 2013 and later, and OutlookWeb App (OWA) for Exchange 2013 and later.

On Exchange Server 2016, the term Microsoft Office Mail App is renamed MicrosoftOffice Add-In, and Outlook Web App is renamed Outlook on the web. As theEnterprise Vault Office Mail App applies to Exchange Server 2013 and later, Outlook2013 and later, and Outlook Web App (OWA) on Exchange Server 2013 and later,the earlier terminology is currently used in this book. The terms refer to all thesupported versions unless otherwise stated.

For detailed information about Microsoft Office Mail App, see the Microsoft website.

About the Enterprise Vault Office Mail AppThe Enterprise Vault Office Mail App provides Enterprise Vault features in thefollowing mail clients for mailboxes that are hosted on Exchange 2013 and later:

■ Outlook 2013 and later. You can enable the Office Mail App in Outlook whetheror not the Enterprise Vault Outlook Add-In is installed.

■ OWA 2013 and later. The Office Mail App is the only Enterprise Vault clientavailable for OWA users.

The Enterprise Vault Office Mail App has the following advantages over previousEnterprise Vault integrations with Exchange Server and OWA:

■ There is no installation impact on Exchange servers. The Office Mail App requiresdeployment to users, for which we recommend that you use Microsoft PowerShellcommands in the Exchange Management Shell.See “Deploying the Enterprise Vault Office Mail App” on page 125.

■ No client installation is required to enable the Office Mail App for either Outlookor OWA.

For information about operating system support for use of the Office Mail App ontablets and phones, see the Enterprise Vault Compatibility Charts athttp://www.veritas.com/docs/000097605.

The following figure shows the Office Mail App in Outlook 2013:

121Setting up Enterprise Vault Office Mail App for Exchange Server 2013 and laterAbout Microsoft Office Mail App


Enterprise Vault Office Mail App

STORE

Enterprise Vault Office Mail App featuresThe Enterprise Vault Office Mail App provides a different set of features from thefollowing Enterprise Vault clients:

■ The Enterprise Vault Outlook Add-In

■ Enterprise Vault integrations with Exchange Server 2010 and OWA 2010

Table 9-1 describes the differences. You may find that this information is useful indeciding whether to make the Enterprise Vault Office Mail App, the Enterprise VaultOutlook Add-In, or both available to Outlook users. The information applies to theEnterprise Vault Office Mail App in both Outlook 2013 and later, and OWA 2013and later, unless it states otherwise.

122Setting up Enterprise Vault Office Mail App for Exchange Server 2013 and laterAbout the Enterprise Vault Office Mail App

Table 9-1 Differences between the Enterprise Vault Office Mail App andother Enterprise Vault clients

DifferencesFeatures

Users cannot open, reply to, or forward an archived itemdirectly from a shortcut. They have to view the item from theOffice Mail App and then perform the action.

On Mac computers, the Enterprise Vault Office Mail App doesnot provide the View button in Outlook 2016.

Open, reply to, and forwardfrom shortcut

The Office Mail App allows actions on a single selected item,not on multiple selections.

Actions on multiple selectionsof items

The Office Mail App is available only when users haveselected a mail item, calendar item, or meeting request.

To find an archived item of another type or one with noshortcut, users can open facilities such as Enterprise VaultSearch.

Availability for all item typesthat can be archived

The Office Mail App does not support deletion of archiveditems using the normal Outlook or OWA Delete options; forexample, by selecting a shortcut and pressing the Deletekey.

To perform the Delete action, users have to use the OfficeMail App.

Support for Outlook and OWAdeletion of archived items

The Office Mail App is not available for draft items.Availability for draft items

The Office Mail App is not available for items in public folders.Availability for public folders

The Office Mail App is only available in the OWA 2013 andlater Premium client. The OWA Light client does not supportMicrosoft Office Mail App.

Enterprise Vault support inOWA Light client

Enterprise Vault Office Mail App policy settingsand options

The Enterprise Vault Office Mail App advanced setting Availability in the Exchangedesktop policy controls the availability of the Office Mail App. You can choosewhether the Office Mail App is available for Outlook, or OWA, or both. Otheradvanced settings let you control some details of Office Mail App behavior.

For details of the Office Mail App advanced settings, see the Administrator's Guide.

123Setting up Enterprise Vault Office Mail App for Exchange Server 2013 and laterEnterprise Vault Office Mail App policy settings and options

The settings on the Exchange Desktop policy Options tab control the availability ofthe Office Mail App options, with the following exceptions:

■ Expiry Report setting on the Options tab: the Office Mail App does not includean Expiry Report option.

■ Help setting on the Options tab: the Office Mail App Help option is alwaysavailable.

■ Shortcut Deletion setting on the Options tab: this option does not apply to theOffice Mail App.

For information about the settings on the Exchange Desktop policy Options tab,see the Administration Console help.

Table 9-2 describes the Enterprise Vault options that are available in the OfficeMail App.

Table 9-2 Enterprise Vault Office Mail App options

NotesEnterprise Vault OfficeMail App options

The Office Mail App View option is always available.

The Office Mail App advanced policy setting Behavior ofMail App Bar controls how the Office Mail App opens items.You can specify that clicking the Enterprise Vault tab in theOffice Mail App bar does both of the following:

■ Shows the available options for a shortcut■ Automatically opens the item in a new window

The default is to show the Office Mail App options withoutautomatically opening the item.

View: view an archived itemfrom its shortcut

The Office Mail App advanced policy setting Mode lets youchoose an Office Mail App mode.

Light mode is the default. In Light mode, Enterprise Vaultarchives the item with the default retention category for themailbox folder that contains the item. In Full mode, users canselect a retention category when they archive an itemmanually.

Store: archive an itemmanually

Users can restore an archived item from its shortcut.

If a user opens an archived item with the Office Mail AppView option, the Restore option is not available while theitem is open.

Restore: restore an archiveditem

124Setting up Enterprise Vault Office Mail App for Exchange Server 2013 and laterEnterprise Vault Office Mail App policy settings and options

Table 9-2 Enterprise Vault Office Mail App options (continued)

NotesEnterprise Vault OfficeMail App options

As in other Enterprise Vault clients, the Office Mail AppDeleteoption deletes the selected shortcut and the archived item.

Delete: delete an archiveditem

The Office Mail AppCancel option appears temporarily whenan action that users can cancel is in progress.

Cancel: cancel an action

Initial configuration of HTTPS for use of theEnterprise Vault Office Mail App

The following initial configuration is required for use of the Enterprise Vault OfficeMail App.

You must configure HTTPS with a suitable certificate on Enterprise Vault serversthat serve the Enterprise Vault Office Mail App. Office Mail Apps must be servedusing Secure Sockets Layer (SSL).

We recommend that you obtain a certificate from a certification authority. Otherwise,if the certificate is from another source, a browser may display a warning and requirethe user to accept the certificate. Prompting for acceptance of a certificate is notavailable in the Office Mail App. The result is that the user sees a blank window inthe Office Mail App.

You do not have to configure Enterprise Vault to use HTTPS at site level.

See the following technical note for instructions on how to request and apply anSSL certificate:

http://www.veritas.com/docs/HOWTO83452

Deploying the Enterprise Vault Office Mail AppThe Enterprise Vault Office Mail App does not appear in Outlook or OWA by default.It requires deployment to users.

We recommend that you use Microsoft PowerShell commands in the ExchangeManagement Shell to deploy the Office Mail App.

The main methods are as follows:

■ Deploy the Office Mail App for each user who is enabled for Enterprise Vault.

■ Deploy the Office Mail App at organization level.

125Setting up Enterprise Vault Office Mail App for Exchange Server 2013 and laterInitial configuration of HTTPS for use of the Enterprise Vault Office Mail App

http://www.veritas.com/docs/HOWTO83452

If you consider deploying the Office Mail App at organization level, note thefollowing:

■ All users will see the Office Mail App in Outlook 2013 and later, and OWA2013 and later, including users who are not enabled for Enterprise Vault. Ifa user is not enabled for Enterprise Vault, a message in the Office Mail Appsays that it is not available.

■ The same Enterprise Vault server is used for Office Mail App requests fromall users, which could affect the overall performance of that server.

About the PowerShell commands for Office Mail AppsThe following Microsoft PowerShell commands are available for managing OfficeMail Apps:

Returns information about the installed Office Mail Apps.Get-App

Deploys an Office Mail App.New-App

Removes the specified Office Mail App.Remove-App

Disables a specific Office Mail App for a specific user.Disable-App

Enables an Office Mail App for a specific user.Enable-App

Sets configuration properties on an Office Mail App.Set-App

About deploying the Office Mail App with the New-App commandFigure 9-1 shows the process when you use the New-App command to deploy theEnterprise Vault Office Mail App for an individual user. A simplified representationof the command is shown at the top of the figure.

The process is similar when you deploy the Office Mail App for a whole organization.You still specify only one mailbox in the New-App command. This mailbox must beone whose archive is stored on the Enterprise Vault server to which you want allorganization level requests to be sent. In this case the Exchange Server configuresthe manifest file for all the mailboxes in the organization. The result is that a singleEnterprise Vault server has to serve the Office Mail App to all users.

126Setting up Enterprise Vault Office Mail App for Exchange Server 2013 and laterDeploying the Enterprise Vault Office Mail App

Figure 9-1 New-App command overview

Exchange server

MBX2

MBX1

Enterprise Vault site

Enterprise Vault server EV1

OfficeMailAppManifest.aspx

Exchange managementPowerShell

PowerShellcommandNew-App

URL

Manifest.xml


Archive MBX1

New-App -mailbox MBX1 -url URL


Archive MBX2

1 2

3

4

5

In the figure, the numbered stages are as follows:

1 You run the PowerShell command New-App in the Exchange ManagementShell.

The command specifies the following:

■ A mailbox (MBX1) that is enabled for archiving and that you want to enablefor the Office Mail App.

■ The URL of the OfficeMailAppManifest.aspx page.The server that is specified in the URL can be any Enterprise Vault serverin your site. In this example, the URL specifies a server named EV1.The URL for OfficeMailAppManifest.aspx can use the HTTP or HTTPSprotocol, depending on the protocol that is enabled in IIS on the EnterpriseVault server.

2 The Exchange server sends a request to Enterprise Vault server EV1 toconfigure a manifest file.


3 On EV1, the OfficeMailAppManifest.aspx page generates a manifest filefor MBX1 and sends it to the Exchange server. The manifest file contains theOffice Mail App settings for MBX1. The settings include the URL from whichthe Office Mail App will be loaded, which in this example is on Enterprise Vaultserver EV2 because the MBX1 archive is stored on EV2.

4 The manifest file is associated with MBX1 on the Exchange server.

5 The New-App command completes.

About New-App command parameters for the Enterprise Vault OfficeMail App

In the New-App command, you must specify the Active Directory attributeLegacyExchangeDN with the OfficeMailAppManifest.aspx page. You can alsospecify other parameters, if required. The OfficeMailAppManifest.aspx pagesupports the following query string parameters:

Mandatory. The Active Directory attribute LegacyExchangeDN forthe user.

If the LegacyExchangeDN value includes any URI reservedcharacters, then the LegacyExchangeDN value in the -Url parametermust be encoded. The following are examples of URI reservedcharacters:

: / ? # [ ] @ $ & ' / + , ; =

LegacyMbxDN

Optional. The name of the Office Mail App in the Office Mail AppBar. The name defaults to Enterprise Vault.

OfficeAppName

Optional. The URL of the EnterpriseVault virtual directory onthe server that is to be used to load the Office Mail App. You canset this value for an external URL or a specific Enterprise Vaultserver if required.

BaseURL

The manifest file is not generated if invalid values are supplied. The typical causesare as follows:

■ The mailbox is not enabled for archiving.

■ The LegacyExchangeDN value in the -Url parameter includes reservedcharacters, but the value is not encoded.

■ The BaseURL value is not valid.

If the manifest file is not generated, the New-App command may return an errormessage of the following type:


The app couldn't be downloaded. Error message: The remote server

returned an error: (500) Internal Server Error.

The Office Mail App troubleshooting information includes an example script thatreturns a more detailed error message when the manifest file is not created.

See “The Enterprise Vault Office Mail App manifest file is not created” on page 142.

Deploying the Enterprise Vault Office Mail App for an individual userTo deploy the Enterprise Vault Office Mail App for an individual user, use thePowerShell command New-App in the Exchange Management Shell.

See “About deploying the Office Mail App with the New-App command” on page 126.

Note: You must log in to the Exchange server using an account that is assignedthe management role User Options. By default, members of the "OrganizationManagement" role group are assigned this role.

The following example shows how to use the New-App command to enable anindividual user for the Office Mail App.

The backtick character (`) is the PowerShell line-continuation character.

Add-Type -AssemblyName System.Web$Mbx = get-mailbox "mailbox"

New-App -mailbox $Mbx.LegacyExchangeDN -Url `("http://EV_server/EnterpriseVault/OfficeMailAppManifest.aspx?LegacyMbxDn=" +[System.Web.HttpUtility]::UrlEncode($Mbx.LegacyExchangeDN))

where:

■ mailbox is the name of a mailbox that is enabled for archiving, and that youwant to enable for the Office Mail App.

■ EV_server is the name of any Enterprise Vault server in your site. This EnterpriseVault server is not necessarily the one that is used to load the Office Mail App.The Enterprise Vault server that is used to load the Office Mail App is the serverwhere the archive for the specified mailbox is located. The name of the correctEnterprise Vault server for the specified mailbox is returned within the manifestfile.

Users may access the Enterprise Vault server externally, with no direct access. Inthis case, the manifest file must point to the URL of the server that provides external


access. The same server would also be used for internal access. For example, theserver may be a Microsoft Forefront Threat Management Gateway (TMG) server.

The following example shows how to use the BaseURL parameter with theOfficeMailAppManifest.aspx page to configure the manifest file to point to aserver that provides external access.



New-App -mailbox $Mbx.LegacyExchangeDN -Url `("http://EV_server/EnterpriseVault/OfficeMailAppManifest.aspx?LegacyMbxDn=" +[System.Web.HttpUtility]::UrlEncode($Mbx.LegacyExchangeDN) +"&BaseURL=https://external_access_server/EnterpriseVault")

where:

■ mailbox is the name of a mailbox that is enabled for archiving, and that youwant to enable for the Office Mail App.

■ EV_server is the name of any Enterprise Vault server in your site. This EnterpriseVault server is not necessarily the one that is used to load the Office Mail App.The Enterprise Vault server that is used to load the Office Mail App is the serverthat is specified in the BaseURL parameter.

■ external_access_server is the name of the server that provides externalaccess.

See “About configuring Threat Management Gateway 2010 for Outlook 2013 andOWA 2013” on page 176.

Deploying the Enterprise Vault Office Mail App for multiple usersThe following example PowerShell script shows how to deploy the Enterprise VaultOffice Mail App for multiple users. All the users must be within a single organizationalunit.

A script of this type may take some time to complete for a large number of users.The speed at which the script enables users will vary from system to system,depending on the particular environment in which it is run.

Note: You must log in to the Exchange server using an account that is assignedthe management role User Options. By default, members of the "OrganizationManagement" role group are assigned this role.



Add-Type -AssemblyName System.Webfunction EVDeploy([string]$evserver, [string]$ou) {Get-Mailbox -OrganizationalUnit $ou |ForEach-Object {If (New-App -mailbox $_.LegacyExchangeDN -ErrorAction:Ignore -Url `

("http://" + $evserver +"/EnterpriseVault/OfficeMailAppManifest.aspx?LegacyMbxDn=" +[System.Web.HttpUtility]::UrlEncode($_.LegacyExchangeDN))) {

Write-host ("Deployed to: " + $_.DisplayName);} Else {If (Get-App -mailbox $_.LegacyExchangeDN `

-Identity 0cc6d075-e610-4b8a-90c6-1460e6d4d710 `-ErrorAction:Ignore) {

Write-host ("Already deployed to: " + $_.DisplayName);} Else {Write-host ("Could not deploy to: " + $_.DisplayName);

};};

};};

EVDeploy "EV_server" "org_unit"

where:

■ EV_server is the name of any Enterprise Vault server in your site. This EnterpriseVault server is not necessarily the one that is used to load the Office Mail App.The Enterprise Vault server that is used to load the Office Mail App is the serverwhere the archive for the specified mailbox is located. The name of the correctEnterprise Vault server for the specified mailbox is returned within the manifestfile.

■ org_unit is the organizational unit that contains the users for whom you wantto deploy the Office Mail App.

Note: EV_server and org_unit in the final line of this script are the only variablesthat you need to replace.

The GUID identifies the Enterprise Vault Office Mail App, and does not change.


About the Enterprise Vault Office Mail App after deployment for anindividual user

Figure 9-2 shows what happens when:

■ The Office Mail App has been deployed for an individual user.

■ The user selects the Office Mail App and stores an item.

Figure 9-2 Office Mail App after deployment for an individual user

Initiate App load

Initiate storeoperation

User in OWA or Outlook

Select Enterprise VaultOffice Mail App

Office Mail App loads

Click Store button inOffice Mail App

MBX1

1

3

4


Archive MBX1

OfficeMailApp.htm

Store operationcompleted locallyby archiving task

5

2


1 The user of mailbox MBX1 selects the Office Mail App in OWA or Outlook.

2 A request to load the Office Mail App is sent to OfficeMailApp.htm onEnterprise Vault server EV2, where the archive for MBX1 is stored.

3 The Office Mail App loads.

4 The user selects an unarchived item and clicks Store.

5 The Office Mail App sends a request to store the item to EV2. On EV2,Enterprise Vault stores the item in the archive MBX1.

Each Enterprise Vault server only serves the Office Mail App to users whose archivesare stored on that server.

Deploying the Enterprise Vault Office Mail App for an organizationIn an Exchange environment where archiving is to a single Enterprise Vaultinstallation, you may decide to deploy the Office Mail App at organization level. Theadvantage of deployment at organization level is that it is simpler and quicker thandeployment to individual mailboxes.

However, if you consider deploying the Enterprise Vault Office Mail App atorganization level, note the following:


■ All users will see the Office Mail App in Outlook 2013 and later, and OWA 2013and later, including users who are not enabled for Enterprise Vault. If a user isnot enabled for Enterprise Vault, a message in the Office Mail App says that itis not available.

■ The same Enterprise Vault server is used for Office Mail App requests from allusers, which could affect the overall performance of that server.If this Enterprise Vault server becomes unavailable, all requests to load theOffice Mail App will fail. You could mitigate this impact and other performanceimpacts by using a round robin DNS load-balancing solution.

To deploy the Enterprise Vault Office Mail App at organization level, use thePowerShell command New-App in the Exchange Management Shell.

See “About deploying the Office Mail App with the New-App command” on page 126.

Note: You must log in to the Exchange server using an account that is assignedthe management roles Org Custom Apps and User Options. By default, membersof the "Organization Management" role group are assigned these roles. The mailboxassociated with this account must reside on Exchange Server 2013 or later.

The following example shows how to use the New-App command to enable anorganization for the Office Mail App.



New-App -OrganizationApp -DefaultStateForUser:enabled -Url `("http://EV_server/EnterpriseVault/OfficeMailAppManifest.aspx?LegacyMbxDn=" +[System.Web.HttpUtility]::UrlEncode($Mbx.LegacyExchangeDN))

where:

■ mailbox is the name of a mailbox that is enabled for archiving. This mailboxmust be one whose archive is stored on the Enterprise Vault server to whichyou want all organization level requests to be sent.

■ EV_server is the name of any Enterprise Vault server in your site.This EnterpriseVault server is not necessarily the one that is used to load the Office Mail App.The Enterprise Vault server that is used to load the Office Mail App for all usersis the server where the archive for the specified mailbox is located. The nameof the correct Enterprise Vault server for the specified mailbox is returned withinthe manifest file.


Users in the organization may access the Enterprise Vault server externally, withno direct access. In this case, the manifest file must point to the URL of the serverthat provides external access. The same server would also be used for internalaccess. For example, the server may be a Microsoft Forefront Threat ManagementGateway (TMG) server.

The following example shows how to use the BaseURL parameter with theOfficeMailAppManifest.aspx page to configure the manifest file to point to aserver that provides external access.



New-App -OrganizationApp -DefaultStateForUser:enabled -Url `("http://EV_server/EnterpriseVault/OfficeMailAppManifest.aspx?LegacyMbxDn=" +[System.Web.HttpUtility]::UrlEncode($Mbx.LegacyExchangeDN) +"&BaseURL=https://external_access_server/EnterpriseVault")

where:

■ mailbox is the name of any mailbox that is enabled for archiving.

■ EV_server is the name of any Enterprise Vault server in your site. This EnterpriseVault server is not necessarily the one that is used to load the Office Mail App.The Enterprise Vault server that is used to load the Office Mail App for all usersis the server that is specified in the BaseURL parameter.

■ external_access_server is the name of the server that provides externalaccess.

See “About configuring Threat Management Gateway 2010 for Outlook 2013 andOWA 2013” on page 176.

About the Enterprise Vault Office Mail App after deployment for anorganization

Figure 9-3 shows what happens when:

■ The Office Mail App has been deployed for an organization.

■ The New-App command specified mailbox MBX1 and a URL on Enterprise Vaultserver EV1 for OfficeMailAppManifest.aspx.

■ The user selects the Office Mail App and stores an item.


Figure 9-3 Office Mail App after deployment for an organization

User in OWA or Outlook

Select Enterprise VaultOffice Mail App

Office Mail App loads

Click Store button inOffice Mail App

MBX2

Initiate storeoperation


Archive MBX1

OfficeMailApp.htm

Store operationforwarded

Initiate App load


Archive MBX2

OfficeMailApp.htm

Store operationcompleted locallyby archiving task

1

3

4 5

2

6


1 The user of mailbox MBX2 selects the Office Mail App in OWA or Outlook.

2 A request to load the Office Mail App is sent to OfficeMailApp.htm onEnterprise Vault server EV2, where the archive for MBX1 is stored.

3 The Office Mail App loads.

4 The user selects an unarchived item and clicks Store.

5 The Office Mail App sends a request to store the item to EV2.

6 Enterprise Vault on EV2 forwards the request to Enterprise Vault server EV3.On EV3, Enterprise Vault stores the item in the archive MBX2.

No forwarding of the request to store is required for users whose archives are onEV2.


Mailbox synchronization after upgrade to enable use of the OfficeMail App

If you have upgraded Enterprise Vault and deployed the Enterprise Vault OfficeMail App to existing users' mailboxes, those mailboxes must be synchronized.

Until the mailboxes are synchronized, the Office Mail App does not load fully afterthe user clicks the Enterprise Vault tab. It does not show any buttons, and insteaddisplays an appropriate error message.

If the Exchange Mailbox archiving task is set to run automatically, it synchronizesmailboxes the next time it runs. If the startup type is manual, or if you want to runthe task before the next scheduled time, you can optionally start the task from theAdministration Console. The startup type is set on the Exchange Mailbox TaskProperties: General tab in the Administration Console.

Additional requirements on Enterprise Vault OfficeMail App users' computers

You should ensure that client computers meet the following additional requirementsfor use of the Enterprise Vault Office Mail App:

■ Internet Explorer 9 or later must be installed on client computers. For the latestinformation on supported browsers, see the Enterprise VaultCompatibility Chartsat http://www.veritas.com/docs/000097605.

■ In the Internet Explorer Security settings, the Enterprise Vault server must beincluded in the Local intranet zone. Including the Enterprise Vault server in theLocal intranet zone prevents unwanted authentication prompts to users.Note that installation of the Enterprise Vault Outlook Add-In automatically addsthe Enterprise Vault server to Local intranet zone sites.

■ This requirement applies when both of the following are true:

■ Internet Explorer 10 or later is installed.

■ The Exchange server and the Enterprise Vault web server are in differentzones in the Internet Explorer Security settings.

In this case, each zone must have the same Enable Protected Mode setting.If the Enable Protected Mode settings are different, then the Office Mail Appoptions that open a browser window, such as Search, may not work. This issueoccurs only if the user runs the Office Mail App from OWA in Internet Explorer10 or later. It does not occur if the user runs the Office Mail App in Outlook.An error message informs the user if a window fails to open.

136Setting up Enterprise Vault Office Mail App for Exchange Server 2013 and laterAdditional requirements on Enterprise Vault Office Mail App users' computers


■ Users' computers must have external Internet access. They must be able toaccess the following URLs for the Office Mail App to load correctly:

■ https://appsforoffice.microsoft.com/lib/1.0/hosted/office.js

■ https://ajax.aspnetcdn.com/ajax/3.5/MicrosoftAjax.js

Disabling and re-enabling the Enterprise VaultOffice Mail App for a device type

After deployment of the Enterprise Vault Office Mail App, it is enabled by defaultfor computers, tablets, and phones. To disable the Office Mail App for any of thesedevice types, you can add an entry to the web.config file on the Enterprise Vaultserver. For example, you might want to disable the Office Mail App for tablets andphones, but leave it enabled for computers.

The web.config file is in the \WebApp folder below the Enterprise Vault installationfolder, for example C:\Program Files (x86)\Enterprise Vault\WebApp.

When you disable a device type, the Enterprise Vault tab still appears but the OfficeMail App does not show the usual options. Instead, the following message isdisplayed:

The Enterprise Vault Office Mail App is not available on this device

To disable the Office Mail App for a device type

1 Make a copy of web.config and rename the copy in case you need to revertto it.

2 Open web.config in a text editor.

Note: User Account Control (UAC) may prevent you from editing web.config

in its usual location. If so, copy it from the \WebApp folder to a location whereyou can edit it.

3 If the <appsettings> section does not exist, add the section. The start andthe end tags are <appsettings> and </appsettings>.

4 In the <appsettings> section, add the following line:

<add key="key_name" value="false"/>

where key_name is one of the following:

■ To disable the Office Mail App for computers: OMAEnabledOnDesktop.

137Setting up Enterprise Vault Office Mail App for Exchange Server 2013 and laterDisabling and re-enabling the Enterprise Vault Office Mail App for a device type

https://appsforoffice.microsoft.com/lib/1.0/hosted/office.js

https://ajax.aspnetcdn.com/ajax/3.5/MicrosoftAjax.js

■ To disable the Office Mail App for tablets: OMAEnabledOnTablet.

■ To disable the Office Mail App for phones: OMAEnabledOnPhone.

5 Save and close web.config.

6 If necessary, copy the edited web.config file back to the \WebApp folder.

To re-enable the Office Mail App for a device type

1 Repeat steps 1 and 2 in the procedure above.

2 In the <appsettings> section, do one of the following:

■ Delete the line that disables the device type.

■ In the relevant line, change the value false to true.

3 Repeat steps 5 and 6 in the procedure above.

Removing, disabling, and re-enabling theEnterprise Vault Office Mail App for a user or anorganization

You can remove the Enterprise Vault Office Mail App for an individual user or anorganization by using the PowerShell command Remove-App.

You can disable the Office Mail App for an individual user by using the commandDisable-App. It is not possible to disable an Office Mail App that is installed at theorganization level.

After you have disabled the Office Mail App, you can re-enable it by using thecommand Enable-App.

When you disable the Office Mail App with Disable-App, it does not load and theEnterprise Vault tab does not appear on the Office Mail App bar. As an alternative,you can use a separate, more easily reversible method to disable the Office MailApp for a particular device type. With this method, the Office Mail App still loads.The Enterprise Vault tab appears on the Office Mail App bar, but the usual optionsare not available.

See “Disabling and re-enabling the Enterprise Vault Office Mail App for a devicetype” on page 137.

138Setting up Enterprise Vault Office Mail App for Exchange Server 2013 and laterRemoving, disabling, and re-enabling the Enterprise Vault Office Mail App for a user or an organization

To remove the Office Mail App for an individual user

1 Log in to the Exchange server using an account that is assigned themanagement role User Options. By default, members of the "OrganizationManagement" role group are assigned this role.

2 Open the Exchange Management Shell.

3 Run a PowerShell command based on the following example:

Remove-App -mailbox mailbox -Identity 0cc6d075-e610-4b8a-90c6-1460e6d4d710

where mailbox is the mailbox from which you want to remove the Office MailApp.


You are prompted to confirm the action.

4 To confirm, enter your response and press Enter.

To remove the Office Mail App for an organization



3 Run the following PowerShell command:

Remove-App -OrganizationApp -Identity 0cc6d075-e610-4b8a-90c6-1460e6d4d710




To disable the Office Mail App for an individual user



139Setting up Enterprise Vault Office Mail App for Exchange Server 2013 and laterRemoving, disabling, and re-enabling the Enterprise Vault Office Mail App for a user or an organization


Disable-App -mailbox mailbox -Identity 0cc6d075-e610-4b8a-90c6-1460e6d4d710

where mailbox is the mailbox for which you want to disable the Office MailApp.




To re-enable the Office Mail App for an individual user




Enable-App -mailbox mailbox -Identity 0cc6d075-e610-4b8a-90c6-1460e6d4d710

where mailbox is the mailbox for which you want to re-enable the Office MailApp.




Troubleshooting the Enterprise Vault Office MailApp

This section includes the following topics:

■ Enterprise Vault Office Mail App: client tracing

■ Enterprise Vault Office Mail App: server tracing

■ Checking deployment of the Enterprise Vault Office Mail App

■ The Enterprise Vault Office Mail App manifest file is not created

■ Unable to deploy the Enterprise Vault Office Mail App at organization level

■ The Enterprise Vault Office Mail App window is blank or contains an errormessage

■ An Enterprise Vault Office Mail App action fails with an error message

140Setting up Enterprise Vault Office Mail App for Exchange Server 2013 and laterTroubleshooting the Enterprise Vault Office Mail App

Enterprise Vault Office Mail App: client tracingThe Enterprise Vault Office Mail App writes to a console trace window on the clientcomputer.

To launch the console trace in a new window

◆ Hold down the Ctrl key and click Help in the Enterprise Vault Office Mail Appwindow.

Enterprise Vault Office Mail App: server tracingYou can use the DTrace utility to trace Office Mail App problems on the EnterpriseVault server.

Table 9-3 shows the processes to monitor with DTrace.

Table 9-3 Processes to monitor for the Office Mail App

DescriptionProcess

This process hosts .aspx pages. Tracing this process canshow errors in the .aspx pages.

W3wp.exe

When Enterprise Vault initially marks items to archive,restore, delete, or view, it uses AgentClientBroker.exe.Tracing this process can show errors in connecting toExchange Server.

AgentClientBroker.exe

Enterprise Vault uses this process as part of its restore andview functionality.

ShoppingService.exe

Enterprise Vault uses this process when it retrieves anitem.

RetrievalTask.exe

Enterprise Vault uses this process when it restores an item.StorageRestore.exe

Enterprise Vault uses this process when it deletes an item.StorageDelete.exe

Enterprise Vault uses this process when it archives an item.StorageArchive.exe

For more information on DTrace, see the Enterprise Vault Utilities guide.

Checking deployment of the Enterprise Vault Office Mail AppYou can find out the following information about deployment of the Enterprise VaultOffice Mail App by using the PowerShell command Get-App:

■ Whether the Office Mail App is deployed at the organization level.


■ A list of the mailboxes to which the Office Mail App has been deployedindividually.

To check whether the Office Mail App is deployed at the organization level



3 Run the following PowerShell command:

Get-App -OrganizationApp -Identity 0cc6d075-e610-4b8a-90c6-1460e6d4d710


The command either reports that the Office Mail App is deployed, or it displaysan error saying that the application identity was not found.

To list the mailboxes to which the Office Mail App has been deployedindividually



3 Run the following PowerShell command. The backtick character (`) is thePowerShell line-continuation character.

Get-Mailbox |ForEach {If (Get-App -mailbox $_.LegacyExchangeDN `

-Identity 0cc6d075-e610-4b8a-90c6-1460e6d4d710 `-ErrorAction:Ignore | Where {$_.Type -Eq "Private"} )

{Write-Host $_.DisplayName} }


The command lists the mailbox display names of all the mailboxes to whichthe Office Mail App has been deployed individually.

The Enterprise Vault Office Mail App manifest file is not createdIf invalid parameter values are supplied for the OfficeMailAppManifest.aspx

page for use with the PowerShell command New-App, no manifest file is created.The command fails and returns an error message of the following type:


The app couldn't be downloaded. Error message: The remote server

returned an error: (500) Internal Server Error.

The typical causes of this error are as follows:

■ The user is not enabled for Enterprise Vault.

■ The LegacyExchangeDN value in the -Url parameter includes reservedcharacters, but the value is not encoded.

■ The BaseURL value is not valid.

The following example returns a more detailed error message when the manifestfile is not created for a specified individual user. This script also shows how youcan download the application manifest to a file, then specify the file in the New-App

command instead of the URL.

Add-Type -AssemblyName System.Web$Mbx = get-mailbox "mailbox"$uri = new-object system.uri(

"http://EV_server/EnterpriseVault/OfficeMailAppManifest.aspx?LegacyMbxDn=" +[System.Web.HttpUtility]::UrlEncode($Mbx.LegacyExchangeDN))

$webclient = New-Object Net.Webclient$webClient.UseDefaultCredentials = $truetry{

$bytes = $webclient.DownloadData($uri)New-App -mailbox $Mbx.LegacyExchangeDN -FileData $bytes

}catch [Net.WebException]{

[Net.HttpWebResponse] $webResponse = [Net.HttpWebResponse]$_.Exception.Response;Write-Warning $webResponse.StatusDescription

}

where:

■ mailbox is the name of the mailbox you are trying to enable for the Office MailApp.

■ EV_server is the name of the Enterprise Vault server.

Unable to deploy the Enterprise Vault Office Mail App at organizationlevel

When you log in to the Exchange Server to deploy the Enterprise Vault Office MailApp at organization level, you must use an account that is assigned the management


roles "Org Custom Apps" and "User Options". If the mailbox that is associated withthis account resides on a version of Exchange Server that is earlier than 2013, thenthe New-App command fails. An error message similar to the following example isreturned:

Cannot open mailbox /o=Example/ou=Exchange Administrative Group

(FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=EX01/

cn=Microsoft System Attendant.

+ CategoryInfo : NotSpecified:

(example.local/Users/Administrator:ADObjectId) [New-App],

MailboxInTransitException

+ FullyQualifiedErrorId :

[Server=EX03,RequestId=7f1977fb-0bac-4ca1-99d7-33b7db3a5da2,

TimeStamp=04/08/2015 13:26:43] [FailureCategory=

Cmdlet-MailboxInTransitException]

4A87ABB,Microsoft.Exchange.Management.Extension.NewApp

+ PSComputerName : ex03.example.local

To resolve this issue, move the account mailbox to Exchange Server 2013 or later,then rerun the New-App command.

The Enterprise Vault Office Mail App window is blank or contains anerror message

The Enterprise Vault Office Mail App may appear on the Office Mail App bar, butits window is blank or it displays only an error message.

If this problem occurs, try the following steps:

■ If you have more than one Enterprise Vault server, determine which EnterpriseVault server is requested when Enterprise Vault tries to load the Office MailApp, as described in the procedure below.

■ Check whether you can load the following web page from the client computer:https://EV_server/EnterpriseVault/OfficeMailApp.aspx

where EV_server is the name of the Enterprise Vault server from which theOffice Mail App is loaded.

Navigating directly to OfficeMailApp.aspx can show the following:

■ Whether there are certificate errors

■ Whether there is a particular problem loading the web pageThe Office Mail App does not initialize fully when you load it in this way.

■ Check that the following URLs are accessible from the client computer:

■ https://appsforoffice.microsoft.com/lib/1.0/hosted/office.js


https://appsforoffice.microsoft.com/lib/1.0/hosted/office.js

■ https://ajax.aspnetcdn.com/ajax/3.5/MicrosoftAjax.js

Access to these URLs is required for the Office Mail App to load correctly. Ifthey are not accessible, it may be because the client computer has no Internetconnection, or the connection is too slow.

To determine the Enterprise Vault server with the Get-App command



3 If the Office Mail App is deployed to an organization, go to step 4.

If the Office Mail App is deployed to individual users, run the followingPowerShell command:

Get-App 0cc6d075-e610-4b8a-90c6-1460e6d4d710 -Mailbox mailbox | Format-List ManifestXML

where mailbox is the mailbox you are troubleshooting.


4 If the Office Mail App is deployed to an organization, run the followingPowerShell command:

Get-App 0cc6d075-e610-4b8a-90c6-1460e6d4d710 -OrganizationApp | Format-List ManifestXML


5 In the output XML, find the <DesktopSettings> node. The DefaultValue

contains the Enterprise Vault server URL that is requested when EnterpriseVault tries to load the Office Mail App.

An Enterprise Vault Office Mail App action fails with an error messageWhen a user clicks an Enterprise Vault Office Mail App option, a problem may causethe action to fail. The Office Mail App displays an error message.

When an action fails, you can hover over the error message to see additionalinformation.

For example, if the error message says Failed to archive item, one possibleadditional information message is as follows:

Enterprise Vault cannot perform the requested action because a service

is not running

The Office Mail App client tracing includes more detailed information.


https://ajax.aspnetcdn.com/ajax/3.5/MicrosoftAjax.js

See “Enterprise Vault Office Mail App: client tracing” on page 141.


Setting up Enterprise Vaultaccess for OWA clients onExchange Server 2010


■ About Enterprise Vault functionality in OWA clients

■ Enterprise Vault OWA Extensions in an Exchange Server 2010 environment

■ Steps to configure Enterprise Vault access for OWA users

■ Configuring Enterprise Vault for anonymous connections

■ Creating the ExchangeServers.txt file

■ Configuring the Data Access account

■ Restart the Admin Service and synchronize mailboxes for OWA configuration

■ Configuring Enterprise Vault Exchange Desktop Policy for OWA

■ Installing Enterprise Vault OWA 2010 Extensions

■ Additional configuration steps for Exchange Server 2010 CAS proxying for usewith OWA

10Chapter

About Enterprise Vault functionality in OWAclients

To provide access to Enterprise Vault in OWA clients on Exchange Server 2010,you install Enterprise Vault OWA 2010 Extensions on all Exchange Server 2010CAS computers.

For mailboxes that are hosted on Exchange Server 2013 and later, the EnterpriseVault Office Mail App provides Enterprise Vault features in OWA clients. Thesefeatures differ slightly from the features that are available to users of ExchangeServer 2010 OWA clients.

See “About the Enterprise Vault Office Mail App” on page 121.

The following features are available to users whose mailboxes are hosted onExchange Server 2010:

■ View items using standard OWA functionality.

■ Reply to and forward shortcuts or original items (using standard OWAfunctionality).

■ Archive items and folders using Enterprise Vault buttons or menu options. Defaultarchiving properties can be changed.

■ Restore items using Enterprise Vault buttons or menu options. Restore propertiescan be set.

■ Delete shortcuts, archived items, or both using Enterprise Vault buttons or menuoptions or standard OWA functionality.

■ Browse and search archives.

■ View archived public folder items.

■ Administrator can configure Enterprise Vault functionality available in Premiumand Basic clients.

Exchange Desktop policy settings in the Enterprise Vault Administration Consolelet you customize Enterprise Vault functionality in OWA clients. Settings in theOptions page of the Exchange Desktop policy let you choose the features to makeavailable to users in OWA and Outlook clients. Separate lists of OWA and Outlooksettings in the Advanced page of the Exchange Desktop policy let you customizehow the Enterprise Vault features behave in different clients. See the Administrator’sGuide for more details.

No Enterprise Vault extensions are required to support Enterprise Vault accessfrom Outlook Anywhere clients (that is, Outlook clients working in RPC over HTTPmode).

148Setting up Enterprise Vault access for OWA clients on Exchange Server 2010About Enterprise Vault functionality in OWA clients

See “Configuring Outlook Anywhere client access to Enterprise Vault” on page 168.

About OWA forms-based authentication for Enterprise VaultWith forms-based authentication, OWA users must re-enter login credentials whenthey start Enterprise Vault Search or first open an archived item using EnterpriseVault View mode. This is because the request accesses a different web server,which requires different authentication.

View mode can be set to Enterprise Vault in the OWA settings on the Advancedpage of the Exchange Desktop policy. The View mode setting controls what happenswhen a user clicks Open the original item in the banner of a custom shortcut. IfOWA is set as the value of this setting, OWA renders the original item, which lookslike an OWA message. If Enterprise Vault is set as the value, Enterprise Vaultrenders the item.

Enterprise Vault OWAExtensions in an ExchangeServer 2010 environment

Figure 10-1 shows a simple OWA on Exchange Server 2010 environment.

149Setting up Enterprise Vault access for OWA clients on Exchange Server 2010Enterprise Vault OWA Extensions in an Exchange Server 2010 environment

Figure 10-1 Simple OWA on Exchange Server 2010 environment

Anonymous

Archive browse andsearch requests

Exchange Server2010 mailbox

Exchange Server2010 CAS

+Enterprise Vault

OWA 2010Extensions

Browser

EnterpriseVaultserver

In this configuration Enterprise Vault OWA 2010 Extensions are installed on theExchange CAS computer. Typically, the Exchange Mailbox server would be on aseparate computer, but it could be co-located with the Exchange CAS.

When an OWA client user chooses to browse or search an archive, the client alwaystries to connect directly to the Enterprise Vault web server on the Enterprise Vaultserver.

If clients connect to the Exchange CAS computer using firewall software, then boththe Exchange CAS URL and the Enterprise Vault web server URL must be publishedto clients using web publishing rules.

The Exchange CAS connects to the Enterprise Vault server using anonymousauthentication. On the Enterprise Vault server, the Data Access account is configuredto manage the anonymous connections.

150Setting up Enterprise Vault access for OWA clients on Exchange Server 2010Enterprise Vault OWA Extensions in an Exchange Server 2010 environment

Clustered OWA configurationsIn an OWA environment on Exchange Server 2010, the Mailbox server can beclustered, but the CAS server cannot. As it is the CAS server that contacts theEnterprise Vault server, the Enterprise Vault configuration is unaffected whenExchange Server 2010 Mailbox servers are clustered.

Steps to configure Enterprise Vault access forOWA users

Before starting the tasks described in this section, it is important to check that yourExchange Servers and Enterprise Vault servers meet the prerequisites describedin "Requirements for OWA" in Installing and Configuring.

When you install the Enterprise Vault OWA 2010 Extensions on your ExchangeServers, ensure that you install the same Enterprise Vault release version of theextensions on all the Exchange Servers. All the Exchange Servers on which youinstall the extensions should be at the same Exchange Server service pack andhotfix level.

Table 10-1 lists the tasks required to configure Enterprise Vault access for OWAclients. There are a number of tasks that you need to complete before installing theextensions. There may also be post-installation steps required, depending on yourOWA environment.

Table 10-1 Steps to configure Enterprise Vault for OWA clients

More informationTaskStep

The Data Access account is used toaccept anonymous connections fromExchange 2010 CAS servers.

See “Configuring Enterprise Vault foranonymous connections” on page 153.

You will need to restart the EnterpriseVault Admin Service to complete thistask.

On Enterprise Vault servers, configurethe Data Access account.

Step 1

151Setting up Enterprise Vault access for OWA clients on Exchange Server 2010Steps to configure Enterprise Vault access for OWA users

Table 10-1 Steps to configure Enterprise Vault for OWA clients (continued)


If required, you can configure OWAsettings in the Exchange DesktopPolicy to change the Enterprise Vaultfunctionality available in OWA clients.

See “Configuring Enterprise VaultExchange Desktop Policy for OWA”on page 156.

In the Enterprise Vault AdministrationConsole, configure OWA settings in theExchange Desktop Policy.

Step 2

See “Installing Enterprise Vault OWA2010 Extensions” on page 160.

On Exchange 2010 CAS servercomputers, install the Enterprise VaultOWA 2010 Extensions.

Step 3

See “Additional configuration steps forExchange Server 2010 CAS proxyingfor use with OWA” on page 161.

If your Exchange Server 2010environment includes CAS proxyservers, then you need to allow theCAS proxy servers to use ExchangeWeb Services impersonation.

Step 4

When an OWA 2010 client userchooses to browse or search anarchive, the client tries to access theEnterprise Vault server directly. For thisreason you need to publish to clientsthe URL for the Enterprise Vault server.

See “About configuring ThreatManagement Gateway 2010 forOutlook 2013 and OWA 2013”on page 176.

See “Configuring ISA Server 2006 forOWA 2010 access to Enterprise Vault”on page 177.

For details of how to configure differentURLs for internal and external accessto Enterprise Vault, see the followingdocument on the Veritas Supportwebsite:http://www.veritas.com/docs/TECH63250.

If you are using firewall software, setup rules to publish both the ExchangeCAS server URL and the EnterpriseVault web server URL.

Step 5

If you have problems with installing Enterprise Vault OWA 2010 Extensions, orwhen accessing archived items using OWA, see the following document on theVeritas Support website: http://www.veritas.com/docs/TECH69113. This document

152Setting up Enterprise Vault access for OWA clients on Exchange Server 2010Steps to configure Enterprise Vault access for OWA users



gives detailed troubleshooting information for Enterprise Vault OWA 2010Extensions.

Configuring Enterprise Vault for anonymousconnections

To prepare Enterprise Vault servers for anonymous connections from Exchange2010 CAS servers, perform the tasks that are listed in Table 10-2.

Table 10-2 Steps to configure anonymous connections


See the section, "Requirements forOWA 2010" in Installing andConfiguring.

On each Enterprise Vault server, checkthat IIS Roles and Feature Delegationrights are correctly configured.

Step 1

This file contains a list of the IPaddresses for all the Exchange 2010CAS servers that will connect to theEnterprise Vault server.

See “Creating the ExchangeServers.txtfile” on page 154.

On each Enterprise Vault server thatmay receive connection requests fromOWA servers, create anExchangeServers.txt file in theEnterprise Vault installation folder.

Step 2

This account is referred to as the DataAccess account.

See “Configuring the Data Accessaccount” on page 154.

Note that the Data Access account isalso used for anonymous connectionsto the Domino Mailbox Archiving webapplication. If you are configuring bothEnterprise Vault OWA 2010 Extensionsand Domino Mailbox Archiving it isimportant to use the same account asthe Data Access account for bothfeatures.

In Active Directory create or select adomain account to be used foranonymous connections fromExchange Servers to the EnterpriseVault server.

Step 3

See “Configuring the Data Accessaccount” on page 154.

On each Enterprise Vault server onwhich you have created anExchangeServers.txt file, run thescript, owauser.wsf, to configure theData Access account.

Step 4

153Setting up Enterprise Vault access for OWA clients on Exchange Server 2010Configuring Enterprise Vault for anonymous connections

Table 10-2 Steps to configure anonymous connections (continued)


See “Restart the Admin Service andsynchronize mailboxes for OWAconfiguration” on page 155.

Synchronize mailboxes and restart theEnterprise Vault Admin service.

Step 5

Creating the ExchangeServers.txt fileTo create the ExchangeServers.txt file

1 Open Notepad.

2 Type the IP address of each Exchange CAS server that will connect to theEnterprise Vault server, one entry per line.

Addresses can be in either IPv4 or IPv6 format. IPv6 addresses must be in theform fdfa:9c37:5267:d2e3:a192:b168:cc80:d204.

3 Save the file as ExchangeServers.txt in the Enterprise Vault installation folder(for example C:\Program Files (x86)\Enterprise Vault). When you savethe file, select ANSI, Unicode, or Unicode big endian encoding.

4 Close Notepad.

Configuring the Data Access accountCreate or select a domain account to use as the Data Access account for anonymousconnections to the Enterprise Vault server. The account should be a basic domainaccount; a local machine account cannot be used. The account should not belongto any administrator group, such as Administrators or Account Operators.

If you are configuring both Enterprise Vault OWA 2010 Extensions and DominoMailbox Archiving, it is important to use the same account as the Data Accessaccount for both features. If you have already set up Domino Mailbox Archiving,note the details of the account specified on the Data Access Account tab ofDirectory properties in the Administration Console. Configure this account for OWAas described in this section.

To configure the Data Access account for OWA

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

2 Open a Command Prompt window with administrator privileges.

3 Navigate to the Enterprise Vault installation folder.

154Setting up Enterprise Vault access for OWA clients on Exchange Server 2010Creating the ExchangeServers.txt file

4 Enter the following command:

cscript owauser.wsf /domain:domain /user:username

/password:password

The file owauser.wsf is installed in the Enterprise Vault installation folder.

For domain, give the domain of the Data Access account.

For username, give the username of the Data Access account.

For password, give the password of the Data Access account.

To display help for the cscript command, type

cscript owauser.wsf /?

5 The progress of the script execution is displayed in the command promptwindow.

The configuration changes made by the script are described in the followingtechnical note on the Veritas Support website:


When the configuration script finishes, you are prompted to restart theEnterprise Vault Admin service and synchronize mailboxes.

6 If there are multiple Enterprise Vault servers in your environment, logon toeach server on which you created an ExchangeServers.txt file, and run thescript, owauser.wsf, using the instructions given in this section.

If you add another Exchange CAS server to your environment at a later date,add the IP address of the server to the ExchangeServers.txt file on theEnterprise Vault server to which the Exchange Server will connect, and thenrerun the owauser.wsf script.

Restart the Admin Service and synchronizemailboxes for OWA configuration

To complete the configuration, you need to restart the Enterprise Vault Adminservice and synchronize mailboxes on Enterprise Vault servers. Restarting theAdmin service ensures that Enterprise Vault authentication knows the identity ofthe Data Access account. Synchronizing the mailboxes updates the client hiddenmessage with the URL to be used by the OWA Extensions when connecting toEnterprise Vault.

155Setting up Enterprise Vault access for OWA clients on Exchange Server 2010Restart the Admin Service and synchronize mailboxes for OWA configuration


To restart the Admin Service

1 In Control Panel, select Services.

2 Right-click Enterprise Vault Admin Service and select Restart.

Enterprise Vault services and tasks will restart.

3 Close the Services console.

To synchronize mailboxes

1 Start the Enterprise Vault Administration Console.

2 Expand the Enterprise Vault Directory container and then your site. ExpandEnterprise Vault Servers and select the required Enterprise Vault server.Expand this container. Expand Tasks.

3 In the right hand pane, double-click the Exchange Mailbox Archiving taskfor the Exchange Server, to display the properties window for the task.

4 Select the Synchronization tab. Make sure All mailboxes and Mailboxproperties and permissions are selected.

5 Click Synchronize.

6 Click OK to close the properties window.

7 Close the Enterprise Vault Administration Console.

Configuring Enterprise Vault Exchange DesktopPolicy for OWA

If required, you can customize the Enterprise Vault functionality that you wantavailable in OWA clients.

You can customize OWA clients on Exchange Server 2010 using theOWA versionsbefore 2013 settings on the Advanced page of the Exchange Desktop policyproperties. The settings available are listed in Table 10-3

For more information on these settings, see the Enterprise Vault Administrator'sGuide.

If you change any settings in the Exchange Desktop policy, then you will need tosynchronize the mailboxes.

See “To synchronize mailboxes” on page 156.

156Setting up Enterprise Vault access for OWA clients on Exchange Server 2010Configuring Enterprise Vault Exchange Desktop Policy for OWA

Table 10-3 OWA versions before 2013 (Exchange desktop policy advancedsettings)

DescriptionSetting

Specifies whether there is a confirmationprompt when a user tries to archive an itemmanually. Default is On — Prompt forconfirmation.

Archive confirmation

For manual archiving, controls whethersubfolders are archived if they are includedin a user's selection. Default is On —Subfolders are archived

Archive subfolders

Controls whether users of the OWA Basicclient are allowed to choose archivingsettings, such as retention category anddestination archive, when archiving itemsmanually. Default is Basic — Users cannotchange settings when archiving.

Basic archive function

Controls whether the OWA context menu forthe OWA Basic client has a Restore option.Default is Basic — There is noRestore optionon the context menu.

Basic restore function

Controls the connection to use when OutlookAnywhere clients (RPC over HTTP) contactthe Enterprise Vault web server.

Default is Use proxy — Outlook Anywhereclients first attempt to connect to the defaultEnterprise Vault web server. If the URLcannot be contacted, then the clients attemptto contact an Enterprise Vault proxy serverusing the RPC over HTTP proxy URLconfigured in the advanced Outlook settingsin the desktop policy. The Enterprise Vaultproxy server routes the requests to theEnterprise Vault server that hosts the archive.

Client connection

Controls whether a shortcut is deleted whenit is used to restore the correspondingarchived item. Default is Delete.

Delete shortcut after restore


Table 10-3 OWA versions before 2013 (Exchange desktop policy advancedsettings) (continued)

DescriptionSetting

Specifies an external URL for EnterpriseVault; that is, a URL that is used outside thecorporate network to access the EnterpriseVault server through a firewall. For moreinformation on the use of this setting, see thefollowing technical note on the VeritasSupport website:http://www.veritas.com/docs/TECH63250.

External Web Application URL

Controls the behavior when a user choosesto forward an Enterprise Vault shortcut. It ispossible to forward either the shortcut itself,or the archived item. The recipients cannotaccess the archived item unless they haveaccess to the archive. Default is Archiveditem.

Forward mode

Controls the destination for an item that isrestored using a shortcut. The destination canbe either of the following:

■ The current location (the same folder asthe shortcut).

■ The Enterprise Vault Restored Itemsfolder.

Default is Current location.

Location for restored items

Controls the behavior when a user opens anEnterprise Vault shortcut. Default is Archiveditem.

Open mode




DescriptionSetting

In Exchange Server 2010 the OWA archivepolicy enables users to archive items to thesecondary Exchange Server mailbox. Thissetting lets you hide the OWA archive policyoptions in OWA 2010 Premium clients.Setting the value to On removes the OWAarchive policy option from the followingmenus:

■ Folder context menu Item context menu(non-conversation view)

■ Item context menu (conversation view)■ Conversation Actions menu

Default is Off — The option is displayed onthe menus.

OWA 'Archive Policy' context menu option

Controls whether users of the OWA Premiumclient are allowed to choose archivingsettings, such as retention category anddestination archive, when archiving itemsmanually. Default is Enhanced — Users canselect archiving settings when they performmanual archives.

Premium archive function

Controls whether users of the OWA Premiumclient are allowed to choose archivingsettings, such as retention category anddestination archive, when archiving itemsmanually. Default is Enhanced — Users canselect archiving settings when they performmanual archives.

Premium restore function

Controls the behavior when a user choosesto reply to an Enterprise Vault shortcut.Default is Archived item — The archived itemis replied to.

Reply mode

Controls the behavior when a user selects ashortcut and chooses Reply to All. Defaultis Archived item — The archived item isreplied to.

'Reply To All' mode



DescriptionSetting

Controls whether the user is asked forconfirmation after choosing to restore anarchived item. Default is On — There is aconfirmation prompt before an item isrestored.

Restore confirmation

Controls whetherEnterprise Vault Search isavailable in the OWA Basic client. Default isOn — Enterprise Vault Search is available.

'Search Vaults' in Basic OWA client

Controls whether the Enterprise Vault Searchis available in the OWA Premium client.Default is On — Enterprise Vault Search isavailable.

'Search Vaults' in Premium OWA client

Controls whether when a user clicks Openthe Original Item in the banner of a customshortcut, the original item is rendered by OWA(and looks like an Outlook message), or byEnterprise Vault (and looks like a webbrowser page). Default is OWA.

View mode

Specifies the name of the virtual directory foranonymous connections, EVAnon. This issynchronized to the hidden settings in eachmailbox.

Web Application alias

Installing Enterprise Vault OWA 2010 ExtensionsBefore you install the Enterprise Vault OWA 2010 Extensions, ensure that you havecompleted the required tasks.

See “Steps to configure Enterprise Vault access for OWA users” on page 151.

Install the same Enterprise Vault release version of the extensions on all theExchange Server 2010 CAS computers. All the Exchange Servers on which youinstall the extensions should be at the same Exchange Server service pack andhotfix level.

Enterprise Vault OWA 2010 Extensions are located in the folder, VeritasEnterprise Vault\OWA Extensions\OWA 2010 Extensions on the EnterpriseVault release media.

160Setting up Enterprise Vault access for OWA clients on Exchange Server 2010Installing Enterprise Vault OWA 2010 Extensions

A ReadMeFirst file is located in the Veritas Enterprise Vault folder. Before youinstall the extensions, ensure that you check this file for details of any last-minutechanges.

Follow the instructions in this section to install the extensions interactively.Alternatively, you can deploy the extensions silently using an MSI command line,or using a software distribution application.

To enable logging for the installation process, either set up the logging policy forWindows Installer on the server, or run the installer using the msiexec commandline and include the logging option:

/l*v log_filename

If you have problems with installing the extensions, see the following technical noteon the Veritas Support website:


This document gives detailed troubleshooting information for Enterprise Vault OWA2010 Extensions.

To install Enterprise Vault OWA 2010 Extensions

1 Copy the Enterprise Vault OWA 2010 Extensions .msi file to the ExchangeServer 2010 CAS computer.

2 Double-click the .msi file to start the installation wizard.

3 Follow the installation instructions.

4 Repeat the installation on each Exchange Server 2010 CAS computer.

Additional configuration steps for ExchangeServer 2010 CAS proxying for use with OWA

If CAS proxying is configured in an Exchange Server 2010 environment, you needto perform additional configuration steps to allow the CAS proxy servers to useExchange Web Services impersonation.

161Setting up Enterprise Vault access for OWA clients on Exchange Server 2010Additional configuration steps for Exchange Server 2010 CAS proxying for use with OWA


Configuring Exchange Web Services impersonation on CAS proxy servers

1 Create a new security group that contains only the Exchange Server 2010 CAScomputers that act as proxy servers.

2 Log on to an Exchange Server 2010 computer using an account that is assignedthe "Role Management" role. By default, members of the "OrganizationManagement" role group are assigned this role.

3 Using Exchange Management Shell, run the following command line:

New-ManagementRoleAssignment -Name:role assignment

name-Role:ApplicationImpersonation -SecurityGroup:security group

name

role assignment name can be a name of your choice.

security group name is the name of the security group you created for the proxyExchange Server 2010 CAS computers.

162Setting up Enterprise Vault access for OWA clients on Exchange Server 2010Additional configuration steps for Exchange Server 2010 CAS proxying for use with OWA

Configuring access toEnterprise Vault fromOutlook RPC over HTTPclients


■ About Outlook RPC over HTTP and Outlook Anywhere configurations

■ Configuring Outlook Anywhere client access to Enterprise Vault

■ Setting up an Enterprise Vault proxy server to manage connections from OutlookAnywhere clients

■ Configuring RPC over HTTP settings in Enterprise Vault Exchange Desktoppolicy

About Outlook RPC over HTTP and OutlookAnywhere configurations

This section provides overview information about access to Enterprise Vault fromOutlook RPC over HTTP clients and Outlook Anywhere clients. References areprovided to other sections where you can find more detailed instructions onconfiguration tasks.

In an Exchange Server 2010 environment, users can access mailboxes using remoteprocedure call (RPC) over HTTP. This feature is called Outlook Anywhere. Using

11Chapter

RPC over HTTP remote Outlook users can connect to Exchange Server mailboxeswithout the requirement for OWA or a virtual private network (VPN) connection.

With RPC over HTTP enabled, the Enterprise Vault Outlook Add-In can performthe following actions:

■ View archived items.

■ Archive items manually.

■ Restore archived items.

■ Delete archived items.

■ Browse and search archives.

■ Use Vault Cache.

■ Perform client-side PST migrations.

About Exchange Server Outlook Anywhere configurationsWith Outlook Anywhere, the Enterprise Vault Outlook Add-In contacts an EnterpriseVault server directly. The Enterprise Vault client does not route requests to EnterpriseVault using an Exchange Server CAS computer. The Enterprise Vault OWAExtensions are not required on your Exchange Server to support Enterprise Vaultaccess from Outlook Anywhere clients.

164Configuring access to Enterprise Vault from Outlook RPC over HTTP clientsAbout Outlook RPC over HTTP and Outlook Anywhere configurations

Figure 11-1 Example Outlook Anywhere and Exchange Server configuration

RPC overHTTP

EnterpriseVault

requests

HTTP orHTTPS

Exchangerequests

ExchangeServer CAS(RPC proxy)

ExchangeServermailbox

role

EnterpriseVault

Servershosting

archives

OutlookAnywhere

client

In Figure 11-1 Outlook is configured for Outlook Anywhere, and the Enterprise VaultOutlook Add-In is enabled for RPC over HTTP connections.

The Enterprise Vault client contacts Enterprise Vault as follows:

■ By default, the client first attempts to contact the default Enterprise Vault serverthat hosts the archive.

■ If that is unavailable, the client uses the RPC over HTTP proxy URL configuredin the Enterprise Vault Exchange Desktop policy.

■ If no URL is specified in the Enterprise Vault policy, then the client uses theExchange proxy URL configured in the Outlook profile.

With direct connections, all the Enterprise Vault servers that host the archives mustbe accessible to the internal and external clients. If you do not want to publishmultiple Enterprise Vault servers to external clients, then you can use an EnterpriseVault server as a proxy server. A client connects to the Enterprise Vault proxyserver, and the proxy server forwards the requests to the Enterprise Vault serverthat hosts the archive.

See “About Enterprise Vault proxy server configurations for access to Outlook RPCover HTTP clients” on page 166.


See “Configuring Outlook Anywhere client access to Enterprise Vault” on page 168.

About Enterprise Vault proxy server configurations for access toOutlook RPC over HTTP clients

Optionally, you can use an Enterprise Vault server as a proxy server for EnterpriseVault requests from the Enterprise Vault Outlook Add-In when Outlook Anywhereis configured. The Enterprise Vault proxy server forwards Enterprise Vault requeststo the Enterprise Vault server that hosts the archive. In environments with multipleEnterprise Vault sites, a separate Enterprise Vault proxy server is required for eachsite.

An Enterprise Vault proxy server is useful in the following situations:

■ If you do not want to publish multiple Enterprise Vault servers to external users.

■ If you want to publish separate URLs for external and internal Enterprise Vaultusers.

Note that an Enterprise Vault proxy server can only be used to manage connectionsfrom Outlook Anywhere clients. It cannot be used for other types of connections,such as OWA.

The figure, Figure 11-2, illustrates an Enterprise Vault proxy server in an OutlookAnywhere configuration. The Enterprise Vault server that is used as a proxy servercan also host archives, if required. Alternatively, you can set up a minimal EnterpriseVault server to be used as a proxy server only.


Figure 11-2 Example Outlook Anywhere configuration using an EnterpriseVault proxy server

Anonymous

RPC overHTTP

EnterpriseVault requests

HTTP orHTTPS

Exchangerequests

ExchangeServer

CAS(RPC proxy)

OutlookAnywhere

client

ExchangeServermailbox

role

EnterpriseVaultproxy

server

EnterpriseVault

Servershosting

archives

Settings in the Enterprise Vault Exchange Desktop policy let you configure thebehavior of the Enterprise Vault Outlook Add-In when Outlook is configured to useRPC over HTTP.

The Enterprise Vault client contacts Enterprise Vault as follows:

■ The Enterprise Vault client first attempts to connect to the default EnterpriseVault server that hosts the archive.

■ If the client cannot contact the server, then the client uses the URL that youspecify for the Enterprise Vault Exchange Desktop policy setting, RPC overHTTP proxy URL.This logic enables users to connect directly to the Enterprise Vault server thathosts the archive when they are in the office. When they are away from theoffice, the Enterprise Vault client connects to the Enterprise Vault proxy server.

■ If no URL is specified in the Enterprise Vault policy, then the client uses theExchange proxy URL configured in the Outlook profile.

The Enterprise Vault proxy server connects to the Enterprise Vault server that hoststhe archive using anonymous connections. For this reason you must configure


support for anonymous connections on each Enterprise Vault server that the proxyserver contacts.

In an Enterprise Vault cluster you need to configure each node in the cluster foranonymous connections.

Similarly, in building blocks configurations you may need to configure support foranonymous connections on the proxy server computer. This configuration is requiredfor Virtual Vault users if a Storage Service can fail over to the Enterprise Vault proxyserver computer.

Instructions for setting up an Enterprise Vault proxy server, and configuring supportfor anonymous connections are given in the following section:

See “Setting up an Enterprise Vault proxy server to manage connections fromOutlook Anywhere clients” on page 169.

Configuring Outlook Anywhere client access toEnterprise Vault

This section describes the configuration steps required to enable Outlook Anywhereclient access to Enterprise Vault servers.

To configure Enterprise Vault in an Outlook Anywhere environment

1 Check that required tasks on Exchange Servers and client computers arecompleted.

See “Required tasks for configuring Outlook Anywhere access to EnterpriseVault” on page 169.

2 If you plan to use an Enterprise Vault proxy server, then prepare the proxyserver and any Enterprise Vault servers that it contacts.

See “Setting up an Enterprise Vault proxy server to manage connections fromOutlook Anywhere clients” on page 169.

3 On an Enterprise Vault server, configure RPC over HTTP settings in theExchange Desktop policy to enable and customize Enterprise Vault functionalityin the Enterprise Vault Outlook Add-In.

See “Configuring RPC over HTTP settings in Enterprise Vault ExchangeDesktop policy” on page 173.

168Configuring access to Enterprise Vault from Outlook RPC over HTTP clientsConfiguring Outlook Anywhere client access to Enterprise Vault

Required tasks for configuring Outlook Anywhere access toEnterprise Vault

The instructions for configuring Outlook Anywhere access to Enterprise Vaultassume that you have already completed the following tasks:

■ Configured your Exchange environment and Outlook profiles for OutlookAnywhere.

■ Configured your Enterprise Vault server to archive Exchange Server mailboxes.

■ Installed Enterprise Vault the Outlook Add-In on the desktop computers.

Setting up an Enterprise Vault proxy server tomanage connections from Outlook Anywhereclients

This section describes what you need to do if you want to use an Enterprise Vaultproxy server to manage connections from Outlook Anywhere clients. These taskinclude:

■ Configuring the Enterprise Vault proxy server to manage connections fromOutlook Anywhere clientsSee “Configuring the Enterprise Vault proxy server to manage connections fromOutlook Anywhere clients” on page 169.

■ Configuring Enterprise Vault servers for anonymous connections from theEnterprise Vault proxy serverSee “Configuring Enterprise Vault servers for anonymous connections from theEnterprise Vault proxy server” on page 170.

See “About Enterprise Vault proxy server configurations for access to Outlook RPCover HTTP clients” on page 166.

Configuring the Enterprise Vault proxy server to manage connectionsfrom Outlook Anywhere clients

If there are multiple Enterprise Vault sites, separate Enterprise Vault proxy serversare required for each site.

The Enterprise Vault server that is used as a proxy server can also host archives,if required. Alternatively, you can set up a minimal Enterprise Vault server to beused as a proxy server.

169Configuring access to Enterprise Vault from Outlook RPC over HTTP clientsSetting up an Enterprise Vault proxy server to manage connections from Outlook Anywhere clients

At minimum the proxy server must have the following Enterprise Vault componentsinstalled and configured:

■ Admin Service.

■ Directory service.

■ Shopping service.

■ Task Controller service.

■ Web Access application.

Clients use basic or integrated windows authentication (IWA) authentication toconnect to the Enterprise Vault proxy server. If required, you can configure SSL onthe Enterprise Vault proxy server to secure the client connections.

See "Customizing security for the Enterprise Vault Web Access components" inthe Installing and Configuring manual.

If the Enterprise Vault proxy server does not host archives, then it does not requireany additional configuration to support Enterprise Vault requests.

The Enterprise Vault proxy server uses anonymous connections when it connectsto the Enterprise Vault servers that host archives. Detailed instructions are providedon how to configure the Enterprise Vault servers to support anonymous connections.

See “Configuring Enterprise Vault servers for anonymous connections from theEnterprise Vault proxy server” on page 170.

If the Enterprise Vault proxy server hosts archives, then you also need to configurethe proxy server for anonymous connections.

In a clustered Enterprise Vault environment, you need to configure each node inthe cluster for anonymous connections.

Configuring Enterprise Vault servers for anonymous connectionsfrom the Enterprise Vault proxy server

The instructions in this section are similar to the instructions for configuringEnterprise Vault servers for anonymous connections from OWA Exchange Servers.To support anonymous connections from an Enterprise Vault proxy server, you runthe same script, owauser.wsf, but provide the details of connecting Enterprise Vaultproxy servers instead of Exchange Servers.


To prepare Enterprise Vault servers for anonymous connections from anEnterprise Vault proxy server

1 Ensure that IIS Roles and Feature Delegation rights are configured as describedin the section, "Requirements for OWA 2010" in Installing and Configuring.

2 On each Enterprise Vault server that may receive anonymous connectionsfrom Enterprise Vault proxy servers, create an ExchangeServers.txt file asdescribed in this section. This file contains a list of the IP addresses for all theEnterprise Vault proxy servers that connect to the Enterprise Vault server.

3 On each Enterprise Vault server on which you have created anExchangeServers.txt file, run the script, owauser.wsf, as described in thissection. This script configures the Data Access account for anonymousconnections.

4 Restart the Enterprise Vault Admin Service.

5 Synchronize mailboxes.

To create the ExchangeServers.txt file

1 Open Notepad.

2 Type the IP address of each Enterprise Vault proxy server that connects to theEnterprise Vault server, one entry per line.

Addresses can be in either IPv4 or IPv6 format. IPv6 addresses must be in theform fdfa:9c37:5267:d2e3:a192:b168:cc80:d204.

3 Save the file as ExchangeServers.txt in the Enterprise Vault installation folder(for example C:\Program Files (x86)\Enterprise Vault). When you savethe file, select ANSI, Unicode, or Unicode big endian encoding.

4 Close Notepad.


To configure the Data Access account for Outlook RPC over HTTP clientconnections

1 If you have already configured Enterprise Vault for OWA or Domino ServerArchiving, then an account already exists for managing anonymous connections.This account is the Data Access account. If the account already exists, youmust use the same account for anonymous connections from Enterprise Vaultproxy servers.

For Domino Mailbox Archiving, the details of the Data Access account arespecified on the Data Access Account tab of Directory properties in theAdministration Console.

If the Data Access account does not exist, then create an account for thispurpose. The account should be a basic domain account; a local machineaccount cannot be used. The account should not belong to any administratorgroup, such as Administrators or Account Operators.

2 Use the Vault Service account to log on to the Enterprise Vault server thatreceives anonymous connections from the Enterprise Vault proxy server.

3 Open a Command Prompt window with administrator privileges.

4 Navigate to the Enterprise Vault installation folder.

5 Enter the following command line:

cscript owauser.wsf /domain:domain /user:username

/password:password

The file owauser.wsf is installed in the Enterprise Vault installation folder.

For domain, give the domain of the Data Access account.

For username, give the user name of the Data Access account.

For password, give the password of the Data Access account.

To display help for the cscript command, type

cscript owauser.wsf /?


6 The progress of the script execution is displayed in the command promptwindow.

The configuration changes made by the script are described in the followingtechnical note on the Veritas Support website:


When the configuration script finishes, you are prompted to restart theEnterprise Vault Admin service and synchronize mailboxes.

Restart the Admin service using the Services console.

Use the Enterprise Vault Administration Console to synchronize mailboxes. Inthe ExchangeMailbox Archiving task properties, select the Synchronizationtab. Synchronize Mailbox properties and permissions for all mailboxes.

Restarting the Admin service ensures that Enterprise Vault authenticationknows the identity of the Data Access account. Synchronizing the mailboxesupdates the client hidden message with the URL to use when connecting tothe Enterprise Vault proxy server.

7 If there are multiple Enterprise Vault servers in your environment, logon toeach server on which you created an ExchangeServers.txt file. Run the script,owauser.wsf, using the instructions that are given in this section.

If you add another Enterprise Vault proxy server to your environment at a laterdate, first add the IP address of the server to the ExchangeServers.txt file.Then you rerun the owauser.wsf script.

ConfiguringRPC over HTTP settings in EnterpriseVault Exchange Desktop policy

RPC over HTTP settings in the Enterprise Vault Exchange Desktop policy enableaccess to Enterprise Vault, and let you customize the Enterprise Vault functionalityin Outlook RPC over HTTP clients.

To modify RPC over HTTP Exchange Desktop policy settings

1 In the left pane of the Administration Console, expand the Policies containeruntil Exchange Desktop policies are visible.

2 In the right-hand pane, double-click the name of the policy you want to edit.

The policy’s properties are displayed.

3 Click the Advanced tab.

4 Next to List settings from, select Outlook.

173Configuring access to Enterprise Vault from Outlook RPC over HTTP clientsConfiguring RPC over HTTP settings in Enterprise Vault Exchange Desktop policy


5 Edit the following settings as required.

Double-click a setting to edit it, or click it once to select it and then click Modify.

■ RPC over HTTP restrictions. By default Outlook RPC over HTTP clientaccess is disabled for mailboxes that are hosted on Exchange Server 2010(Disable Outlook Add-In). Configure the functionality that is required inOutlook by selecting one of the other values:

All Enterprise Vault client functionality is available.None

Enterprise Vault functionality is not available in OutlookRPC over HTTP clients. This is the default value.

Exchange Server 2013 only allows connections that useRPC over HTTP. If the default value is selected, allEnterprise Vault Outlook Add-In functionality is availablefor mailboxes that are hosted on Exchange Server 2013.

Disable Outlook Add-In

Vault Cache is disabled.Disable Vault Cache

Client-side PST migration is disabled.

Note that currently you cannot use client-side PSTmigration to migrate any files that reside on mappednetwork drives when using an Outlook client in RPC overHTTP mode.

Disable PST Import

Vault Cache and client-side PST migration are disabled.Disable Vault Cacheand PST Import

■ RPC over HTTP connection. This setting controls how the Enterprise VaultOutlook Add-In connects to the Enterprise Vault server that hosts thearchive. The value for this setting can be Use proxy or Direct. The optionshave the following effect.

■ In an Exchange Server 2010 environment. With the default value, Useproxy, the client routes all Enterprise Vault requests to the EnterpriseVault server using the Enterprise Vault proxy server for the site in whichthe client is located. The URL for the site proxy server must be specifiedin the RPC over HTTP Proxy URL setting.When the user requests an Enterprise Vault operation, the client firstattempts to contact the default Enterprise Vault server. If the connectioncannot be made, and RPC over HTTP connection is set to Use proxy,then the URL configured for RPC over HTTP Proxy URL is used.If the value is Direct, then the client attempts to connect directly to thedefault Enterprise Vault server.


The value can be set to Direct even if you have an ISA Server configured.In this situation you must publish on the ISA Server the URLs of all theEnterprise Vault servers that host the archives.

■ RPC over HTTP Proxy URL. This setting enables you to specify analternative URL for the Enterprise Vault server. Enterprise Vault OutlookAdd-In uses the URL when Outlook is configured to use RPC over HTTP,and RPC over HTTP connection is set to Use proxy.

■ In an Exchange Server 2010 environment. If RPC over HTTPconnection is set toUse proxy, the clients connect to the URL specifiedin this setting. In a multiple site environment, specify the URL of theEnterprise Vault proxy server for the site in which the client is located.

If you change the name of the virtual directory, then you can use this settingto specify the alternative URL. For example, if you change the virtualdirectory name to EVProxy, then you use the RPC over HTTP Proxy URLsetting to specify the URL:

HTTP://Web_server/EVProxy

6 The settings are applied to mailboxes during the next synchronization run ofthe Exchange Mailbox task. If you want to apply the changes before the nextsynchronization, run Synchronize, which is on the Synchronization tab ofthe Exchange Mailbox task’s properties.


Using firewall software forexternal access to OWAand Outlook


■ About configuring Threat Management Gateway 2010 for Outlook 2013 andOWA 2013

■ Configuring ISA Server 2006 for OWA 2010 access to Enterprise Vault

■ About configuring ISA Server 2006 for Outlook Anywhere client access toEnterprise Vault

About configuring Threat Management Gateway2010 for Outlook 2013 and OWA 2013

Microsoft Forefront Threat Management Gateway 2010 (Forefront TMG 2010) canbe used to create an external secure access point to Exchange servers. You canthen make OWA, Outlook, and Enterprise Vault available on the Internet using webpublishing rules.

See the following technical note for instructions on how to configure Forefront TMG2010 for access to Enterprise Vault from OWA 2013 and Outlook 2013:


12Chapter


Configuring ISAServer 2006 for OWA2010 accessto Enterprise Vault

Microsoft ISA Server 2006 can be used to secure OWA access to Exchange Server2010 by using web publishing rules to make the Exchange OWA website availableon the Internet.

As OWA clients connect directly to Enterprise Vault for archive browse and searchrequests, you need to configure your ISA Server to ensure that clients can accessEnterprise Vault. In addition to publishing the OWA website, you also need to publishto clients the Enterprise Vault web server URL.

Figure 12-1 shows how ISA Server 2006 can provide access to Enterprise Vault.

Figure 12-1 Access to Enterprise Vault using ISA Server 2006

ISA 2006 Firewall

Web Publishing Rules Virtual Directories

Exchange 2010CAS Server

Exchange 2010Mailbox Server

/Exchange/Exchweb/EnterpriseVault

/Exchange/Exchweb

Enterprise Vaultserver

See the following technical note for detailed instructions on how to configure ISAServer 2006 for access to Enterprise Vault from OWA clients:


177Using firewall software for external access to OWA and OutlookConfiguring ISA Server 2006 for OWA 2010 access to Enterprise Vault


About configuring ISA Server 2006 for OutlookAnywhere client access to Enterprise Vault

Microsoft ISA Server 2006 can be used to secure Outlook Anywhere client accessto Exchange 2010 CAS computers by using web publishing rules to make RPCservers available on the Internet.

As Outlook Anywhere clients connect directly to Enterprise Vault, you need toconfigure your ISA Server to ensure that clients can access Enterprise Vault.

See the following technical note for detailed instructions on how to configure ISAServer 2006 for access to Enterprise Vault when using Outlook Anywhere clients:


178Using firewall software for external access to OWA and OutlookAbout configuring ISA Server 2006 for Outlook Anywhere client access to Enterprise Vault


Configuring filteringThis chapter includes the following topics:

■ About filtering

■ Configuring selective journaling

■ Configuring group journaling

■ Configuring custom filtering

About filteringFiltering provides more granular control over how Enterprise Vault archiving tasksprocess items during an archiving run.

Note: It is important that you test your filtering configuration on a developmentserver, using realistic data, before implementing it on your production servers.

Enterprise Vault provides the following filtering features:

■ Selective journaling. This feature provides simple filtering of Exchange Serverjournaled messages. You can configure the Exchange Journaling task to callthe selective journaling external filter that decides whether to archive or deletean item. To select messages, you set up filtering rules to match the To, CC, andFrom fields. If a message matches any of these rules it is archived, otherwiseit is deleted.If you enable selective journaling on an Enterprise Vault server, it is enabled forall Exchange Journaling tasks that are hosted on that computer.

■ Group journaling. This feature enables the Exchange Journaling task to markselected messages, in order to reduce the scope of subsequent searches. Thiscan be particularly useful where there is a high volume of journaled email and

13Chapter

you want to be able to identify messages sent between particular groups ofusers.

■ Custom filtering. This feature provides sophisticated filtering. You create rulesthat select messages by matching one or more attributes, such as emailaddresses, subject text, message direction or the value of certain messageproperties.The rules also include instructions on how Enterprise Vault is to process aselected message. This can include archiving the message, assigning a particularretention category, storing the message in a specified archive, deletingattachments of a specified type or size, or deleting or marking the message.By default, Enterprise Vault archives items that do not match any filter rule. Youcan configure filter rules so that only items that match a rule are archived.See “About custom filtering ruleset files” on page 195.

■ Custom properties. This feature is an extension of custom filtering. It enablesyou to configure Enterprise Vault to index additional properties on messagesthat are selected by the custom filters. These properties may be standardproperties that a default Enterprise Vault system does not index, or they maybe properties added to messages by a proprietary, third party application.Custom properties also introduces the concept of “content categories” forgrouping the settings that are to be applied to messages that match a rule.These settings can include the retention category to assign, the archive to useand the additional properties to index.As the custom properties feature provides extended functionality to customfiltering, it is enabled with custom filtering, and shares the custom filteringconfiguration.

About journal filters with Envelope JournalingAll methods of filtering journal mailboxes support Microsoft Exchange ServerEnvelope Journaling. This feature ensures that target addresses in all BCC,Undisclosed and Alternate Recipient fields are captured.

See “About Enterprise Vault and Exchange Server journal reports” on page 117.

If you have journal filtering enabled and intend enabling Envelope Journaling, werecommend that you test your existing filters and check the results before enablingEnvelope Journaling on your production Exchange Server.

Before enabling Envelope Journaling, you will need to make changes to anyproprietary journal filters that modify the selected message, so that the journal reportor the original message are accessed, as required.

See "Exchange Filtering API" in the Application Programmer’s Guide for moreinformation.

180Configuring filteringAbout filtering

Configuring selective journalingTable 13-1 describes the steps required to configure selective journaling. Repeatthe steps on each Enterprise Vault server that hosts an Enterprise Vault ExchangeJournaling task.

Table 13-1 Steps to configure selective journaling

More informationActionStep

For detailed instructions see the chapter"Setting up archiving of journaledmessages" in this manual.

Set up Exchange Journal archiving.Step 1

See “Creating the selective journalingrules file” on page 181.

Create a filtering rules file. The samefiltering rules file will be used by allExchange Journaling tasks that arehosted on the computer.

Step 2

See “Adding selective journaling registrysettings” on page 183.

Add the selective journaling registrysettings for the Exchange Journalingtask.

Step 3

See “Starting the Journaling task”on page 115.

Restart the Exchange Journaling task.Step 4

Creating the selective journaling rules fileThis section describes how to create a file of journaling filtering rules.

To set up the filtering rules file

1 Log on to the Exchange Journaling task computer as the Vault Service account.

2 Use Notepad to create a file called SelectiveJournal_config.dat in theEnterprise Vault installation folder (for example C:\Program Files

(x86)\Enterprise Vault).

3 In the file, specify the rules that you want the filter to use to select journaledmessages for archiving.

See “Selective journaling filter rules” on page 181.


Selective journaling filter rulesEach line of the rules file takes the following format:

181Configuring filteringConfiguring selective journaling

keyword:value

Table 13-2 describes the keywords and values that you can enter in the file.

Table 13-2 List of selective journaling keywords for rules

ValueDescriptionKeyword

A text string. For example:

cont:flashads

The string can be part of an SMTP address.

Archive all items that have been sentto addresses that contain the specifiedtext.

cont

The legacyExchangeDN of the distribution list. For example:

distlist:/o=acme/ou=finance/cn=recipients/cn=allfinance

Archive all items that have been sentto anyone who is on the specifieddistribution list.

Note that selective journaling does notsupport Dynamic Distribution Groups.

distlist


ends:example.com


Archive all items that have been sentto or from addresses that end with thespecified text.

ends

The SMTP email address of the recipient. For example:

exact:[email protected]

Archive all items that have been sentto the specified email address.

exact

The legacyExchangeDN of the recipient user account ordistribution list. For example:

recip:/o=acme/ou=developer/cn=recipients/cn=smithj

Archive all items that have been sentto the specified recipient. The recipientcan be a user account or a distributionlist.

recip


starts:john


Archive all items that have been sentto addresses that start with thespecified text.

starts

Note: You can view the legacyExchangeDN property using ADSIEdit.msc or asimilar Active Directory tool.

Employees and resources in an organization may have several SMTP addressesin addition to an internal, Exchange Server address. If you want to capture all emailto a recipient in your organization use either the recip or distlist keyword with theaddress specified using the legacyExchangeDN. For example:

recip:/o=acme/ou=first administrative

group/cn=recipients/cn=John Doe


Alternatively, specify a distribution list that the recipient is a member of. For example,

distlist:/o=acme/ou=first administrative

group/cn=recipients/cn=Sales

Using the recip or distlist keyword will capture email to any of the recipient's SMTPaddresses and also internal email to their Exchange Server address. In this situation,the keywords, exact, starts, ends, and cont are not appropriate, as they may notcapture external inbound email to all the addresses that the recipient may have.

You can use the keywords, exact, starts, ends, and cont to capture email to andfrom domains or SMTP addresses that are external to your organization. Forexample, you could use ends:acme.com to capture all communication to and fromthe external domain, acme.com.

Adding selective journaling registry settingsThis section describes how to configure the registry settings that enable selectivejournaling.

To add the selective journaling registry settings

1 Log on to the Journaling task computer as the Vault Service account.

2 Run regedit and navigate to the following location:

HKEY_LOCAL_MACHINE

\Software

\Wow6432Node

\KVS

\Enterprise Vault

\External Filtering

\Journaling

Add the External Filtering key under Enterprise Vault, and theJournaling key under External Filtering, if they do not exist.


3 In Journaling, create a new STRING value with the name 1 and set its valueto SelectiveJournal.SJFilter.

By default, items that are not archived are sent to the Deleted Items folder inthe journal mailbox.

If you want items to be deleted immediately, without going to the Deleted Itemsfolder, add the DWORD, HardDeleteItems, to the following location and giveit a value of 1:

HKEY_LOCAL_MACHINE

\Software

\Wow6432Node

\KVS

\Enterprise Vault

\Agents

\SelectiveJournal

Add the SelectiveJournal key, if it does not exist.

4 To apply your changes, stop and restart all Journaling tasks on the server. Youneed to do this whenever you make a change to the rules file or if you modifythe registry values.

Managing invalid distribution lists with selective journalingYou can set the following registry entry to control what the Exchange Journalingtask does if a distribution list is invalid.


To manage invalid distribution lists



HKEY_LOCAL_MACHINE

\Software

\Wow6432Node

\KVS

\Enterprise Vault

\Agents

3 Create a new DWORD value with the name ActionForInvalidDL and set itsvalue to one of the following:

(Default) If a distribution list is invalid, continue to process the remainder of therecipient list.

0

If a distribution list is invalid, stop processing the recipient list.1

If a distribution list is invalid, treat this as a match and archive the message.2

If a distribution list is invalid, leave the message in the journaling mailbox andreport an error event in the Event Log.

3

Configuring group journalingGroup journaling stamps a message with a specific retention category if it was sentbetween two identified groups. The scope of subsequent searches can besubstantially reduced by including the retention category in the search criteria.

You can also specify that only a sample of messages with the retention categoryare to be archived. The percentage is specified in the configuration (minimum of0.1%; 1 in every 1000).

If you enable group journaling on an Enterprise Vault server, it will be enabled forall Exchange Journaling tasks that are hosted on that computer.

Table 13-3 describes the steps required to configure group journaling. Repeat thesteps on each Enterprise Vault server that hosts an Enterprise Vault ExchangeJournaling task.

185Configuring filteringConfiguring group journaling

Table 13-3 Steps to configure group journaling


For detailed instructions see the chapter"Setting up archiving of journaledmessages" in this manual.

Set up Exchange Journal archiving.Step 1

See “Creating the group journaling rulesfile” on page 186.

Create a rules file. This file specifies theaddresses to match, the retentioncategory to assign and the sample size.The same rules file will be used by allExchange Journaling tasks that arehosted on the computer.

Step 2

See the Administrator’s Guide forinstructions on how to do this.

If it does not exist, create the retentioncategory to be assigned to matchedmessages.

Step 3

On the Exchange Server, ensure thatthe distribution lists exist and arepopulated with the required users.

Note that group journaling does notsupport Dynamic Distribution Groups.

Check the distribution lists.Step 4

See “Adding group journaling registrysettings” on page 188.

On the Enterprise Vault ExchangeJournaling task computer, add the groupjournaling registry settings.

Step 3

See “Starting the Journaling task”on page 115.

See “Testing the group journalingsettings” on page 188.

Restart all Exchange Journaling taskson the computer, and test yourconfiguration.

Step 4

Creating the group journaling rules fileThis section describes how to create the group journaling rules file. The same rulesfile will be used by all Exchange Journaling tasks that are hosted on the computer.

To create the group journaling rules file

1 Log on to the Exchange Journaling task computer as the Vault Service account.

2 Use Notepad to create a file called SJGroupFilter.dat in the Enterprise Vaultinstallation folder (for example C:\Program Files (x86)\Enterprise Vault).


3 In the file, specify the rules that you want the filter to use to select journaledmessages for archiving.

See “Group journaling filter rules” on page 187.


Group journaling filter rulesEach line of the rules file takes the following format:

<keyword>:<value>

Table 13-4 shows the keywords and values that you can enter in the file.

Table 13-4 List of Group Journaling keywords for rules

ValueDescriptionKeyword

Retention category name. For example:

retcat:Flagged

The retention category to assign tomatching messages. The file mustcontain a retention category line andthe retention category must exist.

retcat

Integer (without % sign). For example:

sample:25

The percentage sample rate ofmatching messages to be archived. Ifthis line is missing, the sample ratedefaults to 100%.

sample

legacyExchangeDN of the distribution list. For example:

userset:/o=acme/ou=research/cn=recipients/cn=groupa

Used to define the groups of useraddresses to be matched. The rulesfile must contain two userset lines; onefor each group. Each line defines adistribution list containing theaddresses of group members. Thespecified distribution lists must not beempty.

Note that group journaliing does notsupport Dynamic Distribution Groups.

userset

Note: You can view the legacyExchangeDN property using ADSIEdit.msc or asimilar Active Directory tool.

Using the following example rules file, 25% of the messages sent by members ofone distribution list to members of the other distribution list will be assigned theretention category, Flagged.


userset:/o=acme/ou=research/cn=recipients/cn=groupa

userset:/o=acme/ou=research/cn=recipients/cn=groupb

retcat:Flagged

sample:25

Adding group journaling registry settingsThis section describes how to configure the registry settings for group journaling.

To add the group journaling registry settings



HKEY_LOCAL_MACHINE

\Software

\Wow6432Node

\KVS

\Enterprise Vault

\External Filtering

\Journaling

Add the External Filtering and Journaling keys, if they do not exist.

3 Create a new STRING value called 1 and set its value toSelectiveJournal.SJGroupFilter.

4 Restart all Enterprise Vault Exchange Journaling tasks on the computer.

Testing the group journaling settingsThis section describes how to test the group journaling settings.

To test the group journaling settings

1 Send a message from a user in one of the specified distribution lists to a userin the other distribution list.

2 Wait for Enterprise Vault to archive the message, and then use the advancedfacilities in Enterprise Vault Search to search for it by retention category.

The message should have the group journaling retention category assigned.

3 Repeat the test in reverse: send a message from a user in the seconddistribution list to a user in the first distribution list.

Again, the message should have the group journaling retention categoryassigned.


4 Send a message from a user in the first distribution list to someone who is notin the second distribution list.

The message should be archived with the retention category specified in thedefault Exchange journal policy.

5 Send a message from a user in the second distribution list to someone who isnot in the first distribution list.

Again, the message should be archived with the retention category specifiedin the default Exchange journal policy.

Configuring custom filteringSelective and group journaling provide very limited filtering capabilities and are onlyavailable with Exchange Server journal mailbox archiving; the same filtering isapplied to all journal mailboxes serviced by the Exchange Journaling tasksconfigured on the Enterprise Vault server computer. Custom filtering provides moresophisticated filtering for all types of Exchange Server archiving (user and journalmailbox and public folder). For example, you may want items with a particularsubject, sender or recipients to be sent to a separate archive, or you may wantmessages sent within the company to be given a special retention category of"Internal".

You can set up default filters that apply to all archiving tasks that are enabled forcustom filtering. In addition, you can create separate custom filters for public folderarchiving, or specific user or journal mailboxes.

If custom properties have been added to items, you may want these propertiesindexed for selected items. Instructions are provided on how to extend customfiltering to use the custom properties feature.

See “Configuring custom properties and content categories” on page 231.

189Configuring filteringConfiguring custom filtering

Table 13-5 Steps to configure custom filtering


See “Configuring registry settings forExchange Server journal customfiltering” on page 191.

See “Configuring registry settings forExchange Server mailbox customfiltering” on page 192.

See “Configuring registry settings forExchange Server public folder customfiltering” on page 194.

Configure registry settings to enablecustom filtering for the required archivingtasks.

Step 1

See “About custom filtering ruleset files”on page 195.

See “About the general format of rulesetfiles for custom filtering” on page 202.

See “About rule actions for customfiltering” on page 205.

See “About message attribute filters forcustom filtering” on page 208.

See “Attachment attribute filters forcustom filtering” on page 222.

See “Example ruleset file for customfiltering” on page 227.

Create filter rules and actions in one ormore XML ruleset files, as required. Theruleset files must be placed in the folderEnterprise Vault\Custom FilterRules .

Step 2

The following message is sent to theEnterprise Vault event log when theExchange Server archiving tasks start:

EventID = 45329Description = External Filter'EnterpriseVault.CustomFilter'initialising...

The following message is sent to theEnterprise Vault event log when theExchange Server archiving tasks stop:

EventID = 45330Description = External Filter'EnterpriseVault.CustomFilter'stopped.

Restart the archiving tasks that havecustom filtering enabled.

Step 3


About custom filtering in distributed Enterprise Vault environmentsIn a distributed environment, with archiving tasks on more than one computer, theregistry entries must be set up on each computer that hosts archiving tasks thatare to be enabled for custom filtering. Similarly, the XML ruleset files must be copiedto all computers that host archiving tasks that are enabled for custom filtering.

If you change the registry settings or XML files, remember to propagate the changesto each of the other computers.

Configuring registry settings for Exchange Server journal customfiltering

Configuring the registry settings described in this section will enable custom filteringfor all the Exchange Journaling tasks hosted on the server.

By creating a named ruleset file you can limit filtering to particular journal mailboxes.

See “About custom filtering ruleset files” on page 195.

Note: If you use Compliance Accelerator to capture a required percentage of alljournaled messages, do not configure a custom filter that deletes selected messages.Deleting messages compromises the accuracy of the Compliance Acceleratormonitoring policy, because any deleted messages are not available for capture.

To configure the registry settings for Exchange Server journal custom filtering

1 On the computer that hosts the Enterprise Vault Exchange Journaling task,log on as the Vault Service account.

2 Start Regedit.

3 Navigate to the following location:

HKEY_LOCAL_MACHINE

\Software

\Wow6432Node

\KVS

\Enterprise Vault

\External Filtering

\Journaling

If the External Filtering key does not exist, create it by performing thefollowing steps in the order listed:

■ Right-click Enterprise Vault and select New > Key.

■ Name the key External Filtering.


Similarly, if the Journaling key does not exist, create it as follows:

■ Right-click External Filtering and select New > Key

■ Name the key Journaling.

4 If the Journaling key does exist, any existing filters will be listed under it. Filternames will be an unbroken numbered sequence starting at 1.

5 Create a new string value for the new custom filtering setting. The name of thissetting must fit into the existing number sequence. If no other journaling filtersexist, set the name to 1. Give it the value EnterpriseVault.CustomFilter.

6 Optionally, you can create a DWORD entry with the name Override, if it doesnot exist. Set its value to 0 (zero). This entry controls whether the ExchangeJournaling task reexamines any messages that are marked asMARK_DO_NOT_ARCHIVE each time it processes the journal mailbox. If thevalue is 0, or the Override entry does not exist, then the Exchange Journalingtask does not reexamine the messages.

If you later change the rule action, you can temporarily set the value to 1.Setting this value forces the Exchange Journaling task to reprocess anymessages in the journal mailbox.

7 If it does not exist, create a DWORD value called MoveOnFilterFailure andset its value to 1.

This entry controls whether the Exchange Journaling task moves messagesto the folder Failed External Filter when an unhandled error occurs in theexternal filter. This folder is automatically created when required in the journalmailbox.

If the MoveOnFilterFailure registry entry does not exist then, when anunhandled error occurs in the external filter, the Exchange Journaling taskmoves the associated messages to the Enterprise Vault Journaling

Service\Invalid Journal Report folder in the journal mailbox.

8 Close Regedit.

9 After you have configured the required XML filter rules, restart the ExchangeJournaling tasks.


Configuring registry settings for Exchange Server mailbox customfiltering

Configuring the registry settings described in this section will enable custom filteringfor all the Exchange Mailbox tasks hosted on the server.


By creating named ruleset files, you can limit filtering to particular mailboxes.


To configure the registry settings for Exchange Servermailbox custom filtering

1 On the computer that hosts the Enterprise Vault Exchange Mailbox task, logon as the Vault Service account.

2 Start Regedit.


HKEY_LOCAL_MACHINE

\Software

\Wow6432Node

\KVS

\Enterprise Vault

\External Filtering

If the External Filtering key does not exist, create it by performing thefollowing steps in the order listed:



4 Create a Mailbox key as follows:

■ Right-click External Filtering and select New > Key.

■ Name the key Mailbox.

5 Create a new string entry called 1 for the new custom filtering entry.

6 Right-click the new entry and select Modify. Give it the value:

EnterpriseVault.CustomFilter

7 Optionally, you can create a new DWORD entry with the name Override, andset its value to 0 (zero). By changing the value of this entry you can controlwhether the Exchange Mailbox task applies the custom filtering rules duringarchiving:

■ 0 (zero) — The Exchange Mailbox task applies the custom filtering rules toall messages.

■ 1 — The Exchange Mailbox task does not apply the custom filtering rules.

If the Override entry does not exist, then the task applies the custom filteringrules to all messages.


8 If it does not exist, create a DWORD entry called MoveOnFilterFailure andset its value to 1.

This entry controls whether the Exchange Mailbox task moves messages tothe folder Failed External Filter when an unhandled error occurs in theexternal filter. This folder is automatically created when required in the usermailbox.

If the MoveOnFilterFailure registry entry does not exist then, when anunhandled error occurs in the external filter, the Exchange Mailbox task doesnot move the associated messages. The task tries to process the messagesduring each archiving run.

9 Close Regedit.

10 After you have configured the required XML filter rules, restart the ExchangeMailbox tasks.

Configuring registry settings for Exchange Server public folder customfiltering

Configuring the registry settings described in this section will enable custom filteringfor all the Exchange Public Folder tasks hosted on the server. You can create apublic folder ruleset file to apply specific rules to public folder archiving.

Unlike mailbox filtering, you cannot use named ruleset files to configure filtering forparticular public folders.

To configure the registry settings for Exchange Server public folder customfiltering

1 On the computer that hosts the Enterprise Vault Exchange Public Folder task,log on as the Vault Service account.

2 Start Regedit.


HKEY_LOCAL_MACHINE

\Software

\Wow6432Node

\KVS

\Enterprise Vault

\External Filtering

If the External Filtering key does not exist, create it as follows:




4 Create a PublicFolder key as follows:

■ Right-click External Filtering and select New > Key.

■ Name the key PublicFolder.

5 Create a new string value called 1 for the new custom filtering entry.

6 Right-click the new entry and select Modify. Give it the value:

EnterpriseVault.CustomFilter

7 Optionally, you can create a new DWORD entry with the name Override, andset its value to 0 (zero). By changing the value of this entry you can controlwhether the Exchange Public Folder task applies the custom filtering rulesduring archiving:

■ 0 (zero) — The Exchange Public Folder task applies the custom filteringrules to all messages.

■ 1 — The Exchange Public Folder task does not apply the custom filteringrules.

If the Override entry does not exist, then the task applies the custom filteringrules to all messages.

8 Close Regedit.

9 After you have configured the required XML filter rules, restart the ExchangePublic Folder tasks.


About custom filtering ruleset filesCustom filter rules and actions are defined in XML ruleset files. Each ruleset filecontains one or more rules with associated actions.

Each rule contains the following:

■ A set of one or more attribute filters for evaluating each item that the archivingtask processes. The order of attribute filters in a rule is not significant, all theattribute filters are evaluated.

■ An action to be applied to an item that matches all the attribute filters in the rule.Examples of actions are applying a particular retention category or storing theitem in a specified archive. More than one action can be applied to matchingitems.


Although the order of the attribute filters in a rule is not significant, the order of therules in the ruleset file is significant. The rules are evaluated in the order in whichthey appear in the file. The action associated with the first matching rule is appliedto the item, and no further rules are evaluated for that item. If none of the rulesmatch the item, the default action is to archive the item.

An item may be a message or an attachment. If a message has an attachment, themessage is evaluated first, and then the attachment is evaluated.

By default items that do not match any rules are archived by the mailbox archivingtask or the journal archiving task. If you want to archive only items that match arule, you can create a catch-all rule as the last rule in the ruleset file. Assign theaction "MARK_DO_NOT_ARCHIVE" to this last rule.

While developing and testing your filter, we strongly advise that you assign theaction "MARK_DO_NOT_ARCHIVE" to your rules. Check that the rules are appliedexactly as you expect before changing them to the actions that you want to use inyour production environment.

All ruleset files must be available in the folder Custom Filter Rules in the mainEnterprise Vault folder (for example C:\Program Files (x86)\Enterprise Vault)on the computer hosting the archiving tasks that are enabled for custom filtering.

After Enterprise Vault has been installed, this folder contains the following XMLfiles:

■ Example Filter Rules.xml — This provides examples of filter rules.

■ ruleset schema.xdr — This contains the XML schema for validating the XMLruleset files.

■ Example Custom Properties.xml — This provides example entries for thecustom properties.xml file.See “About the general format of Custom Properties.xml” on page 234.

■ customproperties.xsd — This contains the XML schema for validating thecustom properties XML file.

When you create ruleset files or modify existing ruleset files, you must restart theassociated archiving tasks before the changes take effect. In a distributedenvironment, you must copy the updated file to each computer with tasks enabledfor custom filtering, and then restart the associated tasks on each computer.

Note: If you create rules to match names that contain special characters, you mustsave the XML ruleset files with Unicode encoding.


About the default filter rules file for custom filteringDefault filters and actions are defined in a ruleset file called Default Filter

Rules.xml.

To implement specific filtering for public folders or particular mailboxes, you cancreate named ruleset files in addition to the default ruleset file. Each target locationassociated with a named ruleset file is processed according to the rules in its namedruleset file. All other custom filtering will use the rules in the default ruleset file.

If you choose not to use Default Filter Rules.xml, you must configure theIGNORENODEFAULT registry value.

See “About controlling default custom filtering behavior” on page 198.

In this way, custom filtering is only applied to target locations explicitly defined bynamed ruleset files.

If you implement the custom properties feature, and want the same actions appliedto all items that the archiving tasks process (that is, specific items are not selectedfor processing by matching attributes), you can omit ruleset files altogether anddefine a default content category in the file, custom properties.xml.

Information on content categories and the custom properties.xml file is providedin the following section:


About named ruleset files for individual Exchange ServermailboxesTo set up custom filtering for an individual Exchange Server user or journal mailbox,you need to create a separate ruleset file for each mailbox you want to filter. Thename of each ruleset file must be mailbox_owner.xml.

The mailbox owner will typically be the same as the account Display Name, butcould be different if you have changed the mailbox owner name, for some reason.

For example, if you want to filter John Doe’s mailbox, and John Doe is the mailboxowner name, you would create a ruleset file called "John Doe.xml". To apply filteringto a journal mailbox with the mailbox owner name "Journal US1", you would createa ruleset file called "Journal US1.xml". Any other mailboxes that do not have anamed ruleset file and are serviced by the archiving tasks which have been enabledfor custom filtering, are processed using the default ruleset file, Default Filter

Rules.xml.

If archiving tasks are enabled for custom filtering, but neither the default ruleset filenor named ruleset files exist, the archiving tasks will attempt to use a default content


category, as defined in custom properties.xml. If none of the above exists, anerror is logged and the archiving tasks stop.

You can configure archiving tasks to manage missing defaults gracefully using theIGNORENODEFAULT registry setting.


This registry setting is particularly useful if you want to restrict filtering to namedmailboxes only.

Note: If custom filtering is enabled for all Exchange Server mailbox archiving andyou want to apply different rules to Exchange Server user and journal mailboxes,you could create a named ruleset file for the Exchange Server journal mailbox andconfigure the default ruleset file for filtering all user mailboxes. This would avoidhaving to create a large number of named ruleset files.

About the named ruleset file for public foldersTo set up specific filtering for Exchange Server public folders, you need to createa separate ruleset file called Public Folder Rules.xml. This will be used by allExchange Public Folder tasks hosted on the Enterprise Vault server computer. IfPublic Folder Rules.xml does not exist, the default ruleset file, Default Filter

Rules.xml, will be used. If neither of these files exist, but a default content categoryis defined in custom properties.xml, items will be archived according to thesettings in the default content category.


If none of the above exists—Public Folder Rules.xml, Default Filter

Rules.xml or a default content category—an error will be logged and the archivingtasks will stop, unless you have configured the IGNORENODEFAULT registrysetting.

You can configure archiving tasks to manage missing defaults gracefully using theIGNORENODEFAULT registry setting.

About controlling default custom filtering behaviorIf Enterprise Vault archiving tasks are enabled for filtering, the actions they takewhen archiving is determined by the existence of the various configuration entities:

■ XML ruleset files in the folder, Enterprise Vault\Custom Filter Rules

■ The XML ruleset file, Default Filter Rules.xml

■ The XML custom properties file, Custom Properties.xml


■ Content category entries in Custom Properties.xml

An additional configuration option, IGNORENODEFAULT registry entry, can beused to alter the archiving task behavior, if some of the configuration entities arenot defined.

See “Setting IGNORENODEFAULT registry entry for custom filtering” on page 199.

Different configurations and the resulting actions of archiving tasks for eachconfiguration are shown in Table 13-6 and Table 13-7.

Setting IGNORENODEFAULT registry entry for customfilteringIf the appropriate registry keys are configured to enable custom filtering andproperties for archiving tasks, then certain configuration entities are required todefine the default actions of the archiving tasks. For example, if specific targets areto be archived using particular filter rules, then a named XML ruleset file must existfor each of the archiving targets for custom filtering, and a Default Filter

Rules.xml file must also exist to provide filtering rules for the other archiving targetsserviced by the archiving tasks. If this file does not exist, then the archiving taskswill stop and an error reported in the event log.

Alternatively, if the Default Filter Rules.xml file does not exist, but you configurethe IGNORENODEFAULT registry entry, the archiving tasks ignore the fact thatthe file is missing and use the default archiving task policy settings when archivingall targets that do not have a named ruleset file.

The IGNORENODEFAULT registry entry also enables you to restrict custom filteringto target archiving targets with named ruleset files only. (If the Default Filter

Rules.xml file exists, it is used as the default by all archiving tasks enabled forcustom filtering.)

Similarly, to apply custom property indexing to specific target archiving locations,you would typically require the following configuration entities:

■ A Custom Properties.xml file with entries defining the custom properties toindex and an associated content category.

■ A separate, named ruleset file for each of the archiving targets requiring customproperty indexing.

■ In Custom Properties.xml, a default content category to use for all messagesarchived from other locations that are not covered by the named ruleset files.

However, if you want to restrict custom filtering and custom property indexing tothe named targets, it is more efficient to omit setting the default content categoryin Custom Properties.xml and set the IGNORENODEFAULT registry entry. In


this way, custom property indexing is applied only to locations explicitly defined bynamed ruleset files.

To set the IGNORENODEFAULT registry entry for custom filtering

1 Log in as the Enterprise Vault Service account on the computer running thearchiving tasks enabled for custom properties and filters.

2 Start Regedit.


HKEY_LOCAL_MACHINE

\Software

\Wow6432Node

\KVS

\Enterprise Vault

\External Filtering

\Journaling|Mailbox|PublicFolder

4 Right-click the required archiving key (Journaling, Mailbox or PublicFolder)and select New,Key.

5 Name the new key EnterpriseVault.CustomFilter.

6 Right-click EnterpriseVault.CustomFilter and create a new DWORD calledIGNORENODEFAULT.

7 Set the value to 1 to ignore missing default files or settings.

This key will apply to all tasks for the selected type of archiving.

8 Close Regedit.

9 Restart the associated archiving tasks.

In a distributed environment, where you have archiving tasks running on morethan one computer, you need to perform these steps on each computer runningarchiving tasks that have been enabled for custom filtering and properties.

Summary of default behavior for custom filteringTable 13-6 shows ten different configurations for custom filtering and properties.

The resulting actions taken by archiving tasks in each case are described inTable 13-7.

In all cases it is assumed that the appropriate registry settings have been configuredto enable the archiving task for custom filtering. The following configuration entitiesare considered:


■ Named XML ruleset files in the folder, Enterprise Vault\Custom Filter

Rules. In the example cases shown, John Doe.xml and Sam Cole.xml arenamed ruleset files for the mailboxes John Doe and Sam Cole respectively.Remember that named ruleset files can also be created for Exchange Serverpublic folders or specific Exchange Server journal mailboxes.See “About custom filtering ruleset files” on page 195.

■ The default ruleset file for all types of archiving, Enterprise Vault\Custom

Filter Rules\Default Filter Rules.xml.

■ The custom properties file, Enterprise Vault\Custom Filter Rules\Custom

Properties.xml, with custom properties defined for indexing.

■ Content category entries in the Custom Properties.xml file.

■ The registry setting, IGNORENODEFAULT, with a value of 1.

Table 13-6 Example custom filter and custom property configurations

IGNORENODEFAULTset

Defaultruleset fileexists

Namedruleset fileexists: SamCole.xml

Namedruleset fileexists: JohnDoe.xml

Defaultcontentcategorydefined

Custompropertiesfile exists

Case

NoNoNoNoNoNo1

YesNoNoNoNoNo2

NoNoNoYesNoNo3

YesNoNoYesNoNo4

NoYesNoYesNoNo5

YesYesNoYesNoNo6

NoNoYesNoNoYes7

YesNoYesNoNoYes8

NoNoYesNoYesYes9

YesNoYesNoYesYes10

Table 13-7 Resulting actions for example configurations

Resulting actionCase

An error is written to the event log and the archiving task stops, because customfiltering is enabled but there is no ruleset file or custom property file.

1


Table 13-7 Resulting actions for example configurations (continued)

Resulting actionCase

Missing defaults are ignored and both mailboxes are archived according to thedefault mailbox policy.

2

An error is reported for Sam Cole’s mailbox and the archiving task stops, becauseno default ruleset file or custom properties file exists.

3

John Doe’s mailbox is archived according to rules in John Doe.xml and SamCole’s mailbox is archived according to the default mailbox policy. Missing defaultsare ignored.

4

John Doe’s mailbox is archived according to rules in John Doe.xml and SamCole’s mailbox is archived according to the rules in Default FilterRules.xml.

No custom properties are indexed. Content categories cannot be used.

5

As for case 5. The fact that IGNORENODEFAULT is set makes no difference.6

An error is reported for John Doe’s mailbox and the archiving task stops, becausethere is no applicable named ruleset file or default ruleset file or custom propertyfile.

7

John Doe’s mailbox is archived according to rules in the default mailbox policy.Sam Cole’s mailbox is archived according to the rules in Sam Cole.xml.

8

All messages are archived from John Doe’s mailbox and custom propertiesindexed. Messages are archived from Sam Cole’s mailbox according to the rulesin Sam Cole.xml.

9

As for case 9. The fact that IGNORENODEFAULT is set makes no difference.10

About the general format of ruleset files for custom filteringThis section describes the required overall format of the XML ruleset files.

All ruleset files must be located in the Custom Filter Rules folder, in the mainEnterprise Vault folder (for example C:\Program Files (x86)\Enterprise Vault)on the computer hosting the archiving tasks that are enabled for custom filtering.

Ruleset files have the following general format:

<?xml version="1.0"?>

<RULE_SET xmlns="x-schema:ruleset schema.xdr">

<RULE [NAME="rule_name"] [ACTION="match_action"]


[ATTACHMENT_ACTION="match_action"]

[CONTENTCATEGORY="content_category"]

[RETENTION="retention_category"]

[ARCHIVEID="archiveid"]>

<message_attribute [attribute_value_operators]>

<attribute_value>

[<attribute_value>]

</message_attribute>

[<message_attribute>... </message_attribute>]

[<attachment_attributes> [attribute_value_operator]>

<attachment_attribute_values>

[<attachment_attribute_values>]

</attachment_attributes>]

[<attachment_attributes>... </attachment_attributes>]

</RULE>

[<RULE> ... </RULE>]

</RULE_SET>

The ruleset can contain one or more rules. Naming a rule (NAME="rule_name") isoptional. It is advisable to include it for documentation purposes and to distinguishthe rule in trace output.

Each rule contains one or more message attribute filters for evaluating messages.A rule may also contain attachment attribute filters for evaluating attachments tomessages.

Table 13-8 shows the message attributes that you can use to select messages.

Table 13-8 Message attributes for custom filtering

More informationMessage attribute

See “Message author and recipients filtersfor custom filtering” on page 209.

Author

See “Message author and recipients filtersfor custom filtering” on page 209.

Recipients

See “Message direction filters for customfiltering” on page 217.

Direction


Table 13-8 Message attributes for custom filtering (continued)

More informationMessage attribute

See “Message subject filters for customfiltering” on page 219.

Subject text

See “About MAPI named properties filters forcustom filtering” on page 220.

Named MAPI properties

Table 13-9 shows the attachment attributes that you can use to select specific filesattached to messages.

Table 13-9 Attachment attributes for custom filtering

More informationAttachment attribute

See “Attachment attribute filters for customfiltering” on page 222.

File name

See “Attachment attribute filters for customfiltering” on page 222.

File size

Matching against attribute values is case-insensitive. All message attribute filtersin a rule will be applied to a message, so the order of message attribute filters in arule is not significant. A message matches a rule when it matches all the messageattribute filters contained in that rule. When a message matches a rule, the actionspecified by ACTION= is applied to the message.

If the message attributes satisfy a rule, any attachments are then evaluated usingattachment attributes. When an attachment matches a rule, the action specified byATTACHMENT_ACTION= is applied to the attachment.

Each rule has a message action associated with it. ACTION="match_action" definesthe action to be applied to the message when it matches a rule. For example, anaction could be to mark the item as evaluated but not archive it(ACTION="MARK_DO_NOT_ARCHIVE"). If the action is to archive the item,additional actions can be specified, such as assigning a specific retention category(RETENTION="retention_category") or storing the item in a particular archive(ARCHIVEID="archive_ID"). If no action is specified, it defaults to "ARCHIVE_ITEM".

The preferred way to specify how messages that match a rule are to be archivedis to assign a content category. A content category is a group of settings that areto be applied to an archived item. This can include a retention category, an archiveID and a list of the additional properties that are to be indexed by Enterprise Vault.You define content categories in the file custom properties.xml.

See “About content categories” on page 238.


If attachments to messages are to be evaluated, a rule must have an attachmentaction associated with it; ATTACHMENT_ACTION="match_action". If an attachmentaction is specified, an attachment attribute element ( <FILES> element) must alsobe present in the rule. This defines the file names or file size (or both) to use whenmatching attachments. If attachments match the specified attachment filter, theattachment action is performed. Attachments to nested messages are also processedby the filter.

Note: For messages (and then attachments), each rule in the ruleset file will beevaluated in the order in which it appears in the file and only the first matching rulewill be executed. For this reason, it is important to put the highest priority rules first.

About validating XML ruleset files for custom filteringArchiving tasks that are enabled for custom filtering validate ruleset XML againstthe schema, ruleset schema.xdr, when they start archiving items. If any of theXML is invalid, the tasks stop and you must correct any errors before restartingthem.

To avoid disrupting tasks because of syntactic errors, it is a good idea to validateyour XML file before it is accessed by the tasks. You could use a third party tool,such as the graphical XML Editor in Liquid XML Studio:

http://www.liquid-technologies.com/XmlStudio/Free-Xml-Editor.aspx

When using the tool, specify the namespace as:

x-schema:ruleset schema.xdr

The schema file, ruleset schema.xdr, is shipped in the Custom Filter Rules

folder . The schema must be referenced at the start of any ruleset files as follows:



If the file contains non-ANSI characters, ensure the correct encoding is set on thefirst line and save the file using the appropriate encoding.

Note: All the XML tags and predefined values shown in upper case in this documentare case-sensitive and must be entered as upper case in the ruleset file. Valuesentered should also be treated as case-sensitive.

About rule actions for custom filteringThe following actions can be applied to messages that match a rule filter:



■ ACTION="ARCHIVE_ITEM" — Archive the message. This is the default actionif you do not include the ACTION= clause or a message does not match any ofthe rules.With this action you can have additional actions: assigning a retention category(RETENTION="retention_category") to the item, sending the item to a specificarchive (ARCHIVEID="archive_ID") and assigning a particular content category.See “Assigning a retention category for custom filtering” on page 207.See “Specifying an archive for custom filtering” on page 208.

■ ACTION="MARK_DO_NOT_ARCHIVE" — Do not archive the message; leaveit in the original location.

Note: Messages marked as MARK_DO_NOT_ARCHIVE remain in the originallocation. If you are applying filtering to the journal mailbox, this action shouldonly be used for a small number of messages, as leaving lots of messages mayaffect journaling performance.

If you later change the rule action, you can temporarily set the Override registryvalue to 1 to force the task to reprocess marked items. The Override registryvalue is described in the sections describing how to configure custom filteringregistry settings for archiving tasks:

■ See “Configuring registry settings for Exchange Server journal customfiltering” on page 191.

■ See “Configuring registry settings for Exchange Server mailbox customfiltering” on page 192.

■ See “Configuring registry settings for Exchange Server public folder customfiltering” on page 194.

■ ACTION="MOVE_DELETED_ITEMS" — Do not archive the message; move itto the Deleted Items folder.This action cannot be used with public folder filtering; if this action is configured,an error will be logged and the tasks will stop.

■ ACTION="HARD_DELETE" — Do not archive the message; delete it immediatelywithout moving it to the Deleted Items folder. This action is not recommendedfor Exchange Server public folder filtering.

Note: If you use Compliance Accelerator to capture a required percentage ofall Exchange Server journaled messages, do not configure a custom journalfilter that deletes selected messages. This compromises the accuracy of theCompliance Accelerator monitoring policy, because any deleted messages arenot available for capture.


The following actions can be applied to message attachments that match anattachment filter:

■ ATTACHMENT_ACTION="REMOVE" — If a file attached to a message matchesthe name or size specified in the attachment attribute filter, delete it.

■ ATTACHMENT_ACTION="REPLACE" — If a file attached to a message matchesthe name or size specified in the attachment attribute filter, replace it with a filecalled Deleted Attachments.txt, which lists the attachments that have beendeleted.See “About the Deleted Attachments.txt file for custom filtering” on page 208.

If the message has nested messages with attachments, the action will be appliedto all nested message attachments.

If the action applied to a message is "HARD_DELETE", no attempt is made toevaluate any files attached to the message.

The extract below shows how a rule name, message action and attachment actionmight be specified in the ruleset file. In this example, any messages that satisfy themessage attribute filters will be archived in the default archive. Also, any ExchangeServer messages attachments that match the attachment filter will be deleted andreplaced with a file called Deleted Attachments.txt:

<RULE NAME="Archive Rule 1" ACTION="ARCHIVE_ITEM"

ATTACHMENT_ACTION="REPLACE">

<message attribute filters>

<attachment attribute filter>

</RULE>

Assigning a retention category for custom filteringThe RETENTION="retention_category" option is only applicable if the rule actionis ACTION="ARCHIVE_ITEM".

Retention_category is the name of an existing retention category defined inEnterprise Vault. A different retention category may be specified for different rules.

The extract below shows how the option might be specified in the ruleset file. Inthis example, any messages that satisfy the message attribute filters will be archivedand given the retention category, Legal:

<RULE NAME="Example rule2" ACTION="ARCHIVE_ITEM"

RETENTION="Legal">


</RULE>


Specifying an archive for custom filteringThe ARCHIVEID="<archive_ID>" option is only applicable if the rule action isACTION="ARCHIVE_ITEM". Archive_ID identifies an existing, enabled archive.

You can define a different archive for different rules. If you do not specify an archive,the default archive for the mailbox or public folder is used.

The extract below shows how the option might be specified in the ruleset file. Inthis example, any messages that satisfy the message attribute filters will be storedin the archive specified:

<RULE NAME="Example rule" ACTION="ARCHIVE_ITEM"

ARCHIVEID="15165263832890493848568161647.server1.local">


</RULE>

To find the ID of the required archive

1 Right-click the archive in the Enterprise Vault Administration Console.

2 Select Properties. The archive ID is displayed on the Advanced page ofProperties.

About the Deleted Attachments.txt file for custom filteringIf the attachment action is "REPLACE", users will see a file called Deleted

Attachments.txt attached to messages that have had attachments deleted by thefilter. When they open this file, it contains a list of the files that have been deleted.

The contents of this file are taken from the file, CF_Replace_Attachment.txt, inthe Enterprise Vault directory (for example, C:\Program Files (x86)\Enterprise

Vault). If required, you can modify the text of this file. For example, you may wantto localize the descriptive text.

About message attribute filters for custom filteringEach rule can contain one or more message attribute filters. Each message attributefilter defines an attribute in the message to evaluate. To match a rule, a messagemust satisfy all the message attribute filters included in the rule. That is to say, thereis an implicit AND between all message attributes included in a rule. The order ofthe attributes within a rule is not significant.

Message attributes are defined in a rule using the following general format:

<RULE NAME="rule_name" ...>

<message_attribute [attribute_value_operators]>


<attribute_value>

[<attribute_value>]

</message_attribute>


</RULE>

message_attribute defines a message attribute to match. This can be AUTHOR,RECIPIENTS, DIRECTION or SUBJECTS.

attribute_value defines the message attribute value(s) to match. For each attributethere may be one or more values.

attribute_value_operators are special operator options that enable you to definehow values for an attribute are to be applied. The operators INCLUDES= andALLOWOTHERS= are particularly useful if you want to define negative and positivematches when filtering on AUTHOR, RECIPIENTS and SUBJECTS.

See “About creating complex filters using the INCLUDES and ALLOWOTHERSoperators” on page 213.

Attribute value operators are not available when filtering on message DIRECTION.

Message author and recipients filters for custom filteringTo match message sender ("From" address) and recipient addresses ("To", "cc","Bcc" and "Undisclosed" addresses), you can use the message attributes<AUTHOR> </AUTHOR> and <RECIPIENTS></RECIPIENTS>; in the ruleset fileoutline, message attributes are shown as:

<message_attribute>...</message_attribute>

Note: Matching attribute values is case-insensitive.

You can specify the actual addresses to match as SMTP email addresses, displaynames or SMTP domains using the following XML elements (these are representedby the <attribute_value> lines in the ruleset file outline):

■ <EA>name@domain</EA>This form can be used to specify SMTP addresses. The value specified mustbe the complete SMTP email address; if the value specified here is only part ofan address, the message will not match. Wildcard characters cannot be used.If the ampersand character (&) is included in an SMTP address, the charactermust be replaced with

&


because & is a special character in XML. For example, the SMTP addressadmin&[email protected] should be specified in the XML file as:

admin&[email protected]

■ <DISPN>display name</DISPN>This form can be used to specify display names. As with the SMTP address,the value must be the full display name, without wildcard characters. As displaynames can take many different forms, it is advisable to include a filter for theassociated SMTP address.An example display name for Exchange Server messages is

<DISPN>John Doe</DISPN>

■ <DOMAIN>exampledomain.com</DOMAIN>This form can be used to specify SMTP domains. The value specified can bethe full domain or a subdomain. For example, if the following domain value isspecified:

<DOMAIN>ourcompany.com</DOMAIN>

The following addresses will match:

■ [email protected]



but the following address will not match:


■ <DL>distribution list name</DL>Use this form when you want to match messages that have been sent to anymembers of the specified distribution list or group. For example, if a rule containsthe following line:

<DL>ALL SALES</DL>

Then messages sent to any member of the distribution list or group called ALLSALES will match, irrespective of whether the member’s name is shown as theDisplay Name or SMTP address on the message.

Note: Custom filtering cannot match against distribution lists that are hiddenfrom the Exchange 2013 and Exchange 2010 Global Address List.


See “About distribution lists in attribute values with custom filtering” on page 212.

The following example shows how you can specify a simple rule to archive and setthe retention category "Legal" on any messages sent from anyone in the domain,ourcompany.com, with [email protected] or the Notes user, Greg Court, inthe recipient list:

<RULE ... ACTION='ARCHIVE_ITEM' RETENTION='legal'>

<AUTHOR>

<DOMAIN>ourcompany.com</DOMAIN>

</AUTHOR>

<RECIPIENTS>

<EA>[email protected]</EA>

<DISPN>Greg Court/ourorg</DISPN>

</RECIPIENTS>

</RULE>

The attribute value operators, INCLUDES= and ALLOWOTHERS=, enable you todefine complex filters.

See “About creating complex filters using the INCLUDES and ALLOWOTHERSoperators” on page 213.

Note the following:

■ There are situations where messages may not have an SMTP address; forexample, messages imported into a mailbox from a PST file and ExchangeServer addresses set up for internal messaging only. For this reason you maywant to include both the display name and the email address in a rule (providedyou are not using the INCLUDES="ALL" operator).

■ Be aware that display names do not have to be unique; an external sender, forexample, could have the same display name as an internal sender.

■ If changes to your Microsoft Exchange Server Global Address List (or GlobalAddress Catalog in Active Directory) affect users or distribution lists included incustom filters, you may have to update your custom filter rules accordingly. Forexample, if you are filtering on the display name of a distribution list and thenchange the display name, you will need to update the appropriate ruleset fileentry.

■ Changes made to the Microsoft Exchange Server Global Address List will notbecome effective until the next scheduled GAL update. If, for example, a user’saddress has been changed to their married name, and you have set up a filterthat includes the new address as AUTHOR, there may be a delay beforemessages are matched.


■ To ensure that Bcc and Undisclosed recipients are available when filtering onthe Exchange Server journal mailbox, Envelope Journaling must be enabled onyour Microsoft Exchange Server.

About distribution lists in attribute values with customfilteringIf you want to match all messages sent to members of a particular Exchange Serverdistribution list, then use the <DL> </DL> message attribute. For example,

<RECIPIENTS>

<DL>ALL SALES</DL>

</RECIPIENTS>

would match any message sent to any member of the distribution list, ALL SALES.

For this matching to work, ensure that expansion of distribution lists is enabled inthe Administration Console (in the "Archiving General" settings on the "Advanced"tab of the Exchange journal policy). Also, the distribution list must not be includedin the Agents registry setting, BlacklistedDLs.

You can specify distribution lists and groups using the <EA>, <DISPN> and<DOMAIN> message attributes. However, only messages with the specified stringwill match; no attempt is made to compare message recipients with individualmembers in the specified distribution list.

For example, the members of an Exchange Server distribution list called ALL SALESare:




In the ruleset file, the following message attribute filter is specified in a rule:

<RECIPIENTS>

<DISPN>ALL SALES</DISPN>

</RECIPIENTS>

If a message has the display name ALL SALES in the recipient list, the messagewill satisfy the attribute filter above. If the message does not have the display nameALL SALES in the recipient list, it will not match the attribute filter, even if therecipient list does include the email address of a member of the distribution list.


About creating complex filters using the INCLUDES andALLOWOTHERS operatorsYou can create more complex filters by specifying several values for AUTHOR orRECIPIENTS message attributes and using the operators, INCLUDES= andALLOWOTHERS= to define how the attribute values are to be matched.

INCLUDES= can have the following values:

■ INCLUDES="NONE" means match messages that do not include the valuesspecified for the attribute

■ INCLUDES="ANY" means match messages that include one or more of thevalues specified for the attribute

■ INCLUDES="ALL" means match messages that include all of the values specifiedfor the attribute

If the INCLUDES= operator is not specified, INCLUDES="ANY" is assumed.

ALLOWOTHERS= can have the following values:

■ ALLOWOTHERS="N" means match messages that include only the valuesspecified in the filter and no others

■ ALLOWOTHERS="Y" means that matched messages can include attributevalues other than those listed in the filter can be included

If the ALLOWOTHERS= operator is not specified, ALLOWOTHERS="Y" is assumed.

In the following example, messages will match the rule if they have all three of thelisted email addresses (INCLUDES="ALL"), and only these addresses(ALLOWOTHERS="N"), in the recipient list:

<RULE ... >

<RECIPIENTS INCLUDES="ALL" ALLOWOTHERS="N">




</RECIPIENTS>

</RULE>

In the next example, messages will match the rule if they have any of the listedemail addresses (INCLUDES="ANY") but nothing else (ALLOWOTHERS="N"):

<RULE ... >

<RECIPIENTS INCLUDES="ANY" ALLOWOTHERS="N">





</RECIPIENTS>

</RULE>

In the next example, messages will match the rule if they do not include any of thelisted email addresses in the recipient list (INCLUDES="NONE"). Matched messagescan have other addresses in the recipient list (ALLOWOTHERS="Y"):

<RULE ... >

<RECIPIENTS INCLUDES="NONE" ALLOWOTHERS="Y">




</RECIPIENTS>

</RULE>

If you want to specify both positive and negative matches within a single rule, youcan have multiple message attribute entries and use INCLUDES="NONE" orINCLUDES="ALL", as appropriate. For example:

<RULE ... >

<RECIPIENTS INCLUDES="NONE">



</RECIPIENTS>

<RECIPIENTS> INCLUDES="ALL">



</RECIPIENTS>

</RULE>

In the above example, messages will match if they do not [email protected] or [email protected] in the recipient list:

<RECIPIENTS INCLUDES="NONE" ...</RECIPIENTS>

but do include both [email protected] [email protected]

<RECIPIENTS INCLUDES="ALL" ... </RECIPIENTS>

By using different combinations of INCLUDES= and ALLOWOTHERS= values, youcan set fairly complex filters.

Table 13-10 shows filter results for different messages when different combinationsof values are set for the operators, INCLUDES= and ALLOWOTHERS=, in thefollowing example filter:


<RULE ... ACTION="ARCHIVE_ITEM">

<RECIPIENTS INCLUDES="NONE|ANY|ALL"

ALLOWOTHERS="N|Y">



</RECIPIENTS>

</RULE>

[email protected] and [email protected] are the recipient addresses to match.

Table 13-10 Effect of using different operator value combinations

Msg 5:recipient isColin

Msg 4:recipients areBill & Colin

Msg 3:recipients areAnn, Bill &Colin

Msg 2:recipients areAnn & Bill

Msg 1:recipient isAnn

Operator values set

matchno matchno matchno matchno matchINCLUDES="NONE" +ALLOWOTHERS="Y"

no matchno matchno matchno matchno matchINCLUDES="NONE "+ALLOWOTHERS="N"

no matchmatchmatchmatchmatchINCLUDES="ANY "+ALLOWOTHERS="Y"

no matchno matchno matchmatchmatchINCLUDES="ANY" +ALLOWOTHERS="N"

no matchno matchmatchmatchno matchINCLUDES="ALL" +ALLOWOTHERS="Y"

no matchno matchno matchmatchno matchINCLUDES="ALL" +ALLOWOTHERS="N"

In the table, the main column headings show the recipients in five different testmessages. (For brevity, the recipients are called Ann, Bill, and Colin in the columnheadings.)

The first column shows different combinations of values set for the INCLUDES=and ALLOWOTHERS= operators.

"no match" means that, if the operator combination shown in the left column is set,a message sent to the recipients shown in the column heading would not satisfythe filter rule and would not be archived (that is, the rule action is not applied).

"match" means that, if the operator combination shown in the left column is set, amessage sent to the recipients shown in the column heading would satisfy the filterrule and be archived.


Figure 13-1 and Figure 13-2 illustrate what happens in two of the scenarios inTable 13-10.

Figure 13-1 Msg 1 with INCLUDES="NONE" and ALLOWOTHERS="N"

To: Ann

Custom filtering enabled.Rule filter configured:

<RULE ...ACTION="ARCHIVE_ITEM"><RECIPIENTS INCLUDES="NONE"

ALLOWOTHERS="N"><DISPN>Ann</DISPN><DISPN>Bill</DISPN>

</RECIPIENTS></RULE>

Enterprise Vaultarchiving task Message does

not match rule,so it is notarchived


Figure 13-2 Msg 1 with INCLUDES="ANY" and ALLOWOTHERS="Y"

Custom filtering enabled.Rule filter configured:

<RULE ...ACTION="ARCHIVE_ITEM"><RECIPIENTS INCLUDES="ANY"

ALLOWOTHERS="Y"><DISPN>Ann</DISPN><DISPN>Bill</DISPN>

</RECIPIENTS></RULE>

Enterprise Vaultarchiving task

Message matchesrule, so it isarchived

ArchiveTo: Ann

To: Ann

Message direction filters for custom filteringThe <DIRECTION></DIRECTION> message attribute enables you to matchmessages based on the direction of the message, in relation to the organization,without needing to specify the author or recipient details in the rule. Messagedirection can be internal to the organization, outbound from the organization orinbound to the organization.

One or more of the following values can be specified in the<DIRECTION></DIRECTION> message attribute:

■ INTERNAL="Y" means match the message if it is from an internal address toan internal address. The message must not include any external addresses inthe recipient list.

■ OUTBOUND="Y" means match the message if it is from an internal address toan external address. The message must include at least one external addressin the recipient list.

■ INBOUND="Y" means match the message if it is from an external address toan internal address. The message must include at least one internal address inthe recipient list.


If the value is not specified, it defaults to "N". For any messages to match, at leastone value must be set to "Y".

The following example rule will archive and set the retention category "Internal", onmessages from one internal address to another internal address only. Note that amessage from one internal address to another internal address that also has anexternal address in the recipient list will be treated as external:

<RULE NAME="Internal only" RETENTION="Internal" >

<DIRECTION INTERNAL="Y" OUTBOUND="N" INBOUND="N"/>

</RULE>

The following example rule will archive and set the retention category "External",on messages sent to or received from addresses outside the organization:

<RULE NAME="External" RETENTION="External" >

<DIRECTION OUTBOUND="Y" INBOUND="Y"/>

</RULE>

If you want only items that match the rules to be archived, the following examplerule can be added to the end of the file as a "catch-all" rule:

<RULE NAME="Do not archive anything else" ACTION="MARK_DO_NOT_ARCHIVE">

<DIRECTION INBOUND="Y" OUTBOUND="Y" INTERNAL="Y"/> </RULE>

For each item that is evaluated using this example rule, one of the direction attributeswill always have the value "Y". Therefore items that do not match any other rule inthe file will match this rule. The associated action means that the matching itemsare not archived.

About defining which addresses are internal with customfilteringTo determine whether addresses are internal or external addresses, EnterpriseVault uses the SMTP address domains listed for the system mailbox accountassociated with the Enterprise Vault Journaling task. You can see the emailaddresses associated with a mailbox in Active Directory.

For example, if the following SMTP addresses are listed for the system mailbox:



then any of the following addresses will be recognized as internal:

■ *@ourcompanyplc.com

■ *@[*.]ourcompanyplc.com


■ *@ourcompanyinc.com

■ *@[*.]ourcompanyinc.com

where [*.] means the string can be repeated, as [email protected].

Any other addresses are treated as external.

With Exchange Server filtering, addresses from local Microsoft Exchange Serversare also regarded as internal. (These addresses include the MAPI attribute,PR_SENDER_ADDRTYPE.)

For Exchange Server users, you can change the email addresses associated witha mailbox in Active Directory.

Alternatively, you can specify additional internal domains using theInternalSMTPDomains registry key.

To add domains using the registry key, do the following on each computerwith an Enterprise Vault Journaling task

1 Start Regedit and navigate to the following location:

HKEY_LOCAL_MACHINE

\Software

\Wow6432Node

\KVS

\Enterprise Vault

\Agents

2 Create a new String Value called InternalSMTPDomains.

3 Modify the key and in the Value Data field enter the required domains as asemicolon delimited string. For example, setting this string to the followingmeans that addresses such as [email protected] [email protected] will also be treated as internal:

"ourcompanyplc.com;ourcompanyinc.com;ourcompany.parentcorp.com"

Message subject filters for custom filteringThe <SUBJECTS></SUBJECTS> message attribute enables you to matchmessages on the subject text of the message. Within a <SUBJECTS> attribute,values to match can be defined as follows:

■ Match any message with a subject that is exactly the same as the specifiedstring:

<SUBJ MATCH="EXACT">string</SUBJ>


■ Match any message with a subject that contains the specified string:

<SUBJ MATCH="CONTAINS">string</SUBJ>

■ Match any message with a subject that starts with the specified string:

<SUBJ MATCH="STARTS">string</SUBJ>

■ Match any message with a subject that ends with the specified string:

<SUBJ MATCH="ENDS">string</SUBJ>

Matching against attribute values is case-insensitive. Wildcards cannot be used.

In the following example, messages that have a subject of exactly "Welcome NewEmployee" or starts with "Salary Summary for" or ends with "Message Notification"will be deleted without being archived:

<RULE NAME="Delete" ACTION="HARD_DELETE">

<SUBJECTS>

<SUBJ MATCH="EXACT">Welcome New Employee</SUBJ>

<SUBJ MATCH="STARTS">Salary Summary for</SUBJ>

<SUBJ MATCH="ENDS">Message Notification</SUBJ>

</SUBJECTS>

</RULE>

The INCLUDES="NONE" operator can be used to match messages with a subjectthat does not include particular strings. For example, the following rule will matchmessages that do not have any of the specified values in the message subject:

<RULE ... >

<SUBJECTS INCLUDES="NONE">

<SUBJ MATCH="EXACT">Welcome New Employee</SUBJ>

<SUBJ MATCH="STARTS">Salary Summary for</SUBJ>

<SUBJ MATCH="ENDS">Message Notification</SUBJ>

</SUBJECTS>

</RULE>

About MAPI named properties filters for custom filteringThe <NAMEDPROP> </NAMEDPROP> message attribute enables you to selectExchange Server messages for processing depending on the value assigned tospecific MAPI named properties. Named properties can be single-valued ormulti-valued.


The custom properties feature is used to define the required properties, so that theyare indexed by Enterprise Vault. Users can then search archived messages forthose with a particular value set for the named property.

Instructions are provided on how to define named properties.

See “Defining additional MAPI properties in custom properties” on page 236.

A named property filter takes the following general format:

<NAMEDPROP TAG="EV_tag_name" INCLUDES="operator_value">

<PROP VALUE="value" />

[<PROP VALUE="value" />]

</NAMEDPROP>

The value of the TAG attribute is the name by which Enterprise Vault knows theproperty. This is the TAG value set in the Custom Properties.xml file.

The operator value can be "ANY", "NONE" or "ALL".

Each <PROP> line defines a specific value for the property that custom filtering isto use when evaluating messages.

For example, a third party application adds a multi-valued, named MAPI propertycalled "Location" to messages. This property identifies the department and locationof the sender or recipient. The property is identified in the Custom Properties.xml

file and given the Enterprise Vault tag name, "Loc". The following example showsa filter that would match messages that have the value "Pittsburgh" or "Finance"set for the "Location" property. Any messages that match are archived with theretention category, "Confidential".



<RULE NAME="Location rule" ACTION="ARCHIVE_ITEM"

RETENTION="Confidential">

<NAMEDPROP TAG="Loc" INCLUDES="ANY">

<PROP VALUE="Pittsburgh" />

<PROP VALUE="Finance" />

</NAMEDPROP>

</RULE>

Searches could be performed for messages that have specific values set for thatnamed property.

Instructions are provided on how to create and implement an example custom filterthat uses named MAPI properties. The example custom filter assigns a differentretention category to messages of a particular message class.

See “Custom properties example” on page 250.


For more information on named properties, see the following Microsoft article:

http://msdn.microsoft.com/library/office/cc765864.aspx

Attachment attribute filters for custom filteringTo enable you to delete certain attachments before archiving messages, a rule cancontain attachment attribute filters which define which attachment files to select.

The following example XML shows how you can include one or more attachmentattribute filters in a rule:

<RULE NAME="rule_name" ... ATTACHMENT_ACTION="action">


<FILES INCLUDES="ANY|ALL|NONE">

<FILE FILENAME="filename" SIZE_GREATER_THAN_KB="integer" />

<FILE ... />

...

</FILES>

<FILES INCLUDES="ANY|ALL|NONE">

<FILE ... />

...

</FILES>

</RULE>

The <FILES> tag defines an attachment filter.

If you specify an attachment action (ATTACHMENT_ACTION=), then you need toinclude at least one attachment filter (using the <FILES> tag). For an attachmentto match a rule (and the attachment action applied), the attachment must satisfyall attachment filters specified in the rule. The order of attachment filters in a ruleis not significant.

The INCLUDES= operator enables you to define how the following attribute linesare to be applied, when evaluating each attachment.

An attachment filter contains one or more <FILE> elements, that define the attributesto match. Each <FILE> element contains one or both of the following attributes:

■ FILENAME="filename"<filename> is all or part of the file name to match. Wildcards can be included inthe file name. You can use this attribute to filter files with specific text strings inthe name or extension, for example, "*.AVI".


http://msdn.microsoft.com/library/office/cc765864.aspx

When selecting files using the file extension, custom filtering only evaluates thefile name; it does not check the type of the file contents. If files that wouldnormally be deleted by a filter are given a different extension, they will not bedeleted by the filter.Also, files contained in compressed files, such as .ZIP files, are not evaluated.

■ SIZE_GREATER_THAN_KB="integer"This enables you to configure the filter to remove attachments over a certainsize.

Where file name and size are specified in a <FILE> element, both must be satisfiedfor an attachment to match. For example, if an attachment is to match the followingline, it must have an extension of .MP3 and be larger than 1 MB:

<FILE FILENAME="*.MP3" SIZE_GREATER_THAN_KB="1000" />

If you specify multiple <FILE> elements to use in evaluating attachment files, eachone will be applied. For an attachment to match the rule, it must match each <FILE>element.

To define how the <FILE> lines are to be applied, when evaluating each attachment,use the INCLUDES= operator:

■ INCLUDES="ANY" means that the attachment matches if it has the attributesspecified in at least one of the <FILE> lines. This is the default action if theoperator is not specified.

■ INCLUDES="ALL" means that the attachment matches only if it has the attributesspecified in all the <FILE> lines.

■ INCLUDES="NONE" means that the attachment matches if it does not includeany of the attributes specified in the <FILE> lines.

In the following example, an attachment will match the filter if all the following aretrue:

■ The file is an MP3 file larger than 2MB

■ The file name includes the text, "enlarge", and the file is larger than 1 MB

■ The file has the extension, MPG

■ The file is larger than 12 MB

<FILES INCLUDES="ANY">


<FILE FILENAME="*enlarge*.*" SIZE_GREATER_THAN_KB="1000" />

<FILE FILENAME="*.MPG" />

<FILE SIZE_GREATER_THAN_KB="12000" />

</FILES>


The following example shows how multiple attachment filters can be used to excludecertain attachments from deletion:

<RULE NAME="Filter attachments rule" ... ATTACHMENT_ACTION="REMOVE">


<FILES INCLUDES="NONE">

<FILE FILENAME="signature.jpg" />

</FILES>


<FILE SIZE_GREATER_THAN_KB="5000" />

</FILES>

</RULE>

With these attachment filters, attachments will be deleted if they do not have thefilename, signature.jpg, and are larger than 5 MB.

How message and attachment filters are applied for custom filteringThis section describes the order in which message and attachment evaluation isapplied when filtering Exchange Server messages.

When custom filters processes messages, the following general points are observed:

■ Messages and attachments are evaluated separately. Messages are evaluatedfirst against rules in the ruleset file, and then attachments are evaluated againstany rules that contain an attachment action.If an attachment is a message, the message is evaluated using message filtersin rules (with attachment action set) and then any attachments to the nestedmessage are evaluated using attachment filters in rules.

■ When evaluating a message, only the first rule in the ruleset file that matchesthe message is applied. Similarly, when evaluating attachments, only the firstrule that matches is applied to the attachment. For this reason the order of rulesin a ruleset file is significant.

■ The rule action (and attachment action) are only applied to a message (orattachment) that satisfies all the filters in the rule.

■ The default action for both messages and attachments is to archive the item.This means that messages and attachments that do not match any rules will bearchived.

Figure 13-3 shows how custom filtering processes a message with attachments.


Figure 13-3 Processing attachments

Ruleset file:

<RULE NAME="rule1"><message filter><message filter>

</RULE>

<RULE NAME="rule2"><message filter><message filter>

</RULE>

<RULE NAME="rule3" …ATTACHMENT_ACTION="REMOVE">

<attachment filter><attachment filter>

</RULE>

Attachedfile

1

2

3

Nested message

4

5

The message illustrated has a nested message attached and that message has afile attached. The simple ruleset file has two rules that contain message filters andone rule that contains attachment filters, as follows:

■ The top-level message is evaluated using the first message rule, rule1.

■ If that rule does match, then the rule ACTION is applied to the message. If therule does not match, then rule2 is tried.

■ (If the message ACTION is HARD_DELETE", no further evaluation is done.) Asthere is a rule with ATTACHMENT_ACTION, and the message has anattachment, the message attachment is evaluated using the attachment filtersin rule3.

■ Custom filters recognizes that the attachment is a message, so the message isevaluated against message filters in any rules with ATTACHMENT_ACTIONset. In this example, only rule3 has ATTACHMENT_ACTION set and it doesnot have any message filters, so the message will not match the rule. Items thatdo not match filter rules are archived (the default action).

■ The attachment to the nested message is then evaluated using the attachmentfilters in rule3. If the attachment matches the attachment filters then theATTACHMENT_ACTION is applied to the attachment.

Message filters and attachment filters can be combined in a single rule to selectattachments to particular messages.


Figure 13-4 shows an example message to the recipient, Karen Little, that has anMP3 file attached and also a message attached (a nested message).

Figure 13-4 Example message with attachments

Nested messageTo: John Doe

File.MP3

To: Karen Little

Message with one attached file,File.MP3, which is 10 MB, and a

nested message

The message may also have attachments.

The following example ruleset file contains a single rule to be applied to thismessage. The overall effect of this rule is to delete certain attachments in ExchangeServer messages to recipients other than Gill Smith or John Doe. Attachments inmessages to Gill Smith or John Doe are not deleted. Attachments with the followingattributes will be deleted:

■ MP3 attachments larger than 2 MB

■ JPG attachments larger than 1 MB

■ MPG files larger than 5 MB

<?xml version="1.0" encoding="UTF-8"?>




<RULE NAME="Disallowed attachments (except directors)"

ATTACHMENT_ACTION="REMOVE" >

<RECIPIENTS INCLUDES="NONE" ALLOWOTHERS="N">



</RECIPIENTS>



<FILE FILENAME="*.JPG" SIZE_GREATER_THAN_KB="1000" />

<FILE FILENAME="*.MPG" SIZE_GREATER_THAN_KB="5000" />


</FILES>

</RULE>

Assuming the appropriate archiving task has custom filtering enabled, the filters inthis ruleset will be applied to the example message, as follows:

■ First apply the message attribute filter (the <RECIPIENTS> element) to thetop-level message.

■ The recipient is not Gill Smith or John Doe, so the message attribute filtermatches.

■ As the message matches the rule, it will be archived (ACTION=).

■ Is there a rule that contains ATTACHMENT_ACTION? Yes. This means thatany attachments to the message must be evaluated using <FILES> attachmentfilters.

■ Does the attachment file name and file size match any of the <FILE> attributelines in the rule? Yes, the attached file matches the first <FILE> line. This meansthat the attachment matches the rule, so delete the attachment, as specified inthe ATTACHMENT_ACTION.

■ Does the message have another attachment? Yes, there is an attached message.Custom filtering recognizes that the attachment is a message and evaluatesthe message using the message attribute filter (the <RECIPIENTS> element).

■ As the nested message is to John Doe, the <RECIPIENTS> filter is not satisfied.The message is therefore archived together with its attachments.

Example ruleset file for custom filteringThe following shows the supplied example ruleset file, Default Filter Rules.xml

(a renamed copy of Example Filter Rules.xml). If the registry keys have beenset to enable custom filtering, this file will be used for filtering any archiving targetsthat do not have a named ruleset file.





<RULE NAME="Benefits correspondence" ACTION="MARK_DO_NOT_ARCHIVE">

<AUTHOR>

<DISPN>HR Employee Benefits</DISPN>

</AUTHOR>


</RULE>



<RULE NAME="Benefits correspondence" ACTION="MARK_DO_NOT_ARCHIVE">

<RECIPIENTS>

<DISPN>HR Employee Benefits</DISPN>

</RECIPIENTS>

</RULE>



<RULE NAME="Newsletters" ACTION="MOVE_DELETED_ITEMS">

<AUTHOR INCLUDES="ANY">



<DOMAIN>limra.com</DOMAIN>

</AUTHOR>

<SUBJECTS INCLUDES="ANY">

<SUBJ MATCH="STARTS">Society SmartBrief</SUBJ>

<SUBJ MATCH="EXACT">TaxFacts ENews</SUBJ>

</SUBJECTS>

</RULE>



<RULE NAME="Junk Mail" ACTION="HARD_DELETE">

<AUTHOR INCLUDES="ANY" ALLOWOTHERS="Y">

<DOMAIN>indiatimes.com</DOMAIN>

<DOMAIN>websavings-usa.net</DOMAIN>

</AUTHOR>

<SUBJECTS INCLUDES="ANY">

<SUBJ MATCH="CONTAINS">enlargement</SUBJ>

<SUBJ MATCH="CONTAINS">weight loss</SUBJ>

</SUBJECTS>

<SUBJECTS INCLUDES="ALL">

<SUBJ MATCH="CONTAINS">debt</SUBJ>

<SUBJ MATCH="CONTAINS">consolidate</SUBJ>

<SUBJ MATCH="CONTAINS">loan</SUBJ>


</SUBJECTS>

</RULE>



<RULE NAME="Internal Memo" CONTENTCATEGORY="Memoranda">

<SUBJECTS INCLUDES="ALL">

<SUBJ MATCH="STARTS">Memo</SUBJ>

<SUBJ MATCH="CONTAINS">Internal</SUBJ>

<SUBJ MATCH="ENDS">OurCompany</SUBJ>

</SUBJECTS>

</RULE>



<RULE NAME="Management" CONTENTCATEGORY="ManagementMail"

RETENTION="Important">

<AUTHOR INCLUDES="ANY">




</AUTHOR>

</RULE>



<RULE NAME="Sent to Management ONLY"

ARCHIVEID="16611B008A3F65749BC4118182E0021461110000evsite.

ourcompany.com">

<RECIPIENTS INCLUDES="ANY" ALLOWOTHERS="N">





</RECIPIENTS>

</RULE>



<RULE NAME="External Recipient" ACTION="MARK_DO_NOT_ARCHIVE">

<RECIPIENTS INCLUDES="NONE">

<DOMAIN>OurCompany.com</DOMAIN>

</RECIPIENTS>

</RULE>



<RULE NAME="Internal Recipient" ACTION="ARCHIVE_ITEM"

RETENTION="Internal">

<DIRECTION INTERNAL="Y"/>

</RULE>



<RULE NAME="On the VIP list" RETENTION="VeryImportant">

<RECIPIENTS>

<DL>TheVIPs</DL>

</RECIPIENTS>

</RULE>


Delete MP3 attachments before archiving-->

<RULE NAME="DeleteMP3s" ATTACHMENT_ACTION="REMOVE">

<FILES>

<FILE FILENAME="*.MP3"/>

</FILES>

</RULE>


Match against named MAPI properties defined in

Custom Properties.xml-->

<RULE NAME="Category Match" ACTION="ARCHIVE_ITEM">

<NAMEDPROP TAG="CaseAuthor" INCLUDES="ANY">


<PROP VALUE="Engineering"/>

<PROP VALUE="Support"/>

</NAMEDPROP>

<NAMEDPROP TAG="CaseStatus" INCLUDES="ANY">

<PROP VALUE="Open"/>

<PROP VALUE="Pending"/>

</NAMEDPROP>

</RULE>

</RULE_SET>

Configuring custom properties and content categoriesCustom properties is an extension to custom filtering. It enables you to configureEnterprise Vault to index additional properties on messages that are selected bythe custom filters. These properties may be standard properties that a defaultEnterprise Vault system does not index, or they may be properties added tomessages by a proprietary, third party application.

Read this section to find out:

■ How to include in Enterprise Vault indexes additional properties on an item, forexample, properties that have been added to messages by third-partyapplications.

■ How to configure Enterprise Vault Search to enable users to search on theseindexed properties.

■ How to configure content categories.

The custom properties feature is an extension to custom filtering that enablesEnterprise Vault to access and index additional message properties when archivingitems. The properties can be Exchange Server MAPI properties that have beenadded to messages by a third-party application, as follows:

■ Standard MAPI properties that are not currently indexed by Enterprise Vault

■ Custom MAPI properties

■ Named MAPI properties

Content categories are groups of settings to be applied to messages as they arearchived. Settings can include a retention category to be applied, an archive to beused and particular message properties to be indexed. You can configure EnterpriseVault to apply a content category on all messages archived by particular archivingtasks. Alternatively, by using custom filtering together with custom properties, youcan configure Enterprise Vault to apply a content category on selected messagesonly.

See “Custom properties example” on page 250.


You define custom properties and content categories in the XML file, CustomProperties.xml, which must be located in the folder Enterprise Vault\Custom

Filter Rules. Additional entries in this file enable you to make the indexedproperties available to other applications, for example, Enterprise Vault Search.Users can then include the custom properties in archive search criteria. An exampleof the custom properties file, Example Custom Properties.xml, is installed in theCustom Filter Rules folder.

If you have special filtering requirements for your archiving system, Veritas cansupply the appropriate custom filters.

Table 13-11 Steps to configure custom properties or content categories


See “Configuring registry settings forExchange Server journal customfiltering” on page 191.

See “Configuring registry settings forExchange Server mailbox customfiltering” on page 192.

See “Configuring registry settings forExchange Server public folder customfiltering” on page 194.

Ensure that the custom filtering registrysettings for the required archiving tasksare configured. These need to be set,even if you want to implement customproperties or content categories, withoutfiltering.

Step 1


Table 13-11 Steps to configure custom properties or content categories(continued)


See “About the general format ofCustom Properties.xml” on page 234.

The entries in Custom Properties.xml

enable you to do the following:

■ Index custom properties onmessages.

■ Define required content categories.■ Define how custom properties and

content categories are displayed inproprietary search applications.

To configure Enterprise Vault to indexspecific custom properties on allmessages, without performing anyfiltering, create a CustomProperties.xml file but no rulesetfile. The Custom Properties.xmlfile must include definitions of thecustom properties and a default contentcategory. The default content categorywill be applied to all messages anddefines which properties EnterpriseVault is to index. This behavior can bealtered using the IGNORENODEFAULTregistry setting.

See “About controlling default customfiltering behavior” on page 198.

Create the XML file, CustomProperties.xml. Place this file in thefolder Enterprise Vault\CustomFilter Rules.

Step 2

See “Configuring custom filtering”on page 189.

If you want to index the properties onselected messages or apply contentcategories to selected messages, createthe required filter rules and actions inXML ruleset files. These are held in oneor more XML ruleset files, which mustalso be placed in the folder,Enterprise Vault\Custom FilterRules.

Step 3

Restart the archiving tasks that havecustom properties and filters enabled.

Step 4


About the general format of Custom Properties.xmlFor Enterprise Vault to access and index additional custom or standard MAPIproperties on Exchange Server messages, the properties must be defined in thefile Custom Properties.xml, which you create in the Enterprise Vault\Custom

Filter Rules folder on the computer running the archiving tasks enabled forcustom filtering. The installed file, Enterprise Vault\Custom Filter

Rules\Example Custom Properties.xml provides an example of this file.

The file has the following sections:

■ <CONTENTCATEGORIES></CONTENTCATEGORIES> This section definesavailable content categories. A content category is a group of settings that willbe applied to an item when it is archived. This can include custom properties toindex.See “About content categories” on page 238.

■ <CUSTOMPROPERTIES></CUSTOMPROPERTIES> This section defines theadditional message properties that are to be available to Enterprise Vault.See “Defining additional MAPI properties in custom properties” on page 236.

■ <PRESENTATION></PRESENTATION> This section defines how the contentcategories and custom properties are displayed to users in proprietary thirdparty applications.See “Defining how custom properties are presented in third party applications”on page 242.

Note: The order of these sections is significant.

The following outline shows the general format of the file:


<CUSTOMPROPERTYMETADATA xmlns:xsi="http://www.w3.org/2001/

XMLSchema-instance"

xsi:noNamespaceSchemaLocation="customproperties.xsd">



<CONTENTCATEGORIES>

<CONTENTCATEGORY> ... </CONTENTCATEGORY>

[<CONTENTCATEGORY> ... </CONTENTCATEGORY>]

</CONTENTCATEGORIES>



<CUSTOMPROPERTIES>

<NAMESPACE> ... </NAMESPACE>

[<NAMESPACE> ... </NAMESPACE>]


</CUSTOMPROPERTIES>



<PRESENTATION>

<APPLICATION>

<FIELDGROUPS>

<FIELDGROUP> ... </FIELDGROUP>

[<FIELDGROUP> ... </FIELDGROUP>]

</FIELDGROUPS>

<AVAILABLECATEGORIES>

<AVAILABLECATEGORY> ... </AVAILABLECATEGORY>

[<AVAILABLECATEGORY> ... </AVAILABLECATEGORY>]

</AVAILABLECATEGORIES>

</APPLICATION>

[<APPLICATION> ... </APPLICATION>]

</PRESENTATION>

A summary description of all mandatory and optional elements and attributes in thefile is provided in the following section:

See Table 13-12 on page 246.

Whenever you modify the file, you must restart the associated archiving tasks. Ina distributed environment, you must copy the updated file to each computer withtasks enabled for custom properties, and then restart the associated tasks on eachcomputer.

If Enterprise Vault Search is used to search for custom properties, then theEnterprise Vault Application Pool in IIS Manager must also be restarted.

When performing a search for custom properties using Enterprise Vault Search,you must enter the property name in the search criteria exactly as it is specified inthe Custom Properties.xml file; the case used for the property name in the searchcriteria must match that used in the file. Values entered for custom properties arealso case-sensitive.

About validating Custom Properties.xmlWhen Enterprise Vault is installed, customproperties.xsd is placed in the Custom

Filter Rules folder. This is the XML schema for validating Custom

Properties.xml.

The schema file must be referenced in the CUSTOMPROPERTYMETADATA entryat the start of the Custom Properties.xml file, as follows:




XMLSchema-instance"

xsi:noNamespaceSchemaLocation="customproperties.xsd">

If the file contains non-ANSI characters, ensure the correct encoding is set on thefirst line and save the file using the appropriate encoding.

The XML is validated when the associated task starts processing messages. Ifanything is invalid, the task stops and you must correct any errors before restartingthe task.

To avoid disrupting tasks because of syntactic errors, it is a good idea to validateyour XML file before it is accessed by the tasks. You could use a third party tool,such as the graphical XML Editor in Liquid XML Studio:


When using the tool, specify the namespace as:

x-schema:customproperties.xsd

Note: All the XML tags and predefined values shown in upper case in this documentare case-sensitive and must be entered as upper case in the file. Values enteredshould also be treated as case-sensitive.

Defining additional MAPI properties in custom propertiesIn the <CUSTOMPROPERTIES> section of Custom Properties.xml, you definethe additional MAPI properties that you want Enterprise Vault to evaluate or index.

Before MAPI properties can be defined in Custom Properties.xml, they must bedefined in the MAPI subsystem. Currently, the Enterprise Vault custom propertiesfeature supports only STRING and DOUBLE properties. Enterprise Vault supportssingle or multi-valued properties.

In MAPI, properties are grouped by NAMESPACE. Typically, properties accessedby a particular application are defined in the same namespace. Each namespaceis identified by a GUID. Each property is defined by its STRING ID and namespaceGUID.

For each property that you want to include, you will need the following details fromthe property definition in the MAPI subsystem:

■ If the property is a standard MAPI property, the hexadecimal MAPI property tag.You can specify just the Identifier part of the 32-bit hexadecimal MAPI propertytag (bits 16 to 31), or the Identifier part (bits 16 to 31) plus the Property typepart (bits 0 to 15). For example, if the MAPI Property tag for a standard propertyis 0x0070001E, the Enterprise Vault NAME value could be specified as either0x0070001E or 0x0070.



■ If the property is a custom property, the GUID of the property’s namespace.

■ If the property is a custom property, the property’s STRING ID. If the propertyis a named property, the ID will be a name.

You can use third party MAPI tools, such as OutlookSpy, to view the MAPI propertiesassociated with mailbox items.

Figure 13-5 shows how MAPI properties on a message are displayed in OutlookSpy.

Figure 13-5 Viewing MAPI properties

The selected property is the named property, "Keywords". This multi-valued propertyholds the Outlook categories assigned to the message. Details of the selectedproperty are displayed on the right-hand side of the window.

Note that the "Keywords" property is only used here as an example of a namedMAPI property. You do not need to add it as a custom property, because it is alreadyindexed in a default Enterprise Vault system.

To make MAPI properties available to Enterprise Vault, you define them in the<CUSTOMPROPERTIES> section of Custom Properties.xml. The propertiesdefined in this section can then be referenced in the content category andpresentation sections.

Here is an example showing how properties can be defined:



<CUSTOMPROPERTIES>

<NAMESPACE TYPE="MAPI"

GUID="{DA6007CD-01AA-408f-B7D3-6DA958A09583}">

<PROPERTY NAME="Author1" TAG="CaseAuthor"/>

<PROPERTY NAME="Status1" TAG="CaseStatus"/>

</NAMESPACE>


<NAMESPACE TYPE="MAPI" GUID="{EF1A0001-01AA-408f-B7D3-6DA958A09583}">

<PROPERTY NAME="Author2" TAG="Client"/>

</NAMESPACE>

<NAMESPACE TYPE="MAPI">

<PROPERTY NAME="0x0070" TAG="Topic"/>

</PROPERTY>

<PROPERTY NAME="0x1035" TAG="MsgID"/>

</PROPERTY>

</NAMESPACE>

</CUSTOMPROPERTIES>

In this example there are three NAMESPACES. The first two define custom MAPIproperties, so the GUID of the NAMESPACE is required. As the properties definedin the third NAMESPACE are standard MAPI properties, no GUID is required.

The value of the TYPE attribute identifies the property type; in this example, theproperties are MAPI properties.

Within each NAMESPACE the properties are defined in PROPERTY elementsusing NAME and TAG values, as follows:

■ If the property is a custom named MAPI property, NAME is the STRING IDdefined in the MAPI subsystem. The value is case-sensitive and must matchexactly the value in the MAPI subsystem.If the property is a standard MAPI property, NAME is either the Identifier part(bits 16 to 31) of the hexadecimal MAPI tag, or the Identifier part (bits 16 to 31)plus the Property type part (bits 0 to 15).

■ TAG identifies the property within Enterprise Vault. It must contain four or morealphanumeric characters (A-Z, a-z, or 0-9); spaces and underscore charactersare not permitted. The value assigned to the property TAG must be unique withinthe XML file; although you can cross refer to the property using the TAG value,the same value cannot be used to identify any other entities in the file.If you want to select messages by matching the values of specific properties,you need to create a <NAMEDPROP> filter in the appropriate XML ruleset fileand specify the TAG value defined here.See “About MAPI named properties filters for custom filtering” on page 220.

About content categoriesIn the <CONTENTCATEGORIES> section of Custom Properties.xml, you definethe content categories that you want to apply to filtered messages.

A content category defines a group of settings that are to be applied to an itemwhen it is archived.


The settings can include the following:

■ The retention category to assign to the item

■ The destination archive

■ A list of the additional message properties that Enterprise Vault is to index

There can be more than one content category defined in the<CONTENTCATEGORIES> element.

In ruleset files, the actions associated with a rule can include assigning a particularcontent category to messages that satisfy the rule. The content category definitionin Custom Properties.xml provides the default settings for the content category.Some of these can be overridden for particular rules.

See “About assigning content categories in rules when configuring customproperties” on page 240.

The following example shows entries for a content category called Litigation:



<CONTENTCATEGORIES DEFAULT="Litigation">

<CONTENTCATEGORY NAME="Litigation" RETENTIONCATEGORY="Litigation"


<INDEXEDPROPERTIES RETRIEVE="Y">

<PROPERTY TAG="CaseAuthor"/>

<PROPERTY TAG="CaseStatus"/>

</INDEXEDPROPERTIES>

</CONTENTCATEGORY>


■ <CONTENTCATEGORIES></CONTENTCATEGORIES> defines the contentcategory section in the file.

■ The DEFAULT attribute specifies the content category to be used as the default.This default applies to all types of archiving enabled for custom filtering.This attribute is optional, if custom filtering is used, but mandatory if there areno ruleset files (unless the registry setting IGNORENODEFAULT is configured).If filters are configured in ruleset files and a default content category is specified,any item that does not match any rules will be archived according to the settingsin the default content category. If no default content category is specified, thena content category will only be applied to an item if specified by a matching rulein a filter ruleset file.If no applicable ruleset files exist, then you must specify a default contentcategory using the DEFAULT attribute in the <CONTENTCATEGORIES>element in Custom Properties.xml. The settings in the content category are


then applied to all messages archived (unless the registry settingIGNORENODEFAULT is configured).The actions of archiving tasks are determined by combinations of ruleset files,custom properties, content categories and the registry settingIGNORENODEFAULT.

■ The <CONTENTCATEGORY> element defines a particular content category.There must be at least one content category defined.

■ The content category NAME is used to identify this content category in thepresentation section of the file, rules in custom filter ruleset files and externalsubsystems, such as the Enterprise Vault Indexing service. The name musthave at least five characters, which can include alphanumeric characters only(A-Z a-z 0-9); space and underscore characters are not permitted.If the content category is included in the presentation section of the file, it willbe possible to search on the content category name in order to find all itemsarchived using this particular content category.

■ RETENTIONCATEGORY is optional and enables you to assign a retentioncategory to each item archived using this content category. The retentioncategory must already exist in Enterprise Vault.

■ ARCHIVEID is optional and enables you to specify a destination archive for theitem. The archive must exist and be enabled. To find the ID of an archive, displaythe archive properties in the administration console and click the "Advanced"tab.

■ The <INDEXEDPROPERTIES> element is mandatory and groups the additionalproperties that Enterprise Vault is to index.

■ The RETRIEVE attribute (optional) determines whether or not the definedproperties should be returned with archive search results. By default, theproperties are not displayed with search results (RETRIEVE="N").

■ A <PROPERTY> element is required for each additional property to be indexed.

■ The TAG value must match the associated Enterprise Vault TAG value specifiedin the custom properties section.See “Defining additional MAPI properties in custom properties” on page 236.

About assigning content categories in rules whenconfiguring custom propertiesWhen using custom properties, the preferred way to specify the actions to be takenfor messages that match a filter rule is to assign a content category in the rule, inthe ruleset file. You define the default settings included in a content category in thecontent categories section of Custom Properties.xml.


In the ruleset file, you assign a content category as follows:

<RULE NAME="Example rule" ACTION="ARCHIVE_ITEM"

CONTENTCATEGORY="content_category_name">


</RULE>

The value of "content_category_name" is the name of the required contentcategory as specified in Custom Properties.xml.

In the ruleset file, content categories can only be assigned whenACTION="ARCHIVE_ITEM".

Overriding default content category settingsA rule can assign a content category and override some of the default contentcategory settings. For example, if you have a content category that defines all thecustom properties to index, a retention category and a destination archive, differentrules can assign the content category but override values for the archive or retentioncategory, as required.

For example, if a content category called Litigation is defined in CustomProperties.xml as follows:

<CONTENTCATEGORY NAME="Litigation" RETENTIONCATEGORY="Litigation"


<INDEXEDPROPERTIES RETRIEVE="Y">

<PROPERTY TAG="AUTHOR01"/>

<PROPERTY TAG="CASESTATUS"/>


</CONTENTCATEGORY>

It can be referenced in a ruleset file as follows:


CONTENTCATEGORY="Litigation">


</RULE>


CONTENTCATEGORY="Litigation"



</RULE>


Additional properties defined in the content category will be indexed with both rules.The second rule uses the same content category, but items that match this rule willbe stored in a different archive.

Note: Before you alter an existing configuration, make sure that you understandwhat default behavior has been configured for each type of archiving. Check theDEFAULT content category attribute in Custom Properties.xml and theIGNORENODEFAULT registry setting.


Defining how custom properties are presented in third partyapplications

The presentation section of the file, <PRESENTATION>, defines how availablecontent categories and custom properties are presented to external applications,such as a proprietary archive search engine.

Separating the presentation of properties from the underlying property definitionsenables flexible mapping of custom property details onto a user interface. This alsofacilitates the support of multiple languages.

Entries in the presentation section define the following:

■ Custom properties available for displaying by the named application

■ How properties are to be grouped and displayed in the application

■ Content categories available to the application

■ How each content category should be displayed in the application

Presentation information can be defined for each application that will require accessto custom properties in archived items.

Here is an example of a presentation section (partially completed) that shows howto define how custom properties are displayed in a web search application:



<PRESENTATION>

<APPLICATION NAME="engsearch.asp" LOCALE="1033">

<FIELDGROUPS>

<FIELDGROUP LABEL="Case Properties">

<FIELD TAG="CaseAuthor" LABEL="Author" CATEGORY="Litigation">

</FIELD>

<FIELD TAG="CaseStatus" LABEL="Status" CATEGORY="Litigation">


</FIELD>

</FIELDGROUP>

<FIELDGROUP LABEL="Client Properties">

<FIELD TAG="Client" LABEL="Client Name" CATEGORY="ClientAction">

</FIELD>

<FIELD TAG="Topic" LABEL="Message Topic" CATEGORY="ClientAction">

</FIELD>

</FIELDGROUP>

</FIELDGROUPS>


<AVAILABLECATEGORY CONTENTCATEGORY="Litigation" LABEL="Litigation">

</AVAILABLECATEGORY>

<AVAILABLECATEGORY CONTENTCATEGORY="ClientAction" LABEL="Client Action">



</APPLICATION>

<APPLICATION NAME="jpnsearch.asp" LOCALE="1041">

<FIELDGROUPS>

<FIELDGROUP LABEL="...">

<FIELD TAG="CaseAuthor" LABEL="..." CATEGORY="Litigation"></FIELD>

<FIELD TAG="CaseStatus" LABEL="..." CATEGORY="Litigation"></FIELD>

</FIELDGROUP>

<FIELDGROUP LABEL="...">

<FIELD TAG="Client" LABEL="..." CATEGORY="ClientAction"></FIELD>

<FIELD TAG="Topic" LABEL="..." CATEGORY="ClientAction">

</FIELD>

</FIELDGROUP>

</FIELDGROUPS>


<AVAILABLECATEGORY CONTENTCATEGORY="Litigation" LABEL="...">


<AVAILABLECATEGORY CONTENTCATEGORY="ClientAction" LABEL="...">



</APPLICATION>

</PRESENTATION>

The example shows entries for two versions of an application — the US English(locale "1033") version, and a Japanese (locale "1041") version. In this particularcase, the same elements and attributes have been specified for both versions, but


the LABEL values for the second version (omitted in the example) would be inJapanese.

Note the following:

■ The properties available to each application are grouped using the<APPLICATION> element.

■ The NAME attribute identifies the application.

■ The value of the LOCALE attribute is defined by the calling application. It isassumed here that the application uses the standard Microsoft Locale ID for thelanguage that the application will use: 1033 represents US English. The secondapplication in the example, jpnsearch.asp, also uses the Microsoft Locale ID;1041 represents Japanese.

In the application search page, custom properties are displayed in groups definedby their content category; that is, when a particular content category is selected,the custom properties with that content category are displayed.

Note the following:

■ The <FIELDGROUPS> element is used to define all the groups of customproperties to be displayed.

■ Each group is defined in a <FIELDGROUP> element. The LABEL attribute givesthe title that will be displayed in the application for the group of properties. Thevalue of the LABEL attribute must be unique in the application.

■ <FIELD> elements define each property to be displayed in the group.The value of the TAG attribute identifies the property to be displayed. The valuespecified here must match the associated TAG value of the property in the<CUSTOMPROPERTIES> section of the file.The value of the CATEGORY attribute identifies the content category with whichthis property is to be associated. When the user selects this content categoryin the search criteria, a box for this property could be displayed. The valuespecified for CATEGORY must match the associated NAME for the contentcategory in the content category section of the file. Also, CATEGORY must beone defined in the <AVAILABLECATEGORIES> element.TAG must be unique in the <FIELDGROUP> and the TAG/CATEGORYcombination must be unique within the <APPLICATION> element.LABEL defines the name that you want displayed in the user interface for thecustom property.

■ <AVAILABLECATEGORIES> groups the content categories that are to beavailable for selection in the application. Each content category is defined usingthe <AVAILABLECATEGORY> element; the value of the CONTENTCATEGORYattribute must match the name of the content category specified in the content


category section of the file. The LABEL attribute defines the name you wantdisplayed for the content category in the user interface.

Displaying custom properties in an example searchapplicationThis section shows how the example presentation section entries might be displayedin a proprietary archive search application. It is assumed that the search applicationuses the Custom Properties.xml file for details of the custom properties, and howto present them in the user interface.

Figure 13-6 shows search criteria with the example custom properties and contentcategories displayed.

Figure 13-6 Example presentation properties displayed in an example searchpage

In this example, a Content Category dropdown box shows the content categoriesavailable for searches. These were defined using the <AVAILABLECATEGORIES>element.

Searching on a content category returns all items that were archived with theselected content category.

TheCase Properties andClient Properties sections display each group of customproperties (FIELDGROUP) associated with the selected content category. Searching


on a custom property value searches the custom property index entry of archiveditems.

As RETRIEVE="Y" was set in the definition of the Litigation content category, thedefined custom properties should be displayed for search result items.

Figure 13-7 Example of custom properties displayed in search results

If the contents of the Custom Properties.xml file is changed, searches may returndifferent results. For example, if an item is indexed using one content category, andthe properties included in the content category are changed, the custom propertiesreturned by subsequent searches will be different. To ensure you can still searchon the original properties, leave the original content category and create a new one.

Summary of custom property elements and attributesTable 13-12 summarizes all elements and attributes in Custom Properties.xml.

The value in the Mandatory column assumes that the IGNORENODEFAULTregistry setting is not used.

Table 13-12 XML elements and attributes in the Custom Properties.xml file

DescriptionMandatoryAttributeElement

Defines the content category sectionof the file.

YesCONTENTCATEGORIES

Value is the name of the contentcategory to be used as default.Required if custom properties in allitems are to be indexed.

NoDEFAULT=


Table 13-12 XML elements and attributes in the Custom Properties.xml file(continued)


Defines a group of settings that areto be assigned to an archived item.

YesCONTENTCATEGORY

Value is a unique name to identifycategory to ruleset and presentationinterface.

YesNAME=

Value is a retention category to beassigned to the archived item.retention category must exist inEnterprise Vault.

NoRETENTIONCATEGORY=

Value is the ID of the archive to storethe item in. Value can be found in theproperties of the archive in theEnterprise Vault AdministrationConsole.

NoARCHIVEID=

Defines a set of additional propertiesin the content category.

YesINDEXEDPROPERTIES

Value is "Y" or "N". Indicates whetheror not properties in this set shouldappear in the search results. Defaultis "N".

NoRETRIEVE=

Defines an additional property toindex for items that are assigned thiscontent category.

YesPROPERTY

Value is the Enterprise Vault TAG ofthe property.

YesTAG=

Defines the custom property sectionof the file.

YesCUSTOMPROPERTIES

Defines a NAMESPACE thatcontains a group of customproperties.

YesNAMESPACE

Value is the type of property: "MAPI".YesTYPE=

MAPI properties only. Value isidentity of NAMESPACE to externalapplications.

YesGUID=




Defines a custom property.YesPROPERTY

If the property is a custom MAPIproperty, value is the STRING IDdefined in the MAPI subsystem. Thevalue is case-sensitive and mustmatch exactly the value in the MAPIsubsystem.

If the property is a standard MAPIproperty, value is either the Identifierpart of the 32-bit hexadecimal MAPIproperty tag (bits 16 to 31), or theIdentifier part (bits 16 to 31) plus theProperty type part (bits 0 to 15).

Value must be unique inNAMESPACE.

YesNAME=

TAG identifies the property withinEnterprise Vault. It must contain fouror more alphanumeric characters(A-Z a-z 0-9); spaces and underscorecharacters are not permitted. Thevalue must be unique within the XMLfile.

TAG value is the property name thatwill be stored in the index.

YesTAG=

Defines the presentation propertysection of the file.

YesPRESENTATION

Defines a group of fields for use bya named application.

YesAPPLICATION

Value is the name of the applicationthat will use the fields in thisdefinition.

YesNAME=




The value depends on what thecalling application requires to definethe language. For example, anapplication may use the standardMicrosoft Locale ID number that theapplication runs under.

YesLOCALE=

Define the field groups available tothe application.

YesFIELDGROUPS

A logical grouping of fields for thepresentation interface.

YesFIELDGROUP

Value will be presented to theapplication for this field group. Thelabel must be unique within theapplication.

NoLABEL=

Defines a field that will reference acustom property.

YesFIELD

Value will be displayed on theapplication user interface torepresent this custom property.

YesLABEL=

Value is the name of a contentcategory listed inAVAILABLECATEGORIES for theapplication.

YesCATEGORY=

Value is the TAG of a customproperty. The tag must be unique inthe FIELDGROUP.

YesTAG=

Define which content categories areavailable to the application.

YesAVAILABLECATEGORIES

Defines a content category.YesAVAILABLECATEGORY

Value defines how the contentcategory is to appear in the userinterface.

YesLABEL=




Value is the NAME of the requiredcontent category as specified in theContent Category section of the file.

YesCONTENTCATEGORY=

Custom properties exampleThis section provides an example custom filter for Exchange Server mailboxarchiving. The example custom filter assigns a different retention category (180Days)to calendar items (Exchange message class, IPM.Appointment).

To implement the example custom filter

1 Create the ruleset file, Default Filter Rules.xml.

See “Example ruleset file for configuring custom properties” on page 250.

2 Create the custom properties file, Custom Properties.xml.

See “Example custom properties file” on page 251.

3 Configure the registry settings to enable Exchange Server mailbox filtering.

See “Configuring registry settings for Exchange Server mailbox custom filtering”on page 192.

4 Set Dtrace logging for the archiving task (set ArchiveTask v).

For instructions on how to configure Dtrace logging, see the Utilities guide.

5 Test the custom filter.

See “Testing the example custom filter for configuring custom properties”on page 253.

6 Check the Dtrace log entries.

See “DTrace log entries for the example custom filter when configuring customproperties” on page 254.

Example ruleset file for configuring custom propertiesThe following example Default Filter Rules.xml file shows the filter rule required.This file must be located in the folder, Custom Filter Rules, in the EnterpriseVault installation folder (for example C:\Program Files (x86)\Enterprise

Vault\Custom Filter Rules).




<RULE NAME="MBX DIFF_RET_CAT" ACTION="ARCHIVE_ITEM"

CONTENTCATEGORY="MsgClassTest" RETENTION="180Day">

<NAMEDPROP TAG="MSGCLASS" INCLUDES="ANY">

<PROP VALUE="IPM.Appointment" />

</NAMEDPROP>

</RULE>

</RULE_SET>

Settings in the file are used as follows:

■ NAME="MBX DIFF_RET_CAT". This setting assigns a name to the rule. If Dtracelogging is enabled for the Exchange Mailbox task, the rule name is displayedwhen items are evaluated using this rule.

■ ACTION="ARCHIVE_ITEM" CONTENTCATEGORY="MsgClassTest"RETENTION="180Day". Items that match the rule are processed as follows:

■ The items are archived.

■ The settings that are defined in the content category, MsgClassTest, areapplied to the items. (The content category is defined in the file, CustomProperties.xml).

■ The existing retention category, 180Day, is applied to the items.

■ The <NAMEDPROP> element defines the message property and value to usewhen evaluating items using this rule.TAG="MSGCLASS" is the Enterprise Vault label for the property. This label isassigned to the associated MAPI property in Custom Properties.xml.INCLUDES="ANY". Any item with the property value shown matches the rule.<PROP VALUE="IPM.Appointment" />. When an item has a MSGCLASSproperty with the valueIPM.Appointment, then that item matches the rule.

Example custom properties fileThe content category, MsgClassTest, and the property, MSGCLASS, are definedin the following example Custom Properties.xml file. This file also defines howthe content category and property are presented in the specified application. CustomProperties.xml must be located in the folder, Custom Filter Rules, in theEnterprise Vault installation folder.



XMLSchema-instance" xsi:noNamespaceSchemaLocation=

"customproperties.xsd">


<CONTENTCATEGORIES DEFAULT="MsgClassTest">

<CONTENTCATEGORY NAME="MsgClassTest">

<INDEXEDPROPERTIES>

<PROPERTY TAG="MSGCLASS"/>


</CONTENTCATEGORY>


<CUSTOMPROPERTIES>

<NAMESPACE TYPE="MAPI">

<PROPERTY TAG="MSGCLASS" NAME="0x001A" />

</NAMESPACE>

</CUSTOMPROPERTIES>

<PRESENTATION>

<APPLICATION NAME="mysearch.asp" LOCALE="1033">

<FIELDGROUPS>

<FIELDGROUP LABEL="Content Category">

<FIELD TAG="MSGCLASS" LABEL="Message Class"

CATEGORY="MsgClassTest"/>

</FIELDGROUP>

</FIELDGROUPS>


<AVAILABLECATEGORY CONTENTCATEGORY="MsgClassTest"

LABEL="Message Class Test"/>


</APPLICATION>

</PRESENTATION>

</CUSTOMPROPERTYMETADATA>

Settings in the file are used as follows:

■ The <CONTENTCATEGORY> element defines the content category,MsgClassTest.In the <INDEXEDPROPERTIES> element, the <PROPERTY> element specifiesthat the MSGCLASS property is to be indexed when the content category isapplied to an item.

■ In the <PROPERTY> part of the <CUSTOMPROPERTIES> element, thestandard MAPI property (NAME="0x001A") is mapped to the Enterprise Vaultproperty tag (TAG="MSGCLASS").0x001A is the Identifier part (bits 16 to 31) of the hexadecimal MAPI tag for themessage class property.

■ The <PRESENTATION> element defines how the message class property isdisplayed in the application specified in the <APPLICATION> element. In this


example, NAME="mysearch.asp" identifies the search application. The languagefor this application (LOCALE) is US English.In the context of the search application, <FIELDGROUPS> identifies the newsearch criteria to be added to the search page. As the new property is to belisted under its associated content category, <FIELDGROUP LABEL="ContentCategory"> identifies the top level search criteria label. The properties to belisted when a particular content category is selected are identified by the <FIELD>settings. The <AVAILABLECATEGORIES> element identifies the contentcategories that can be selected. In this example, there is only one contentcategory, which has only one property.

Testing the example custom filter for configuring custompropertiesWe recommend that you test the custom filter on a development system; not onyour production Enterprise Vault server.

Before testing the custom filter, do the following:

■ Configure the registry settings to enable Exchange Server mailbox filtering.See “Configuring registry settings for Exchange Server mailbox custom filtering”on page 192.

■ In the Enterprise Vault Administration Console, configure an Exchange Mailboxpolicy to archive new items immediately.Click theMessage Classes tab, and ensure that IPM.Appointment* is selected.Check that the policy is assigned to the appropriate provisioning group.

■ In the Enterprise Vault Administration Console, create a new retention categorycalled 180Day.

■ Restart the Exchange Mailbox task in the Enterprise VaultAdministration Console,to apply the policy change and the changes in the ruleset file, Default Filter

Rules.xml.

To test the custom filter

1 Start Outlook and log in as the test user. Create a calendar appointment thatoccurred in the past. Ensure the appointment is not a recurring appointment,and does not have a reminder set.

2 Enable DTrace to trace the Exchange Mailbox task (set ArchiveTask v).

For instructions on how to configure DTrace logging, see the Utilities guide.

3 Run the Exchange Mailbox task to archive the new items, and then wait for afew minutes.


4 Check the entries in the DTrace log.

See “DTrace log entries for the example custom filter when configuring customproperties” on page 254.

5 Use Enterprise Vault Search to search for the appointment in the test user'sarchive.

On the Advanced search page, click Subject or Content and select a suitablecustom field for your property search. In that box enter the content categoryand property tag of the property that you want to search for. In the exampleabove you would select Custom Text Field and enterMsgClassTest.MSGCLASS. Select contains any of and enterAppointment.Search results show the item that matched the custom filter rule. This calendaritem should have the retention category 180Day.

You can customize the columns in Enterprise Vault Search to display the valueof the MsgClassTest.MSGCLASS property.

To display the custom property in the search results the attribute RETRIEVE="Y"must be included in the <INDEXEDPROPERTIES> element in the contentcategory definition in Custom Properties.xml.

See “About content categories” on page 238.

DTrace log entries for the example custom filter whenconfiguring custom propertiesThis section gives examples of the lines in the Dtrace log. The lines that are includedshow the archiving task loading the custom filter, evaluating the appointment item,and applying the rule actions.

In the DTrace log, lines similar to the following show that the example custom filterhas loaded successfully.

1167927 06:23:38.027 [6860] (ArchiveTask) <17472>

EV~I Event ID: 45329 External Filter 'EnterpriseVault.CustomFilter'

initialising... |

1167950 06:23:38.308 [6860] (ArchiveTask) <17472> EV-M

{CustomPropertiesDefinition} Loading Custom Properties from file:

\C:\PROGRAM FILES (X86)\ENTERPRISE VAULT\Custom Filter Rules\

Custom Properties.xml

1167951 06:23:38.308 [6860] (ArchiveTask) <17472> EV-L

{CustomPropertiesDefinition} Loading Custom Property definitions...

1167952 06:23:38.324 [6860] (ArchiveTask) <17472> EV-L

{CustomPropertiesDefinition} Adding property MSGCLASS [namespace=]

1167953 06:23:38.324 [6860] (ArchiveTask) <17472> EV-L

{CustomPropertiesDefinition} Adding content categories...


1167954 06:23:38.324 [6860] (ArchiveTask) <17472> EV-L

{CustomPropertiesDefinition} Adding category MsgClassTest

1167955 06:23:38.324 [6860] (ArchiveTask) <17472> EV-L

{CustomPropertiesDefinition} Default Category = MsgClassTest

1167956 06:23:38.339 [6860] (ArchiveTask) <17472> EV-L

{CustomPropertiesDefinition} Adding presentation applications...

1167957 06:23:38.339 [6860] (ArchiveTask) <17472> EV-L

{CustomPropertiesDefinition} Adding application search.asp

(Locale='1033')

1167958 06:23:38.339 [6860] (ArchiveTask) <17472> EV:M

[CustomXMLFilter] Setting DEFAULT Content Category to [MsgClassTest]

1167959 06:23:38.339 [6860] (ArchiveTask) <17472> EV:M

Adding External Filter 'EnterpriseVault.CustomFilter' to the list

for processing|

1167960 06:23:38.339 [6860] (ArchiveTask) <17472> EV:M

Successfully added External Filter 'EnterpriseVault.CustomFilter'|

Calling Initialize

1167961 06:23:38.339 [6860] (ArchiveTask) <17472> EV:M

[CustomXMLFilter] Custom Filter initialized on thread.

1167962 06:23:38.339 [6860] (ArchiveTask) <17472> EV:M

CEVFilterController::CreateFilterObject() (Exit) |Success [0] |

1167963 06:23:38.339 [6860] (ArchiveTask) <17472> EV:M

CEVFilterController::InitializeFiltersFromRegistry - MoveOnFilterFailure

RegKey: [0x00000000]

1167964 06:23:38.339 [6860] (ArchiveTask) <17472> EV:M

CEVFilterController::InitializeFiltersFromRegistry() (Exit) |Success [0] |

1167965 06:23:38.339 [6860] (ArchiveTask) <17472> EV:M

Successfully enabled external filtering

Lines similar to the following show the appointment is evaluated using the examplefilter rule, and matches:

1171158 06:23:49.996 [6860] (ArchiveTask) <17472> EV:H

[CustomXMLFilter] Custom Filter processing message 'test appointment'

1171159 06:23:49.996 [6860] (ArchiveTask) <17472> EV:L

...

1171161 06:23:49.996 [6860] (ArchiveTask) <17472> EV:H

[CustomRules][CRuleSet] Getting rule data...

...

1171164 06:23:50.058 [6860] (ArchiveTask) <17472> EV:H

[CustomXMLFilter] New RuleDataXML is now '<?xml version="1.0"

encoding="UTF-16"?> <RULE_DATA><DATATYPE NAME="NAMEDPROPERTIES">

<DATA NAME="TAG"><VALUE>MSGCLASS</VALUE> </DATA></DATATYPE>

</RULE_DATA>'


1171165 06:23:50.058 [6860] (ArchiveTask) <17472> EV:L

[CustomXMLFilter] GetMessageNamedProperties - XML RULE Data ='

<?xml version="1.0" encoding="UTF-16"?><RULE_DATA><DATATYPE NAME=

"NAMEDPROPERTIES"><DATA NAME="TAG"><VALUE>MSGCLASS</VALUE></DATA>

</DATATYPE></RULE_DATA>'

...

1171167 06:23:50.058 [6860] (ArchiveTask) <17472> EV:L

[CustomXMLFilter] GetMessageNamedProperties - Getting Tag =

'MSGCLASS' from custom properties

...

1171169 06:23:50.058 [6860] (ArchiveTask) <17472> EV:M

CEVFilterController::get_MessageClass - Returning

'Original Message Class' = IPm.Appointment

1171170 06:23:50.058 [6860] (ArchiveTask) <17472> EV:L

[CustomXMLFilter] Custom tag 'MSGCLASS' and name

'0x001A', set to IPm.Appointment

1171171 06:23:50.058 [6860] (ArchiveTask) <17472> EV:L

[CustomXMLFilter] Adding property 'PR_MESSAGE_CLASS (0x001a)'

to Items XML. [tag='MSGCLASS', value=

'IPm.Appointment']

1171172 06:23:50.058 [6860] (ArchiveTask) <17472> EV:L

[CustomRules][CRule] Evaluating item against MBX DIFF_RET_CAT rule...

1171173 06:23:50.058 [6860] (ArchiveTask) <17472> EV:L

[CustomRules][CNamedPropClause] testing against ANY of 1 NamedProps

1171174 06:23:50.058 [6860] (ArchiveTask) <17472> EV:L

[CustomRules][CNamedPropClause] : ipm.appointment MATCHED

ipm.appointment

1171175 06:23:50.058 [6860] (ArchiveTask) <17472> EV:L

[CustomRules][CNamedPropClause] match with test ''ipm.appointment''

1171176 06:23:50.058 [6860] (ArchiveTask) <17472> EV:L

[CustomRules][CNamedPropClause] Named prop clause: MSGCLASS MATCHED

ANY PROP Values

1171177 06:23:50.058 [6860] (ArchiveTask) <17472> EV:L

[CustomRules][CRule] Finished evaluating item against MBX DIFF_RET_CAT

rule; matches

Lines similar to the following show the example filter rule actions are applied to thetest message:

1171179 06:23:50.058 [6860] (ArchiveTask) <17472> EV:M

[CustomXMLFilter] Reading MBX DIFF_RET_CAT rule properties...

...

1171181 06:23:50.074 [6860] (ArchiveTask) <17472> EV:M

[CustomXMLFilter] Setting recognised ACTION to [1]


1171182 06:23:50.074 [6860] (ArchiveTask) <17472> EV:M

[CustomXMLFilter] Setting message content category to [MsgClassTest]

...

1171184 06:23:50.074 [6860] (ArchiveTask) <17472> EV:M

CEVFilterController::get_MessageClass - Returning

'Original Message Class' = IPm.appointment

...

1171187 06:23:50.074 [6860] (ArchiveTask) <17472> EV:L

[CustomXMLFilter] Adding property 'PR_MESSAGE_CLASS (0x001a)'

to index property set 'MsgClassTest' [tag='MSGCLASS',

value='IPm.appointment']

1171188 06:23:50.074 [6860] (ArchiveTask) <17472> EV:M

[CustomXMLFilter] Setting retention category to

[167A06CB31E01744F8500E3D54FC80BEC1b10000evsite]

1171189 06:23:50.074 [6860] (ArchiveTask) <17472> EV:M

Returning IndexedPropertiesSet = <?xml version="1.0"

encoding="UTF-16"?>|<ARCHIVED_ITEM xmlns:o="urn:kvsplc-com:

archived_item" version="1.0"><MSG><PROPSETLIST><PROPSET

NAME="MsgClassTest" SEARCH="y" RESULTS="y"><PROP NAME="MSGCLASS">

<VALUE>IPm.appointment</VALUE></PROP></PROPSET>

</PROPSETLIST></MSG></ARCHIVED_ITEM>|

1171190 06:23:50.074 [6860] (ArchiveTask) <17472> EV:M

Returning Create Shortcut = TRUE

1171191 06:23:50.074 [6860] (ArchiveTask) <17472> EV:M

Returning Delete Original = TRUE

1171192 06:23:50.074 [6860] (ArchiveTask) <17472> EV:M

Returning Vault Id = 1E5850B2EA77101459FCD56CBC4D3A5871110000evsite

1171193 06:23:50.074 [6860] (ArchiveTask) <17472> EV:M

Returning Retention Category = 167A06CB31E01744F8500E3D54FC80BEC

1b10000evsite

1171194 06:23:50.074 [6860] (ArchiveTask) <17472> EV:M

Returning Action = 1

1171195 06:23:50.074 [6860] (ArchiveTask) <17472> EV:L

CEVFilterController::FilteringCompleted() (Entry) |

1171196 06:23:50.074 [6860] (ArchiveTask) <17472> EV:M

CEVFilterController::FilteringCompleted() (Exit) |Success [0] |

...

1171200 06:23:50.089 [6860] (ArchiveTask) <17472> EV:M

EF: Item will be archived|Mailbox: /o=EV Training/

ou=First Administrative Group/cn=Recipients/cn=VSA|Folder: Calendar|

Message: test appointment

1171201 06:23:50.089 [6860] (ArchiveTask) <17472> EV:L

CArchivingAgent::ExternalFiltering() (Exit) |Success [0] |


1171202 06:23:50.089 [6860] (ArchiveTask) <17472> EV:M

CArchivingAgent::ProcessItemInternal - After call to ExternalFiltering.

RetentionCategory[167A06CB31E01744F8500E3D54FC80BEC1b10000evsite]

ArchiveId[1E5850B2EA77101459FCD56CBC4D3A5871110000evsite]

ContainingArchiveId[1DF2DFF131A9AFB4EB0B493648330C02B1110000evsite]

IndexedPropertiesSet[<?xml version="1.0" encoding="UTF-16"?>|

<ARCHIVED_ITEM xmlns:o="urn:kvsplc-com:archived_item" version="1.0">

<MSG><PROPSETLIST><PROPSET NAME="MsgClassTest" SEARCH="y" RESULTS="y">

<PROP NAME="MSGCLASS"><VALUE>IPm.appointment</VALUE>

</PROP></PROPSET></PROPSETLIST></MSG></ARCHIVED_ITEM>|]

MessageModified[FALSE] RetryCount[0] [0x00000000]


AActive Directory

Publishing the Outlook Add-In 65Advanced desktop policy settings

Exchange Server archiving 43Advanced mailbox policy settings

Exchange Server archiving 35Archiving

initially suspended, impact to users 61Archiving of journaled messages 111, 116

vault store group, vault store and partition 112

BBlacklistedDLs 212

CClient for Mac OS X

distributing 68Setting up Kerberos authentication for 69

Configuring OWAConfiguring Exchange Server 2010 CAS

proxy 161Content categories

introduction 180Custom filtering

ALLOWOTHERS operator 213assigning archive 208assigning retention category 207attachment filtering 207configuring 189default rules 197Dtrace log entries 254example of filtering on custom properties 250example ruleset file 250filtering attachments 222filtering messages 208filtering on DLs 210, 212filtering on message direction 217filtering on message subject 219format of ruleset files 202

Custom filtering (continued)how to test a custom filter 253INCLUDES operator 213introduction 180named ruleset files 197–198registry settings for Exchange journal filtering 191rule actions 205ruleset file example 227ruleset file schema 196ruleset files 195

Custom propertiesexample Custom Properties.xml file 251introduction 180, 231supported properties 231

Custom properties.xmlschema 196

Customized filters 232

DDatabase availability groups 25Deleted Attachments.txt file 208Desktop policies

Exchange Server archiving 36Download item age limit 83

EEnableMailboxMessage.msg 55Enabling mailbox

manually 58wizard 58

Enterprise Vaultconfiguring 116

Enterprise Vault OWA 2010 Extensionsinstalling 160

Enterprise Vault proxy serverconfiguring anonymous connections 170

Envelope Journaling 180Exchange Server 2010 journal report

decryption 118Exchange Server 2010 journal reports 118Exchange Server journal reports 117

Index

Exchange Desktop Policy PropertiesOptions tab 37

Exchange Journalingadding task 113

Exchange Serverdatabase availability groups 25

Exchange Server 2010journal report decryption 118

Exchange Server archivingadding a Provisioning Group 46adding an Exchange Server 46adding archiving targets 45Archive Usage Limit message 56automatic messages 55creating Organizational Forms folders 20customized shortcuts 52desktop policies 36enabling mailboxes 57installing Microsoft Exchange forms 22mailbox archiving task 49mailbox policies 27Microsoft Exchange forms 19ordering a Provisioning Group 48Organizational Forms Library 20Provisioning Task 49shared archives 58ShortcutText.txt layout 54starting Task Controller and archiving task 57updating desktop policies 23use of Personal Forms Libraries 20user tasks 61Welcome message 55

Exchange server archivingadding a domain 45

Exchange Server archiving desktop policyAdvance tab Deploy forms Locally 44Advanced tab 43General tab 36Options tab Outlook behavior settings 38Targets tab 45Vault Cache tab 40Web Applications tab 39

Exchange Server journal mailboxadding as a target 114

Exchange Server mailbox archivingAdvanced tab 35Archiving Actions tab 29Archiving Rules tab 28Existing Items tab 32

Exchange Server mailbox archiving (continued)General tab 28Indexing tab 33Message Classes tab 31Shortcut Content tab 30Shortcut Deletion tab 31Targets tab 35vault store group, vault store, and vault store

partition 25Exchange server mailbox archiving 25

FFiltering

Custom filtering 180Group journaling 180Selective journaling 179

GGroup journaling

configuring 185introduction 180registry settings 188rules file 186

IInstallation

Outlook Add-In 63, 66Internal addresses

Defining 219InternalSMTPDomains 219ISA Server 2006 177

configuring for Outlook Anywhere 178

JJournal archive

adding permissions 112creating 112

journal reports 117Journaling policy settings

review 114Journaling task

starting 115

KKerberos authentication

setting up for Client for Mac OS X 69

260Index

LLock for download item age limit 83

MMac OS X client

distributing 68Setting up Kerberos authentication for 69

Mail messagearchive limit messages 56

Mailboxenabling manually 58

Mailbox policiesExchange Server archiving 27

Manual archive inserts 83MAPI named properties 220Max archive requests per synchronization 89Max attempts to archive an item 90Max data archived per synchronization 90Max delete requests per synchronization 91Max item size to archive 91Max item updates per synchronization 92Max total size of contentless operations 92Max total size of items to archive 93Message classes 31, 104Microsoft Exchange Forms

distributing 19

OOffice Mail App 121

additional configuration 136client tracing 141deploying 125–126, 128–130, 132, 134, 141–142deploying to organization 143disabling

for device type 137for organization 138for user 138

features 122initial configuration 125policy settings and options 123PowerShell commands 126, 128–130, 132, 141–

142removing 138server tracing 141troubleshooting 140–145

Offline store required 84Organization Forms Library 20

Outlook Add-In 63distributing 63installing on a server 59Publishing in Active Directory 65

Outlook Anywhereconfiguration 163–164configuring client access 168

Outlook Cached Exchange Mode 70Outlook RPC over HTTP

configuration 163OVItemArchiveAttempts 90OVMaxItemArchivesPerSync 89OVMaxItemDeletesPerSync 91OVMaxItemUpdatesPerSync 92OVMaxMessageSizeToArchiveMB 91OVMaxToArchivePerSyncMB 90OVMaxTotalToArchiveMB 93OVPauseInterval 84OVPerItemSleep 84OVRequireOfflineStore 84OVRootDirectory 86OVRootDirectorySearchPath 86OVSetupWizard 87OVSyncArchiveTypes 87OWA

authentication 149configuration 149, 161configuration steps 151configuring Exchange Desktop Policy 156configuring for anonymous connections 153installing extensions 151

PPause interval 84Per item sleep 84Preemptive archiving in advance 85Preemptive caching 80PSTDisableGrow 59PSTDisableGrowAllowAuthenticodeOverrides 59Public folder archive

creating 100Public folder archiving 99

public folder policy 101settings 108vault store and vault store partition 100

Public folder archiving targets 106automatic method 107manual (standard) method 106

261Index

Public folder policy settings 101advanced settings 104archiving actions settings 103archiving rules settings 102general settings 102message classes settings 104shortcut deletion settings 105shortcut settings 103targets settings 104

Public Folder targetremoving 110

Public Folder taskadding 101scheduling 109

RRetention Category

none, impact to users 61Root folder 85Root folder search path 86RPC over HTTP

configuring an Enterprise Vault proxy server 169configuring the Enterprise Vault proxy server 169Enterprise Vault proxy server 166Exchange Desktop policy settings 173Outlook Anywhere 164

Ruleset file schema 205

SSelective journaling

configuring 181introduction 179invalid distribution lists 184registry settings 183rules file 181

Show content in Reading Pane 93Show Setup Wizard 86Synchronize archive types 87

TThreshold number of items to trigger

synchronization 94Threshold total size of items to trigger

synchronization 95

UUsers

getting started 70

Users (continued)starting Windows Search 71

Users can archive items 96Users can copy items to another store 96Users can copy items within their archive 97Users can hard delete items 97Users can reorganize items 98Users' desktops 62

VVault Cache 72

advanced settings 82content download 77content strategy 75control download requests 79preemptive caching 80setting up 81status 78synchronization 75, 77, 79wizard 80

Virtual Vault 72, 75advanced settings 87retention category changes 79setting up 81

VVAllowArchive 96VVAllowHardDelete 97VVAllowInterStoreCopyAndMove 96VVAllowIntraStoreCopy 97VVAllowReOrg 98VVAutoSyncItemsSizeThresholdMB 95VVAutoSyncItemThreshold 95VVDenyMultiContentlessOpsAboveMB 92VVReadingPaneContent 94

WWDS search auto-enable 87Welcome Message

editing 55location of 55

Windows Desktop SearchOverview 64

WizardEnable Mailboxes for Archiving 58

262Index

Documents

Setting up Exchange Server Archiving - Veritas · 2 ClickPolicies>Exchange>Mailbox. 3 Intherightpaneright-clickthepolicythatyouwanttosetasthedefaultpolicy, andselectSetasDefault