Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [SYS] >  [Monitor] >  [Health] >  [SensorObject]
Private  Storage   

persistent class SYS.Monitor.Health.SensorObject extends %Persistent, %XML.Adaptor

Storage for Health Monitor Sensors. Each Sensor may have multiple Charts attached (for different time Periods) to evaluate when a Sensor deviates from 'normal' values.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 2 3 1


Summary

Properties
AlertValue Charts MaxMult Sensor Threshold
WarnMult WarnValue

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%OnNew %OnValidateObject %Open %OpenId
%OriginalNamespace %PackageName %PhysicalAddress %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%Save %SaveDirect %SaveIndices %SerializeObject
%SetModified %SortBegin %SortEnd %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %ValidateIndices
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType


Properties

• property AlertValue as %String [ InitialExpression = 0 ];
• relationship Charts as SYS.Monitor.Health.Chart [ Inverse = SensorObject,Cardinality = many ];
Container Group
• property MaxMult as %String [ InitialExpression = 0 ];
• property Sensor as %String [ Required ];
• property Threshold as %String [ InitialExpression = 0 ];
• property WarnMult as %String [ InitialExpression = 0 ];
• property WarnValue as %String [ InitialExpression = 0 ];

Methods

• method %OnNew(Sensor As %String, Threshold As %Integer = 0, MaxVal As %Integer = 0, MaxMult As %Integer = 0, WarnVal As %Integer = 0, WarnMult As %Integer = 0) as %Status
Set the Sensor properties. WarnValue and WarnMult are optional. If present, there must also be a corresponding AlertValue or MaxMult
• method %OnValidateObject() as %Status
This callback method is invoked by the %ValidateObject method to provide notification that the current object is being validated.

If this method returns an error then %ValidateObject will fail.


Queries

• query Sensors()
SQL Query :
SELECT Sensor,Threshold,AlertValue,MaxMult,WarnValue,WarnMult FROM SensorObject
A list of all sensors
• query SensorsMaxVal()
SQL Query :
SELECT Sensor,AlertValue,WarnValue FROM SensorObject WHERE AlertValue <> 0
A list of all sensors with a AlertValue defined
• query SensorsNotMaxVal()
SQL Query :
SELECT Sensor,Threshold,MaxMult,WarnMult FROM SensorObject WHERE AlertValue = 0
A list of sensors without AlertValue defined

Indices

•index (IDKEY on Sensor) [IdKey,PrimaryKey,Unique];


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