Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %SYSTEM.Config
Private  Storage   

%SYSTEM.Config


abstract class %SYSTEM.Config extends
Help

The $System.Config class provides methods to activate Cache configuration settings without restarting Cache. For the most part, these do not need to be called directly by customer code because configuration classes will call them when modifying configuration settings.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
11


Summary


Methods
Help ModifyConsoleFile ModifyDumpStyle ModifyLineRecallBuffer
ModifyLineRecallEntries ModifyMaxServers ModifyVMSConsoleTerminal ModifyWIJdir
ModifyZFSize ModifyZFString Modifybbsiz Modifynetjob


Methods


• classmethod ModifyConsoleFile() as %String
$SYSTEM.Config.ModifyConsoleFile(NewSetting) changes the console file. It returns the previous value of the Config.config.ConsoleFile setting.
$SYSTEM.Config.ModifyConsoleFile() with no argument returns the current value.
The input value will be modified to its canonic form.
• classmethod ModifyDumpStyle() as %Integer
$SYSTEM.Config.ModifyDumpStyle(NewSetting) changes the dumpstyle setting specified by the [Debug] section of cache.cpf for new processes. It returns the previous value of the dumpstyle setting.
$SYSTEM.Config.ModifyDumpStyle() with no argument returns the current value.
Consult "dumpstyle" in the Caché Parameter File Reference for valid values.
• classmethod ModifyLineRecallBuffer() as %Integer
$SYSTEM.Config.ModifyLineRecallBuffer(NewSetting) sets the default LineRecallBuffer size. This setting will apply to all new Cache processes which do not specify -h on the command line. It returns the previous value of the Config.config.LineRecallBuffer setting.
$SYSTEM.Config.ModifyLineRecallBuffer() with no argument returns the active value of the Config.config.LineRecallBuffer setting.
The value of LineRecallBuffer is 1024 out of the box. The input value will be modified to insure that it is within the range of permitted values and will be rounded up to a power of 2. See the configuration settings section for permitted values.
• classmethod ModifyLineRecallEntries() as %Integer
$SYSTEM.Config.ModifyLineRecallEntries(NewSetting) sets the default LineRecallEntries size. This setting will apply to all new Cache processes which do not specify -h on the command line. It returns the previous value of the Config.config.LineRecallEntries setting.
$SYSTEM.Config.ModifyLineRecallEntries() with no argument returns the active value of the Config.config.LineRecallEntries setting.
The value of LineRecallEntries is 32 out of the box. The input value will be modified to insure that it is within the range of permitted values. See the configuration settings section for permitted values.
• classmethod ModifyMaxServers() as %Integer
$SYSTEM.Config.ModifyMaxServers(NewSetting) will change the active Config.config.MaxServers setting. It returns the new active value of the Config.config.MaxServers setting.
$SYSTEM.Config.ModifyMaxServers() with no argument returns the current value.
This API works in conjunction with the Config.config class to determine how many ECP servers the Cache instance can access. Sufficient client network buffer and control structures are allocated during instance startup to support connection to Config.config.MaxServers ECP database servers. If the MaxServers setting is increased, the Config.config class will call $SYSTEM.Config.ModifyMaxServers() to activate the new maximum ECP database server setting. Additional client network buffer or control structures are allocated from the shared memory heap (SMheap) at this time if available and the new active number of ECP server structures is returned. An attempt to reduce MaxServers below the number allocated at startup or below the number actually in use will be ignored. If the Cache instance is restarted, buffers and control structures will be statically allocated to accomodate the Config.config.MaxServers setting. The $SYSTEM.Config.ModifyMaxServers() method is intended for use by InterSystems utilities and should not be called by customer code.
• classmethod ModifyVMSConsoleTerminal() as %String
$SYSTEM.Config.ModifyVMSConsoleTerminal(NewSetting) changes the console file. It returns the previous value of the Config.config.VMSConsoleTerminal setting.
$SYSTEM.Config.ModifyVMSConsoleTerminal() with no argument returns the current value.
If input value is "" no output will be made to a console terminal.
• classmethod ModifyWIJdir() as %String
$SYSTEM.Config.ModifyWIJdir(NewDirectory) modifies the active Config.config.wijdir setting and causes the Write Daemon to create and initializes the new CACHE.WIJ file. This Method does not modify the configuration file or the configuration object. It is not intended to be called from customer code. It will be called as a result of the wijdir being changed when the CONFIG.config object is saved. It returns the previous active value of the Config.config.wijdir.
It returns "" and does not change the active wij directory if a CACHE.WIJ file already exists in the target directory.
$SYSTEM.Config.ModifyWIJdir() with no argument returns the active value of the Config.config.wijdir setting.
• classmethod ModifyZFSize() as %Integer
$SYSTEM.Config.ModifyZFSize(NewSetting) sets the default zfheap allocation for Cache processes. This setting will apply to all new Cache processes. It returns the previous value of the Config.config.ZFSize setting.
$SYSTEM.Config.ModifyZFSize() with no argument returns the current value of the Config.config.ZFSize setting.
$SYSTEM.Config.ModifyZFSize(0) sets ZFSize to the default value.
The input value will be modified to insure that it is at least as large as the minimum permitted value, no larger than the the largest permitted value, and rounded up to an appropriate chunk size. See the configuration settings section for permitted values.
• classmethod ModifyZFString() as %Integer
$SYSTEM.Config.ModifyZFString(NewSetting) sets the amount of space allocated for values returned by callouts to external functions using $zf() It returns the previous value of the Config.config.ZFString setting.
$SYSTEM.Config.ModifyZFString() with no argument returns the current value.
$SYSTEM.Config.ModifyZFString(0) sets ZFString to the default value.
The input value will be modified to insure that it is at least as large as the minimum permitted value, no larger than the the largest permitted value, and rounded up to an appropriate chunk size. See the configuration settings section for permitted values.
• classmethod Modifybbsiz() as %Integer
$SYSTEM.Config.Modifybbsiz(NewSetting) sets the default maximum bbsize. This setting will apply to all new Cache processes. It returns the previous value of the Config.config.bbsiz setting.
$SYSTEM.Config.Modifybbsiz() with no argument returns the active value of the Config.config.bbsiz setting.
The input value will be modified to insure that it is at least as large as the minimum permitted value, no larger than the the largest permitted value, and rounded up to an appropriate chunk size. See the configuration settings section for permitted values.
• classmethod Modifynetjob() as %Integer
$SYSTEM.Config.Modifynetjob(NewSetting) sets the activate value of the Config.config.netjob setting to NewSetting. Valid values of NewSetting are 0 (disable) and 1 (enable). This method is intended for use by Cache utilities. It should not be called directly by customer code. It will be executed when the Config.config object is saved if the netjob setting has been modified.
$SYSTEM.Config.Modifynetjob() with no argument returns the active value of the Config.config.netjob setting.