Skip to main content

SYS.Monitor.Health.Chart

Class SYS.Monitor.Health.Chart Extends (%Persistent, %XML.Adaptor) [ ClassType = persistent, ProcedureBlock, System = 3 ]

Storage for Health Monitor Sensor Charts. Each SensorObject may have multiple Charts for different time Periods.

Properties

PeriodID

Property PeriodID As %String [ Required ];

Owner Period

Sensor

Property Sensor As %String(MAXLEN = 250) [ Required ];

Sensor name

SensorItem

Property SensorItem As %String(MAXLEN = 250) [ Required ];

Sensor item

Mean

Property Mean As %String;

Sensor mean

Sigma

Property Sigma As %String;

Sensor standard deviation (sigma)

HighValue

Property HighValue As %String [ InitialExpression = 0, Required ];

Sensor High Value. The highest value during the Period

WarnValue

Property WarnValue As %String [ InitialExpression = 0, Required ];

Sensor Warn Value. An adjusted warning value based on High Value

AlertValue

Property AlertValue As %String [ Calculated ];

Sensor Alert Value. The value which will trigger an Alert.

Computed based on Sensor Object and runtime statistics.

WarningValue

Property WarningValue As %String [ Calculated ];

Sensor Warning Value. The value which will trigger a warning.

Computed based on Sensor Object and runtime statistics.

Readings

Property Readings As %List;

Sensor readings

Version

Property Version As %String(MAXLEN = 250) [ Required ];

Version

SampleMeans

Property SampleMeans As %List;

Sensor mean samples

SampleReadings

Property SampleReadings As %List;

Sensor readings samples

SensorObject

Relationship SensorObject As SYS.Monitor.Health.SensorObject [ Cardinality = one, Inverse = Charts ];

Columns for this table

Methods

SetChartStats

ClassMethod SetChartStats(pID As %String, sensor As %String, readings As %List, item As %String = "-", highvalue As %String = 0, warnvalue As %String = 0) As %Status

Set chart statistics based on list of values

CreateChart

ClassMethod CreateChart(pID As %String, sensor As %String, mean As %Numeric = "", sigma As %Numeric = "", readings As %List = "", item As %String = "-", high As %String = "", warn As %String = "") As %Status

Create a chart for a Period ID, sensor, and list of readings

%OnNew

Method %OnNew(pID As %String, sensor As %String, sensoritem As %String = "-", mean As %String, sigma As %String, readings As %List = "", highvalue As %String, warnvalue As %String, version As %String = "USER CHART") As %Status [ Private ]

Set the Chart properties

AlertValueGet

Method AlertValueGet() As %String

returns Alert value

WarningValueGet

Method WarningValueGet() As %String

returns Warning value