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

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


class %CSP.UI.Portal.OpDatabases extends %CSP.UI.Portal.Utils

System Management Portal - System Operations - Local Databases

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/op/%CSP.UI.Portal.OpDatabases.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 HELPADDRESS = Home,Databases;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Operation Local Databases;
Displayed name of this page.
parameter RESOURCE = %Admin_Operate;
Security requirement


property FreespacePage as %String;
Property methods: FreespacePageDisplayToLogical(), FreespacePageGet(), FreespacePageIsValid(), FreespacePageLogicalToDisplay(), FreespacePageLogicalToOdbc(), FreespacePageNormalize(), FreespacePageSet()
property colDismount as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Dismount") ];
Store translated targetCol linkCaption for
Property methods: colDismountDisplayToLogical(), colDismountGet(), colDismountIsValid(), colDismountLogicalToDisplay(), colDismountLogicalToOdbc(), colDismountNormalize(), colDismountSet()
property colMount as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Mount") ];
Property methods: colMountDisplayToLogical(), colMountGet(), colMountIsValid(), colMountLogicalToDisplay(), colMountLogicalToOdbc(), colMountNormalize(), colMountSet()
property msgDismount as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to dismount database %1?") ];
Property methods: msgDismountDisplayToLogical(), msgDismountGet(), msgDismountIsValid(), msgDismountLogicalToDisplay(), msgDismountLogicalToOdbc(), msgDismountNormalize(), msgDismountSet()


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.
classmethod Dismount(Dir As %String) as %String [ ZenMethod ]
Dismount a DB.
method OnDrawRibbon() as %Status
This is called in the middle of rendering the tool ribbon. Subclasses can inject their own content into the ribbon by writing it out in this method. This content should be wrapped within a td element.
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.
clientmethod doDismount(dir, dbname) [ Language = javascript ]
clientmethod doFreespace() [ Language = javascript ]
clientmethod doIntegrity() [ Language = javascript ]
clientmethod doLog() [ Language = javascript ]
clientmethod doMount(dir, dbname) [ Language = javascript ]
clientmethod filterChanged(value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
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 updateView() [ Language = javascript ]
Update / Reload table. This overrides the one in Portal.Utils.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)