Setting and updating autoarchive rules using IDAPI

To add or update autoarchive rules for an existing file or folder, use the SetArchiveRules, AddArchiveRules, or RemoveArchiveRules suboperations of UpdateFile. Each of these suboperations has an ArchiveRule element.

Table 13‑1 ArchiveRule elements
Element	Description
ArchiveOnExpiration	True if you want to archive the file before the system deletes it.
ExpirationAge	The number of minutes before expiration. If you set ExpirationAge, you cannot set ExpirationTime.
ExpirationTime	The time of day for the expiration. If you set ExpirationTime, you cannot set ExpirationAge.
ExpireDependentFiles	True if dependent files expire with the original file.
FileType	The file type to which the rule applies. To set the rule for a folder and its subfolders, specify Directory.
InheritedFrom	The source of an inherited rule.
IsInherited	True if the item inherits archiving rules. If this element is True, the system ignores all other elements except FileType.
NeverExpire	True if the file does not have an expiration date or expiration age. If this element is True, the system ignores ExpirationAge and ExpirationTime.

Use the SetParameters suboperation to change the autoarchive rules for the job output file. You can change the following archive-related elements of SetParameters, described in Table 13‑2.

Table 13‑2 Archive-related elements of SetParameters
Element	Description
ArchiveOnExpire	True if you want to archive the file before the system deletes it
ArchiveRuleInherited	Indicates whether the job output file inherits archive rules
ExpirationAge	The number of minutes before the output file expires
ExpirationDate	The date on which the output file expires
NeverExpire	True if the file does not have an expiration date or expiration age