This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


class %CSP.UI.Portal.Mappings extends %CSP.UI.Portal.Template, %CSP.UI.Portal.UtilsNav

Zen page for System Management Portal - Show Databases Freespace

Property Inventory

Method Inventory


parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.Mappings.zen;
Inherited description: This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
parameter EMSSERVICE = Namespace;
parameter HELPADDRESS = Home,Configuration,Namespaces,Global Mappings;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Mappings;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/mgr/%CSP.UI.Portal.Namespaces.zen;
Inherited description: This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.
parameter RECENT = 0;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Admin_Manage;
Security requirement


property CPFMapFile as %String;
Property methods: CPFMapFileDisplayToLogical(), CPFMapFileGet(), CPFMapFileIsValid(), CPFMapFileLogicalToDisplay(), CPFMapFileLogicalToOdbc(), CPFMapFileNormalize(), CPFMapFileSet()
property CPFMapName as %String;
Property methods: CPFMapNameDisplayToLogical(), CPFMapNameGet(), CPFMapNameIsValid(), CPFMapNameLogicalToDisplay(), CPFMapNameLogicalToOdbc(), CPFMapNameNormalize(), CPFMapNameSet()
property EditPage as %String;
Property methods: EditPageDisplayToLogical(), EditPageGet(), EditPageIsValid(), EditPageLogicalToDisplay(), EditPageLogicalToOdbc(), EditPageNormalize(), EditPageSet()
property MapType as %ZEN.Datatype.string (ZENURL = "MapType");
Property methods: MapTypeDisplayToLogical(), MapTypeGet(), MapTypeIsValid(), MapTypeLogicalToDisplay(), MapTypeLogicalToOdbc(), MapTypeNormalize(), MapTypeSet()
property Namespace as %ZEN.Datatype.string (ZENURL = "PID");
Property methods: NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSet()


Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
classmethod %OnPreHTTP() as %Boolean
Zen page notification of an HTTP request. This method can be overwritten by subclasses.
This is called before the standard Zen pre-HTTP processing occurs.
classmethod CancelChanges(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
Call server cancel method.
classmethod DeleteItem(Name As %String, pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
Call server delete method.
method DrawCollation(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
method Init(CPFName As %String) as %Status
Initialize CPF file/global
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
classmethod SaveChanges(pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]
Call server save method.
classmethod UpdateTableNavState(pFilter As %String, pPageSize As %Integer, pMaxRows As %Integer, pMapType As %String) [ ZenMethod ]
Used to Save tableNavBar values, add MapType to the page name to distinguish the type for the page.
clientmethod deleteMapping(idRow) [ Language = javascript ]
Delete existing mapping.
clientmethod doDiscard() [ Language = javascript ]
Cancel current mappings.
clientmethod doSave() [ Language = javascript ]
Save current mappings.
clientmethod editMapping(selectedName) [ Language = javascript ]
Process Add or Edit. Open popup window and pass in parameters.
clientmethod filterChanged(value, tableID) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
Overriden to add MapType to the page name to distinguish the type for the page.
Overriden to add MapType to the page name to distinguish the type for the page.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod refreshTable(flag) [ Language = javascript ]
Refresh table. flag = 1: user has either Saved Changes or Canceled Changes.
flag = 0: user returned from Edit or Delete. Leave changeMade flag to be true
clientmethod removeElement(el) [ Language = javascript ]
clientmethod setModified(flag) [ Language = javascript ]
Set the modified flag for the page.

Inherited Members

Inherited Properties

Inherited Methods