Skip to main content


class %CSP.UI.Portal.Mirror.Monitor extends %CSP.UI.Portal.Utils, %CSP.UI.Portal.Mirror.Utils

System Management Portal - System Operations - Mirror Monitor

Property Inventory

Method Inventory


parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/op/%CSP.UI.Portal.Mirror.Monitor.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,Mirror Monitor;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Mirror Monitor;
Displayed name of this page.
parameter RESOURCE = %Admin_Operate;
Security requirement


property CanConnect as %Boolean [ InitialExpression = 0 ];
True on the secondary failover member, when it is disconnected
Property methods: CanConnectDisplayToLogical(), CanConnectGet(), CanConnectIsValid(), CanConnectLogicalToDisplay(), CanConnectLogicalToXSD(), CanConnectNormalize(), CanConnectSet(), CanConnectXSDToLogical()
property CanDisconnect as %Boolean [ InitialExpression = 0 ];
True on the secondary failover member, when it is connected
Property methods: CanDisconnectDisplayToLogical(), CanDisconnectGet(), CanDisconnectIsValid(), CanDisconnectLogicalToDisplay(), CanDisconnectLogicalToXSD(), CanDisconnectNormalize(), CanDisconnectSet(), CanDisconnectXSDToLogical()
property CanManage as %ZEN.Datatype.boolean [ InitialExpression = $System.Security.Check("%Admin_Manage","USE") ];
Check if user has manage privilege
Property methods: CanManageDisplayToLogical(), CanManageGet(), CanManageIsValid(), CanManageLogicalToDisplay(), CanManageLogicalToOdbc(), CanManageLogicalToXSD(), CanManageNormalize(), CanManageSet(), CanManageXSDToLogical()
property DefinedPrimary as %String;
Current 'no failover' state.
Property methods: DefinedPrimaryDisplayToLogical(), DefinedPrimaryGet(), DefinedPrimaryIsValid(), DefinedPrimaryLogicalToDisplay(), DefinedPrimaryLogicalToOdbc(), DefinedPrimaryNormalize(), DefinedPrimarySet()
property DemoteOther as %Boolean [ InitialExpression = 0 ];
Property methods: DemoteOtherDisplayToLogical(), DemoteOtherGet(), DemoteOtherIsValid(), DemoteOtherLogicalToDisplay(), DemoteOtherLogicalToXSD(), DemoteOtherNormalize(), DemoteOtherSet(), DemoteOtherXSDToLogical()
property DownList as %String;
Property methods: DownListDisplayToLogical(), DownListGet(), DownListIsValid(), DownListLogicalToDisplay(), DownListLogicalToOdbc(), DownListNormalize(), DownListSet()
property IsDR as %Integer [ InitialExpression = 0 ];
Property methods: IsDRDisplayToLogical(), IsDRGet(), IsDRIsValid(), IsDRLogicalToDisplay(), IsDRNormalize(), IsDRSet(), IsDRXSDToLogical()
property IsNoPartnerNoFailover as %Integer [ InitialExpression = 0 ];
1 - The DefinedPrimary is the special name of No Partner No Failover promotion.
Property methods: IsNoPartnerNoFailoverDisplayToLogical(), IsNoPartnerNoFailoverGet(), IsNoPartnerNoFailoverIsValid(), IsNoPartnerNoFailoverLogicalToDisplay(), IsNoPartnerNoFailoverNormalize(), IsNoPartnerNoFailoverSet(), IsNoPartnerNoFailoverXSDToLogical()
property IsNotSetUp as %Boolean [ InitialExpression = 0 ];
True on the secondary failover member, when it hasn't been added to the primary
Property methods: IsNotSetUpDisplayToLogical(), IsNotSetUpGet(), IsNotSetUpIsValid(), IsNotSetUpLogicalToDisplay(), IsNotSetUpLogicalToXSD(), IsNotSetUpNormalize(), IsNotSetUpSet(), IsNotSetUpXSDToLogical()
property IsPrimary as %Integer [ InitialExpression = $SYSTEM.Mirror.IsPrimary() ];
Property methods: IsPrimaryDisplayToLogical(), IsPrimaryGet(), IsPrimaryIsValid(), IsPrimaryLogicalToDisplay(), IsPrimaryNormalize(), IsPrimarySet(), IsPrimaryXSDToLogical()
property MirrorMemberType as %Integer [ InitialExpression = $System.Mirror.IsMember() ];
0 - not a mirror member
1 - failover mirror member
2 - async mirror member
Property methods: MirrorMemberTypeDisplayToLogical(), MirrorMemberTypeGet(), MirrorMemberTypeIsValid(), MirrorMemberTypeLogicalToDisplay(), MirrorMemberTypeNormalize(), MirrorMemberTypeSet(), MirrorMemberTypeXSDToLogical()
property MirrorName as %String;
Failover member's mirror name
Property methods: MirrorNameDisplayToLogical(), MirrorNameGet(), MirrorNameIsValid(), MirrorNameLogicalToDisplay(), MirrorNameLogicalToOdbc(), MirrorNameNormalize(), MirrorNameSet()
property MyMemberName as %String;
Member name of local system.
Property methods: MyMemberNameDisplayToLogical(), MyMemberNameGet(), MyMemberNameIsValid(), MyMemberNameLogicalToDisplay(), MyMemberNameLogicalToOdbc(), MyMemberNameNormalize(), MyMemberNameSet()
property NewDefinedPrimary as %String;
Candidate of the new DefinedPrimary.
Property methods: NewDefinedPrimaryDisplayToLogical(), NewDefinedPrimaryGet(), NewDefinedPrimaryIsValid(), NewDefinedPrimaryLogicalToDisplay(), NewDefinedPrimaryLogicalToOdbc(), NewDefinedPrimaryNormalize(), NewDefinedPrimarySet()
property NoFailoverBtn as %Integer [ InitialExpression = 0 ];
1 - display 'Clear/Set No Failover' button, 0 - don't display
Property methods: NoFailoverBtnDisplayToLogical(), NoFailoverBtnGet(), NoFailoverBtnIsValid(), NoFailoverBtnLogicalToDisplay(), NoFailoverBtnNormalize(), NoFailoverBtnSet(), NoFailoverBtnXSDToLogical()
property NumberOfMirrorSet as %Integer [ InitialExpression = 0 ];
Number of mirror set configured.
Property methods: NumberOfMirrorSetDisplayToLogical(), NumberOfMirrorSetGet(), NumberOfMirrorSetIsValid(), NumberOfMirrorSetLogicalToDisplay(), NumberOfMirrorSetNormalize(), NumberOfMirrorSetSet(), NumberOfMirrorSetXSDToLogical()
property OtherMemberECP as %ZEN.Datatype.string [ InitialExpression = "n/a" ];
Property methods: OtherMemberECPDisplayToLogical(), OtherMemberECPGet(), OtherMemberECPIsValid(), OtherMemberECPLogicalToDisplay(), OtherMemberECPLogicalToOdbc(), OtherMemberECPNormalize(), OtherMemberECPSet()
property OtherMemberName as %ZEN.Datatype.string [ InitialExpression = "n/a" ];
Property methods: OtherMemberNameDisplayToLogical(), OtherMemberNameGet(), OtherMemberNameIsValid(), OtherMemberNameLogicalToDisplay(), OtherMemberNameLogicalToOdbc(), OtherMemberNameNormalize(), OtherMemberNameSet()
property OtherMemberPrivateAddress as %ZEN.Datatype.string [ InitialExpression = "n/a" ];
Property methods: OtherMemberPrivateAddressDisplayToLogical(), OtherMemberPrivateAddressGet(), OtherMemberPrivateAddressIsValid(), OtherMemberPrivateAddressLogicalToDisplay(), OtherMemberPrivateAddressLogicalToOdbc(), OtherMemberPrivateAddressNormalize(), OtherMemberPrivateAddressSet()
property PromoteErrorText as %String;
Property methods: PromoteErrorTextDisplayToLogical(), PromoteErrorTextGet(), PromoteErrorTextIsValid(), PromoteErrorTextLogicalToDisplay(), PromoteErrorTextLogicalToOdbc(), PromoteErrorTextNormalize(), PromoteErrorTextSet()
property ReceivedData as %String [ InitialExpression = "0,0,0" ];
Failover member's mirror name
Property methods: ReceivedDataDisplayToLogical(), ReceivedDataGet(), ReceivedDataIsValid(), ReceivedDataLogicalToDisplay(), ReceivedDataLogicalToOdbc(), ReceivedDataNormalize(), ReceivedDataSet()
property SelectedMirror as %String [ InitialExpression = "*" ];
The currently selected mirror on an async member
Property methods: SelectedMirrorDisplayToLogical(), SelectedMirrorGet(), SelectedMirrorIsValid(), SelectedMirrorLogicalToDisplay(), SelectedMirrorLogicalToOdbc(), SelectedMirrorNormalize(), SelectedMirrorSet()
property ThisMemberECP as %ZEN.Datatype.string [ InitialExpression = "n/a" ];
Property methods: ThisMemberECPDisplayToLogical(), ThisMemberECPGet(), ThisMemberECPIsValid(), ThisMemberECPLogicalToDisplay(), ThisMemberECPLogicalToOdbc(), ThisMemberECPNormalize(), ThisMemberECPSet()
property ThisMemberName as %ZEN.Datatype.string [ InitialExpression = "n/a" ];
Property methods: ThisMemberNameDisplayToLogical(), ThisMemberNameGet(), ThisMemberNameIsValid(), ThisMemberNameLogicalToDisplay(), ThisMemberNameLogicalToOdbc(), ThisMemberNameNormalize(), ThisMemberNameSet()
property ThisMemberPrivateAddress as %ZEN.Datatype.string [ InitialExpression = "n/a" ];
Property methods: ThisMemberPrivateAddressDisplayToLogical(), ThisMemberPrivateAddressGet(), ThisMemberPrivateAddressIsValid(), ThisMemberPrivateAddressLogicalToDisplay(), ThisMemberPrivateAddressLogicalToOdbc(), ThisMemberPrivateAddressNormalize(), ThisMemberPrivateAddressSet()
property VirtualIP as %String;
Property methods: VirtualIPDisplayToLogical(), VirtualIPGet(), VirtualIPIsValid(), VirtualIPLogicalToDisplay(), VirtualIPLogicalToOdbc(), VirtualIPNormalize(), VirtualIPSet()
property VirtualInterface as %String;
Property methods: VirtualInterfaceDisplayToLogical(), VirtualInterfaceGet(), VirtualInterfaceIsValid(), VirtualInterfaceLogicalToDisplay(), VirtualInterfaceLogicalToOdbc(), VirtualInterfaceNormalize(), VirtualInterfaceSet()
property colActivate as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Activate") ];
Property methods: colActivateDisplayToLogical(), colActivateGet(), colActivateIsValid(), colActivateLogicalToDisplay(), colActivateLogicalToOdbc(), colActivateNormalize(), colActivateSet()
property colCatchup as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Catchup") ];
Property methods: colCatchupDisplayToLogical(), colCatchupGet(), colCatchupIsValid(), colCatchupLogicalToDisplay(), colCatchupLogicalToOdbc(), colCatchupNormalize(), colCatchupSet()
property colMount as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Mount") ];
Store translated targetCol linkCaption for
Property methods: colMountDisplayToLogical(), colMountGet(), colMountIsValid(), colMountLogicalToDisplay(), colMountLogicalToOdbc(), colMountNormalize(), colMountSet()
property colRemove as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Remove") ];
Property methods: colRemoveDisplayToLogical(), colRemoveGet(), colRemoveIsValid(), colRemoveLogicalToDisplay(), colRemoveLogicalToOdbc(), colRemoveNormalize(), colRemoveSet()
property failedCnt as %ZEN.Datatype.boolean [ InitialExpression = ##class(SYS.MirrorConfiguration).LookupLocalValidationFailures(.failure,0) ];
If server encountered failure that cannot be ignored.
Property methods: failedCntDisplayToLogical(), failedCntGet(), failedCntIsValid(), failedCntLogicalToDisplay(), failedCntLogicalToOdbc(), failedCntLogicalToXSD(), failedCntNormalize(), failedCntSet(), failedCntXSDToLogical()


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 ActivateDB(Dir As %String) as %String [ ZenMethod ]
classmethod CatchupDB(Dir As %String, ActReq As %Boolean) as %String [ ZenMethod ]
method ChangeNoFailover(mirname As %String) as %String [ ZenMethod ]
method CheckJournaling() as %Integer [ ZenMethod ]
clientmethod CheckMissingDB() [ Language = javascript ]
classmethod CheckPromoteWarn(mirname) as %String [ ZenMethod ]
method CheckVIP(mirname) as %Integer [ ZenMethod ]
method ClearNoFailover(mirname As %String) as %String [ ZenMethod ]
method DemotePartner(MirrorName) as %String [ ZenMethod ]
method DemoteToDR(MirrorName) as %String [ ZenMethod ]
method DrawAsyncInfo() as %Status [ ZenMethod ]
method DrawFailoverInfo(RefreshCompress) as %Status [ ZenMethod ]
method DrawMirrorStatus(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
method DrawNoFailoverInfo() as %Status [ ZenMethod ]
method GetCompressRate(mirrorName As %String, Async As %Integer) as %Status [ ZenMethod ]
method GetValidationInfo(ByRef pParms, Output pObject As %RegisteredObject) as %Status
classmethod MultipleFailover(mirname As %String) as %Integer [ ZenMethod ]
method OnDrawRibbon() as %Status
Add to the contents of the tool ribbon.
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 OtherIsPrimary(mirname As %String) as %Integer [ ZenMethod ]
classmethod ProcessConnect(mirrorName As %String, canDisconnect As %Boolean) as %String [ ZenMethod ]
method PromoteToFailoverMember(virtualinterface) as %Integer [ ZenMethod ]
method RefreshFailoverInfo() as %Status [ ZenMethod ]
classmethod RemoveDB(Dir As %String) as %String [ ZenMethod ]
classmethod UpdateTableNavState(pFilter As %String, pPageSize As %Integer, pMaxRows As %Integer, ptableId As %String) [ ZenMethod ]
Used to Save tableNavBar values, add MapType to the page name to distinguish the type for the page.
clientmethod doAction(action) [ Language = javascript ]
clientmethod doActivate(dbName, dbDir) [ Language = javascript ]
clientmethod doAuth(PID) [ Language = javascript ]
clientmethod doCatchup(dbName, dbDir, actReq) [ Language = javascript ]
clientmethod doConnect(mirrorName, canDisconnect) [ Language = javascript ]
clientmethod doDemote() [ Language = javascript ]
clientmethod doDetails(mirName) [ Language = javascript ]
clientmethod doJournal() [ Language = javascript ]
clientmethod doMount(dbName, dbDir) [ Language = javascript ]
clientmethod doNoFailover() [ Language = javascript ]
clientmethod doPromote() [ Language = javascript ]
clientmethod doPromotePage(vipact, InterfaceSeed, DownList) [ Language = javascript ]
clientmethod doRemove(dbName, dbDir) [ Language = javascript ]
clientmethod filterChanged(value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
Overriden to add tabId and tableId to the page name to distinguish the type for the page.
Overriden to add tabId and tableId to the page name to distinguish the type for the page.
clientmethod 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.
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
clientmethod updateView(InTimer, NoCompress) [ Language = javascript ]
Update / Reload tables. This overrides the one in Portal.Utils.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab