Class %CSP.UI.Portal.ECP

class %CSP.UI.Portal.ECP extends %CSP.UI.Portal.Template

System Management Portal - System Configuration - ECP

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
6	4	17

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	ConfigIsManaged	DialogLink	FirstFailed
HelpAddress	ISREADONLY	InvalidParam	IsEMSReadOnly
IsEditForm	LocatorHeader	OnclickArray	PID
ParentURL	SSLLinkCli	SSLLinkSvr	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
BuildMenu	CheckAllBlanks	CheckContextLinks	CheckECPSSL
CheckEnterpriseManager	ConvertParameter	Decrypt	DoLogout
DrawLocator	DrawRibbon	DrawSSLStatus	DrawServiceStatus
DrawTitle	Encrypt	EscapeHTML	EscapeURL
EvalResult	GetCSPURL	GetContextLinks	GetDocURL
GetHomePage	GetNewURL	GetQuickLinks	HyperEventCall
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	JavaInstalled	Link	OnDrawRibbon
OnGetRibbonInfo	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	QuoteJS	RegisterRecent	RewriteURL
SSLChanged	SaveData	ShowError	StartTimer
StopTimer	ThrowError	UnescapeHTML	UnescapeURL
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore	afterSave
afterValidate	cancelPopup	changePassword	childrenMutated
correctIELayering	createComponent	createComponentNS	deleteComponent
disableCommandButton	doAppServers	doCancel	doDataServers
doModified	doSave	doService	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	enableCommandButton	endModal	exposeComponent
findElement	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	getChildIndex	getComponent	getComponentById
getEnclosingDiv	getHidden	getHintElement	getLabelElement
getOpener	getPageTitle	getProperty	getSettings
getTitleAreaHeight	getType	goHome	goMenu
gotoNamespace	gotoPage	hideCommandButton	invokeSuper
isButtonDisabled	isOfType	launchPopupWindow	logout
makeId	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	setComponentId	setConnectivityStatusMsg	setHidden
setModified	setOverlayMode	setPageTitle	setProperty
setPropertyAll	setSortMode	setSortModeHandler	setTraceOption
setViewMode	setViewModeHandler	showAbout	showCommandButton
showContact	showDocumentation	showHelp	showMsg
startModal	startProgressBar	stopProgressBar	switchNamespace
trimSpace	validate	validateRequired

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.ECP.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 HELPADDRESS = "Home,Configuration,ECP Settings";

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

• parameter PAGENAME = "ECP Settings";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Manage";

Security requirement

Properties

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

Property ConfigIsManaged As %Boolean [ InitialExpression = {##class(%SYS.EMS).IsReadOnly("Config.config")} ];

• property DialogLink as %String [ InitialExpression = ..Link("/csp/sys/sec/%CSP.UI.Portal.Dialog.Service.zen",,1) ];

• property SSLLinkCli as %ZEN.Datatype.string;

• property SSLLinkSvr as %ZEN.Datatype.string;

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.

• classmethod CheckECPSSL() as %Integer [ ZenMethod ]

Return -1: not exist, 0: disabled, 1: exist and enabled.

• method DrawSSLStatus() as %Status [ ZenMethod ]

• method DrawServiceStatus() as %Status [ 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.

• method SSLChanged(newvalue) [ Language = javascript ]

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

• method doDataServers() [ Language = javascript ]

• method doSave() [ Language = javascript ]

• method doService() [ Language = javascript ]

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

Get the title string to add to the locator row.

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

This client event, if present, is fired when the a popup page launched from this page fires an action.

• method onloadHandler() [ Language = javascript ]

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

• method openSSL(isClient) [ Language = javascript ]

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

Class Reference IRIS for UNIX 2024.1.2
Documentation Search