Skip to main content


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

System Management Portal - System Operations - Database Details

Property Inventory

Method Inventory


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


property %Pane as %CSP.Util.Pane;
Server-side reference to the pane object so that the head and body sections can be added to the page correctly.
Property methods: %PaneGet(), %PaneGetSwizzled(), %PaneIsValid(), %PaneNewObject(), %PaneSet()
property AllowDismount as %ZEN.Datatype.boolean [ InitialExpression = "0" ];
Property methods: AllowDismountDisplayToLogical(), AllowDismountGet(), AllowDismountIsValid(), AllowDismountLogicalToDisplay(), AllowDismountLogicalToOdbc(), AllowDismountLogicalToXSD(), AllowDismountNormalize(), AllowDismountSet(), AllowDismountXSDToLogical()
property AllowMount as %ZEN.Datatype.boolean [ InitialExpression = "0" ];
Property methods: AllowMountDisplayToLogical(), AllowMountGet(), AllowMountIsValid(), AllowMountLogicalToDisplay(), AllowMountLogicalToOdbc(), AllowMountLogicalToXSD(), AllowMountNormalize(), AllowMountSet(), AllowMountXSDToLogical()
property BackgroundPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/%25CSP.UI.Portal.BackgroundTaskList.zen",,1) ];
Property methods: BackgroundPageDisplayToLogical(), BackgroundPageGet(), BackgroundPageIsValid(), BackgroundPageLogicalToDisplay(), BackgroundPageLogicalToOdbc(), BackgroundPageNormalize(), BackgroundPageSet()
property BackgroundTasks as %ZEN.Datatype.integer [ InitialExpression = "0" ];
Property methods: BackgroundTasksDisplayToLogical(), BackgroundTasksGet(), BackgroundTasksIsValid(), BackgroundTasksLogicalToDisplay(), BackgroundTasksLogicalToOdbc(), BackgroundTasksNormalize(), BackgroundTasksSet()
property CompactDialog as %ZEN.Datatype.string [ InitialExpression = ..Link("%CSP.UI.Portal.Background.Dialog.DatabaseCompact.zen",,1) ];
Property methods: CompactDialogDisplayToLogical(), CompactDialogGet(), CompactDialogIsValid(), CompactDialogLogicalToDisplay(), CompactDialogLogicalToOdbc(), CompactDialogNormalize(), CompactDialogSet()
property DBName as %String (ZENURL = "DBName");
Database Name
Property methods: DBNameDisplayToLogical(), DBNameGet(), DBNameIsValid(), DBNameLogicalToDisplay(), DBNameLogicalToOdbc(), DBNameNormalize(), DBNameSet()
property DatabaseDetailsPage as %String;
this page's link with Directory and DBName
Property methods: DatabaseDetailsPageDisplayToLogical(), DatabaseDetailsPageGet(), DatabaseDetailsPageIsValid(), DatabaseDetailsPageLogicalToDisplay(), DatabaseDetailsPageLogicalToOdbc(), DatabaseDetailsPageNormalize(), DatabaseDetailsPageSet()
property DatabasesPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/op/%CSP.UI.Portal.OpDatabases.zen") ];
parent page link
Property methods: DatabasesPageDisplayToLogical(), DatabasesPageGet(), DatabasesPageIsValid(), DatabasesPageLogicalToDisplay(), DatabasesPageLogicalToOdbc(), DatabasesPageNormalize(), DatabasesPageSet()
property DefragDialog as %ZEN.Datatype.string [ InitialExpression = ..Link("%CSP.UI.Portal.Background.Dialog.DatabaseDefragment.zen",,1) ];
Property methods: DefragDialogDisplayToLogical(), DefragDialogGet(), DefragDialogIsValid(), DefragDialogLogicalToDisplay(), DefragDialogLogicalToOdbc(), DefragDialogNormalize(), DefragDialogSet()
property Directory as %String (ZENURL = "$ID1");
Database Directory
Property methods: DirectoryDisplayToLogical(), DirectoryGet(), DirectoryIsValid(), DirectoryLogicalToDisplay(), DirectoryLogicalToOdbc(), DirectoryNormalize(), DirectorySet()
property SysBGTaskId as %String;
ID for Systems background task id
Property methods: SysBGTaskIdDisplayToLogical(), SysBGTaskIdGet(), SysBGTaskIdIsValid(), SysBGTaskIdLogicalToDisplay(), SysBGTaskIdLogicalToOdbc(), SysBGTaskIdNormalize(), SysBGTaskIdSet()
property TaskInfoDialog as %String [ InitialExpression = ..Link("/csp/sys/%CSP.UI.Portal.Background.Dialog.TaskInfo.zen",,1) ];
Property methods: TaskInfoDialogDisplayToLogical(), TaskInfoDialogGet(), TaskInfoDialogIsValid(), TaskInfoDialogLogicalToDisplay(), TaskInfoDialogLogicalToOdbc(), TaskInfoDialogNormalize(), TaskInfoDialogSet()
property TruncateDialog as %ZEN.Datatype.string [ InitialExpression = ..Link("%CSP.UI.Portal.Background.Dialog.DatabaseTruncate.zen",,1) ];
Property methods: TruncateDialogDisplayToLogical(), TruncateDialogGet(), TruncateDialogIsValid(), TruncateDialogLogicalToDisplay(), TruncateDialogLogicalToOdbc(), TruncateDialogNormalize(), TruncateDialogSet()
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()
property paneDone as %Boolean;
Flag to indicate whether %Pane's OnDrawHEAD() method has been executed.
Property methods: paneDoneDisplayToLogical(), paneDoneGet(), paneDoneIsValid(), paneDoneLogicalToDisplay(), paneDoneLogicalToXSD(), paneDoneNormalize(), paneDoneSet(), paneDoneXSDToLogical()


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 %OnDrawHTMLHead() as %Status
Add the HEAD section for %Pane and override some CSS styles if HTML5 is enabled. Without these overrides, the font size is calculated to be 0.8px and padding is calculated to be 0 for the header cells..
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 DrawDetails(pSeed As %String) as %Status
Draw the contents of the diagram header, in the HTMLDashboard style.
method DrawSize(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
method DrawTasks(pDirectory As %String) as %Status
Draw the contents of the ongoing tasks.
classmethod GetDBOBJ(pDir) as %String [ ZenMethod ]
classmethod GetDetailPane(pInstance As %CSP.Util.PageInstance) as %CSP.Util.Pane
Set properties for HTMLDashboardPane to draw details.
method OnDrawRibbon() as %Status
Add to the contents of the tool ribbon.
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 doAction(action) [ Language = javascript ]
clientmethod doDismount() [ Language = javascript ]
clientmethod doMount() [ Language = javascript ]
clientmethod doTableViewSwitch() [ Language = javascript ]
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 ]
Inherited description: Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
clientmethod openTaskPage(SysBGTaskId) [ Language = javascript ]
clientmethod taskTimeout() [ Language = javascript ]
open task status info page after an action (such as Compact and Defragment) is commited and the page is closed.
clientmethod updateView() [ Language = javascript ]
For auto-refresh on this page.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab