Enterprise Vault™ Administrator's Guide
- About this guide
- Managing administrator security
- Roles-based administration
- Working with predefined RBA roles
- Customizing RBA roles
- Day-to-day administration
- About Exchange mailbox archiving reports
- About starting or stopping tasks or services
- Monitoring journal mailboxes
- About monitoring disks
- About maintaining the SQL databases
- Using SQL AlwaysOn availability groups
- About managing vault store groups and sharing
- About managing safety copies
- About managing partition rollover
- About expiry and deletion
- Working with retention categories and retention plans
- Setting up retention folders
- Enabling archiving for new mailboxes
- About moving archives
- How Move Archive works
- About moving mailbox archives within a site
- About moving mailbox archives between sites
- About configuring Move Archive
- Running Move Archive
- Monitoring Move Archive
- PowerShell cmdlets for managing archives
- Using Enterprise Vault for records management
- Setting the default record type for users
- Common configuration scenarios
- Searching archives for items marked as records
- Automatically filtering events
- Managing indexes
- About the indexing wizards
- Managing indexing exclusions
- About the indexing PowerShell cmdlets
- Advanced Domino mailbox and desktop policy settings
- Editing the advanced settings for Domino mailbox and desktop policy
- Domino mailbox policy advanced settings
- Archiving General: Domino mailbox policy
- Archiving General: Domino mailbox policy
- Domino desktop policy advanced settings
- Advanced Exchange mailbox and desktop policy settings
- Editing the advanced Exchange mailbox and desktop settings
- Exchange mailbox policy advanced settings
- Archiving General (Exchange mailbox policy advanced settings)
- Archiving General (Exchange mailbox policy advanced settings)
- Exchange desktop policy advanced settings
- Office Mail App (Exchange desktop policy advanced settings)
- Outlook (Exchange desktop policy advanced settings)
- OWA versions before 2013 (Exchange desktop policy advanced settings)
- Vault Cache (Exchange desktop policy advanced settings)
- Virtual Vault (Exchange desktop policy advanced settings)
- Advanced Exchange journal policy settings
- Archiving General (Exchange journal policy advanced settings)
- Advanced Exchange public folder policy settings
- Archiving General (Exchange public folder policy advanced settings)
- Advanced SMTP policy settings
- Site properties advanced settings
- Editing site properties advanced settings
- Site properties advanced settings
- Content Conversion (site properties advanced settings)
- File System Archiving (site properties advanced settings)
- IMAP (site properties advanced settings)
- Indexing (site properties advanced settings)
- Skype for Business (site properties advanced settings)
- SQL Server (site properties advanced settings)
- SMTP (site properties advanced settings)
- Storage (site properties advanced settings)
- Content Conversion (site properties advanced settings)
- Computer properties advanced settings
- Editing computer properties advanced settings
- Computer properties advanced settings
- Agents (computer properties advanced settings)
- IMAP (computer properties advanced settings)
- Indexing (computer properties advanced settings)
- Storage (computer properties advanced settings)
- Task properties advanced settings
- Advanced Personal Store Management properties
- Classification policy advanced settings
- Managing the Storage queue
- Automatic monitoring
- About monitoring using Enterprise Vault Operations Manager
- About monitoring using MOM
- About monitoring using SCOM
- Managing extension content providers
- Exporting archives
- Enterprise Vault message queues
- Customizations and best practice
- Mailbox archiving strategies
- Notes on archiving based on quota or age and quota
- Notes on archiving items from Exchange Server 2010 managed folders
- About performance tuning
- Mailbox archiving strategies
- Failover in a building blocks configuration
- Appendix A. Ports used by Enterprise Vault
- Appendix B. Useful SQL queries
- Appendix C. Troubleshooting
- Installation problems
- Microsoft SQL Server problems
- Server problems
- Client problems
- Problems enabling or processing mailboxes
- Problems with Vault Cache synchronization
- Identifying and resolving Vault Cache issues on the Enterprise Vault server
- Identifying and resolving Vault Cache issues on an end-user computer
- Problems with Enterprise Vault components
- Troubleshooting: All tasks and services
- Troubleshooting: Directory service
- Troubleshooting: Exchange archiving or Journaling tasks
- Troubleshooting: Storage service
- Troubleshooting: Shopping service
- Troubleshooting: Web Access application
- Troubleshooting: All tasks and services
- Techniques to aid troubleshooting
- How to modify registry settings
- About moving an Indexing service
- Appendix D. Enterprise Vault accounts and permissions
Creating an XML file to define the attributes of retention folders
Enterprise Vault comes with a sample XML file, RetentionFoldersSample.xml
, which you can copy and modify as required. The file is in the Modules\EnterpriseVault
subfolder of the Enterprise Vault installation folder (for example, C:\Program Files (x86)\Enterprise Vault\Modules\EnterpriseVault
).
The following is an example of a typical XML file for defining the attributes of retention folders:
<?xml version="1.0" encoding="UTF-8"?> <RetentionFolderRoot> <RetentionFolder Name="Inbox" RetentionCategory="1-year" Expiry="Item" Inheritance="ThisFolderOnly"> <RetentionFolder Name="Legal" RetentionCategory="5-year" Expiry="Item" Inheritance="ThisFolderAndAllSubfolders" /> <RetentionFolder Name="Finance" RetentionCategory="2-year" Expiry="Folder" Inheritance="ThisFolderOnly" /> </RetentionFolder> <RetentionFolder Name="Inbox" RetentionCategory="1-year" Expiry="Item" Inheritance="AllSubfolders"/> <RetentionFolder Name="Business" RetentionCategory="2-year" Expiry="Item" Inheritance="ThisFolderOnly" > <RetentionFolder Name="2018" RetentionCategory="5-year" Expiry="Item" Inheritance="ThisFolderAndAllSubfolders" /> <RetentionFolder Name="2020" RetentionCategory="2-year" Expiry="Folder" Inheritance="AllSubfolders" /> <RetentionFolder Name="2020" RetentionCategory="1-year" Expiry="Folder" Inheritance="ThisFolderOnly" /> </RetentionFolder> </RetentionFolderRoot>
This file defines the attributes of two top-level retention folders, Inbox
and Business
, each of which contains two subfolders ("Legal" and "Finance", and "2018" and "2020"). In your own XML file, you can specify as many retention folders as you want.
Table: Retention folder attributes describes the attributes and required values that you must set for each retention folder that you want to create. All the attributes are mandatory.
Table: Retention folder attributes
Attribute | Specifies |
---|---|
Name | The name of the retention folder. This name can contain up to 255 characters, but these cannot include the character \. If a folder with the specified name already exists in the target archives, Enterprise Vault updates its retention settings to match those that you have defined in the XML file. Otherwise, Enterprise Vault creates the folder in the archives. You can specify multiple variants of the folder name to suit users who employ different languages. |
RetentionCategory | The name of an existing retention category to associate with the retention folder. The extent to which Enterprise Vault applies this retention category to the contents of the folder depends on how you set the Expiry and Inheritance attributes. |
Expiry | Whether the retention category that you have associated with the retention folder overrides the individual retention categories on the items in the folder. The options are as follows:
The Item and Folder values are case-sensitive. For example, you cannot specify Item as item or ITEM. |
Inheritance | The scope of the retention settings that you have defined for this folder. The options are as follows:
All three values are case-sensitive. For example, you cannot specify ThisFolderOnly as thisfolderonly. |