Config.config

persistent class Config.config extends %Library.Persistent, Config.CommonSingleMethods, Config.CommonProperties, %SYSTEM.Help [ Final ]

SQL Table Name: Config.config

This class allows you to modify and view the [config] 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 syntax to open and directly manipulate the config objects.

EXAMPLE:

; Use class methods to modify properties
%SYS>s Status=##Class(Config.config).Get(.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
%SYS>zw Properties("MaxServers")
Properties("MaxServers")=2
%SYS>s Properties("MaxServers")=3
%SYS>s Status=##Class(Config.config).Modify(.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now use Objects to modify properties
%SYS>s Obj=##Class(Config.config).Open()
%SYS>w Obj.MaxServers
3
%SYS>s Obj.MaxServers=4
%SYS>s Status=Obj.%Save()
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)

Property Inventory

Parameters

parameter PROPERTIESACTIVATENORESTART = bbsiz,ConsoleFile,LibPath,history,locksiz,MaxServers,netjob,PythonPath,PythonRuntimeLibrary,targwijsz,VMSConsoleTerminal,wijdir,ZFSize,ZFString;

List of properties which do not require a restart to activate

parameter PROPERTIESCOMBINEDINCPF = globals,console,memlock,overview,zfheap;

List of properties in the CPF file which are constructed from multiple different properties in this class.

parameter PROPERTIESMAYBEINCPF = Asyncwij,Edstrategy,maxglorecord,Maxprocesses,SecureKernel,synctype,usedirectio,useresidentmem,wdparm,wdstrategy,wduseasyncio;

List of properties which may or may not be in the CPF file.
They have a corresponding %Boolean property to determine if they are in the file or not. For example, the property "Asyncwij" will have a %Boolean "AsyncwijPresent" property associated with it.
These properties are for InterSystems use only.

parameter PROPERTIESNOTINCPF = BackoffDisabled,ConsoleFile,globals2kb,globals4kb,globals8kb,globals16kb,globals32kb,globals64kb,LargePagesDisabled,LargePagesRequired,LockSharedMemory,LockTextSegment,OsType,PageSizeAlt,Platform,synctypePresent,VMSConsoleTerminal,ZFString,ZFSize;

List of properties which are in the class but not in the CPF file.
These are properties which are combined with other properties to create a property in the CPF file.

Properties

property BackoffDisabled as %Boolean [ InitialExpression = 0 , Required ];

Upon failure to allocate memory, do not retry with a reduced amount. If shared memory cannot be allocated at its configured size, startup is aborted.

Makes up part of the CPF parameter memlock=

Modifying this property will require a restart of the system to make it active.

Property methods: BackoffDisabledDisplayToLogical(), BackoffDisabledGet(), BackoffDisabledGetStored(), BackoffDisabledIsValid(), BackoffDisabledLogicalToDisplay(), BackoffDisabledLogicalToXSD(), BackoffDisabledNormalize(), BackoffDisabledXSDToLogical()

property ConsoleFile as %SysPath (MAXLEN = 256, MINLEN = 0);

Location of the messages.log file.
Null means the MGR directory.
This is the second piece of the CPF parameter console=VMSConsoleTerminal,ConsoleFile

Modifying this property does not require a restart of the system to make it active.

Property methods: ConsoleFileDisplayToLogical(), ConsoleFileGet(), ConsoleFileGetStored(), ConsoleFileIsValid(), ConsoleFileLogicalToDisplay(), ConsoleFileLogicalToOdbc(), ConsoleFileNormalize()

property LargePagesDisabled as %Boolean [ InitialExpression = 0 , Required ];

If true, on platforms supporting large/huge pages, instructs the system not to use them for global and routine buffers.

Makes up part of the CPF parameter memlock=

Modifying this property will require a restart of the system to make it active.

Property methods: LargePagesDisabledDisplayToLogical(), LargePagesDisabledGet(), LargePagesDisabledGetStored(), LargePagesDisabledIsValid(), LargePagesDisabledLogicalToDisplay(), LargePagesDisabledLogicalToXSD(), LargePagesDisabledNormalize(), LargePagesDisabledXSDToLogical()

property LargePagesRequired as %Boolean [ InitialExpression = 0 , Required ];

