Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [Ens] >  [Util] >  [Tasks] >  [PurgeActivityData]
Private  Storage   

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 4 1


Summary

Properties
%RunDate %RunTime LengthOfPeriodToKeep PeriodToKeep
TableToPurge WriteCountInEventLog

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 OnSubmit OnTask SetSettings


Parameters

• 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.

Properties

• property LengthOfPeriodToKeep as %Integer(MINVAL=0) [ InitialExpression = 1 ];
Amount of period to purge
• property PeriodToKeep as %String(DISPLAYLIST=",Seconds,Minutes,Hours,Days,Weeks,Month,Year",VALUELIST=",s,mi,hh,d,wk,mm,yy") [ InitialExpression = "d" ];
Unit of period to purge
• property TableToPurge as %String(DISPLAYLIST=",Seconds Table,Hourly Table, Daily Table",VALUELIST=",s,hh,d") [ InitialExpression = "s" ];
Activity Table to purge
• property WriteCountInEventLog as %Boolean;

Methods

• method OnTask() as %Status
The OnTask() method is called to execute the task


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