IRISLIB database
Manager Class Reference

Provides system management functions for the MONITOR and Application Monitor. More...

Inheritance diagram for Manager:
Collaboration diagram for Manager:

Static Public Member Functions

_.Library.Integer ClearSystemCounters (_.Library.Boolean System)
 Clear the current system MONITOR counters. More...
 
_.Library.String EmailSender (_.Library.String sender)
 Set email sender.
 
_.Library.Boolean EnableEmail (_.Library.Boolean enable)
 Email enabled.
 
_.Library.Integer Halt ()
 Halt the System monitor.
 
_.Library.String Interval (_.Library.Integer interval)
 Set sampling interval.
 
_.Library.Boolean IsActive ()
 Return summary active status: 0 - no active classes, else 1 (some active classes)
 
_.Library.List Recipients (_.Library.List recipients)
 Set email recipients.
 
_.Library.Integer Refresh ()
 Refresh the System Monitor.
 
_.Library.String SmtpPassword (_.Library.String passwd)
 Set email SMTP password.
 
_.Library.String SmtpServer (_.Library.String server)
 Set email SMTP Server name. More...
 
_.Library.String SmtpServerPort (_.Library.String port)
 Set email SMTP Server port. More...
 
 SmtpServerSSL (_.Library.String SSLConfig, _.Library.Boolean UseSTARTTLS)
 Set email SMTP SSLConfiguration and UseSTARTTLS (as defined in Net.SMTP). More...
 
_.Library.String SmtpUserName (_.Library.String name)
 Set email SMTP user name.
 
_.Library.Integer Start ()
 Start the System Monitor.
 
_.Library.Integer StartSystemCounters (_.Library.Boolean System, _.Library.Integer Processes, _.Library.Integer Routines, _.Library.Integer Globals, _.Library.Integer Network, _.Library.List ProcessList, _.Library.Integer Databases, _.Library.Boolean RtnLines)
 Enable the system MONITOR counters
More...
 
_.Library.Integer StopSystemCounters (_.Library.Boolean System)
 Stop the system MONITOR counters
More...
 
_.Library.String SystemCountersActive (_.Library.Boolean System)
 Check if the system MONITOR counters are currently active
More...
 
- Static Public Member Functions inherited from Adaptor
_.Library.Status XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
 Write the DTD to the current device for this XML enabled class serialized as. More...
 
_.Library.RegisteredObject XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
 Get an instance of an XML enabled class. More...
 
_.Library.Status XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
 Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...
 
_.Library.String XMLSchemaNamespace ()
 Get the namespace to which this class belongs for use in schema generation. More...
 
_.Library.Status XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
 Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Public Member Functions inherited from Adaptor
_.Library.Status XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
 Serialize an XML enabled class as an XML document and write. More...
 
_.Library.Status XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and appends it to a stream. More...
 
_.Library.Status XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and write it to a string. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 
- Static Public Attributes inherited from Adaptor
 ATTRIBUTEQUALIFIED = None
 ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...
 
 ELEMENTQUALIFIED = None
 ELEMENTQUALIFIED controls the format of exported XML. More...
 
 NAMESPACE = None
 NAMESPACE specifies the XML namespace to be used when projecting the. More...
 
 SUPPRESSTYPEPREFIX = None
 SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...
 
 XMLDEFAULTREFERENCE = None
 XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...
 
 XMLENABLED = None
 If this parameter is true then XML-enabling methods. More...
 
 XMLFORMAT = None
 The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNOREINVALIDTAG = None
 The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNORENULL = None
 XMLIGNORENULL allows the programmer to override the default XML handling. More...
 
 XMLINCLUDEINGROUP = None
 XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...
 
 XMLINHERITANCE = None
 If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...
 
 XMLNAME = None
 This parameter provides the default XMLNAME for the class. More...
 
 XMLNIL = None
 The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...
 
 XMLNILNOOBJECT = None
 The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...
 
 XMLPREFIX = None
 The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...
 
 XMLSEQUENCE = None
 If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...
 
 XMLSUMMARY = None
 The summary fields to be used when an object is referenced are specified. More...
 
 XMLTYPE = None
 This parameter provides the default XMLTYPE for the class. More...
 
 XMLUNSWIZZLE = None
 If the XMLUNSWIZZLE parameter is set to 1, then single object. More...
 
 XMLUSEEMPTYELEMENT = None
 If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...
 