If true, on platforms supporting large or huge pages, requires shared memory to be allocated from them. Ignored on other platforms or if large pages are disabled by LargePagesDisabled. If true and not ignored, and memory cannot be allocated in large/huge pages, startup is aborted. Note: startup may retry with a small reduction in memory size, but the extent to which memory may be reduced is smaller than would be allowed in absence of this flag. You can disable this retry altogether with BackoffDisabled.

Makes up part of the CPF parameter memlock=

Modifying this property will require a restart of the system to make it active.

Property methods: LargePagesRequiredDisplayToLogical(), LargePagesRequiredGet(), LargePagesRequiredGetStored(), LargePagesRequiredIsValid(), LargePagesRequiredLogicalToDisplay(), LargePagesRequiredLogicalToXSD(), LargePagesRequiredNormalize(), LargePagesRequiredXSDToLogical()

property LibPath as %String (MAXLEN = 1024);

On Unix systems this sets the LD_LIBRARY_PATH environment variable to set search paths for third-party shared libraries. Ignored on Windows and VMS.

Modifying this property does not require a restart of the system to make it active.

Property methods: LibPathDisplayToLogical(), LibPathGet(), LibPathGetStored(), LibPathIsValid(), LibPathLogicalToDisplay(), LibPathLogicalToOdbc(), LibPathNormalize(), LibPathSet()

property LockSharedMemory as %Boolean [ InitialExpression = 0 , Required ];

On platforms that support it, requests control structures, global and routine buffers to be locked in physical memory. When using large or huge pages for shared memory, there is no need to set this property since they are automatically locked in physical memory.

Makes up part of the CPF parameter memlock=.

Modifying this property will require a restart of the system to make it active.

Property methods: LockSharedMemoryDisplayToLogical(), LockSharedMemoryGet(), LockSharedMemoryGetStored(), LockSharedMemoryIsValid(), LockSharedMemoryLogicalToDisplay(), LockSharedMemoryLogicalToXSD(), LockSharedMemoryNormalize(), LockSharedMemoryXSDToLogical()

property LockTextSegment as %Boolean [ InitialExpression = 0 , Required ];

On some UNIX platforms, requests the text segment (executable image) to be locked in physical memory.

Makes up part of the CPF parameter memlock=

Modifying this property will require a restart of the system to make it active.

Property methods: LockTextSegmentDisplayToLogical(), LockTextSegmentGet(), LockTextSegmentGetStored(), LockTextSegmentIsValid(), LockTextSegmentLogicalToDisplay(), LockTextSegmentLogicalToXSD(), LockTextSegmentNormalize(), LockTextSegmentXSDToLogical()

property MaxServerConn as %Integer (MAXVAL = 254, MINVAL = 0) [ InitialExpression = 1 , Required ];

Maximum number of clients that can access this server simultaneously.

Modifying this property will require a restart of the system to make it active.

Property methods: MaxServerConnDisplayToLogical(), MaxServerConnGet(), MaxServerConnGetStored(), MaxServerConnIsValid(), MaxServerConnLogicalToDisplay(), MaxServerConnNormalize(), MaxServerConnSet(), MaxServerConnXSDToLogical()

property MaxServers as %Integer (MAXVAL = 254, MINVAL = 0) [ InitialExpression = 2 , Required ];

Maximum number of ECP servers that can be accessed from this system.

Modifying this property does not require a restart of the system to make it active if memory is available in the shared memory heap.

Property methods: MaxServersDisplayToLogical(), MaxServersGet(), MaxServersGetStored(), MaxServersIsValid(), MaxServersLogicalToDisplay(), MaxServersNormalize(), MaxServersSet(), MaxServersXSDToLogical()

property PythonPath as %String (MAXLEN = 1024);

Non instance relative sys.path element to be added to sys.path for all Embedded Python methods and Shell()
Also see iris_site.py (in the instance directory) and Embedded Python documentation for other ways to affect sys.path.

Modifying this property does not require a restart of the system to make it active.

Property methods: PythonPathDisplayToLogical(), PythonPathGet(), PythonPathGetStored(), PythonPathIsValid(), PythonPathLogicalToDisplay(), PythonPathLogicalToOdbc(), PythonPathNormalize(), PythonPathSet()

property PythonRuntimeLibrary as %String (MAXLEN = 1024);

Absolute path & file name of the python runtime library that you want Embedded Python to use to override the
default Embedded Python that Intersystems tests with.
Example on Ubuntu 22:
/lib/x86_64-linux-gnu/libpython3.11.so.1.0

Modifying this property does not require a restart of the system to make it active.

