Skip to main content


abstract class Config.Map extends %SYSTEM.Help

This class contains helper functions for the various System Management server functions.

Method Inventory


parameter DOMAIN = %Utility;
Default Localization Domain


classmethod InitializeEdits(Namespaces As %String, Copy As %Boolean = 0) as %Status
Initialize storage for Mapping edits in a Namespace. This should be called before any Map edits which use the $$$CPFMappingEdit flag for saving multiple edits before they are activated. This clears anything in the CACHE_MAPPINGSFILE index and copies the current Namespace settings. The edits would then be processed and activated using the DataMove API.

Note that this temporary storage area is the same as used by the Management Portal. There is no locking implemented, so care must be taken to not use both at the same time.

The 'Copy' argument will create a second copy of the current Mappings for the Namespace, using the CACHE_MAPPINGSFILE_MAPCOPY index. This can later be used to revert any Mapping changes by calling RevertEdits().
classmethod RevertEdits(Activate As %Boolean = 1) as %Status
This will Replace and immediately Activate the copy of the original Mappings created with the 'Copy' argument of InitializeEdits(), overwriting the current Namespace Mappings. Make sure you understand the implications of this before calling here.

This can be used to recover from a "bad" Mappings update, while the system is still inactive. The caller is responsible for ensuring that no global activity has used the new, editted Mappings.

If 'Activate'=0, then the original Mappings will be copied to the $$$CPFMappingEdit storage, and the user may call the DataMove API to reverse the data copy and do the Activation.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab