Class %CSP.UI.Portal.Applications.Web

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

System Management Portal - System Administration - Edit Web Application

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	5	25

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	ApplicationType	EditHeader	FirstFailed
HelpAddress	ISREADONLY	InvalidParam	IsEMSReadOnly
IsEditForm	IsNewSave	IsSysApp	LocatorHeader
NumTabs	OldDefaultApp	OnclickArray	PID
ParentURL	RolesHeader	StdTitle	UserChangedPath
ValidationErrorMsg	aboutPage	align	aux
backgroundTimerInterval	cellAlign	cellSize	cellStyle
cellVAlign	children	composite	contactPage
containerStyle	cssLevel	currSortMode	currStep
currViewMode	disabled	dragAndDrop	dragEnabled
dropEnabled	enableAutoRefresh	enableWebType	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
BuildAutheArray	BuildMenu	CheckAllBlanks	CheckContextLinks
CheckEnterpriseManager	CheckEventClass	ConvertParameter	CopyApp
Decrypt	DoLogout	DrawCookiePath	DrawDefaultApp
DrawLocator	DrawRibbon	DrawTitle	Encrypt
EscapeHTML	EscapeURL	EvalResult	GetCSPURL
GetContextLinks	GetDefaultApp	GetDocURL	GetHomePage
GetNewURL	GetQuickLinks	GiveRenameWarning	HyperEventCall
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsEnsembleNamespace	IsPrivate	JWTAuthChanged	JavaInstalled
Link	OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	PopulateFields
QuoteJS	RegisterRecent	RewriteURL	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	dispatchClassModified
doBrowse	doCancel	doCopyApp	doModified
doSave	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	enableCommandButton
enableWebTypeChanged	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	pathChanged
popupActionHandler	refreshContents	removeChild	render
renderContents	renderSVG	resetMsg	searchBlur
searchBoxHandler	searchFocus	searchKeyDown	searchKeyPress
setComponentId	setConnectivityStatusMsg	setHidden	setModified
setOverlayMode	setPageTitle	setProperty	setPropertyAll
setSortMode	setSortModeHandler	setSubEnablers	setTraceOption
setViewMode	setViewModeHandler	showAbout	showCommandButton
showContact	showDocumentation	showHelp	showMsg
startModal	startProgressBar	stopProgressBar	switchNamespace
tabChanged	trimSpace	updateCookiePath	updateDefaultApp
validate	validateRequired

Parameters

• parameter CSPURL = "/csp/sys/sec/%CSP.UI.Portal.Applications.Web.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 HELPADDRESS = "System Administration,Security,Applications,Web Applications";

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";

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.

Properties

• property ApplicationType as %Integer [ InitialExpression = $$$AppTypeCSP ];

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

• property OldDefaultApp as %String;

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

• property enableWebType as %String [ InitialExpression = "REST" ];

Methods

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

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 ]

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

• deprecatedmethod dispatchClassModified(newClass) [ Language = javascript ]

Disable/enable the CSP setting fields if DispatchClass is defined/undefined. (Deprecated)

• method doCopyApp(newApp) [ Language = javascript ]

• method doSave() [ Language = javascript ]

• method enableWebTypeChanged(value) [ Language = javascript ]

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

Get the title string to add to the locator row.

• method onloadHandler() [ Language = javascript ]

Set focus to the Name or Description field, disable fields if DispatchClass is defined.

• method pathChanged(newPath) [ Language = javascript ]

If the user enters a path, it will not be overwritten by then choosing a CopyFrom application

• method setSubEnablers() [ Language = javascript ]

• method updateCookiePath(newName) [ Language = javascript ]

When the app name changes, redraw the cookie path options

• method updateDefaultApp(newNS) [ Language = javascript ]

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

Class Reference IRIS for UNIX 2024.1.2
Documentation Search