Property methods: PythonRuntimeLibraryDisplayToLogical(), PythonRuntimeLibraryGet(), PythonRuntimeLibraryGetStored(), PythonRuntimeLibraryIsValid(), PythonRuntimeLibraryLogicalToDisplay(), PythonRuntimeLibraryLogicalToOdbc(), PythonRuntimeLibraryNormalize(), PythonRuntimeLibrarySet()

property VMSConsoleTerminal as %SysPath (MAXLEN = 256, MINLEN = 0);

Location of the VMS console terminal.
This is the first piece of the CPF parameter console=VMSConsoleTerminal,ConsoleFile

Modifying this property does not require a restart of the system to make it active.

Property methods: VMSConsoleTerminalDisplayToLogical(), VMSConsoleTerminalGet(), VMSConsoleTerminalGetStored(), VMSConsoleTerminalIsValid(), VMSConsoleTerminalLogicalToDisplay(), VMSConsoleTerminalLogicalToOdbc(), VMSConsoleTerminalNormalize()

property ZFSize as %Integer (MAXVAL = 270336, MINVAL = 0) [ InitialExpression = 0 , Required ];

The total number of bytes allocated in virtual memory for $ZF input and output parameters, including strings.
This is the second piece of the CPF parameter zfheap=ZFString,ZFSize

Modifying this property does not require a restart of the system to make it active.

Property methods: ZFSizeDisplayToLogical(), ZFSizeGet(), ZFSizeGetStored(), ZFSizeIsValid(), ZFSizeLogicalToDisplay(), ZFSizeNormalize(), ZFSizeXSDToLogical()

property ZFString as %Integer (MAXVAL = 32767, MINVAL = 0) [ InitialExpression = 0 , Required ];

Number of bytes allocated for the each output byte array or string parameter on the $ZF heap.
This is the First piece of the CPF parameter zfheap=ZFString,ZFSize

Modifying this property does not require a restart of the system to make it active.

Property methods: ZFStringDisplayToLogical(), ZFStringGet(), ZFStringGetStored(), ZFStringIsValid(), ZFStringLogicalToDisplay(), ZFStringNormalize(), ZFStringXSDToLogical()

property bbsiz as %Integer (MAXVAL = 2147483647, MINVAL = 256) [ InitialExpression = -1 , Required ];

Maximum amount of memory in KB that a process can use for local variables and similar process-private application memory. This is the value of the $zstorage system special variable when a process starts up.

-1 means "unlimited" (limited only by the implementation maximum of ~2TB).

Modifying this property does not require a restart of the system to make it active.

Property methods: bbsizDisplayToLogical(), bbsizGet(), bbsizGetStored(), bbsizLogicalToDisplay(), bbsizNormalize(), bbsizSet(), bbsizXSDToLogical()

property console as %String (MAXLEN = 300) [ InitialExpression = "," , ReadOnly ];

CPF file representation of console=VMSConsoleTerminal,ConsoleFile.

Property methods: consoleDisplayToLogical(), consoleGet(), consoleGetStored(), consoleIsValid(), consoleLogicalToDisplay(), consoleLogicalToOdbc(), consoleNormalize()

property errlog as %Integer (MINVAL = 10) [ InitialExpression = 500 , Required ];

Maximum number of entries you want to store in the SYSLOG log file.
The log file will expire old entries when this limit is reached.

Modifying this property will require a restart of the system to make it active.

Property methods: errlogDisplayToLogical(), errlogGet(), errlogGetStored(), errlogIsValid(), errlogLogicalToDisplay(), errlogNormalize(), errlogSet(), errlogXSDToLogical()

property globals as %String [ InitialExpression = "0,0,0,0,0,0" , ReadOnly ];

List of configured sizes (in MBytes) for the global caches.
Element #1 corresponds to 2KB blocks (deprecated, always 0 now).
Element #2 corresponds to 4KB blocks.
Element #3 corresponds to 8KB blocks.
Element #4 corresponds to 16KB blocks.
Element #5 corresponds to 32KB blocks.
Element #6 corresponds to 64KB blocks.

If all values are zero, as they are by default, the system selects a value based on physical memory. This is designed so that newly installed system can perform reasonably well, and it is intended to be changed.

Property methods: globalsDisplayToLogical(), globalsGet(), globalsGetStored(), globalsIsValid(), globalsLogicalToDisplay(), globalsLogicalToOdbc(), globalsNormalize()

property globals16kb as %Integer (MINVAL = 0) [ InitialExpression = 0 ];

Number of 16KB buffers in MB.

Modifying this property will require a restart of the system to make it active.

Property methods: globals16kbDisplayToLogical(), globals16kbGet(), globals16kbGetStored(), globals16kbIsValid(), globals16kbLogicalToDisplay(), globals16kbNormalize(), globals16kbXSDToLogical()

property globals32kb as %Integer (MINVAL = 0) [ InitialExpression = 0 ];

Number of 32KB buffers in MB.

Modifying this property will require a restart of the system to make it active.

Property methods: globals32kbDisplayToLogical(), globals32kbGet(), globals32kbGetStored(), globals32kbIsValid(), globals32kbLogicalToDisplay(), globals32kbNormalize(), globals32kbXSDToLogical()

property globals4kb as %Integer (MINVAL = 0) [ InitialExpression = 0 ];

Number of 4KB buffers in MB.

Modifying this property will require a restart of the system to make it active.

Property methods: globals4kbDisplayToLogical(), globals4kbGet(), globals4kbGetStored(), globals4kbIsValid(), globals4kbLogicalToDisplay(), globals4kbNormalize(), globals4kbXSDToLogical()

property globals64kb as %Integer (MINVAL = 0) [ InitialExpression = 0 ];

Number of 64KB buffers in MB.

Modifying this property will require a restart of the system to make it active.

Property methods: globals64kbDisplayToLogical(), globals64kbGet(), globals64kbGetStored(), globals64kbIsValid(), globals64kbLogicalToDisplay(), globals64kbNormalize(), globals64kbXSDToLogical()

property globals8kb as %Integer (MINVAL = 0) [ InitialExpression = 0 ];

Number of 8KB buffers in MB.

Modifying this property will require a restart of the system to make it active.

Property methods: globals8kbDisplayToLogical(), globals8kbGet(), globals8kbGetStored(), globals8kbIsValid(), globals8kbLogicalToDisplay(), globals8kbNormalize(), globals8kbXSDToLogical()

property gmheap as %Integer (MAXVAL = 1073741760) [ InitialExpression = 0 , Required ];

Shared Memory Heap Size in KB.

The shared memory heap is a pool of memory within the large shared memory segment allocated at startup. It is used by many subsystems that require dynamic shared memory reservations (from within this fixed-size heap), including the lock table, dejournaling, NLS tables, and more.

A value of 0 (the default) allows the system to choose a value based on the sizing info inferred from other parameters, and is designed to be sufficient for most systems. Small non-zero values are subject to internal lower limits.

Modifying this property requires a restart of the system to make it active.

Property methods: gmheapDisplayToLogical(), gmheapGet(), gmheapGetStored(), gmheapLogicalToDisplay(), gmheapNormalize(), gmheapSet(), gmheapXSDToLogical()

property history as %Integer (MAXVAL = 1000, MINVAL = 0) [ InitialExpression = "500" , Required ];

The number of entries held in the command line/read line recall buffer.

Modifying this property does not require a restart of the system to make it active.

Property methods: historyDisplayToLogical(), historyGet(), historyGetStored(), historyIsValid(), historyLogicalToDisplay(), historyNormalize(), historySet(), historyXSDToLogical()

property ijcbuff as %Integer (MAXVAL = 8192, MINVAL = 512) [ InitialExpression = 512 , Required ];

Number of bytes allocated for each InterJob Communication Device.

Modifying this property will require a restart of the system to make it active.

Property methods: ijcbuffDisplayToLogical(), ijcbuffGet(), ijcbuffGetStored(), ijcbuffIsValid(), ijcbuffLogicalToDisplay(), ijcbuffNormalize(), ijcbuffSet(), ijcbuffXSDToLogical()

property ijcnum as %Integer (MAXVAL = 256, MINVAL = 0) [ InitialExpression = 16 , Required ];

The number of InterJob Communication devices.

Modifying this property will require a restart of the system to make it active.

Property methods: ijcnumDisplayToLogical(), ijcnumGet(), ijcnumGetStored(), ijcnumIsValid(), ijcnumLogicalToDisplay(), ijcnumNormalize(), ijcnumSet(), ijcnumXSDToLogical()

property jrnbufs as %Integer (MAXVAL = 1024, MINVAL = 8) [ InitialExpression = 64 , Required ];

