abstract class Config.CPF
parameter DOMAIN = "%Utility";
Read and activate the current CPF file.
classmethod CPFFileNeedsActivation(ByRef Msg As %String)
This method will read the currently active CPF file if it has been updated on disk
but not yet read in. After the current settings have been read in, they are activated.
Returns 0/1 if the CPF file has been modified but not activated.
classmethod Convert(ByRef CPFFile As %String = "", Flags As %Integer = 0)
If it has been modified by an editor, an activation must occur before
any of the Config methods can be called to activate any additional changes.
Convert a CPF file to the current version.
classmethod PendingRestart(ByRef Reasons As %String)
This method will take a CPF file and convert it to the current version. Note that it will
not do any validation on the file, it will simply convert it.
CPFFile - CPF file to convert.
Flags - Internal use only, do not pass.
Determines if a restart of the system is required in order to
activate modified CPF parameters.
classmethod Validate(ByRef CPFFile As %String = "", Flags As %Integer = $$$ErrorTextToScreen, ByRef ErrorText As %String)
0 - Restart is not required
1 - Restart is required
Reasons - If a restart is required, an array of reasons why in the following format.
Reasons(1)="Restart required because section [xxx], property yyy modified, new value:zzz, old value:zzz"
Note that if the CPF file has been modified, but not yet activated, this
method will return 1, and the following array:
Reasons(1)="Restart or reactivation required because the CPF file xxxx has been modified, but not activated"
Validate a CPFFile.
classmethod Write(ByRef CPFFile As %String = "")
CPFFile - CPF file to validate.
Flags - Options for error text. Macros defined in %syConfig.inc.
Bit $$$ErrorTextToScreen - Write error text to terminal
Bit $$$ErrorTextToConsole - Write error text to messages.log
Bit $$$ErrorTextToArray - Return error text in ErrorText array
Write to the CPF file from the config object.
CPFFile - CPF file to write, default is currently active one.