Skip to main content


class %CSP.UI.Portal.Dialog.DBMirrorAdd extends %CSP.UI.Portal.Dialog.WizardTemplate, %CSP.UI.Portal.UtilsNav

This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Add to Mirror dialog for Management Portal.

Property Inventory

Method Inventory


parameter APPLICATION = %CSP.UI.Portal.Application;
Class name of application this page belongs to.
parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.Dialog.DBMirrorAdd.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 PAGENAME = AddToMirror;
Displayed name of this page.
parameter RESOURCE = %Admin_Manage:USE;
Inherited description: This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.


property DBName as %ZEN.Datatype.string (ZENURL = "DBName");
DB name to be added to mirror.
Property methods: DBNameDisplayToLogical(), DBNameGet(), DBNameIsValid(), DBNameLogicalToDisplay(), DBNameLogicalToOdbc(), DBNameNormalize(), DBNameSet()
property Dir as %ZEN.Datatype.string (ZENURL = "Dir");
DB directory to be added to mirror.
Property methods: DirDisplayToLogical(), DirGet(), DirIsValid(), DirLogicalToDisplay(), DirLogicalToOdbc(), DirNormalize(), DirSet()
property MirDBName as %ZEN.Datatype.string (ZENURL = "MirDBName");
Primary Mirror name for DB to be added.
Property methods: MirDBNameDisplayToLogical(), MirDBNameGet(), MirDBNameIsValid(), MirDBNameLogicalToDisplay(), MirDBNameLogicalToOdbc(), MirDBNameNormalize(), MirDBNameSet()
property Multi as %ZEN.Datatype.boolean (ZENURL = "Multi") [ InitialExpression = 0 ];
Indicates whether multiple databases can be added.
Property methods: MultiDisplayToLogical(), MultiGet(), MultiIsValid(), MultiLogicalToDisplay(), MultiLogicalToOdbc(), MultiLogicalToXSD(), MultiNormalize(), MultiSet(), MultiXSDToLogical()
property MultiCount as %ZEN.Datatype.integer [ InitialExpression = 0 ];
Indicates how many databases the user is adding.
Property methods: MultiCountDisplayToLogical(), MultiCountGet(), MultiCountIsValid(), MultiCountLogicalToDisplay(), MultiCountLogicalToOdbc(), MultiCountNormalize(), MultiCountSet()


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 %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
classmethod DrawMultiText(pSeed As %String) as %Status
classmethod DrawPageTitle(pSeed As %String) as %Status
classmethod SaveData(Dir As %String, MirDBName As %String) as %String [ ZenMethod ]
classmethod SaveDataMulti(DBNames As %String, Background As %Boolean) as %String [ ZenMethod ]
method ToggleFinishButton(Enabled As %Boolean) as %Status [ ZenMethod ]
clientmethod filterChanged(value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod onstartHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod rowSelect(selectedRows) [ Language = javascript ]
clientmethod validate() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab