System Class Reference

The <class>SYS.System</class> class provides an interface for managing utility functions. More...

Inheritance diagram for System:

Collaboration diagram for System:

Static Public Member Functions
_.Library.Status	ClearSwitch (_.Library.Integer switch)
	The <class>SYS.System</class> class provides an interface for managing utility functions. More...
_.Library.String	GetCPFFileName ()
	Returns the active CPF file name. More...
_.Library.Status	GetDefaultSignatureHash (_.Library.String defaultSignatureHash)
	Get the DefaultSignatureHash property from Security.System.
_.Library.String	GetInstanceName ()
	Returns instance name. More...
_.Library.String	GetNodeName (_.Library.Integer Flag)
	Returns the node name of the machine you are running on. More...
_.Library.String	GetUniqueInstanceName (_.Library.Integer Flag)
	Returns NodeName:InstanceName. More...
_.Library.String	InstanceGUID ()
	Returns instance GUID. More...
_.Library.Status	SetSwitch (_.Library.Integer switch)
	Set a switch on local system (error if switch is already set)
_.Library.String	TempDirectory ()
	Returns the location of the Temp directory, where temporary files are kept.
_.Library.Status	ToggleSwitch (_.Library.Integer switch, _.Library.Integer NewState)
	System Switches More...
_.Library.Status	WriteToConsoleLog (_.Library.String Message, _.Library.Integer Flag, _.Library.Integer Severity, _.Library.String Event)
	Write a message to the messages.log file. More...
_.Library.Status	WriteToMVLog (_.Library.String Message, _.Library.Integer Severity)
	Write a message to the mv.log file. More...

Detailed Description

The <class>SYS.System</class> class provides an interface for managing utility functions.

You can call help to get a list of all entrypoints:

Do $system.Util.Help()

Member Function Documentation

ClearSwitch()

_.Library.Status ClearSwitch ( _.Library.Integer  switch )

static

The <class>SYS.System</class> class provides an interface for managing utility functions.

You can call help to get a list of all entrypoints:

Do $system.Util.Help()

Clear a switch on local system (error if switch is already clear)

GetCPFFileName()

_.Library.String GetCPFFileName ( )

static

Returns the active CPF file name.

GetInstanceName()

_.Library.String GetInstanceName ( )

static

Returns instance name.

GetNodeName()

_.Library.String GetNodeName ( _.Library.Integer  Flag )

static

Returns the node name of the machine you are running on.

Parameters:
Flag = 0 (default) - Node name is the capitalized FQDN of the node, which will include the domain name.
For example:

HEARTOFGOLD.INTERNAL.COM<br>
Flag = 1 - Node name of the machine as defined in the O/S.
For example:

HeartOfGold

GetUniqueInstanceName()

_.Library.String GetUniqueInstanceName ( _.Library.Integer  Flag )

static

Returns NodeName:InstanceName.

This method returns the Node name of the system followed by a ":" followed by the Instance name. This name will be unique among InterSystems IRIS Instances in your network.
Parameters:
Flag = 0 (default) - Node name is the capitalized FQDN of the node, which will include the domain name.
For example:

HEARTOFGOLD.INTERNAL.COM:101U<br>
Flag = 1 - Node name does not contain the domain name.
For example:

HEARTOFGOLD:101U

InstanceGUID()

_.Library.String InstanceGUID ( )

static

Returns instance GUID.

An instance GUID is a 16 byte (128 bit) globally unique identifier, assigned per instance of InterSystems IRIS installation.

ToggleSwitch()

_.Library.Status ToggleSwitch ( _.Library.Integer  switch, _.Library.Integer  NewState  )

static

System Switches

Switches are used to inhibit certain kinds of processing while utilities such as Backups are being run.
Switches 8 & 9 may be of use for specialized customer applications:
Switch 8 - Inhibits responding to net requests
Switch 9 - Inhibits new network signons
The remaining switches are used to quiesce the system or provide a static environment for doing backups or examining the system
Switches 10, 12 and 13 are normally set the user is running backups
Switch 14 may be used to maintain application consistency or block contention
Switch 10 - Inhibits all global access except for the calling job
This switch is used with backups to coordinate with Transaction Processing. Use of this switch makes sure there are no transactions open when you clear the journal after you complete your backup. Switch 12 - Inhibit attempts to sign on Switch 13 - Inhibit sets, kills, and zsaves Switch 14 - Inhibit access to globals and routines
The following system functions for manipulating switches are provided:
Toggle a switch (from set to clear or clear to set) on local system
Set a switch on local system (error if switch is already set)
Clear a switch on local system (error if switch is already clear)

Toggle a switch (from set to clear or clear to set) on local system

WriteToConsoleLog()

_.Library.Status WriteToConsoleLog ( _.Library.String  Message, _.Library.Integer  Flag, _.Library.Integer  Severity, _.Library.String  Event  )

static

Write a message to the messages.log file.

Flag = 1 - write it to the operator console as well
Severity - severity of condition
Severity = -2 (Debug2), -1 (Debug), 0 (Information), 1 (Warning), 2 (Severe), 3 (Fatal)

WriteToMVLog()

_.Library.Status WriteToMVLog ( _.Library.String  Message, _.Library.Integer  Severity  )

static

Write a message to the mv.log file.

Severity = -2 (Debug2), -1 (Debug), 0 (Information), 1 (Warning), 2 (Severe), 3 (Fatal)