Detailed Description

Provides system management functions for the MONITOR and Application Monitor.

Member Function Documentation

◆ ClearSystemCounters()

_.Library.Integer ClearSystemCounters ( _.Library.Boolean  System)
static

Clear the current system MONITOR counters.


System = 1 indicates to specifically clear the system level counters

◆ SmtpServer()

_.Library.String SmtpServer ( _.Library.String  server)
static

Set email SMTP Server name.

Returns current Server name (input argument is optional).

◆ SmtpServerPort()

_.Library.String SmtpServerPort ( _.Library.String  port)
static

Set email SMTP Server port.

Returns current Server port (input argument is optional).

◆ SmtpServerSSL()

SmtpServerSSL ( _.Library.String  SSLConfig,
_.Library.Boolean  UseSTARTTLS 
)
static

Set email SMTP SSLConfiguration and UseSTARTTLS (as defined in Net.SMTP).

Returns current SSLConfiguration and UseSTARTTLS (input arguments are optional).

◆ StartSystemCounters()

_.Library.Integer StartSystemCounters ( _.Library.Boolean  System,
_.Library.Integer  Processes,
_.Library.Integer  Routines,
_.Library.Integer  Globals,
_.Library.Integer  Network,
_.Library.List  ProcessList,
_.Library.Integer  Databases,
_.Library.Boolean  RtnLines 
)
static

Enable the system MONITOR counters


System = 1 to separately enable only system level counters (other parameters ignored)

Note that if System level counters are enabled separately, then they must also be specifically stopped or cleared separately (use System = 1 for the Stop() and Clear() methods)

Processes = the number of individual processes to collect counts for
Routines = the number of individual routines to collect counts for
Globals = the number of individual globals to collect counts for
Network = the number of individual network nodes to collect counts for
ProcessList = a $List of specific process IDs to collect counts for
Databases = the number of individual databases to collect counts for
RtnLines = choice of counting RtnLines metric (disabling this can reduce overhead)

Note that the MONITOR will allocate 'slots' for the number of processes, globals, routines and nodes you indicate. The first 'n' processes, routines, globals and nodes to increment the counters will take those slots, and all counts from other processes, globals, routines, and nodes will be added to the 'Other' slot. The maximum number of 'slots' for each collection is 65,535.
These counters are the same metrics as reported by the PERFMON utility. If you plan to view the data collected via ^PERFMON, you should ensure that the start time for calculating per/second data is properly set for ^PERFMON by running the $$Clear^PERFMON() function. This will reset the counters and start time.

◆ StopSystemCounters()

_.Library.Integer StopSystemCounters ( _.Library.Boolean  System)
static

Stop the system MONITOR counters


System = 1 indicates to specifically stop the system level counters (if those were started separately)

◆ SystemCountersActive()

_.Library.String SystemCountersActive ( _.Library.Boolean  System)
static

Check if the system MONITOR counters are currently active


Returns '0' if not active, or a positive integer if active.
A '1' indicates that PERFMON (or the SystemCounters in this class) are active.
A '2' indicates that SYS.MONLBL (or the Monitor.System.LineByLine class) is active.
If the 'System' parameter is included as '1', then this will also return a second comma-delimited piece indicating the status of the 'system-only' level counters documented above in the StartSystemCounters() method. So, a '1,1' means both PERFMON and the system-only counters are active, but have been started separately. A '1,0' means that just a PERFMON collection was started (which includes system-level counters, but they will be stopped when PERFMON is stopped).