Skip to main content


class Ens.MonitorService extends Ens.BusinessService

Monitor Service
Checks all hosts for inactivity

Property Inventory

Method Inventory


parameter ADAPTER = Ens.InboundAdapter;
Use an adapter to make sure we get invoked.
parameter SETTINGS = SAMDefinitionClass:Alerting,SAMDefinitionXData:Alerting;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property ActorQueueStatement as %SQL.Statement;
Property methods: ActorQueueStatementGet(), ActorQueueStatementGetSwizzled(), ActorQueueStatementIsValid(), ActorQueueStatementNewObject(), ActorQueueStatementSet()
property Config [ MultiDimensional ];
Property methods: ConfigDisplayToLogical(), ConfigGet(), ConfigIsValid(), ConfigLogicalToDisplay(), ConfigLogicalToOdbc(), ConfigNormalize(), ConfigSet()
property LastUpdate as %String;
Property methods: LastUpdateDisplayToLogical(), LastUpdateGet(), LastUpdateIsValid(), LastUpdateLogicalToDisplay(), LastUpdateLogicalToOdbc(), LastUpdateNormalize(), LastUpdateSet()
property QueueCounts [ MultiDimensional ];
Property methods: QueueCountsDisplayToLogical(), QueueCountsGet(), QueueCountsIsValid(), QueueCountsLogicalToDisplay(), QueueCountsLogicalToOdbc(), QueueCountsNormalize(), QueueCountsSet()
property QueueDelays [ MultiDimensional ];
Property methods: QueueDelaysDisplayToLogical(), QueueDelaysGet(), QueueDelaysIsValid(), QueueDelaysLogicalToDisplay(), QueueDelaysLogicalToOdbc(), QueueDelaysNormalize(), QueueDelaysSet()
property SAMDefinitionClass as %String [ InitialExpression = "Ens.SAM.SensorDefinitions" ];
Class that contains the XData JSON definition
Property methods: SAMDefinitionClassDisplayToLogical(), SAMDefinitionClassGet(), SAMDefinitionClassIsValid(), SAMDefinitionClassLogicalToDisplay(), SAMDefinitionClassLogicalToOdbc(), SAMDefinitionClassNormalize(), SAMDefinitionClassSet()
property SAMDefinitionXData as %String [ InitialExpression = "EnsMonitorService" ];
XData JSON definition name
Property methods: SAMDefinitionXDataDisplayToLogical(), SAMDefinitionXDataGet(), SAMDefinitionXDataIsValid(), SAMDefinitionXDataLogicalToDisplay(), SAMDefinitionXDataLogicalToOdbc(), SAMDefinitionXDataNormalize(), SAMDefinitionXDataSet()
property queueWaitResetPercentage as %Numeric [ InitialExpression = ##class(Ens.MonitorService).getQWTPct() , Transient ];
Property methods: queueWaitResetPercentageDisplayToLogical(), queueWaitResetPercentageGet(), queueWaitResetPercentageIsValid(), queueWaitResetPercentageLogicalToDisplay(), queueWaitResetPercentageNormalize(), queueWaitResetPercentageSet()


method CheckEnsRuntime()
Check local array is in sync with ^Ens.Runtime
method OnInit() as %Status
Inherited description: This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnProcessInput(pInput As %Library.RegisteredObject, Output pOutput As %Library.RegisteredObject, ByRef pHint As %Library.String) as %Status
Inherited description: Override this method to process incoming data. Do not call SendRequestSync/Async() from outside this method (e.g. in a SOAP Service or a CSP page).
method OnTearDown() as %Status
If collecting SAM data then remove last sample by this code. This is only needed if this sampler might not be running but the Production is.
This class is expected to be always running when the Production is running but is included here as an example.
classmethod Purge(Output pDeletedCount As %Integer, pDaysToKeep As %Integer = 7, pDummy As %Boolean) as %Status

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab