Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%SYS] >  [Task] >  [PurgeAudit]
Private  Storage   

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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1 2


Summary

Properties
%RunDate %RunTime KeepDays

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
CheckPermission GetCollectionType GetPropertyName GetSettings
GetTaskName KeepDaysIsValid OnSubmit OnTask
SetSettings


Parameters

• parameter TaskName = "PurgeAudit";
This defines the user-visible name of this task. It is defined in the subclasses.

Properties

• property KeepDays as %Integer [ InitialExpression = 62 ];
Default purge of 2 months

Methods

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


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.