Config.Monitor

persistent class Config.Monitor extends %Library.Persistent, Config.CommonSingleMethods, Config.CommonProperties, %SYSTEM.Help

SQL Table Name: Config.Monitor

This class allows you to modify and view the [Monitor] section of the CPF file through programatic APIs. While properties are usually modified through the System Management portal, there may be some occasion where modifying them through the API's is best for your system. In all the Config methods, if you do not specify the CPFFile parameter, the currently active CPF file is used. If you wish to modify a CPF file which is not the currently active one, then specify the CPFFile you wish to modify in the method call.
The Flags parameter does not normally need to be specified; the defaults are usually sufficient for most cases.
You can use either the provided API's (Get/Modify) to modify the properties by passing in the correct parameters, or use Object sytax to open and directly manipulate the config objects.

EXAMPLE:

; Use class methods to modify properties
%SYS>s Status=##Class(Config.Monitor).Get(.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
%SYS>zw Properties
Properties("PatrolCollectionInterval")=30
Properties("PatrolDisplayMode")=0
Properties("PatrolEnabled")=0
Properties("PatrolTopProcesses")=20
Properties("SNMPEnabled")=0
Properties("WMIEnabled")=0
%SYS>s Properties("PatrolCollectionInterval")=40
%SYS>s Status=##Class(Config.Monitor).Modify(.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now use Objects to modify properties
%SYS>s Obj=##Class(Config.Monitor).Open()
%SYS>w Obj.PatrolCollectionInterval
40
%SYS>s Obj.PatrolCollectionInterval=60
%SYS>s Status=Obj.%Save()
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)

Property Inventory

Method Inventory

Properties

property SNMPEnabled as %Boolean [ InitialExpression = 0 , Required ];
Automatically starts the SNMP agent when the system is started.


Modifying this property will require a restart of the system to make it active.
Property methods: SNMPEnabledDisplayToLogical(), SNMPEnabledGet(), SNMPEnabledGetStored(), SNMPEnabledIsValid(), SNMPEnabledLogicalToDisplay(), SNMPEnabledLogicalToXSD(), SNMPEnabledNormalize(), SNMPEnabledSet(), SNMPEnabledXSDToLogical()

Methods

classmethod Load(Obj As %ObjectHandle = "", Flags As %Integer = 1) as %Status
Load the parameters into memory and activate.
Parameters:
Obj = Handle to the object which caused the load. If "", then load everything, only called from STU.
Flags = Type of modification.
0 - Modify
1 - Create/Insert

Indexes

index (CPFNameSectionHeaderName on CPFName,SectionHeader,Name) [IdKey, Type = key, Unique];
Index methods: CPFNameSectionHeaderNameCheck(), CPFNameSectionHeaderNameDelete(), CPFNameSectionHeaderNameExists(), CPFNameSectionHeaderNameOpen(), CPFNameSectionHeaderNameSQLCheckUnique(), CPFNameSectionHeaderNameSQLExists(), CPFNameSectionHeaderNameSQLFindPKeyByConstraint(), CPFNameSectionHeaderNameSQLFindRowIDByConstraint()

Inherited Members

Inherited Properties

Inherited Methods

Storage

Storage Model: Storage (Config.Monitor)

^|"^^"_$ZU(12)|SYS("CONFIG")(ID)
=
%%CLASSNAME
Comments
SNMPEnabled
Feedback