Class Ens.MonitorService

class Ens.MonitorService extends Ens.BusinessService

Monitor Service
Checks all hosts for inactivity

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	8	10

Summary

This is a Business Service class.

The associated Adapter class is Ens.InboundAdapter.

Properties
%AlertStartTime	%ConfigName	%ConfigQueueName
%LastActionTime	%LastHandledTime	%LastReportedError
%OutsideCreated	%PreserveSession	%ProcessInputCalled
%QuitTask	%RequestHeader	%SessionId
%SuperSession	%SuperSessionCreatedBeforeSession	%WaitForNextCallInterval
%WarnedLatest	%isShadow	ActorQueueStatement
Adapter	AlertGracePeriod	AlertGroups
AlertOnError	ArchiveIO	BusinessPartner
Config	GenerateSuperSessionID	IOLogEntry
InactivityTimeout	LastUpdate	QueueCounts
QueueDelays	SAMDefinitionClass	SAMDefinitionXData
ThrottleDelay	queueWaitResetPercentage

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified	%New
%NormalizeObject	%ObjectModified	%OnClose	%OnNew
%OriginalNamespace	%PackageName	%RemoveFromSaveSet	%SerializeObject
%SetModified	%SuperSessionSet	%ValidateObject	AdapterName
AssignOneSetting	CheckEnsRuntime	CloseIOLogEntry	EnumerateSettingsClose
EnumerateSettingsExecute	EnumerateSettingsFetch	ForceSessionId	GenerateSuperSession
GetDeferredResponseToken	GetMsgHdrRequestKey	GetProductionSettingValue	GetProductionSettings
GetPropertyConnections	GetSettings	GetShadowInstance	NewIOLogEntry
OnError	OnGenerateSuperSession	OnGetConnections	OnInit
OnKeepalive	OnMonitor	OnProcessInput	OnProductionStart
OnProductionStop	OnTearDown	PopulateSuperSession	Purge
QueueName	SaveIOLogEntry	SendAlert	SendDeferredResponse
SendRequestAsync	SendRequestSync

Parameters

• parameter ADAPTER = "Ens.InboundAdapter";

Use an adapter to make sure we get invoked.

• parameter SETTINGS = "SAMDefinitionClass:Alerting,SAMDefinitionXData:Alerting";

List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property ActorQueueStatement as %SQL.Statement;

• property Config [ MultiDimensional ];

• property LastUpdate as %String;

• property QueueCounts [ MultiDimensional ];

• property QueueDelays [ MultiDimensional ];

• property SAMDefinitionClass as %String [ InitialExpression = "Ens.SAM.SensorDefinitions" ];

Class that contains the XData JSON definition

• property SAMDefinitionXData as %String [ InitialExpression = "EnsMonitorService" ];

XData JSON definition name

• property queueWaitResetPercentage as %Numeric [ InitialExpression = ##class(Ens.MonitorService).getQWTPct(),Transient ];

Methods

• method CheckEnsRuntime()

Check local array is in sync with ^Ens.Runtime

• method OnInit() as %Status

This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()

• method OnProcessInput(pInput As %RegisteredObject, Output pOutput As %RegisteredObject) as %Status

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


[USER] > [Ens] > [MonitorService]		Private Storage