Class Reference
Cache for UNIX 2018.1
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage  

abstract class %SYS.System extends %SYSTEM.Help

The %SYS.System class provides an interface for managing Caché utility functions.

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

Do $system.Util.Help()

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
15


Summary

Methods
ClearSwitch GetCPFFileName GetDefaultSignatureHash GetInstanceName
GetNodeName GetUniqueInstanceName Help InstanceGUID
SetSwitch TempDirectory ToggleSwitch WriteToConsoleLog
WriteToMVLog


Methods

• classmethod ClearSwitch(switch As %Integer) as %Status
Clear a switch on local system (error if switch is already clear)
• classmethod GetCPFFileName() as %String
Returns the active CPF file name.
• classmethod GetDefaultSignatureHash(defaultSignatureHash As %String) as %Status
Get the DefaultSignatureHash property from Security.System
• classmethod GetInstanceName() as %String
Returns instance name.
• classmethod GetNodeName(Flag As %Integer = 0) as %String
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:

CACHENODE.INTERNAL.COM

Flag = 1 - Node name of the machine as defined in the O/S.
For example:

CacheNode
• classmethod GetUniqueInstanceName(Flag As %Integer = 0) as %String
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 Cache 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:

CACHENODE.INTERNAL.COM:101U

Flag = 1 - Node name does not contain the domain name.
For example:

CACHENODE:101U
• classmethod InstanceGUID() as %String
Returns instance GUID.
An instance GUID is a 16 byte (128 bit) globally unique identifier, assigned per instance of Cache installation.
• classmethod SetSwitch(switch As %Integer) as %Status
Set a switch on local system (error if switch is already set)
• classmethod TempDirectory() as %String
Returns the location of the Temp directory, where temporary files are kept.
• classmethod ToggleSwitch(switch As %Integer, NewState As %Integer) as %Status
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
• classmethod WriteToConsoleLog(Message As %String, Flag As %Integer = 0, Severity As %Integer = 0) as %Status
Write a message to the cconsole.log file.
Flag = 1 - write it to the operator console as well
Severity - severity of condition
Severity = 0 (Information), 1 (Warning), 2 (Severe), 3 (Fatal)
• classmethod WriteToMVLog(Message As %String, Severity As %Integer = 0) as %Status
Write a message to the mv.log file.
Severity = 0 (Information), 1 (Warning), 2 (Severe), 3 (Fatal)


Copyright © 1997-2018 InterSystems Corporation, Cambridge, MA