This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


class %SYS.Task.PurgeAudit extends %SYS.Task.Definition

This task is schedule to run daily after the journal switch (by default At Midnight) The default purge is 2 months (62 days) but can be changed by setting KeepDays to another value in the System Managment Portal.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter TaskName = PurgeAudit;
Inherited description: This defines the user-visible name of this task; This is defined in subclasses.


property KeepDays as %Integer [ InitialExpression = 62 ];
Default purge of 2 months
Property methods: KeepDaysDisplayToLogical(), KeepDaysGet(), KeepDaysIsValid(), KeepDaysLogicalToDisplay(), KeepDaysNormalize(), KeepDaysSet()


classmethod KeepDaysIsValid(KeepDays As %Integer) as %Status
Validate KeepDays value
method OnTask() as %Status
Default purge code

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)