ArchivePoints syntax

ArchivePoints action archive_point_path_share_name 
[subfolders|nosubfolders] [template_XML_file_path_name] 
[folder_to_autoenable <on|off [subfolderdelete]>]

where:

action

Specifies the action to perform. This action can be one of the following:

  • autoenable. Makes the archiving task create an archive point for each new, immediate subfolder of the nominated folder. When new subfolders are added, the archiving task automatically creates a new archive point for each subfolder.

    This can be useful when you have a folder that contains one subfolder for each of a number of users. When you select this option, a new archive is created automatically for each user's folder.

  • create. Creates the archive points.

  • delete. Deletes the archive points.

  • find. Lists all the archive points beneath the specified network share.

  • read. Displays the contents of the archive points.

  • update. Updates the archive points on the specified folders with the contents of template_XML_file. template_XML_file is a mandatory parameter when you use Update.
archive_point_ path_share_name

Specifies the UNC path to the network share to which the command applies.
subfolders| nosubfolders

For create actions only, specifies whether the action applies to each subfolder in the specified network share. The default is nosubfolders.
template_XML_file _path_name

Specifies the full path to an XML template file with which you can override the following attributes when you create an archive point:

  • name. Specifies the archive name.

  • description. Specifies the archive description.

  • owner. Specifies the account to use when billing archive usage.

  • indexDisabled. Specifies whether to disable (True) or enable (False) indexing for the files in the network share. By default, indexing is enabled.

  • indexingLevel. Specifies the indexing level.

  • deleteExpiredItems. Specifies whether automatically to delete expired items from the archive.

  • prefix. Specifies a prefix to add to the start of the archive name. The remainder of the archive name is taken either from the Name attribute, if present, or the folder name.

For example, the following file overrides all the default attributes when you create an archive point:

<archivePoint 
xmlns="urn:kvsplc-com:FileSystemFolderArchivePoint">   

	<name>Newton archive</name>
	<description>Isaac Newton's User Archive</description>
	<owner>astronomy\newtoni</owner>
	<indexDisabled>False</indexDisabled>
	<indexingLevel>brief</indexingLevel> 				
	<deleteExpiredItems>false</deleteExpiredItems>
	<prefix>User 
</prefix></archivePoint>
folder_to_ autoenable

Specifies the full path to the folder for whose immediate subfolders you want to auto-enable archive points.
<on|off [subfolderdelete]>

Specifies whether to switch the auto-enable property of a folder on or off . If you choose to switch off this property then, with the subfolderdelete option, you can also choose to delete the archive points from all the immediate subfolders.