This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


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

Zen page for System Management Portal - Edit Local Database Properties

Property Inventory

Method Inventory


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


property CanBeMirrored as %Boolean;
Property methods: CanBeMirroredDisplayToLogical(), CanBeMirroredGet(), CanBeMirroredIsValid(), CanBeMirroredLogicalToDisplay(), CanBeMirroredLogicalToXSD(), CanBeMirroredNormalize(), CanBeMirroredSet(), CanBeMirroredXSDToLogical()
property MirrorSetName as %ZEN.Datatype.boolean (ZENURL = "MirrorSetName");
MirrorSetName is not null if this window is called from Mirroring Settings
Property methods: MirrorSetNameDisplayToLogical(), MirrorSetNameGet(), MirrorSetNameIsValid(), MirrorSetNameLogicalToDisplay(), MirrorSetNameLogicalToOdbc(), MirrorSetNameLogicalToXSD(), MirrorSetNameNormalize(), MirrorSetNameSet(), MirrorSetNameXSDToLogical()
property NoJournalWarningDBs as %ZEN.Datatype.string [ InitialExpression = ",CACHELIB,CACHETEMP,DOCBOOK,CACHE," ];
Property methods: NoJournalWarningDBsDisplayToLogical(), NoJournalWarningDBsGet(), NoJournalWarningDBsIsValid(), NoJournalWarningDBsLogicalToDisplay(), NoJournalWarningDBsLogicalToOdbc(), NoJournalWarningDBsNormalize(), NoJournalWarningDBsSet()
property OldMaxSize as %ZEN.Datatype.integer;
Property methods: OldMaxSizeDisplayToLogical(), OldMaxSizeGet(), OldMaxSizeIsValid(), OldMaxSizeLogicalToDisplay(), OldMaxSizeLogicalToOdbc(), OldMaxSizeNormalize(), OldMaxSizeSet()
property ResourcePage as %ZEN.Datatype.caption [ InitialExpression = ..Link("/csp/sys/sec/%CSP.UI.Portal.Dialog.Resource.zen",,1) ];
Property methods: ResourcePageDisplayToLogical(), ResourcePageGet(), ResourcePageIsValid(), ResourcePageLogicalToDisplay(), ResourcePageLogicalToOdbc(), ResourcePageNormalize(), ResourcePageSet()
property SystemDBs as %ZEN.Datatype.string [ InitialExpression = ",CACHESYS,CACHETEMP,CACHEAUDIT,CACHELIB,CACHE," ];
Property methods: SystemDBsDisplayToLogical(), SystemDBsGet(), SystemDBsIsValid(), SystemDBsLogicalToDisplay(), SystemDBsLogicalToOdbc(), SystemDBsNormalize(), SystemDBsSet()


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 %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.
clientmethod changeJournal(newVal) [ Language = javascript ]
if user unchecked Journal State, show warning
clientmethod changeMaxSize(newVal) [ Language = javascript ]
if user entered MaxSize, need to make sure it is not less than 'Size'.
clientmethod changeReadOnly(newVal) [ Language = javascript ]
clientmethod changeSize(newVal) [ Language = javascript ]
if user entered Size, need to make sure it is not greater than 'MaxSize'.
classmethod checkCACHETEMP(newdir As %String) as %Integer [ ZenMethod ]
This method is called from JavaScript if user is modifying CACHETEMP and changed to a different directory
We check here to see if the newly selected directory is a CACHETEMP type of database. Returns a number.
clientmethod doAddMirror() [ Language = javascript ]
Add db to mirror
clientmethod doResource() [ Language = javascript ]
clientmethod doSave() [ Language = javascript ]
clientmethod onloadHandler() [ Language = javascript ]
Set focus to the Name field.
clientmethod updateDirectory(NewDirectory) [ Language = javascript ]
clientmethod validate(proxy) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods