Home > Class Reference > ENSLIB namespace > Ens.Activity.Operation.Base


abstract class Ens.Activity.Operation.Base extends Ens.BusinessOperation

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter SETTINGS = RecordStatsInterval;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties (Including Private)

property %Instance as %String (MAXLEN = 128) [ Private , InitialExpression = ##class(%SYS.System).GetUniqueInstanceName() , Transient ];
Property methods: %InstanceDisplayToLogical(), %InstanceGet(), %InstanceIsValid(), %InstanceLogicalToDisplay(), %InstanceLogicalToOdbc(), %InstanceNormalize(), %InstanceSet()
property %StatsInterval as %Integer [ Private , InitialExpression = ##class(Ens.Util.Statistics).StatsCounterInterval() , Transient ];
Property methods: %StatsIntervalDisplayToLogical(), %StatsIntervalGet(), %StatsIntervalIsValid(), %StatsIntervalLogicalToDisplay(), %StatsIntervalNormalize(), %StatsIntervalSet()
property FailureTimeout as %Numeric (MINVAL = -1) [ InitialExpression = -1 ];
How long to keep retrying before giving up and returning an error code.
-1 means never give up.
Property methods: FailureTimeoutDisplayToLogical(), FailureTimeoutGet(), FailureTimeoutIsValid(), FailureTimeoutLogicalToDisplay(), FailureTimeoutNormalize(), FailureTimeoutSet()
property RecordStatsInterval as %Numeric [ InitialExpression = 60 ];
How frequently the activity statistics should be moved into permanent storage.
0 means do not check. Default is 60 seconds.
Property methods: RecordStatsIntervalDisplayToLogical(), RecordStatsIntervalGet(), RecordStatsIntervalIsValid(), RecordStatsIntervalLogicalToDisplay(), RecordStatsIntervalNormalize(), RecordStatsIntervalSet()

Methods (Including Private)

method OnAddActivity(pStatsCategory As %String = "SC", pDays, pSeconds, pLocalTime, pUTC, pInstance, pNamespace, pHostType, pHostName, pUserDimension, pCount, pDuration, pQueueduration, pSquares) as %Status [ Language = objectscript ]
SubClass responsibility
Only return an error if expect a retry will be successful as returning an error will mean the temporary data is not deleted
Expected parameters are "SC",tLocalTime, tUTC, ..%Instance, tNamespace, tHostType, tHostName, tUserDimension, tCount, tDuration, tQueueDuration, tSquares
method OnInit() as %Status [ Language = objectscript ]
Inherited description: This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnKeepalive(pAdapterStatus As %Status) as %Status [ Language = objectscript ]
Inherited description: This method will be called within KeepaliveInterval of the last return from OnTask() or OnKeepalive(). It is called via the Adapter's OnKeepalive() method, which is called from the Host.OnTask() method; if there is no Adapter there is no keepalive call.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)