Class Reference
%CSP.UI.Portal.DatabaseVolumes
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [DatabaseVolumes]
Private  Storage

class %CSP.UI.Portal.DatabaseVolumes extends %CSP.UI.Portal.DatabaseTemplate

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 7 17


Summary

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

Properties
%condition %import %includeFiles %page
%resource DBName Directory FirstFailed
HelpAddress ISREADONLY InvalidParam IsEMSReadOnly
IsEditForm IsNotMounted IsRO LastVolumeDirectory
LastVolumeSize LocatorHeader MirName OldDirectory
OldSize OnclickArray PID ParentURL
ROReasonText ReadOnly ReadOnlyMounted SoftMinimum
StdTitle ValidationErrorMsg aboutPage align
aux backgroundTimerInterval browseselect cellAlign
cellSize cellStyle cellVAlign children
composite contactPage containerStyle cssLevel
curVolSize curVolThreshold currSortMode currStep
currViewMode currentVolDir 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 name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate origVolThreshold
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 %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 CheckAllBlanks CheckContextLinks CheckEnterpriseManager
CheckVolDir ConvertParameter CreateDirectory DbExists
Decrypt DoLogout DrawLocator DrawRibbon
DrawSize DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetCSPURL GetContextLinks
GetDocURL GetFreeSpace GetHomePage GetNewURL
GetQuickLinks HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate JavaInstalled
Link LoadCollations LoadResources MULTIVOLBackupCheck
NormalizeDir OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent RewriteURL SaveData ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
afterSave afterValidate browseSelect browseVolDir
cancelPopup changeMount changePassword changeVolDir
changeVolThreshold childrenMutated correctIELayering createComponent
createComponentNS deleteComponent disableCommandButton doCancel
doModified doSave doSaveExpand doSelectRow
doTableViewSwitch doUnitSwitch dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableCommandButton endModal exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getPageTitle getProperty getSettings getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage hideCommandButton invokeSuper isButtonDisabled
isOfType launchPopupWindow logout makeId
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 removeChild render renderContents
renderSVG resetMsg searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showCommandButton showContact showDocumentation
showHelp showMsg startModal startProgressBar
stopProgressBar switchNamespace trimSpace undoDirChange
validateName validateRequired validateSize


Parameters

• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.DatabaseVolumes.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,Configuration,Local Databases,Multi-Volume Properties";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "Multi-Volume Properties";
Displayed name of this page.

Properties

• property IsNotMounted as %ZEN.Datatype.integer;
• property IsRO as %ZEN.Datatype.integer;
• property LastVolumeDirectory as %ZEN.Datatype.string;
• property LastVolumeSize as %ZEN.Datatype.integer;
• property SoftMinimum as %ZEN.Datatype.integer;
• property curVolSize as %ZEN.Datatype.integer;
• property currentVolDir as %ZEN.Datatype.string;

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
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
• method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
• classmethod CheckVolDir(dbdir, ndir As %String) as %Integer [ ZenMethod ]
• classmethod CreateDirectory(dir As %String) as %Integer [ ZenMethod ]
• method DrawSize(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
• classmethod NormalizeDir(dir As %String) as %String [ ZenMethod ]
• 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 SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Save general association data to server.
Returns proxy.ok = 1 (save successful) or 0 (error occurred)
proxy.Message (save successful, with warning message: require restart)
proxy.ErrorMessage (save failed and display this error message). If proxy.ok is 1 and no messages returned then we return to Database list page.
• method browseVolDir(action) [ Language = javascript ]
• method changeVolDir(newdir) [ Language = javascript ]
• method doSave() [ Language = javascript ]
• method doSaveExpand() [ Language = javascript ]
• method doSelectRow() [ Language = javascript ]
• method doTableViewSwitch() [ Language = javascript ]
• method 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.
• method onloadHandler() [ Language = javascript ]
Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.


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