Skip to main content


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

System Management Portal - System Configuration - ECP

Property Inventory

Method Inventory


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;
Inherited description: 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;
Inherited description: 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


property ConfigIsManaged as %Boolean [ InitialExpression = 0 ];
Property ConfigIsManaged As %Boolean [ InitialExpression = {##class(%SYS.EMS).IsReadOnly("Config.config")} ];
Property methods: ConfigIsManagedDisplayToLogical(), ConfigIsManagedGet(), ConfigIsManagedIsValid(), ConfigIsManagedLogicalToDisplay(), ConfigIsManagedLogicalToXSD(), ConfigIsManagedNormalize(), ConfigIsManagedSet(), ConfigIsManagedXSDToLogical()
Property methods: DialogLinkDisplayToLogical(), DialogLinkGet(), DialogLinkIsValid(), DialogLinkLogicalToDisplay(), DialogLinkLogicalToOdbc(), DialogLinkNormalize(), DialogLinkSet()
property SSLLinkCli as %ZEN.Datatype.string;
Property methods: SSLLinkCliDisplayToLogical(), SSLLinkCliGet(), SSLLinkCliIsValid(), SSLLinkCliLogicalToDisplay(), SSLLinkCliLogicalToOdbc(), SSLLinkCliNormalize(), SSLLinkCliSet()
property SSLLinkSvr as %ZEN.Datatype.string;
Property methods: SSLLinkSvrDisplayToLogical(), SSLLinkSvrGet(), SSLLinkSvrIsValid(), SSLLinkSvrLogicalToDisplay(), SSLLinkSvrLogicalToOdbc(), SSLLinkSvrNormalize(), SSLLinkSvrSet()


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.
clientmethod 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.
clientmethod doAppServers() [ Language = javascript ]
clientmethod doDataServers() [ Language = javascript ]
clientmethod doSave() [ Language = javascript ]
clientmethod doService() [ Language = javascript ]
clientmethod getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
clientmethod 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.
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
clientmethod openSSL(isClient) [ Language = javascript ]
clientmethod validate() as %Boolean [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab