persistent class Config.MapShadows
extends %Persistent, Config.GenericMapMethods, Config.GenericMapProperties, %SYSTEM.Help
This class allows you to modify and view global mappings in the [Map.xxx] 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 (Create/Get/Modify/Delete) to modify the properties by passing
in the correct parameters, or use Object sytax to open and directly manipulate the config
objects (Open() and Exists()). Most objects created here need only to specify the Name of the object,
and 1 or 2 properties since the the defaults are what are commonly used for most cases.
parameter CAPITALNAME = 0;
Determines if the Name specified in the index should be capitalized.
as %SysPath [ Required ];
Database to map global to.
classmethod %OnDeleteCallBack(Obj As %ObjectHandle)
Called from %Delete().
Any error returned here will keep the object from being deleted.
query List(ID As %String, Names As %String = "*", CPFFile As %String = "", Flags As %Integer = 0, Format As %Integer = 0)
Name As %String, Directory As %String
List MapGlobals in a CPF file.
Names - Comma separated list of MapGlobal names
"*" - All records match
"String,String1" - Any records matching one of these elements
"String*" - Any record starting with "String"
"String,String1*,String2" - Any record mathing one of these elements, or starting with "String1"
CPFFile - Name of the CPF file to use. A null string means use the active CPF file.
Flags - Currently ignored.
0 - Standard report list format
1 - ^CONFIG global format
2 - CPF file format format
Note: This query may change in future versions
index (CPFNameSectionHeaderIDName on CPFName,SectionHeader,ID,Name) [IdKey,Unique];