Class %CSP.UI.Portal.AdvancedSettingsTemplate

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

Template for System Management Portal - Advanced Configuration

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3	6	20

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	Category	HelpAddress	ISREADONLY
LocatorHeader	PID	ParentURL	StdTitle
Subject	aboutPage	align	aux
backgroundTimerInterval	cellAlign	cellSize	cellStyle
cellVAlign	children	composite	containerStyle
cssLevel	currSortMode	currStep	currViewMode
disabled	dragAndDrop	dragEnabled	dropEnabled
enclosingClass	enclosingStyle	error	groupClass
groupStyle	height	hidden	hint
hintClass	hintStyle	home	homePage
id	index	isNew	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	lblTitle	msgNoSubject	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	pageModified	parent	searchKey
showLabel	slice	title	tuple
useSVG	useSoftModals	valign	valueModified
visible	width	window	zenPersistentPopup

Methods
%%OIDGet	%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
%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	ConvertParameter	Decrypt
DeleteData	DoLogout	DrawAfterCreatePage	DrawLocator
DrawLocatorExtra	DrawRibbon	DrawTitle	Encrypt
EscapeHTML	EscapeURL	EvalResult	GetCSPURL
GetClassName	GetContextLinks	GetDocPage	GetHomePage
GetNames	GetNewURL	GetQuickLinks	HyperEventBody
HyperEventCall	HyperEventFrame	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	Link
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RegisterRecent
RewriteURL	SaveData	ShowError	StartTimer
StopTimer	SubHelpPath	ThrowError	UnescapeHTML
UnescapeURL	UpdateDetails	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	ZStripW	addChild
addChildAfter	addChildBefore	cancelItem	cancelPopup
changePassword	childrenMutated	correctIELayering	createComponent
createComponentNS	deleteComponent	deleteItem	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	editItem	endModal	exposeComponent
findElement	fireOnLoadEvent	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getEnclosingDiv	getHidden	getHintElement
getLabelElement	getOpener	getProperty	getSettings
getTitleAreaHeight	getType	goHome	goMenu
gotoNamespace	gotoPage	helpItem	invokeSuper
isOfType	launchPopupWindow	logout	makeId
navigate	onCreate	onDelete	onDisplayHandler
onEndModalHandler	onPopupAction	onRefreshContents	onSerialize
onServerMethodCall	onServerMethodError	onServerMethodReturn	onStartModalHandler
ondisabledHandler	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	popupActionHandler	refreshContents
refreshTable	removeChild	render	renderContents
renderSVG	resetMsg	saveItem	searchBlur
searchBoxHandler	searchFocus	searchKeyDown	searchKeyPress
setComponentId	setHidden	setModified	setOverlayMode
setProperty	setPropertyAll	setSortMode	setSortModeHandler
setTraceOption	setViewMode	setViewModeHandler	showAbout
showDocumentation	showHelp	showMsg	startModal
startProgressBar	stopProgressBar	switchNamespace	validateRange
validateRequired	valueChanged

Subclasses
%CSP.UI.Portal.Config.Advanced	%CSP.UI.Portal.Config.AdvancedTable	%CSP.UI.Portal.Config.Device
%CSP.UI.Portal.Config.Devices	%CSP.UI.Portal.Config.RemoteDatabase	%CSP.UI.Portal.Config.RemoteDatabases
%CSP.UI.Portal.Config.SQLDataType	%CSP.UI.Portal.Config.SQLDataTypes	%CSP.UI.Portal.Config.ValueEditor

Parameters

• parameter AUTONS = 0;

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

• parameter PAGENAME = "AdvancedSettingsTemplate";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Manage";

Security requirement

Properties

• property Category as %String(ZENURL="Category");

Subject name for the setting page.

• property PID as %String;

Current ID (Setting) selected. It is null if it is adding a new one.

• property Subject as %String(ZENURL="Subject");

Subject name for the setting page.

• property isNew as %String(ZENURL="isNew") [ InitialExpression = "0" ];

• property msgNoSubject as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Subject unknown. Unable to proceed.") ];

• property valueModified as %Boolean [ InitialExpression = "0" ];

This will be set to 1 whenever a setting is changed.

Methods

• method %OnAfterCreatePage() as %Status

Subclass can override.

• classmethod CheckAllBlanks(string) as %Boolean [ ZenMethod ]

• classmethod DeleteData(Subject, Name) as %String [ ZenMethod ]

Call server delete method.

• classmethod DrawAfterCreatePage(Category, Subject, isNew)

Subclass specific for %OnAfterCreatePage.

• classmethod DrawLocatorExtra(Locator)

Draw extra locator links in between the Configuration and the current.

• classmethod EvalResult(pSC) as %String

Return tmsg. 1 means success. Otherwise error message in HTML.

• classmethod GetClassName(Subject) as %String [ ZenMethod ]

Get Class Name by Subject for package = "Config"

• classmethod GetNames(Category, Subject) as %ZEN.proxyObject

Generic method to determine what the href should be Category is the category name for Configuration, e.g. SQL Subject is the specific subject plural, e.g UserDataTypes - indicating this is a table page P is the array from DocLocalize

• classmethod SaveData(Subject, Properties, Values) as %String [ ZenMethod ]

Call server save method. Subclass may override.

• classmethod SubHelpPath(Subject) as %String

Return submenu in between Configuration and current locatorLink.

• classmethod UpdateDetails(Subject, PID) as %String [ ZenMethod ]

Load data into form. Subclass to override. See %CSP.UI.Portal.Config.Devices for example.

• method cancelItem() [ Language = javascript ]

Cancel current Items.

• method deleteItem() [ Language = javascript ]

Delete existing item.

• method editItem() [ Language = javascript ]

User clicked the Add or Edit button. Subclass to override.

• method helpItem() [ Language = javascript ]

Show help page for this category/subject.

• method refreshTable() [ Language = javascript ]

Refresh table.

• method saveItem() [ Language = javascript ]

Save current item. Subclass may override.

• method validateRange(ctl, min, max, pass) as %Boolean [ Language = javascript ]

validate the control value - if it is less than the minimum or it is greater than the maximum pass is either "true" or "false" indicating if there is already a field failed pass validation.

• method validateRequired(ctl, pass, type) as %Boolean [ Language = javascript ]

validate the control value. pass is either "true" or "false" indicating if there is already a field failed pass validation.

• method valueChanged() [ Language = javascript ]

User has modified a field.


[BASEXML] > [%CSP] > [UI] > [Portal] > [AdvancedSettingsTemplate]		Private Storage