Class %Monitor.ItemGroup

persistent class %Monitor.ItemGroup extends %Persistent, %XML.Adaptor

Monitor Class definition

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	12	1	6	1

Summary

Properties
Activated	Application	ApplicationName	Description
GroupName	Index	Items	KeepHistory
MetricsClassName	Namespace	SampInterval	SampleClassName

Methods
%%OIDGet	%AddToSaveSet	%AddToSyncSet	%BMEBuilt
%BuildIndices	%CheckUnique	%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
%KillExtent	%KillExtentData	%LoadFromMemory	%LockExtent
%LockId	%New	%NormalizeObject	%ObjectModified
%Oid	%OnBeforeAddToSync	%OnDetermineClass	%Open
%OpenId	%OriginalNamespace	%PackageName	%PhysicalAddress
%PurgeIndices	%Reload	%RemoveFromSaveSet	%ResolveConcurrencyConflict
%RollBack	%Save	%SaveDirect	%SaveIndices
%SerializeObject	%SetModified	%SortBegin	%SortEnd
%SyncObjectIn	%SyncTransport	%UnlockExtent	%UnlockId
%ValidateObject	MetricsClassItemGroup	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType

Properties

• property Activated as %Boolean [ InitialExpression = 0 ];

Flag indicating if this item is activated for sampling

• relationship Application as %Monitor.Application [ Inverse = ItemGroup,Cardinality = parent ];

The application definition for this group

• property ApplicationName as %String(TRUNCATE=1) [ Required ];

Name of application for this table

• property Description as %String(MAXLEN=132,TRUNCATE=1);

User specified description of this table

• property GroupName as %String(TRUNCATE=1) [ Required ];

Name of this table

• property Index as %String(MAXLEN=132,TRUNCATE=1);

Comma separated list of index fields for this table

• relationship Items as %Monitor.Item [ Inverse = ItemGroup,Cardinality = children ];

Columns for this table

• property KeepHistory as %Boolean [ InitialExpression = 0 ];

Flag indicating if this item maintains a history

• property MetricsClassName as %String(MAXLEN=250,TRUNCATE=1) [ Required ];

Cache classname for the metrics class

• property Namespace as %String(MAXLEN=256);

Namespace in which the cache class definition resides

• property SampInterval as %Integer [ InitialExpression = 0 ];

Sample interval for the sample class

• property SampleClassName as %String(MAXLEN=250) [ Required ];

Cache classname for the sample class

Methods

• classmethod MetricsClassItemGroup(mclass As %String, ByRef id As %String) as %Status

Returns %ID for the ItemGroup for a Metrics Class

Queries

• query ActiveItemGroups()

SQL Query :
SELECT %ID FROM ItemGroup
WHERE (Activated = 1)

Get the names of active itemgroups

• query ApplicationItemGroups(app As %String)

SQL Query :
SELECT %ID, GroupName FROM ItemGroup
WHERE (Application->Name = :app)

Get itemgroups for an application

• query Classes()

SQL Query :
SELECT MetricsClassName,Activated,SampInterval FROM ItemGroup

Get the class names of all the itemgroups

• query Groups()

SQL Query :
SELECT GroupName FROM ItemGroup

Get the group names of all the itemgroups

• query ItemGroups()

SQL Query :
SELECT %ID FROM ItemGroup

Get all itemgroups in the system

Indices

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


[BASEXML] > [%Monitor] > [ItemGroup]		Private Storage