Home > Class Reference > ENSLIB namespace > Ens.Util.Tasks.PurgeMessageBank
Private  Storage   

Ens.Util.Tasks.PurgeMessageBank


class Ens.Util.Tasks.PurgeMessageBank extends %SYS.Task.Definition

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 2


Summary


Properties
%RunDate %RunTime BodiesToo KeepIntegrity
NumberOfDaysToKeep TypesToPurge

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
GetCollectionType GetPropertyName GetSettings GetTaskName
OnSubmit OnTask PurgeAll SetSettings


Properties


• property BodiesToo as %Boolean [ InitialExpression = 0 ];
Delete message bodies whenever their message header is deleted. This is off by default because some Productions may use message objects that are part of a larger environment and not transitory.
• property KeepIntegrity as %Boolean [ InitialExpression = 1 ];
Preserve messages not yet completely processed
• property NumberOfDaysToKeep as %Integer(MINVAL=0) [ InitialExpression = 7 ];
How many days of messages should not be purged
• property TypesToPurge as %String(DISPLAYLIST=",All Types,Events,Messages,Business Processes,Rule Logs,I/O Logs,Host Monitor Data,Message Bank Events,Message Bank Messages",VALUELIST=",all,events,messages,processes,rulelogs,iologs,hostcounters,message bank events,message bank messages") [ InitialExpression = "events",Required ];
The type of thing to purge

Methods


• method OnTask() as %Status
The OnTask() method is called to execute the task
• classmethod PurgeAll(pTypesToPurge As %String = "all", pNumberOfDaysToKeep As %Integer = 0, pBodiesToo As %Boolean = 1) as %Status
Purge the message store, and event log