Search <book_title>...

Veritas Enterprise Vault™ Utilities

Last Published: 2017-07-28

Product(s): Enterprise Vault (12.1)

About this guide
1. About Enterprise Vault utilities
2. Running the Enterprise Vault command-line utilities with administrator privileges
3. Where to get more information about Enterprise Vault
  1. Enterprise Vault training modules
ArchivePoints
1. About ArchivePoints
2. ArchivePoints syntax
3. ArchivePoints examples
Audit Viewer
1. About Audit Viewer
2. Using Audit Viewer to run a report on audit data
3. Copying the search results from Audit Viewer
4. Changing Audit Viewer settings
Backtrace
1. About Backtrace
2. Backtrace default settings
3. Backtrace registry values
4. Backtrace file name format
5. Backtrace examples
CenteraPing
1. About CenteraPing
2. CenteraPing syntax
Domino Archive Exporter
1. About Domino Archive Exporter
2. Domino Archive Exporter syntax
3. Domino Archive Exporter example
Domino Profile Document Tool
1. About Domino Profile Document Tool
2. Domino Profile Document Tool syntax
3. Domino Profile Document Tool examples
Domino Retention Plan Tool
1. About Domino retention plans
2. Domino Retention Plan Tool permissions
3. Defining a Domino retention plan
4. EVDominoRetentionPlans.exe syntax
DTrace
1. About DTrace
2. Running DTrace from the command line
3. Running DTrace from the Administration Console
4. About the DTrace log
5. DTrace troubleshooting
EVDominoExchangeMigration Tool
1. About the EVDominoExchangeMigration tool
2. Client requirements for the EVDominoExchangeMigration tool
3. Adding the EVDominoExchangeMigration tool to the Windows Server firewall exceptions list
4. EVDominoExchangeMigration tool and Binary Tree
5. Using Quest Notes Migrator for Exchange and the EVDominoExchangeMigration tool
6. Requirements for other migration software with the EVDominoExchangeMigration tool
7. Running the EVDominoExchangeMigration tool
EVDuplicateCleaner
1. About EVDuplicateCleaner
2. Prerequisites for EVDuplicateCleaner
3. Configuring EVDuplicateCleaner
4. Running EVDuplicateCleaner
5. Fixing broken shortcuts after you have run EVDuplicateCleaner
EVEARemovalUtility
1. About EVEARemovalUtility
2. EVEARemovalUtility prerequisites
3. Running EVEARemovalUtility
4. EVEARemovalUtility syntax
5. Format of the EVEARemovalUtility output and log files
6. EVEARemovalUtility usage examples
  1. EVEARemovalUtility example: processing a single file
  2. EVEARemovalUtility example: processing a folder and its subfolders
EVFSASetRightsAndPermissions
1. About EVFSASetRightsAndPermissions
2. Running EVFSASetRightsAndPermissions
EVrights
1. About EVrights
2. EVrights syntax
EVservice
1. About EVservice
2. EVservice prerequisites
3. EVservice syntax
4. EVservice list file format
EVSPShortcutManager
1. About EVSPShortcutManager
2. Permissions required to run EVSPShortcutManager
3. EVSPShortcutManager syntax
4. EVSPShortcutManager examples
EVSVR
1. About EVSVR
  1. About the checkpointing facility in EVSVR
  2. Note on performing EVSVR operations on CIFS and NTFS partitions
2. Starting EVSVR
3. EVSVR commands
4. EVSVR application states
5. Creating an EVSVR operation file
6. Editing an EVSVR operation file in which you have enabled checkpointing
7. Running an EVSVR operation
8. About the EVSVR operation settings
9. Using the output from one EVSVR operation as input for another operation
  1. About EVSVR item list files
  2. EVSVR operations that support item list processing
10. Viewing the EVSVR output log file
11. Running EVSVR in interactive mode
12. Improving EVSVR performance when processing CAB collections
FSARunNow
1. About FSARunNow
2. Running FSARunNow
3. FSARunNow syntax
4. FSARunNow examples
FSAUndelete
1. About FSAUndelete
2. Running FSAUndelete
3. FSAUndelete syntax
4. FSAUndelete examples
FSAUtility
1. About FSAUtility
2. Running FSAUtility
3. About using FSAUtility with EMC Celerra/VNX placeholders
  1. Configuring which API call FSAUtility uses to identify Celerra/VNX placeholders
  2. Example FSAUtility.exe.config file settings
4. FSAUtility options
NTFS to Centera Migration
1. About NTFS to Centera Migration
2. Managing migrator jobs using NTFS to Centera Migration
3. Creating migrator jobs using NTFS to Centera Migration
4. Deleting active jobs using NTFS to Centera Migration
5. Deleting source files after migration using NTFS to Centera Migration
6. NTFS to Centera Migration log files
Permissions Browser
1. About Permissions Browser
2. Running Permissions Browser
3. About the information that Permissions Browser provides
Policy Manager (EVPM)
1. About Policy Manager
2. Policy Manager syntax
3. Saving a Policy Manager initialization file as a Unicode file
4. Policy Manager initialization file syntax
5. Sections and keynames in Policy Manager initialization file
6. Policy Manager initialization file examples
7. About using the Provisioning API to run Policy Manager scripts
ResetEVClient
1. About ResetEVClient
2. ResetEVClient syntax
Vault Store Usage Reporter
1. About Vault Store Usage Reporter
2. Starting Vault Store Usage Reporter
3. Setting up a shortcut link to Vault Store Usage Reporter
4. Understanding the usage summary from Vault Store Usage Reporter
5. Checking that the IIS authentication method is correctly set for 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 MyPlans.xml:

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, Project X and Project Y.
Deletes a temporary retention folder called Test.

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 All Documents 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.