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

abstract class %CSP.UI.Portal.DatabaseTemplate extends %CSP.UI.Portal.Template

Zen template for System Management Portal - Edit Database Properties

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 13 16 1


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 LocatorHeader MirName OldDirectory
OldSize OnclickArray PID ParentURL
ROReasonText ReadOnly ReadOnlyMounted StdTitle
ValidationErrorMsg aboutPage align aux
backgroundTimerInterval browseselect cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel curVolThreshold
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 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
ConvertParameter DbExists Decrypt DoLogout
DrawLocator DrawRibbon DrawTitle Encrypt
EscapeHTML EscapeURL EvalResult GetCSPURL
GetContextLinks GetDocURL GetFreeSpace GetHomePage
GetNewURL GetQuickLinks HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
JavaInstalled Link LoadCollations LoadResources
MULTIVOLBackupCheck OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent RewriteURL ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore afterSave
afterValidate browseSelect cancelPopup changeMount
changePassword changeVolThreshold childrenMutated correctIELayering
createComponent createComponentNS deleteComponent disableCommandButton
doCancel doModified 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

Subclasses
%CSP.UI.Portal.Database %CSP.UI.Portal.DatabaseMirror %CSP.UI.Portal.DatabaseVolumes

Parameters

• parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
• parameter EMSSERVICE = "Namespace";
• parameter PARENTPAGE = "/csp/sys/mgr/%CSP.UI.Portal.Databases.zen";
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;
If true, register visits to this page in the recent list.
• parameter RESOURCE = "%Admin_Manage";
Security requirement

Properties

• property DBName as %ZEN.Datatype.string(ZENURL="DBName");
• property Directory as %ZEN.Datatype.string(ZENURL="Dir");
• property IsEditForm as %Boolean [ InitialExpression = 1 ];
If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.
• property MirName as %ZEN.Datatype.string;
• property OldDirectory as %ZEN.Datatype.string(ZENURL="Dir");
• property OldSize as %ZEN.Datatype.integer;
• property PID as %String(ZENURL="DBName");
ID for edit.
• property ROReasonText as %ZEN.Datatype.string;
• property ReadOnly as %ZEN.Datatype.boolean;
• property ReadOnlyMounted as %ZEN.Datatype.boolean;
• property browseselect as %String;
• property curVolThreshold as %ZEN.Datatype.integer;
• property origVolThreshold as %ZEN.Datatype.integer;

Methods

• classmethod DbExists(Dir) as %String [ ZenMethod ]
• classmethod GetFreeSpace(Dir As %String) as %ZEN.proxyObject [ ZenMethod ]
• method LoadCollations(NewGlobalCollation As %String, ReturnDisplayValue As %Boolean = 0) as %String
• method LoadResources(ResourceName As %String) as %String [ ZenMethod ]
• classmethod MULTIVOLBackupCheck(Dir As %String) as %Boolean [ ZenMethod ]
• method browseSelect(name) [ Language = javascript ]
User clicked one of the Browse buttons. Save the name of the textfield so that when you return you know which textfield to update.
• method changeMount(MountRequired) [ Language = javascript ]
enable/disable MountAtStartup based on MountRequired value
• method changeVolThreshold(newVal) [ Language = javascript ]
• method doUnitSwitch() [ 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 undoDirChange() [ Language = javascript ]
• method validateName(Name, OldName) [ Language = javascript ]
• method validateSize(Size, OldSize, Directory) [ Language = javascript ]

Queries

• query VolumeDirectories(Directory As %SysPath)
Selects VolumeDirectory As %SysPath, NumberOfVolumes As %String, Size As %Integer


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