class Ens.Util.Tasks.PurgeMessageBank
extends %SYS.Task.Definition
• parameter RESOURCE = "%Ens_PurgeSchedule:USE";
This specifies a security resource and optional permission. Access to the resource
will be required to create, modify or run a task of this type.
The format is ":". If is ommited, "USE" is implied.
Note that this parameter cannot be overridden using the COSEXPRESSION parameter type.
• 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
• 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
