Class %CSP.UI.Portal.Mirror.JoinAsync

class %CSP.UI.Portal.Mirror.JoinAsync extends %CSP.UI.Portal.Template, %CSP.UI.Portal.Mirror.Utils

Zen page for System Management Portal - Join Async

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	3	17

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
FirstFailed	HelpAddress	ISREADONLY	InvalidParam
IsEMSReadOnly	IsEditForm	LocatorHeader	MirrorRequiresSSL
ModifiedAgentAddress	ModifiedPrivateAddress	OldAgentAddr	OldECPAddr
OldMemberName	OldMemberType	OldPrivateAddr	OnclickArray
PID	ParentURL	SSLDefined	SSLLink
ShowVAI	StdTitle	ValidationErrorMsg	aboutPage
align	aux	backgroundTimerInterval	cellAlign
cellSize	cellStyle	cellVAlign	children
composite	contactPage	containerStyle	cssLevel
currSortMode	currStep	currViewMode	disabled
dragAndDrop	dragEnabled	dropEnabled	enableAutoRefresh
enclosingClass	enclosingStyle	error	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

Methods
%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	%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
AnyDNUpdates	BuildMenu	CheckAllBlanks	CheckContextLinks
CheckEnterpriseManager	CompressMode	CompressType	Connect
ConvertParameter	Decrypt	DeleteLocalConfig	DisplayError
DoLogout	DrawLocator	DrawNetworkInterface	DrawRibbon
DrawTitle	Encrypt	EscapeHTML	EscapeURL
EvalResult	FixBaseDirectory	GetCSPURL	GetContextLinks
GetDefaultAgentAddress	GetDocURL	GetHomePage	GetJoinInfo
GetMirrorFailureInfo	GetNewURL	GetQuickLinks	GetSSLLink
HyperEventCall	HyperEventHead	Include	InitialSSLverification
InsertHiddenField	InsertHiddenFields	IsAgentUp	IsPrivate
JavaInstalled	Link	MultiDejournal	OnDrawRibbon
OnGetRibbonInfo	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	QuoteJS	RegisterRecent	RewriteURL
SSLverification	SaveData	ShowError	StartTimer
StopTimer	ThrowError	UnescapeHTML	UnescapeURL
UpdateDN	ValidateAddress	ValidateArbiterAddress	ValidateMemberName
ValidateMirror	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
afterSave	afterValidate	cancelPopup	changeArbiter
changePassword	childrenMutated	cleanInput	correctIELayering
createComponent	createComponentNS	deleteComponent	disableCommandButton
doCancel	doChangeBaseDir	doClear	doConnect
doJoinNewMember	doModified	doRemoveLocalConfig	doSave
doUpdateNode	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	enableCommandButton
endModal	exposeComponent	findElement	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getEnclosingDiv	getFailureMessages
getHidden	getHintElement	getLabelElement	getOpener
getPageTitle	getProperty	getSettings	getTitleAreaHeight
getType	goHome	goMenu	goToNextPage
gotoNamespace	gotoPage	hideCommandButton	invokeSuper
isButtonDisabled	isOfType	launchPopupWindow	logout
makeId	modifiedAddress	modifiedAgentAddress	modifiedECPAddress
modifiedMemberName	modifiedMemberType	navigate	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onPopupAction
onRefreshContents	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondisabledHandler	onhandleAutoLogoutWarn
onkeydownHandler	onkeyupHandler	onlayoutHandler	onloadHandler
onlogoutHandler	onoverlayHandler	onresizeHandler	onunloadHandler
onupdateHandler	openSSL	popupActionHandler	refreshContents
removeChild	render	renderContents	renderSVG
resetMsg	searchBlur	searchBoxHandler	searchFocus
searchKeyDown	searchKeyPress	selectVIP	setComponentId
setConnectivityStatusMsg	setHidden	setModified	setOverlayMode
setPageTitle	setProperty	setPropertyAll	setSortMode
setSortModeHandler	setTraceOption	setViewMode	setViewModeHandler
showAbout	showCommandButton	showContact	showDocumentation
showHelp	showMsg	startModal	startProgressBar
stopProgressBar	switchNamespace	toggle	toggleSSL
trimSpace	updateAddress	validateConnect	validateRequired
validateSave

Parameters

• parameter AUTONS = 0;

Do not switch namespace for this page: it needs to stay in %SYS

• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.Mirror.JoinAsync.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,Configuration,Join Mirror as Async";

Each SMP page should set this link which points to the documentation anchor name.

• parameter PAGENAME = "Join Mirror as Async";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Manage";

Security requirement

Properties

• property IsEditForm as %Boolean [ InitialExpression = 1 ];

If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.

• property MirrorRequiresSSL as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

• property OldMemberType as %Integer;

Methods

• method %OnAfterCreatePage() as %Status

Set Locator bar and determine whether to show change password option.

• method %OnGetPageName() as %String

Get the (localized) name of the page. This should be implemented in a subclass.

• method Connect(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]

Save general association data to server.
Returns proxy.ok = 1 (save successful) or 0 (error occurred)
proxy.ErrorMessage (save failed and display this error message). If proxy.ok is 1 and no messages returned then we return to SMP home.

• classmethod IsAgentUp() as %Integer [ ZenMethod ]

• 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 SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]

Save general association data to server.
Returns proxy.ok = 1 (save successful) or 0 (error occurred)
proxy.ErrorMessage (save failed and display this error message). If proxy.ok is 1 and no messages returned then we return to SMP home.

• method UpdateDN() as %Status [ ZenMethod ]

• method doClear() [ Language = javascript ]

• method doConnect() [ Language = javascript ]

• method doSave() [ Language = javascript ]

• method getPageTitle() as %String [ Language = javascript ]

Get the title string to add to the locator row.

• method goToNextPage() [ Language = javascript ]

• method modifiedMemberType(newVal) [ Language = javascript ]

user modified Async Member Type

• method onPopupAction(popupName, action, value) [ Language = javascript ]

Overriding for DN redraw

• method onloadHandler() [ Language = javascript ]

Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.

• method validateConnect() as %Boolean [ Language = javascript ]

• method validateSave(proxy) [ Language = javascript ]

Class Reference IRIS for UNIX 2024.1.2
Documentation Search