Example
XML settings file
An example XML settings
file, RtnFolderSettings.xml, is
installed in the Enterprise Vault folder.
The following example
shows the format of the XML settings file.
<?xml version="1.0" encoding="utf-8" ?>
<Policy>
<Apply>
<ApplyToSubFolders>1</ApplyToSubFolders>
<ArchiveThisFolder>1</ArchiveThisFolder>
<ArchiveSubFolders>0</ArchiveSubFolders>
<AutoUpdate>0</AutoUpdate>
</Apply>
<ArchivePoint>
<OnSubFolders>1</OnSubFolders>
<DoNotCreate>0</DoNotCreate>
</ArchivePoint>
</Policy>
The <Apply> element tags define how to apply the
policy, as specified in Table: <Apply> element tags for the
XML settings file.
Table: <Apply> element tags for the XML
settings file
Tag
|
Value
|
ApplyToSubFolders
|
0 - Apply the Retention Folder policy to top-level folders only
on the FSA target.
1 - Apply the Retention Folder policy to sub-folders under
top-level folders on the FSA target, but not to the top-level
folders on the FSA target.
|
ArchiveThisFolder
|
0 - Do not archive the folders that this Retention Folder policy
manages.
1 - Archive the folders that this Retention Folder Policy
manages.
|
ArchiveSubFolders
|
0 - Do not archive any folders in the Retention Folder hierarchy
that the Retention Folder policy does not manage.
1 - Archive all folders in the Retention Folder hierarchy, even
if the Retention Folder policy does not manage them.
|
AutoUpdate
|
0 - Do not apply the Retention Folder policy on new subfolders
that re created under top-level folders in the Retention Folder
hierarchy. This option is valid only if the tag ApplyToSubFolders
is 1.
1 - Apply the retention folder policy on any new subfolder that
are created under top-level folders in the Retention Folder
hierarchy. This option is valid only if the tag ApplyToSubFolders
is 1.
|
The <ArchivePoint> element tags define where to
create archive points, as specified in Table: <ArchivePoint> element tags
for the XML settings file.
Table: <ArchivePoint> element tags for the
XML settings file
Tag
|
Description
|
OnSubFolders
|
0 - Create an archive point on top-level folders in the
Retention Folder hierarchy. This option is valid irrespective of
the value of the tag ApplyToSubFolders.
1 - Create archive points on the sub-folders under top-level
folders in the Retention Folder hierarchy. This option is valid
only if the tag ApplyToSubFolders is 1.
|
DoNotCreate
|
0 - Use OnSubFolders tag value.
1 - Do not create an archive point. The administrator takes
responsibility for manually creating archive points. Alternatively,
if an archive point exists above the top-level folders in the
Retention Folder hierarchy, the archive is used for all folders in
the Retention Folder hierarchy.
|