Class %CSP.UI.Portal.Dialog.Service

class %CSP.UI.Portal.Dialog.Service extends %CSP.UI.Portal.Dialog.WizardTemplate, %CSP.UI.Component.SelectBoxUtils

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.

Edit Service Popup Dialog for Management Portal

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
7	9	21

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	AuthList	ECPLink	EnableClientSystem
FirstFailed	FromPage	InvalidParam	IsEMSReadOnly
MonitorLink	OldUnauthenticated	PID	ServiceOK
ShadowLink	ValidationErrorMsg	align	aux
avaList	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
selList	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	ConvertParameter	Decrypt	DrawArrows
DrawArrowsOld	DrawAvailableList	DrawCSPLink	DrawConnectionTable
DrawPageTitle	DrawSelectList	DrawUpArrowsOld	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	ValidateIP	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	addChild	addChildAfter
addChildBefore	adjustSize	btnApply	btnOK
canFinish	canGoBack	canGoNext	cancelPopup
childrenMutated	clearList	correctIELayering	createComponent
createComponentNS	ctrlKeyDown	deleteAll	deleteComponent
deleteIndex	dialogApply	dialogCancel	dialogFinish
dialogTitleGet	disableButtons	doAddIP	doSave
doSelectBoxMove	doSelectBoxMoveAll	doSelectBoxMoveItem	doSelectBoxMoveList
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	endModal	exposeComponent
findElement	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	formValidationHandler	getChildIndex	getComponent
getComponentById	getDialogValue	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getProperty
getSelList	getSettings	getType	gotoPage
hasMultiplePages	hideRoles	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
refreshConnectionTable	refreshContents	removeChild	render
renderContents	renderSVG	resetMsg	saveRoles
setComponentId	setHidden	setOverlayMode	setProperty
setPropertyAll	setTraceOption	showDocumentation	showHelp
showMsg	showRoles	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;

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

• parameter CSPURL = "/csp/sys/sec/%CSP.UI.Portal.Dialog.Service.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 = "Security";

• parameter PAGENAME = "ServiceEdit";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Secure";

Security requirement

Properties

• property AuthList as %ZEN.Datatype.list(DELIMITER=";");

• property ECPLink as %String [ InitialExpression = ..Link("/csp/sys/mgr/%25CSP.UI.Portal.ECP.zen") ];

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

• property FromPage as %ZEN.Datatype.string(ZENURL="from");

• property MonitorLink as %String [ InitialExpression = ..Link("/csp/sys/mgr/%25CSP.UI.Portal.Monitoring.zen") ];

• property OldUnauthenticated as %Boolean;

• property PID as %ZEN.Datatype.string(ZENURL="PID");

When editing a service this is passed in as the service name.

• property ServiceOK as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

• property ShadowLink as %String [ InitialExpression = ..Link("/csp/sys/mgr/%25CSP.UI.Portal.Shadows.zen") ];

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 DrawCSPLink(pSeed As %String) as %Status

• method DrawConnectionTable(pSeed As %String) as %Status

• classmethod DrawPageTitle(pSeed As %String) as %Status

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

• classmethod ValidateIP(IP As %String) as %String [ ZenMethod ]

• method deleteAll() [ Language = javascript ]

• method deleteIndex(DeleteIndex, ip, ncli) [ Language = javascript ]

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

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

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

• method refreshConnectionTable() [ Language = javascript ]

refresh the allowed incoming connections table and return whether there are now two or more clients listed

• method saveRoles() [ Language = javascript ]

• method showRoles(index, ip) [ Language = javascript ]

• method validate() [ Language = javascript ]

Class Reference IRIS for UNIX 2024.1.2
Documentation Search