Enterprise Vault™ Utilities
- About this guide
- Audit Viewer
- Domino Archive Exporter
- Domino Profile Document Tool
- Domino Retention Plan Tool
- EVDominoExchangeMigration Tool
- Running the EVDominoExchangeMigration tool
- EVEARemovalUtility usage examples
- About EVSVR
- About the EVSVR operation settings
- Report operations in EVSVR
- Verify operations in EVSVR
- Repair operations in EVSVR
- Using the output from one EVSVR operation as input for another operation
- Viewing the EVSVR output log file
- Running EVSVR in interactive mode
- About using FSAUtility with Dell EMC Celerra/VNX placeholders
- FSAUtility options
- NTFS to Centera Migration
- Permissions Browser
- Policy Manager (EVPM)
- Sections and keynames in Policy Manager initialization file
- Policy Manager initialization file examples
- About using the Provisioning API to run Policy Manager scripts
- Provisioning API scripting properties for Policy Manager scripts
- Provisioning API Advanced settings for Policy Manager scripts
- Vault Store Usage Reporter
Defining a Domino retention plan
If you have previously created a retention plan XML file you can modify that file. If necessary, you can use the
EVDominoRetentionPlans.exe tool to extract the existing retention plans from Enterprise Vault to a file that you can edit. For example, the following command extracts the existing retention plans and saves them in the file
EVDominoRetentionPlans.exe -save MyPlans.xml
The Enterprise Vault program folder contains an example retention plan XML file called
Example RetentionPlans.xml, which you can copy and modify as required. This file defines two retention plans, All Users and Projects.
<RETENTIONPLAN NAME="All Users"> <FOLDER NAME="Retention Folders"> <FOLDER NAME="Business Records" RETCAT="Business"/> <FOLDER NAME="Customer Mails" RETCAT="Customers"/> </FOLDER> </RETENTIONPLAN> <RETENTIONPLAN NAME="Projects"> <FOLDER NAME="Retention Folders"> <FOLDER NAME="Business Records" RETCAT="Business"/> <FOLDER NAME="Customer Mails" RETCAT="Customers"/> <FOLDER NAME="Projects" ARCHIVENOW="true"> <FOLDER NAME="Project X" RETCAT="Project X"/> <FOLDER NAME="Project Y" RETCAT="Project Y"/> </FOLDER> <FOLDER NAME="Test" DELETE="true"/> </FOLDER> </RETENTIONPLAN>
Both retention plans create a retention folder called
Retention Folders, which has the following subfolders:
Business Records, which has a retention category of Business.
Customer Mails, which has a retention category of Customers.
In addition, the Projects retention plan does the following:
Creates a subfolder called
Projects. This subfolder has a setting of ARCHIVENOW="true" and two subfolders,
Deletes a temporary retention folder called
The XML file assigns the Projects retention plan to the Project Members provisioning group as follows:
<PROVISIONINGGROUPS> <DOMAIN NAME="ACME"> <GROUP NAME="Project Members" RETENTIONPLAN="Projects"/> <DEFAULT RETENTIONPLAN="All Users"/> </DOMAIN> </PROVISIONINGGROUPS>
Note the following:
To specify a standard folder or view, use the real name and not the displayed name. For example:
Use "($Inbox)" to specify the Inbox folder.
Use "($ToDo" to specify the Tasks view.
Use "($Calendar)" to specify the Calendar.
Use the FOLDER element to define both folders and views.
FOLDER elements can contain other FOLDER elements. This feature enables you to define a hierarchy of folders or views.
A parent folder's retention category applies to all its subfolders, unless specifically overridden for a particular folder.
If the ARCHIVENOW attribute is set to true, documents present in the folder are archived on the next run of the archive task.
If the ARCHIVENOW attribute is specified on a parent folder, it automatically applies to all subfolders, unless overridden at the subfolder level.
If the DELETE attribute is set to True, Enterprise Vault deletes the folder and all its subfolders provided that Enterprise Vault created the folder originally. The DELETE attribute removes all subfolders, even those that a user created. DELETE does not remove notes; the folder contents are still available in the view.
Optionally, you can specify a default plan for each domain. The default plan is applied if there is no plan for a provisioning group.
A retention plan cannot contain multiple entries for the same folder or view.
A provisioning group can have only one retention plan.
In the DOMAIN section, provisioning group names must be unique.
You can define some folder hierarchies that do not have retention categories assigned.