Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [Mirror] >  [Utils]
Private  Storage   

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

Utility class for System Management Portal mirroring pages

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 16 34


Summary

Properties
CurrentASYNCmpMode CurrentASYNCmpType CurrentFOCmpMode CurrentFOCmpType
CurrentMultiDejournal DisableRemove DisableSave ModifiedAgentAddress
ModifiedPrivateAddress OldAgentAddr OldECPAddr OldMemberName
OldPrivateAddr SSLDefined SSLLink ShowVAI

Methods
AnyDNUpdates CompressMode CompressType DeleteLocalConfig
DisplayError DrawNetworkInterface FixBaseDirectory GetDefaultAgentAddress
GetJoinInfo GetMirrorFailureInfo GetSSLLink InitialSSLverification
MultiDejournal SSLverification ValidateAddress ValidateArbiterAddress
ValidateMemberName ValidateMirror changeArbiter cleanInput
doChangeBaseDir doJoinNewMember doRemoveLocalConfig doUpdateNode
getFailureMessages modifiedAddress modifiedAgentAddress modifiedECPAddress
modifiedMemberName openSSL selectVIP toggle
toggleSSL updateAddress

Subclasses
%CSP.UI.Portal.Mirror.Create %CSP.UI.Portal.Mirror.Dialog.DNUpdates %CSP.UI.Portal.Mirror.Dialog.JoinNewMember
%CSP.UI.Portal.Mirror.EditAsync %CSP.UI.Portal.Mirror.EditFailover %CSP.UI.Portal.Mirror.JoinAsync
%CSP.UI.Portal.Mirror.JoinFailover %CSP.UI.Portal.Mirror.Monitor

Parameters

• parameter DOMAIN = "%Utility";

Properties

• property CurrentASYNCmpMode as %Integer [ InitialExpression = 0 ];
• property CurrentASYNCmpType as %Integer [ InitialExpression = 0 ];
• property CurrentFOCmpMode as %Integer [ InitialExpression = 0 ];
• property CurrentFOCmpType as %Integer [ InitialExpression = 0 ];
• property CurrentMultiDejournal as %Integer [ InitialExpression = 0 ];
• property DisableRemove as %Boolean [ InitialExpression = 0 ];
• property DisableSave as %Boolean [ InitialExpression = 0 ];
• property ModifiedAgentAddress as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
• property ModifiedPrivateAddress as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
• property OldAgentAddr as %ZEN.Datatype.string;
• property OldECPAddr as %ZEN.Datatype.string;
• property OldMemberName as %ZEN.Datatype.string;
• property OldPrivateAddr as %ZEN.Datatype.string;
• property SSLDefined as %ZEN.Datatype.boolean [ InitialExpression = $$$SSLDefined ];
• property SSLLink as %ZEN.Datatype.string;
• property ShowVAI as %ZEN.Datatype.boolean [ InitialExpression = $ZCVT($ZV,"U")["HP-UX" ];

Methods

• classmethod AnyDNUpdates(MirrorName As %String) as %Integer [ ZenMethod ]
• method CompressMode(val, isAsync) [ Language = javascript ]
User modified compression mode.
• method CompressType(val, isAsync) [ Language = javascript ]
User modified compression type.
• 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
• classmethod GetSSLLink(Output linkSSL As %String, Output lblSSL As %String) 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 ]
• method 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.
• method changeArbiter(newVal) [ Language = javascript ]
Updating arbiter address, we need to validate the address.
• method cleanInput(field) [ Language = javascript ]
• method doChangeBaseDir() [ Language = javascript ]
handle possible "BADDIR" failure code. (currently not used)
• method doJoinNewMember() [ Language = javascript ]
handle special case of failure to allow join this mirror as a new member.
• method doRemoveLocalConfig() [ Language = javascript ]
handle special case of failure to remove local config
• method 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
• method getFailureMessages(json) [ Language = javascript ]
Return options to deal with mirroring faiture situations json representing failure object should be passed in.
• method modifiedAddress(NewVal, Type, useZen) [ Language = javascript ]
user modified Private Address
• method modifiedAgentAddress(NewVal, Type, useZen) [ Language = javascript ]
user modified Agent Address
• method modifiedECPAddress(NewVal, Type, useZen) [ Language = javascript ]
user modified Superserver Address
• method modifiedMemberName(NewVal, Type, useZen) [ Language = javascript ]
• method openSSL() [ Language = javascript ]
• method selectVIP(value, useZen) [ Language = javascript ]
user selected a VIP from drop-down. put it into the textbox and show when ShowVAI is true.
• method toggle(id) [ Language = javascript ]
show/hide advanced or connectivity setting box
• method toggleSSL(value) [ Language = javascript ]
show/hide SSL/TLS Config link. value = 1 is to show.
• method updateAddress(val, isZen) [ Language = javascript ]
make Superserver address the default for Private address, if user has not manually changed the Private address.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.