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

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

Zen page for System Management Portal - Edit Local Database Properties

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 5 15


Summary

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

Properties
%condition %import %includeFiles %page
%resource CanBeMirrored DBName Directory
FirstFailed HelpAddress ISREADONLY InvalidParam
IsEMSReadOnly IsEditForm LocatorHeader MirName
MirrorSetName NoJournalWarningDBs OldDirectory OldMaxSize
OldSize OnclickArray PID ParentURL
ROReasonText ReadOnly ReadOnlyMounted ResourcePage
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 SaveData ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
afterSave afterValidate browseSelect cancelPopup
changeJournal changeMaxSize changeMount changePassword
changeReadOnly changeVolThreshold checkCACHETEMP childrenMutated
correctIELayering createComponent createComponentNS deleteComponent
disableCommandButton doAddMirror doCancel doModified
doResource doSave doUnitSwitch dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler enableCommandButton endModal exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getDBSizeLimit 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 updateDirectory validate
validateName validateRequired validateSize


Parameters

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

Properties

• property CanBeMirrored as %Boolean;
• property MirrorSetName as %ZEN.Datatype.boolean(ZENURL="MirrorSetName");
MirrorSetName is not null if this window is called from Mirroring Settings
• property NoJournalWarningDBs as %ZEN.Datatype.string [ InitialExpression = ",IRISLIB,IRISTEMP,DOCBOOK,IRISLOCALDATA," ];
• property OldMaxSize as %ZEN.Datatype.integer;
• property ResourcePage as %ZEN.Datatype.caption [ InitialExpression = ..Link("/csp/sys/sec/%CSP.UI.Portal.Dialog.Resource.zen",,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.
• 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 changeJournal(newVal) [ Language = javascript ]
if user unchecked Journal State, show warning
• method changeMaxSize(newVal) [ Language = javascript ]
• method changeReadOnly(newVal) [ Language = javascript ]
• classmethod checkCACHETEMP(newdir As %String) as %Integer [ ZenMethod ]
This method is called from JavaScript if user is modifying IRISEMP and changed to a different directory
We check here to see if the newly selected directory is a IRISTEMP type of database. Returns a number.
• method doAddMirror() [ Language = javascript ]
Add db to mirror
• method doResource() [ Language = javascript ]
• method doSave() [ Language = javascript ]
• method getDBSizeLimit() [ Language = javascript ]
Get the max size for the DB, based on the current block size.
• method onloadHandler() [ Language = javascript ]
Set focus to the Name field.
• method updateDirectory(NewDirectory) [ Language = javascript ]
• method validate(proxy) [ Language = javascript ]


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