Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [OpDatabases]
Private  Storage   

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

System Management Portal - System Operations - Local Databases

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 4 14


Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource CurrentColumn CurrentSort Filter
FirstFailed FreespacesOn HelpAddress ISREADONLY
InvalidParam IsEMSReadOnly IsEditForm LocatorHeader
OnclickArray PID ParentURL StdTitle
TableMaxRows TablePageSize ValidationErrorMsg aboutPage
align aux backgroundTimerInterval captionLastUpdate
cellAlign cellSize cellStyle cellVAlign
children colDismount colMount composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode disabled dragAndDrop
dragEnabled dropEnabled enableAutoRefresh enclosingClass
enclosingStyle error groupClass groupStyle
height hidden hint hintClass
hintStyle home homePage id
index label labelClass labelDisabledClass
labelPosition labelStyle layout lblTitle
limitPopups msgDismount name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent searchKey showLabel
slice title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddLocatorLinks %AddToSaveSet %ApplyURLParms
%Attr %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML %DrawHTML
%DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetHomePage
%GetHomeParam %GetLinks %GetLocatorLinks %GetNavTableState
%GetPageName %GetParameter %GetProductName %GetValueById
%GetValueByName %GetXMLName %IsA %IsModified
%Link %LinkCSS %LinkScript %MakeId
%New %NormalizeObject %ObjectModified %OnAddToPageAfter
%OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication
%OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody
%OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask
%OnGetPageName %OnGetProductName %OnGetSmallMenu %OnGetTitle
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %Register
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%ZENVersion BuildMenu BuildMeter CheckAllBlanks
CheckContextLinks CheckEnterpriseManager ConvertParameter Decrypt
DoLogout DrawAutoRefresh DrawDB DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetCSPURL GetContextLinks
GetDocURL GetHomePage GetNewURL GetQuickLinks
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate JavaInstalled LastUpdateTime
Link OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent RewriteURL SaveFreespaceOn ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL UpdateAutoRefreshRate UpdateAutoRefreshState UpdateTableNavState
UpdateTableState XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
afterSave afterValidate cancelPopup changePassword
childrenMutated columnSort correctIELayering createComponent
createComponentNS deleteComponent disableCommandButton doCancel
doFreespaceSwitch doIntegrity doLog doModified
doSelectRow dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal exposeComponent filterChanged findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getPageTitle getProperty getSettings getTime
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton invokeSuper
isButtonDisabled isOfType launchPopupWindow logout
makeId navMaxRowsChanged navPageSizeChanged navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler refreshContents
refreshHandler refreshkeyUp removeChild render
renderContents renderSVG resetMsg searchBlur
searchBoxHandler searchFocus searchKeyDown searchKeyPress
setComponentId setConnectivityStatusMsg setHidden setModified
setOverlayMode setPageTitle setProperty setPropertyAll
setRefreshMode setRefreshRate setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showContact showDocumentation showHelp
showMsg startModal startProgressBar stopProgressBar
switchNamespace trimSpace updateTime updateView
validateRequired zeroFill


Parameters

• 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";
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";
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

Properties

• property FreespacesOn as %String(ZENURL="FreespacesOn");
• property colDismount as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Dismount") ];
Store translated targetCol linkCaption for
• property colMount as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Mount") ];
• property msgDismount as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to dismount database %1?") ];

Methods

• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
• method %OnAfterCreatePage() as %Status
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 DrawDB(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
User override of cell-display for tablePane.
• 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.
• classmethod SaveFreespaceOn(pValue As %String) [ ZenMethod ]
Save user's freespace selection value
• method doFreespaceSwitch() [ Language = javascript ]
Method to execute the query and show/hide the table according to user selected view type: General and Free space.
This method is invoked when the page is first loaded, and when user click to change view.
• method doIntegrity() [ Language = javascript ]
• method doLog() [ Language = javascript ]
• method doSelectRow(option) [ Language = javascript ]
allow to open details page when clicking on a row anywhere.
• method filterChanged(value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
• method onloadHandler() [ Language = javascript ]
You may turn freespaces switch on (e.g. from EnsembleMonitor) on page opening Otherwise it is off as default.
• method updateView() [ Language = javascript ]
Update / Reload table. This overrides the one in Portal.Utils.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.