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

Ens.Util.Tasks.PurgeMessageBank

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

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

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 methods: BodiesTooDisplayToLogical(), BodiesTooGet(), BodiesTooIsValid(), BodiesTooLogicalToDisplay(), BodiesTooNormalize(), BodiesTooSet()
property KeepIntegrity as %Boolean [ InitialExpression = 1 ];
Preserve messages not yet completely processed
Property methods: KeepIntegrityDisplayToLogical(), KeepIntegrityGet(), KeepIntegrityIsValid(), KeepIntegrityLogicalToDisplay(), KeepIntegrityNormalize(), KeepIntegritySet()
property NumberOfDaysToKeep as %Integer (MINVAL = 0) [ InitialExpression = 7 ];
How many days of messages should not be purged
Property methods: NumberOfDaysToKeepDisplayToLogical(), NumberOfDaysToKeepGet(), NumberOfDaysToKeepIsValid(), NumberOfDaysToKeepLogicalToDisplay(), NumberOfDaysToKeepNormalize(), NumberOfDaysToKeepSet()
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
Property methods: TypesToPurgeDisplayToLogical(), TypesToPurgeGet(), TypesToPurgeIsValid(), TypesToPurgeLogicalToDisplay(), TypesToPurgeLogicalToOdbc(), TypesToPurgeNormalize(), TypesToPurgeSet()

Methods (Including Private)

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

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)