Class Reference
%CSP.UI.Portal.Mirror.Dialog.JoinNewMember
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
  
-
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [Mirror] >  [Dialog] >  [JoinNewMember]
Private  Storage

class %CSP.UI.Portal.Mirror.Dialog.JoinNewMember extends %CSP.UI.Portal.Dialog.WizardTemplate, %ZEN.Portal.Utils, %CSP.UI.Portal.Mirror.Utils

This page maybe called to allow user to join the system as a new member when certain failure occurred.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 6 28


Summary

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

Properties
%condition %import %includeFiles %page
%resource CurrentASYNCmpMode CurrentASYNCmpType CurrentFOCmpMode
CurrentFOCmpType CurrentMultiDejournal DisableRemove DisableSave
FailoverCount FirstFailed InitialMessage InvalidParam
IsEMSReadOnly MemberCount MemberType MirrorName
ModifiedAgentAddress ModifiedPrivateAddress OldAgentAddr OldECPAddr
OldMemberName OldPrivateAddr PrimaryId SSLDefined
SSLLink ShowVAI ValidationErrorMsg align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
containerStyle cssLevel dialogTitle disabled
disabledStyle dragAndDrop dragEnabled dropEnabled
enclosingClass enclosingStyle error groupClass
groupStyle height helpId hidden
hideApplyButton hideCancelButton hint hintClass
hintStyle id index label
labelClass labelDisabledClass labelPosition labelStyle
layout name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate parent
showLabel slice title tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToSaveSet %ApplyURLParms %Attr
%BindExport %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSStrings %DrawObjectDefinitions %DrawTitle %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetLinks
%GetPageName %GetParameter %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 %OnGetSubtitle
%OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch
%OnPreHTTP %OnSubmit %OnUseSoftModals %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%ZENVersion AnyDNUpdates CompressMode CompressType
ConvertParameter Decrypt DeleteLocalConfig DisplayError
DrawNetworkInterface Encrypt EscapeHTML EscapeURL
EvalResult FixBaseDirectory GetDefaultAgentAddress GetJoinInfo
GetMirrorFailureInfo GetSSLLink GetSystemInfo HyperEventCall
HyperEventHead Include InitialSSLverification InsertHiddenField
InsertHiddenFields IsEnabled IsIPFormatValid IsPrivate
JavaInstalled Link MultiDejournal OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RetrieveMirrorConfig RewriteURL SSLverification SaveData
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL ValidateAddress ValidateArbiterAddress
ValidateMemberName ValidateMirror ValidateVI XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore adjustSize btnApply
btnOK canFinish canGoBack canGoNext
cancelPopup changeArbiter changeType childrenMutated
cleanInput correctIELayering createComponent createComponentNS
ctrlKeyDown deleteComponent dialogApply dialogCancel
dialogFinish dialogTitleGet disableButtons disableCommandButton
doChangeAsyncMemberType doChangeBaseDir doChangeEncryptCommunication doJoinNewMember
doRemoveLocalConfig doSSL doUpdateNode dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler enableCommandButton endModal exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction formValidationHandler getChildIndex getComponent
getComponentById getDialogValue getEnclosingDiv getFailureMessages
getHidden getHintElement getLabelElement getLocalMirrorInfo
getOpener getProperty getSettings getType
gotoPage handleType hasMultiplePages hideCommandButton
hideContent invokeSuper isOfType launchPopupWindow
makeId modifiedAddress modifiedAgentAddress modifiedECPAddress
modifiedMemberName nextPage onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondialogCancel ondialogFinish ondialogStart
ondisabledHandler onfinishHandler onhandleAutoLogoutWarn onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onstartHandler onunloadHandler
onupdateHandler openSSL popupActionHandler previousPage
refreshContents removeChild render renderContents
renderSVG resetMsg selectVIP setComponentId
setHidden setOverlayMode setProperty setPropertyAll
setTraceOption showCommandButton showDocumentation showHelp
showMsg startModal startProgressBar stopProgressBar
toggle toggleSSL updateAddress updateState
validateAgent validateBeforeSave validateIPFormat validateInstanceName
validateLogicalIndex validateOurname validateRequired validateSuperServer


Parameters

• 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.Mirror.Dialog.JoinNewMember.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 PAGENAME = "JoinNewMember";
Displayed name of this page.
• parameter RESOURCE = "%Admin_Manage";
Security requirement

Properties

• property FailoverCount as %ZEN.Datatype.string(ZENURL="FailoverCount");
• property InitialMessage as %String;
• property MemberCount as %ZEN.Datatype.string(ZENURL="MemberCount");
• property MemberType as %ZEN.Datatype.string(ZENURL="MemberType");
• property MirrorName as %ZEN.Datatype.string(ZENURL="MirrorName");
• property PrimaryId as %ZEN.Datatype.string(ZENURL="PrimaryId");

Methods

• method %OnAfterCreatePage() as %Status
Be sure to do ##super() when overriding.
• 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.
• method GetSystemInfo(ByRef pParms, Output pObject As %RegisteredObject) as %Status
Method to get validation info
• classmethod IsIPFormatValid(pAddress, pAddressType) as %String [ ZenMethod ]
pAddressType = "default" or "super" or "agent"
• classmethod RetrieveMirrorConfig(pMirname, pIpaddr, pPort, pInstanceName) as %String [ ZenMethod ]
• classmethod SaveData(pMirrorName, pSystemName, pMemberType, pAsyncMemberType, pMirrorInfo As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
• classmethod ValidateMemberName(pName) as %String [ ZenMethod ]
• classmethod ValidateVI(pIdxnum, pOS, pHpsun, pVirt) as %String [ ZenMethod ]
• method changeType() [ Language = javascript ]
user selected/changed Join Mirror type as Failover(joinType=1) or Async(joinType=2)
• method doChangeAsyncMemberType(AsyncMemberType) [ Language = javascript ]
User has selected an AsyncMemberType
• method doChangeEncryptCommunication() [ Language = javascript ]
User has made a selection of EncryptCommunication type
• method doSSL(btnId) [ Language = javascript ]
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• method getLocalMirrorInfo() [ Language = javascript ]
delete?
• method handleType() [ Language = javascript ]
user changed the join type: Failover or Async. if Failover,
• method hideContent(flag) [ Language = javascript ]
• method onPopupAction(popupName, action, value) [ Language = javascript ]
Overriding for DN redraw
• method ondialogCancel() [ Language = javascript ]
This callback, if defined, is called when the user presses the Cancel button. If this returns false, then the dialog is not cancelled.
• method 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.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method validateAgent() [ Language = javascript ]
• method validateBeforeSave() [ Language = javascript ]
Check all mirroring fields and display all error messages.
• method validateIPFormat() [ Language = javascript ]
• method validateInstanceName() [ Language = javascript ]
• method validateLogicalIndex() [ Language = javascript ]
• method validateOurname() [ Language = javascript ]
• method validateSuperServer() [ Language = javascript ]

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