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

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


abstract class %CSP.UI.Portal.Mirror.Utils

Utility class for System Management Portal mirorring pages

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter DOMAIN = %Utility;


property CurrentASYNCmpMode as %Integer [ InitialExpression = 0 ];
Property methods: CurrentASYNCmpModeDisplayToLogical(), CurrentASYNCmpModeGet(), CurrentASYNCmpModeIsValid(), CurrentASYNCmpModeLogicalToDisplay(), CurrentASYNCmpModeNormalize(), CurrentASYNCmpModeSet()
property CurrentFOCmpMode as %Integer [ InitialExpression = 0 ];
Property methods: CurrentFOCmpModeDisplayToLogical(), CurrentFOCmpModeGet(), CurrentFOCmpModeIsValid(), CurrentFOCmpModeLogicalToDisplay(), CurrentFOCmpModeNormalize(), CurrentFOCmpModeSet()
property CurrentMultiDejournal as %Integer [ InitialExpression = 0 ];
Property methods: CurrentMultiDejournalDisplayToLogical(), CurrentMultiDejournalGet(), CurrentMultiDejournalIsValid(), CurrentMultiDejournalLogicalToDisplay(), CurrentMultiDejournalNormalize(), CurrentMultiDejournalSet()
property DisableRemove as %Boolean [ InitialExpression = 0 ];
Property methods: DisableRemoveDisplayToLogical(), DisableRemoveGet(), DisableRemoveIsValid(), DisableRemoveLogicalToDisplay(), DisableRemoveNormalize(), DisableRemoveSet()
property DisableSave as %Boolean [ InitialExpression = 0 ];
Property methods: DisableSaveDisplayToLogical(), DisableSaveGet(), DisableSaveIsValid(), DisableSaveLogicalToDisplay(), DisableSaveNormalize(), DisableSaveSet()
property ModifiedAgentAddress as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Property methods: ModifiedAgentAddressDisplayToLogical(), ModifiedAgentAddressGet(), ModifiedAgentAddressIsValid(), ModifiedAgentAddressLogicalToDisplay(), ModifiedAgentAddressLogicalToOdbc(), ModifiedAgentAddressNormalize(), ModifiedAgentAddressSet()
property ModifiedPrivateAddress as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Property methods: ModifiedPrivateAddressDisplayToLogical(), ModifiedPrivateAddressGet(), ModifiedPrivateAddressIsValid(), ModifiedPrivateAddressLogicalToDisplay(), ModifiedPrivateAddressLogicalToOdbc(), ModifiedPrivateAddressNormalize(), ModifiedPrivateAddressSet()
property OldAgentAddr as %ZEN.Datatype.string;
Property methods: OldAgentAddrDisplayToLogical(), OldAgentAddrGet(), OldAgentAddrIsValid(), OldAgentAddrLogicalToDisplay(), OldAgentAddrLogicalToOdbc(), OldAgentAddrNormalize(), OldAgentAddrSet()
property OldECPAddr as %ZEN.Datatype.string;
Property methods: OldECPAddrDisplayToLogical(), OldECPAddrGet(), OldECPAddrIsValid(), OldECPAddrLogicalToDisplay(), OldECPAddrLogicalToOdbc(), OldECPAddrNormalize(), OldECPAddrSet()
property OldMemberName as %ZEN.Datatype.string;
Property methods: OldMemberNameDisplayToLogical(), OldMemberNameGet(), OldMemberNameIsValid(), OldMemberNameLogicalToDisplay(), OldMemberNameLogicalToOdbc(), OldMemberNameNormalize(), OldMemberNameSet()
property OldPrivateAddr as %ZEN.Datatype.string;
Property methods: OldPrivateAddrDisplayToLogical(), OldPrivateAddrGet(), OldPrivateAddrIsValid(), OldPrivateAddrLogicalToDisplay(), OldPrivateAddrLogicalToOdbc(), OldPrivateAddrNormalize(), OldPrivateAddrSet()
property SSLDefined as %ZEN.Datatype.boolean [ InitialExpression = $$$SSLDefined ];
Property methods: SSLDefinedDisplayToLogical(), SSLDefinedGet(), SSLDefinedIsValid(), SSLDefinedLogicalToDisplay(), SSLDefinedLogicalToOdbc(), SSLDefinedNormalize(), SSLDefinedSet()
Property methods: SSLLinkDisplayToLogical(), SSLLinkGet(), SSLLinkIsValid(), SSLLinkLogicalToDisplay(), SSLLinkLogicalToOdbc(), SSLLinkNormalize(), SSLLinkSet()
property ShowVAI as %ZEN.Datatype.boolean [ InitialExpression = $ZCVT($ZV,"U")["HP-UX" ];
Property methods: ShowVAIDisplayToLogical(), ShowVAIGet(), ShowVAIIsValid(), ShowVAILogicalToDisplay(), ShowVAILogicalToOdbc(), ShowVAINormalize(), ShowVAISet()


classmethod AnyDNUpdates(MirrorName As %String) as %Integer [ ZenMethod ]
clientmethod CompressMode(val, isAsync) [ Language = javascript ]
User modified compression mode.
classmethod DeleteLocalConfig(pDeleteDBs, pDeleteJournals) as %Status
This method is created based on DeleteLocalConfig^MIRROR for SMP to use
method DisplayError(error As %Status) as %Status
classmethod DrawNetworkInterface(pSeed As %String) as %Status
This method is called by Mirror pages to build drop-down list for Interfaces
classmethod FixBaseDirectory(pMirrorName, pSysName, pBaseDir) as %ZEN.proxyObject [ ZenMethod ]
Fix failure code "BADDIR" with new base directory. (currently not used)
method GetDefaultAgentAddress(ECPAddr As %String) as %String [ ZenMethod ]
classmethod GetJoinInfo(mirname, ByRef pObject As %ZEN.proxyObject) as %Status
Return information about PrimaryId and Failover member count
classmethod GetMirrorFailureInfo(pFailureCode As %String, pMirrorName As %String, pInfo As %String, Output pFail As %ZEN.proxyObject) as %Status
This method is called by Mirror pages to return linkSSL and labelSSL by reference If both %MirrorClient and %MirrorServer are defined, we will return "View Mirror..." link text. Otherwise it is "Create...".
method InitialSSLverification(mirrorname As %String, instance As %String, ipaddr As %String, port As %String) as %String [ ZenMethod ]
clientmethod MultiDejournal(val) [ Language = javascript ]
classmethod SSLverification(mirrorname) as %ZEN.proxyObject [ ZenMethod ]
classmethod ValidateAddress(Addr As %String) as %String [ ZenMethod ]
classmethod ValidateArbiterAddress(Address) as %String [ ZenMethod ]
classmethod ValidateMemberName(Name As %String) as %String [ ZenMethod ]
classmethod ValidateMirror(Output pObject As %ZEN.proxyObject) as %Status
***** The following methods deal with failure management. ***** /// ***** Currently they are shared by EditFailover and Monitor. ***** /// ***** If you make changes, please re-test both pages. ***** /// This method returns information regarding mirror failure, if any, for the UI.
clientmethod changeArbiter(newVal) [ Language = javascript ]
Updating arbiter address, we need to validate the address.
clientmethod cleanInput(field) [ Language = javascript ]
clientmethod doChangeBaseDir() [ Language = javascript ]
handle possible "BADDIR" failure code. (currently not used)
clientmethod doJoinNewMember() [ Language = javascript ]
handle special case of failure to allow join this mirror as a new member.
clientmethod doRemoveLocalConfig() [ Language = javascript ]
handle special case of failure to remove local config
clientmethod doUpdateNode(nodeName) [ Language = javascript ]
Access edit node dialog directly from the "Update network address" link when failureMessage includes it. Maybe called from EditFailover or EditAsync or Monitor
clientmethod getFailureMessages(json) [ Language = javascript ]
Return options to deal with mirroring faiture situations json representing failure object should be passed in.
clientmethod modifiedAddress(NewVal, Type, useZen) [ Language = javascript ]
user modified Private Address
clientmethod modifiedAgentAddress(NewVal, Type, useZen) [ Language = javascript ]
user modified Agent Address
clientmethod modifiedECPAddress(NewVal, Type, useZen) [ Language = javascript ]
user modified SuperServer Address
clientmethod modifiedMemberName(NewVal, Type, useZen) [ Language = javascript ]
clientmethod openSSL() [ Language = javascript ]
clientmethod selectVIP(value, useZen) [ Language = javascript ]
user selected a VIP from drop-down. put it into the textbox and show when ShowVAI is true.
clientmethod toggle(id) [ Language = javascript ]
show/hide advanced or connectivity setting box
clientmethod toggleSSL(value) [ Language = javascript ]
show/hide SSL/TLS Config link. value = 1 is to show.
clientmethod updateAddress(val, isZen) [ Language = javascript ]
make Superserver address the default for Private address, if user has not manually changed the Private address.