Skip to main content


SQL Table Name: Monitor.Sample

Defines persistent monitor sample class

Property Inventory

Method Inventory


parameter INDEX;
Table keys definition


property Application as %String [ Required ];
Application name for the sample
Property methods: ApplicationDisplayToLogical(), ApplicationGet(), ApplicationGetStored(), ApplicationIsValid(), ApplicationLogicalToDisplay(), ApplicationLogicalToOdbc(), ApplicationNormalize(), ApplicationSet()
property DateTime as %String;
Date and time of sample
Property methods: DateTimeDisplayToLogical(), DateTimeGet(), DateTimeGetStored(), DateTimeIsValid(), DateTimeLogicalToDisplay(), DateTimeLogicalToOdbc(), DateTimeNormalize(), DateTimeSet()
property GroupName as %String [ Required ];
Group name for the sample
Property methods: GroupNameDisplayToLogical(), GroupNameGet(), GroupNameGetStored(), GroupNameIsValid(), GroupNameLogicalToDisplay(), GroupNameLogicalToOdbc(), GroupNameNormalize(), GroupNameSet()
property InstanceKey as %String (MAXLEN = 500) [ Required ];
List of key values that identify a unique sample instance
Property methods: InstanceKeyDisplayToLogical(), InstanceKeyGet(), InstanceKeyGetStored(), InstanceKeyIsValid(), InstanceKeyLogicalToDisplay(), InstanceKeyLogicalToOdbc(), InstanceKeyNormalize(), InstanceKeySet()
property MetricsClass as %String (MAXLEN = 250);
Metrics Class for the sample
Property methods: MetricsClassDisplayToLogical(), MetricsClassGet(), MetricsClassGetStored(), MetricsClassIsValid(), MetricsClassLogicalToDisplay(), MetricsClassLogicalToOdbc(), MetricsClassNormalize(), MetricsClassSet()


method %OnNew(sample As Monitor.Sample, timestamp As %String) as %Status
Initialization method for sample data
classmethod Display(mclass As %String) as %Status
method DisplayCSP() as %Status
method DisplayDetails() as %Status
Display details of sample data for this item
classmethod NextKey(app As %String, group As %String, ByRef key As %List) as %Status
Next key value.
classmethod OnPage() as %Status
CSP page display
classmethod SampleDataItem(app As %String, group As %String, key As %List, ByRef id As %String) as %Status
Returns %ID for a sample data item NOTE: for a definition with no indexes (in Sample.InstanceKey) the 'key' value must be passed as $lb(" "). The %OnNew method above sets the space (" ") value in the InstanceKey, and the SQL query here won't find it if 'key' is passed as NULL. ^SNMP in particular uses this convention to get sample data with no secondary index.


query InstanceKeys(app As %String, group As %String)
SQL Query:
SELECT InstanceKey FROM Sample WHERE (Application = :app AND GroupName = :group) HAVING DateTime = MAX(DateTime)
Return the instance keys in their encoded format
query LatestSample(class As %String)
SQL Query:
SELECT %ID FROM Sample WHERE MetricsClass = :class HAVING DateTime = MAX(DateTime)
Query to return all sample data id's for a particular application, group


index (IdKey on Application,GroupName,InstanceKey) [IdKey, Type = key];
Idkey index for samples
Index methods: IdKeyCheck(), IdKeyDelete(), IdKeyExists(), IdKeyOpen(), IdKeySQLCheckUnique(), IdKeySQLExists(), IdKeySQLFindPKeyByConstraint(), IdKeySQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: Storage (Monitor.Sample)



FeedbackOpens in a new tab