Skip to main content

SYS.Monitor.Health.Chart

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

SQL Table Name: SYS_Monitor_Health.Chart

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

Property Inventory

Method Inventory

Properties

property AlertValue as %String [ Calculated ];
Sensor Alert Value. The value which will trigger an Alert.

Computed based on Sensor Object and runtime statistics.

Property methods: AlertValueDisplayToLogical(), AlertValueIsValid(), AlertValueLogicalToDisplay(), AlertValueLogicalToOdbc(), AlertValueNormalize()
property HighValue as %String [ InitialExpression = 0 , Required ];
Sensor High Value. The highest value during the Period
Property methods: HighValueDisplayToLogical(), HighValueGet(), HighValueGetStored(), HighValueIsValid(), HighValueLogicalToDisplay(), HighValueLogicalToOdbc(), HighValueNormalize(), HighValueSet()
property Mean as %String;
Sensor mean
Property methods: MeanDisplayToLogical(), MeanGet(), MeanGetStored(), MeanIsValid(), MeanLogicalToDisplay(), MeanLogicalToOdbc(), MeanNormalize(), MeanSet()
property PeriodID as %String [ Required ];
Owner Period
Property methods: PeriodIDDisplayToLogical(), PeriodIDGet(), PeriodIDGetStored(), PeriodIDIsValid(), PeriodIDLogicalToDisplay(), PeriodIDLogicalToOdbc(), PeriodIDNormalize(), PeriodIDSet()
property Readings as %List;
Sensor readings
Property methods: ReadingsGet(), ReadingsGetStored(), ReadingsIsValid(), ReadingsLogicalToOdbc(), ReadingsLogicalToXSD(), ReadingsOdbcToLogical(), ReadingsSet(), ReadingsXSDToLogical()
property SampleMeans as %List;
Sensor mean samples
Property methods: SampleMeansGet(), SampleMeansGetStored(), SampleMeansIsValid(), SampleMeansLogicalToOdbc(), SampleMeansLogicalToXSD(), SampleMeansOdbcToLogical(), SampleMeansSet(), SampleMeansXSDToLogical()
property SampleReadings as %List;
Sensor readings samples
Property methods: SampleReadingsGet(), SampleReadingsGetStored(), SampleReadingsIsValid(), SampleReadingsLogicalToOdbc(), SampleReadingsLogicalToXSD(), SampleReadingsOdbcToLogical(), SampleReadingsSet(), SampleReadingsXSDToLogical()
property Sensor as %String (MAXLEN = 250) [ Required ];
Sensor name
Property methods: SensorDisplayToLogical(), SensorGet(), SensorGetStored(), SensorIsValid(), SensorLogicalToDisplay(), SensorLogicalToOdbc(), SensorNormalize(), SensorSet()
property SensorItem as %String (MAXLEN = 250) [ Required ];
Sensor item
Property methods: SensorItemDisplayToLogical(), SensorItemGet(), SensorItemGetStored(), SensorItemIsValid(), SensorItemLogicalToDisplay(), SensorItemLogicalToOdbc(), SensorItemNormalize(), SensorItemSet()
relationship SensorObject as SYS.Monitor.Health.SensorObject [ Inverse = Charts , Cardinality = one ];
Columns for this table
Property methods: SensorObjectGet(), SensorObjectGetObject(), SensorObjectGetObjectId(), SensorObjectGetStored(), SensorObjectGetSwizzled(), SensorObjectIsValid(), SensorObjectNewObject(), SensorObjectOnDelete(), SensorObjectRClose(), SensorObjectRExec(), SensorObjectRFetch(), SensorObjectRelate(), SensorObjectSQLCompute(), SensorObjectSet(), SensorObjectSetObject(), SensorObjectSetObjectId(), SensorObjectUnRelate(), SensorObjectUnSwizzle()
property Sigma as %String;
Sensor standard deviation (sigma)
Property methods: SigmaDisplayToLogical(), SigmaGet(), SigmaGetStored(), SigmaIsValid(), SigmaLogicalToDisplay(), SigmaLogicalToOdbc(), SigmaNormalize(), SigmaSet()
property Version as %String (MAXLEN = 250) [ Required ];
Version
Property methods: VersionDisplayToLogical(), VersionGet(), VersionGetStored(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()
property WarnValue as %String [ InitialExpression = 0 , Required ];
Sensor Warn Value. An adjusted warning value based on High Value
Property methods: WarnValueDisplayToLogical(), WarnValueGet(), WarnValueGetStored(), WarnValueIsValid(), WarnValueLogicalToDisplay(), WarnValueLogicalToOdbc(), WarnValueNormalize(), WarnValueSet()
property WarningValue as %String [ Calculated ];
Sensor Warning Value. The value which will trigger a warning.

Computed based on Sensor Object and runtime statistics.

Property methods: WarningValueDisplayToLogical(), WarningValueIsValid(), WarningValueLogicalToDisplay(), WarningValueLogicalToOdbc(), WarningValueNormalize()

Methods

method AlertValueGet() as %String
returns Alert value
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
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
method WarningValueGet() as %String
returns Warning value

Queries

query Charts()
SQL Query:
SELECT PeriodID,Sensor,SensorItem,Mean,Sigma,Version,%ID FROM Chart
A list of all charts
query ChartsByPeriod(period As %String)
SQL Query:
SELECT Sensor,SensorItem,Mean,Sigma,%ID,Version FROM Chart WHERE (PeriodID = :period)
A list of all charts for a period
query ChartsByPeriodSensor(period As %String, sensor As %String)
SQL Query:
SELECT PeriodID,Sensor,SensorItem,Mean,Sigma,%ID FROM Chart WHERE (Sensor = :sensor) AND (PeriodID = :period)
A list of all charts for a period and sensor
query ChartsByPeriodSensorItem(period As %String, sensor As %String, sensoritem As %String)
SQL Query:
SELECT PeriodID,Sensor,SensorItem,Mean,Sigma,%ID FROM Chart WHERE (Sensor = :sensor) AND (PeriodID = :period) AND (SensorItem = :sensoritem)
A list of all charts for a period, sensor, and sensor item
query ChartsBySensor(sensor As %String)
SQL Query:
SELECT PeriodID,Sensor,SensorItem,Mean,Sigma,%ID FROM Chart WHERE (Sensor = :sensor)
A list of all charts for a sensor
query ChartsBySensorItem(sensor As %String, sensoritem As %String)
SQL Query:
SELECT PeriodID,Sensor,SensorItem,Mean,Sigma,%ID FROM Chart WHERE (Sensor = :sensor) AND (SensorItem = :sensoritem)
A list of all charts for a sensor / item
query ChartsByVersion(ver As %String)
SQL Query:
SELECT %ID FROM Chart WHERE (Version = :ver)
A list of all charts for a version

Indexes

index (IDKEY on PeriodID,Sensor,SensorItem) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (SYS.Monitor.Health.Chart)

^ISC.Monitor.Health.ChartD(ID)
 =
%%CLASSNAME
Sensor
Mean
Sigma
Readings
PeriodID
SystemType
Version
SampleMeans
SampleReadings
Adjustable
Means
HighValue
SensorClass
SensorItem
AlertValue
SensorObject
WarnValue
FeedbackOpens in a new tab