Class %CSP.UI.Portal.Dialog.RemoteDatabase

class %CSP.UI.Portal.Dialog.RemoteDatabase extends %CSP.UI.Portal.Dialog.WizardTemplate

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

New Remote Database Dialog for Management Portal

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
8	5	16

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	FirstFailed	InvalidParam	IsEMSReadOnly
MsgDisabled	MsgNotConnected	PID	SelectedServer
SelectedServerNotNormal	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	CheckDBName	ConvertParameter	Decrypt
Encrypt	EscapeHTML	EscapeURL	EvalResult
HyperEventCall	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsEnabled	IsPrivate	JavaInstalled
Link	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	QuoteJS	RewriteURL	SaveData
ShowError	StartTimer	StopTimer	ThrowError
UnescapeHTML	UnescapeURL	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	addChild	addChildAfter
addChildBefore	adjustSize	btnApply	btnOK
canFinish	canGoBack	canGoNext	cancelPopup
changeDirectory	changeSelectList	changeServer	childrenMutated
correctIELayering	createComponent	createComponentNS	ctrlKeyDown
deleteComponent	dialogApply	dialogCancel	dialogFinish
dialogTitleGet	disableButtons	disableDatabaseSelect	doSave
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	endModal	exposeComponent
findElement	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	formValidationHandler	getChildIndex	getComponent
getComponentById	getDialogValue	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getProperty
getSettings	getType	gotoPage	hasMultiplePages
invokeSuper	isOfType	launchPopupWindow	makeId
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
popupActionHandler	previousPage	refreshContents	removeChild
render	renderContents	renderSVG	resetMsg
setComponentId	setHidden	setOverlayMode	setProperty
setPropertyAll	setTraceOption	showDocumentation	showHelp
showMsg	showServerWarning	startModal	startProgressBar
stopProgressBar	updateState	validate	validateRequired

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 AUTONS = 0;

If $NAMESPACE is set, auto switch namespace

• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.Dialog.RemoteDatabase.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 EMSSERVICE = "Namespace";

• parameter HELPID = "GSA_config_databases_remote";

DOCBOOK Topic Id that offers help for this template.

• parameter PAGENAME = "RemoteDatabase";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Manage";

User must hold at least operator privilege to use this dialog.

Properties

• property MsgDisabled as %String [ InitialExpression = $$$Text("The selected server connection is disabled.") ];

• property MsgNotConnected as %String [ InitialExpression = $$$Text("The selected server cannot be reached.") ];

• property PID as %String(ZENURL="PID");

Database for edit. Null if adding new database.

• property SelectedServer as %String;

• property SelectedServerNotNormal as %Boolean [ InitialExpression = 0 ];

Methods

• method %OnAfterCreatePage() as %Status

This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.

• 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.

• classmethod CheckDBName(Name As %String) as %Boolean [ ZenMethod ]

Return 1 if the database name is OK

• classmethod SaveData(PID As %String, pProxy As %ZEN.proxyObject) as %String [ ZenMethod ]

Call server save method. Subclass may override.

• method changeDirectory(dataCombo) [ Language = javascript ]

• method changeSelectList(radioSet) [ Language = javascript ]

• method changeServer(dataCombo) [ Language = javascript ]

• method disableDatabaseSelect(flag) [ Language = javascript ]

• method doSave() [ 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 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 onresizeHandler() [ Language = javascript ]

This client event, if present, is fired when the page is resized.

• method onstartHandler() [ Language = javascript ]

This is called when the template is first displayed; This provides a chance to set focus etc.

• method showServerWarning(flag) [ Language = javascript ]

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


[USER] > [%CSP] > [UI] > [Portal] > [Dialog] > [RemoteDatabase]		Private Storage