Skip to main content


class %CSP.UI.Portal.Applications.Web extends %CSP.UI.Portal.Applications.EditTemplate

System Management Portal - System Administration - Edit Web Application

Property Inventory

Method Inventory


parameter CSPURL = /csp/sys/sec/%CSP.UI.Portal.Applications.Web.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 = Security;
parameter HELPADDRESS = System Administration,Security,Applications,Web Applications;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Edit Web Application;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/sec/%CSP.UI.Portal.Applications.WebList.zen;
Inherited description: This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.


property ApplicationType as %Integer [ InitialExpression = $$$AppTypeCSP ];
Property methods: ApplicationTypeDisplayToLogical(), ApplicationTypeGet(), ApplicationTypeIsValid(), ApplicationTypeLogicalToDisplay(), ApplicationTypeNormalize(), ApplicationTypeSet(), ApplicationTypeXSDToLogical()
property IsSysApp as %Boolean [ InitialExpression = 0 ];
Property methods: IsSysAppDisplayToLogical(), IsSysAppGet(), IsSysAppIsValid(), IsSysAppLogicalToDisplay(), IsSysAppLogicalToXSD(), IsSysAppNormalize(), IsSysAppSet(), IsSysAppXSDToLogical()
property OldDefaultApp as %String;
Property methods: OldDefaultAppDisplayToLogical(), OldDefaultAppGet(), OldDefaultAppIsValid(), OldDefaultAppLogicalToDisplay(), OldDefaultAppLogicalToOdbc(), OldDefaultAppNormalize(), OldDefaultAppSet()
property UserChangedPath as %Boolean [ InitialExpression = 0 ];
Property methods: UserChangedPathDisplayToLogical(), UserChangedPathGet(), UserChangedPathIsValid(), UserChangedPathLogicalToDisplay(), UserChangedPathLogicalToXSD(), UserChangedPathNormalize(), UserChangedPathSet(), UserChangedPathXSDToLogical()
property enableWebType as %String [ InitialExpression = "REST" ];
Property methods: enableWebTypeDisplayToLogical(), enableWebTypeGet(), enableWebTypeIsValid(), enableWebTypeLogicalToDisplay(), enableWebTypeLogicalToOdbc(), enableWebTypeNormalize(), enableWebTypeSet()


Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
classmethod BuildAutheArray() as %ListOfDataTypes
Build a list of available authentication types
classmethod CheckEventClass(pClassName, pNamespace) as %Boolean [ ZenMethod ]
method CopyApp(AppName As %String) as %Status [ ZenMethod ]
method DrawCookiePath(Name As %String) [ ZenMethod ]
method DrawDefaultApp(Nsp As %String) [ ZenMethod ]
classmethod GetDefaultApp(Nsp As %String) as %String [ ZenMethod ]
method GiveRenameWarning(PID As %String, pNamespace As %String) as %Boolean [ ZenMethod ]
Evaluate whether changing the name of this web app will cause Interoperability and Analytics to become unusable in this namespace based on whether the instance is Interoperability or Analytics enabled and whether this app is the one with a name matching the namespace name
method IsEnsembleNamespace(pNamespace) as %Boolean [ ZenMethod ]
clientmethod JWTAuthChanged() [ Language = javascript ]
method PopulateFields(CopyApp As %Boolean, ByRef Properties As %String, AutheArray As %ListOfDataTypes) as %Status
Fill in form fields. Used when loading the page for edit or when choosing a copy from app during creation
classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Call server save method.
deprecated clientmethod dispatchClassModified(newClass) [ Language = javascript ]
Disable/enable the CSP setting fields if DispatchClass is defined/undefined. (Deprecated)
clientmethod doCopyApp(newApp) [ Language = javascript ]
clientmethod doSave() [ Language = javascript ]
clientmethod enableWebTypeChanged(value) [ Language = javascript ]
clientmethod getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
clientmethod onloadHandler() [ Language = javascript ]
Set focus to the Name or Description field, disable fields if DispatchClass is defined.
clientmethod pathChanged(newPath) [ Language = javascript ]
If the user enters a path, it will not be overwritten by then choosing a CopyFrom application
clientmethod setSubEnablers() [ Language = javascript ]
clientmethod updateCookiePath(newName) [ Language = javascript ]
When the app name changes, redraw the cookie path options
clientmethod updateDefaultApp(newNS) [ Language = javascript ]
clientmethod validate(proxy) as %Boolean [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab