Home > Class Reference > ENSLIB namespace > %CSP.UI.Portal.Mirror.Monitor
Private  Storage   


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

System Management Portal - System Operations - Mirror Monitor


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 32 46


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

%condition %import %includeFiles %page
%resource CanConnect CanDisconnect CanManage
CurrentASYNCmpMode CurrentASYNCmpType CurrentColumn CurrentFOCmpMode
CurrentFOCmpType CurrentMultiDejournal CurrentSort DefinedPrimary
DisableRemove DisableSave DownList Filter
FirstFailed HelpAddress ISREADONLY InvalidParam
IsDR IsEMSReadOnly IsEditForm IsNoPartnerNoFailover
IsNotSetUp IsPrimary LocatorHeader MirrorMemberType
MirrorName ModifiedAgentAddress ModifiedPrivateAddress MyMemberName
NewDefinedPrimary NoFailoverBtn NumberOfFailover NumberOfMirrorSet
OldAgentAddr OldECPAddr OldMemberName OldPrivateAddr
OnclickArray OtherMemberECP OtherMemberName OtherMemberPrivateAddress
PID ParentURL PromoteErrorText ReceivedData
SSLDefined SSLLink SelectedMirror ShowVAI
StdTitle TableMaxRows TablePageSize ThisMemberECP
ThisMemberName ThisMemberPrivateAddress ValidationErrorMsg VirtualIP
VirtualInterface aboutPage align aux
backgroundTimerInterval captionLastUpdate cellAlign cellSize
cellStyle cellVAlign children colActivate
colCatchup colMount colRemove composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode disabled dragAndDrop
dragEnabled dropEnabled enableAutoRefresh enclosingClass
enclosingStyle error failedCnt 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
pageModified parent searchKey showLabel
slice title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

%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 %GetNavTableState
%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 ActivateDB AnyDNUpdates BuildMenu
BuildMeter CatchupDB ChangeNoFailover CheckAllBlanks
CheckContextLinks CheckEnterpriseManager CheckMissingDB CheckPromoteWarn
CheckVIP ClearNoFailover CompressMode CompressType
ConvertParameter Decrypt DeleteLocalConfig DemotePartner
DemoteToDR DisplayError DoLogout DrawAsyncInfo
DrawAutoRefresh DrawConnectLink DrawFailoverInfo DrawLocator
DrawMirrorStatus DrawNetworkInterface DrawNoFailoverInfo DrawRibbon
DrawTitle Encrypt EscapeHTML EscapeURL
EvalResult FixBaseDirectory GetCSPURL GetCompressRate
GetContextLinks GetDefaultAgentAddress GetDocURL GetHomePage
GetJoinInfo GetMirrorFailureInfo GetNewURL GetQuickLinks
GetSSLLink GetValidationInfo HyperEventCall HyperEventHead
Include InitialSSLverification InsertHiddenField InsertHiddenFields
IsPrivate LastUpdateTime Link MultiDejournal
MultipleFailover OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page ProcessConnect
PromoteToFailoverMember QuoteJS RefreshFailoverInfo RegisterRecent
RemoveDB RewriteURL SSLverification ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL UpdateAutoRefreshRate UpdateAutoRefreshState UpdateTableNavState
UpdateTableState ValidateAddress ValidateArbiterAddress ValidateMemberName
ValidateMirror XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
afterSave afterValidate cancelPopup changeArbiter
changePassword childrenMutated cleanInput columnSort
correctIELayering createComponent createComponentNS deleteComponent
disableCommandButton doAction doActivate doAuth
doCancel doCatchup doChangeBaseDir doConnect
doDemote doDetails doJoinNewMember doJournal
doModified doMount doNoFailover doPromote
doPromotePage doRemove doRemoveLocalConfig doUpdateNode
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler enableCommandButton endModal
exposeComponent filterChanged findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getEnclosingDiv getFailureMessages
getHidden getHintElement getLabelElement getOpener
getPageTitle getProperty getSettings getTime
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton invokeSuper
isButtonDisabled isOfType launchPopupWindow logout
makeId modifiedAddress modifiedAgentAddress modifiedECPAddress
modifiedMemberName navMaxRowsChanged navPageSizeChanged navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler openSSL popupActionHandler refreshContents
refreshHandler refreshkeyUp removeChild render
renderContents renderSVG resetMsg searchBlur
searchBoxHandler searchFocus searchKeyDown searchKeyPress
selectVIP setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setRefreshMode setRefreshRate setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showCommandButton showContact showDocumentation
showHelp showMsg startModal startProgressBar
stopProgressBar switchNamespace toggle toggleSSL
trimSpace updateAddress updateTime updateView
validateRequired zeroFill


• 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";
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";
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 CanDisconnect as %Boolean [ InitialExpression = 0 ];
True on the secondary failover member, when it is connected
• property CanManage as %ZEN.Datatype.boolean [ InitialExpression = $System.Security.Check("%Admin_Manage","USE") ];
Check if user has manage privilege
• property DefinedPrimary as %String;
Current 'no failover' state.
• property DownList as %String;
• property IsDR as %Integer [ InitialExpression = 0 ];
• property IsNoPartnerNoFailover as %Integer [ InitialExpression = 0 ];
1 - The DefinedPrimary is the special name of No Partner No Failover promotion.
• property IsNotSetUp as %Boolean [ InitialExpression = 0 ];
True on the secondary failover member, when it hasn't been added to the primary
• property IsPrimary as %Integer [ InitialExpression = $SYSTEM.Mirror.IsPrimary() ];
• property MirrorMemberType as %Integer [ InitialExpression = $System.Mirror.IsMember() ];
0 - not a mirror member
1 - failover mirror member
2 - async mirror member
• property MirrorName as %String;
Failover member's mirror name
• property MyMemberName as %String;
Member name of local system.
• property NewDefinedPrimary as %String;
Candidate of the new DefinedPrimary.
• property NoFailoverBtn as %Integer [ InitialExpression = 0 ];
1 - display 'Clear/Set No Failover' button, 0 - don't display
• property NumberOfFailover as %Integer [ InitialExpression = 0 ];
• property NumberOfMirrorSet as %Integer [ InitialExpression = 0 ];
Number of mirror set configured.
• property OtherMemberECP as %ZEN.Datatype.string [ InitialExpression = "n/a" ];
• property OtherMemberName as %ZEN.Datatype.string [ InitialExpression = "n/a" ];
• property OtherMemberPrivateAddress as %ZEN.Datatype.string [ InitialExpression = "n/a" ];
• property PromoteErrorText as %String;
• property ReceivedData as %String [ InitialExpression = "0,0,0" ];
Failover member's mirror name
• property SelectedMirror as %String [ InitialExpression = "*" ];
The currently selected mirror on an async member
• property ThisMemberECP as %ZEN.Datatype.string [ InitialExpression = "n/a" ];
• property ThisMemberName as %ZEN.Datatype.string [ InitialExpression = "n/a" ];
• property ThisMemberPrivateAddress as %ZEN.Datatype.string [ InitialExpression = "n/a" ];
• property VirtualIP as %String;
• property VirtualInterface as %String;
• property colActivate as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Activate") ];
• property colCatchup as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Catchup") ];
• property colMount as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Mount") ];
Store translated targetCol linkCaption for
• property colRemove as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Remove") ];
• property failedCnt as %ZEN.Datatype.boolean [ InitialExpression = ##class(SYS.MirrorConfiguration).LookupLocalValidationFailures(.failure,0) ];
If server encountered failure that cannot be ignored.


• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
• 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 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 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 DrawConnectLink(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
• 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 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.
• method doAction(action) [ Language = javascript ]
• method doActivate(dbName, dbDir) [ Language = javascript ]
• method doAuth(PID) [ Language = javascript ]
• method doCatchup(dbName, dbDir, actReq) [ Language = javascript ]
• method doConnect(mirrorName, canDisconnect) [ Language = javascript ]
• method doDemote() [ Language = javascript ]
• method doDetails(mirName) [ Language = javascript ]
• method doJournal() [ Language = javascript ]
• method doMount(dbName, dbDir) [ Language = javascript ]
• method doNoFailover() [ Language = javascript ]
• method doPromote() [ Language = javascript ]
• method doPromotePage(vipact, InterfaceSeed, DownList) [ Language = javascript ]
• method doRemove(dbName, dbDir) [ Language = javascript ]
• method filterChanged(value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
• method navMaxRowsChanged(value, tableId) [ Language = javascript ]
Overriden to add tabId and tableId to the page name to distinguish the type for the page.
• method navPageSizeChanged(value, tableId) [ Language = javascript ]
Overriden to add tabId and tableId to the page name to distinguish the type for the page.
• 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 onloadHandler() [ Language = javascript ]
Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
• method updateView(InTimer, NoCompress) [ Language = javascript ]
Update / Reload tables. This overrides the one in Portal.Utils.