Skip to main content

Config.MapShadows

Class Config.MapShadows Extends (%Persistent, Config.GenericMapMethods, Config.GenericMapProperties, %SYSTEM.Help) [ Final, Inheritance = right, LegacyInstanceContext, System = 4 ]

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 syntax 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.

EXAMPLE:

Parameters

CAPITALNAME

Parameter CAPITALNAME = 0;

Determines if the Name specified in the index should be capitalized.

EMSSERVICE

Parameter EMSSERVICE [ Internal ] = "Namespace";

Properties

Directory

Property Directory As %SysPath [ Required ];

Database to map global to.

Methods

CreateCallBack

ClassMethod CreateCallBack(Obj As %ObjectHandle, Data As %String) As %Status [ Internal ]

Called by the Create method during import from a CPF file.

WriteSection

ClassMethod WriteSection(CPFFile As %String) As %Status [ Internal ]

Load

ClassMethod Load(Obj As %ObjectHandle = "", Flags As %Integer = 1) As %Status [ Internal ]

Load the parameters into memory and activate.
Parameters:
Obj = Handle to the object which caused the load. If "", then load everything, only called from STU.
If a delete operation, then Obj is the shadow of the item which was deleted since the oject itself has already been deleted. Note that Obj can either be a Config.Shadows object or a Config.Map* object.
Flags = Type of modification.
0 - Modify
1 - Create/Insert
2 - Delete

%OnBeforeSaveCallBack

ClassMethod %OnBeforeSaveCallBack(insert As %Integer, Obj As %ObjectHandle) As %Status [ Internal, Private ]

Stub method, may be overwritten by the individual class.

%OnDeleteCallBack

ClassMethod %OnDeleteCallBack(Obj As %ObjectHandle) As %Status

Called from %Delete().
Any error returned here will keep the object from being deleted.

ListExecute

ClassMethod ListExecute(ByRef %qHandle As %Binary, ID As %String, Names As %String = "*", CPFFile As %String = "", Flags As %Integer = 0, Format As %Integer = 0) As %Status [ Internal ]

List MapGlobals in a CPF file.

Parameters:
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 matching 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.
Format
0 - Standard report list format
1 - ^CONFIG global format
2 - CPF file format format
Note: This query may change in future versions

ListFetch

ClassMethod ListFetch(ByRef %qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = ListExecute ]

ListClose

ClassMethod ListClose(ByRef %qHandle As %Binary) As %Status [ Internal, PlaceAfter = ListExecute ]