Size of journal buffer pool in MBs. Modifying this property will require a restart of the system to make it active. The maximum value is 1024 and the minimum, 16 on Unicode platforms or 8 otherwise.

Property methods: jrnbufsDisplayToLogical(), jrnbufsGet(), jrnbufsGetStored(), jrnbufsLogicalToDisplay(), jrnbufsNormalize(), jrnbufsSet(), jrnbufsXSDToLogical()

property locksiz as %Integer (MAXVAL = 1099511562240) [ InitialExpression = 0 , Required ];

An upper bound on the amount of shared memory heap (see gmheap) that is allowed to be consumed by the lock table as a result of application-level locks. A value of 0 is appropriate for most systems, and allows the lock table to grow unlimited up to the available shared memory heap space as the application demands (lock memory can be freed to the Shared Memory Heap if it's no longer used). If a different value is selected, it acts as an upper limit in bytes.

Modifying this property does not require a restart of the system to make it active.

Property methods: locksizDisplayToLogical(), locksizGet(), locksizGetStored(), locksizLogicalToDisplay(), locksizNormalize(), locksizSet(), locksizXSDToLogical()

property memlock as %Integer [ InitialExpression = 0 , ReadOnly ];

When checked, this allows you to lock control structures in memory to improve access time.
CPF file representation of memlock=

Property methods: memlockDisplayToLogical(), memlockGet(), memlockGetStored(), memlockIsValid(), memlockLogicalToDisplay(), memlockNormalize(), memlockXSDToLogical()

property netjob as %Boolean [ InitialExpression = 1 , Required ];

Allows jobs from remote connections to run on your server.

Modifying this property does not require a restart of the system to make it active.

Property methods: netjobDisplayToLogical(), netjobGet(), netjobGetStored(), netjobIsValid(), netjobLogicalToDisplay(), netjobLogicalToXSD(), netjobNormalize(), netjobSet(), netjobXSDToLogical()

property nlstab as %Integer (MAXVAL = 64, MINVAL = 0) [ InitialExpression = 50 , Required ];

Enter the maximum number of collation tables. This instructs InterSystems IRIS to reserve space for that many tables at startup.

Modifying this property will require a restart of the system to make it active.

Property methods: nlstabDisplayToLogical(), nlstabGet(), nlstabGetStored(), nlstabIsValid(), nlstabLogicalToDisplay(), nlstabNormalize(), nlstabSet(), nlstabXSDToLogical()

property overview as %String [ InitialExpression = "Windows (Intel)~Windows" , ReadOnly ];

Property methods: overviewDisplayToLogical(), overviewGet(), overviewGetStored(), overviewIsValid(), overviewLogicalToDisplay(), overviewLogicalToOdbc(), overviewNormalize()

property pijdir as %SysPath (MAXLEN = 256, MINLEN = 0);

Directory to store the cluster image journal.

Modifying this property will require a restart of the system to make it active.

Property methods: pijdirDisplayToLogical(), pijdirGet(), pijdirGetStored(), pijdirIsValid(), pijdirLogicalToDisplay(), pijdirLogicalToOdbc(), pijdirNormalize(), pijdirSet()

property routines as %String [ InitialExpression = 0 , Required ];

Number of MB allocated for caching routine buffers.

Modifying this property will require a restart of the system to make it active.

Property methods: routinesDisplayToLogical(), routinesGet(), routinesGetStored(), routinesIsValid(), routinesLogicalToDisplay(), routinesLogicalToOdbc(), routinesNormalize(), routinesSet()

property targwijsz as %Integer (MINVAL = 0) [ InitialExpression = 0 , Required ];

When targwijsz is non-zero it is the desired size of the WIJ file in MB. The maximum effective value is the size of the buffer pool. While it would not hurt to have a larger WIJ, it does not help anything. The minimum value is 100MB. When the size of the global buffer pool is less than 100MB at startup the WIJ is sized to hold the entire buffer pool; the minimum size of the WIJ at startup is either 100MB or the size required to hold the entire buffer pool (which is slightly larger than the actual size of the buffer pool). If an existing WIJ is larger than the specified target, the size of the WIJ is not reduced.

When the target size is larger than the size of the existing WIJ, the system will expand the WIJ while the write daemon is idle up to the specified target (but not to exceed the actual size of the WIJ needed to hold the entire buffer pool). The system can expand the WIJ past the target size if that becomes necessary to complete a write cycle.

Leaving this value set to 0 is fine. The system will grow the WIJ as needed based on activity. Generally the WIJ quickly reaches whatever size is needed to support the activity level/the size of the buffer pool. The purpose of setting a target size is that if space has been reserved for the WIJ, setting a target allows the WIJ to grow to occupy that space early on in the life of the system. Since user activity can be blocked if the WIJ is too small (the WIJ will try to expand if this happens), setting the target may lead to a better user experience after startup. If the target is set to 0, the WIJ may quickly expand as needed however users may be blocked at times when this happens until the WIJ reaches the size required by the system.

Property methods: targwijszDisplayToLogical(), targwijszGet(), targwijszGetStored(), targwijszIsValid(), targwijszLogicalToDisplay(), targwijszNormalize(), targwijszSet(), targwijszXSDToLogical()

property udevtabsiz as %Integer (MAXVAL = 65535, MINVAL = 0) [ InitialExpression = 24576 , Required ];

Maximum size in bytes of the device table.

Modifying this property will require a restart of the system to make it active.

Property methods: udevtabsizDisplayToLogical(), udevtabsizGet(), udevtabsizGetStored(), udevtabsizIsValid(), udevtabsizLogicalToDisplay(), udevtabsizNormalize(), udevtabsizSet(), udevtabsizXSDToLogical()

property useresidentmem as %String (MAXLEN = 128, MINLEN = 0);

VMS system resident memory name.

Modifying this property will require a restart of the system to make it active.

Property methods: useresidentmemDisplayToLogical(), useresidentmemGet(), useresidentmemGetStored(), useresidentmemIsValid(), useresidentmemLogicalToDisplay(), useresidentmemLogicalToOdbc(), useresidentmemNormalize(), useresidentmemSet()

property wijdir as %SysPath (MAXLEN = 256, MINLEN = 0);

Enter the directory for the Write Image Journal file into this text box.

Modifying this property does not require an instance restart to activate the change except on cluster members.

Property methods: wijdirDisplayToLogical(), wijdirGet(), wijdirGetStored(), wijdirIsValid(), wijdirLogicalToDisplay(), wijdirLogicalToOdbc(), wijdirNormalize()

Methods

classmethod GetConsoleFileName(ByRef Status As %Status) as %String

Get the console.log file name being used by the system.
This will always return a filename. If a %Status error is returned, the name of the file returned will be $zu(12)_messages.log. Note that this will return the messages.log file the system currently has open, not the one which is defined in the CPF file and not yet activated.

classmethod Modify(ByRef Properties As %String, ByRef CPFFile As %String = "", Flags As %Integer = $$$CPFSave+$$$CPFWrite+$$$CPFActivate) as %Status

Modify a sections properties in a CPF file.

Parameters:
Properties (byref) - List of the properties to modify in Properties(Name)=Value format. See the subclass for a list of valid properties. If a specific property is not passed in the properties array, the value is not modified.
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file. The file must have a .CPF file extension if specified.
Flags - Bit string of options to perform if the object is later saved with the %Save() method. See the Open() method for values.

Return values:
CPFFile (byref) - Name of the CPF file the modification was made in.

classmethod NoRestartOnActivate(Property As %String) as %Boolean

Answers the question "Does the property require a restart?"

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.config)

^|"^^"_$ZU(12)|SYS("CONFIG")(ID)

Comments

Asyncwij

AsyncwijPresent

bbsiz

console

ConsoleFile

Edstrategy

EdstrategyPresent

errlog

globals

globals2kb

globals4kb

globals8kb

globals16kb

globals32kb

globals64kb

gmheap

history

ijcbuff

ijcnum

LibPath

LineRecallBuffer

LineRecallEntries

LockSharedMemory

LockTextSegment

locksiz

maxglorecord

maxglorecordPresent

Maxprocesses

MaxprocessesPresent

MaxServerConn

MaxServers

memlock

netjob

nlstab

OsType

overview

pijdir

Platform

routines

SecureKernel

synctype

synctypePresent

udevtabsiz

usedirectio

usedirectioPresent

useresidentmem

useresidentmemPresent

VMSConsoleTerminal

wdparm

wdparmPresent

wdstrategy

wdstrategyPresent

wduseasyncio

wduseasyncioPresent

wijdir

ZFSize

ZFString

zfheap

Path

jrnbufs

targwijsz

LargePagesDisabled

LargePagesRequired

BackoffDisabled

PageSizeAlt

SecureKernelPresent

PythonPath

PythonRuntimeLibrary