Class %CSP.UI.Portal.Template

class %CSP.UI.Portal.Template extends %ZEN.Portal.standardPage

Zen System Management Portal Template.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	7	15

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	HelpAddress	ISREADONLY	LocatorHeader
ParentURL	StdTitle	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	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	lblTitle	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
%%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
DoLogout	DrawLocator	DrawRibbon	DrawTitle
Encrypt	EscapeHTML	EscapeURL	GetCSPURL
GetContextLinks	GetDocPage	GetHomePage	GetNewURL
GetQuickLinks	HyperEventBody	HyperEventCall	HyperEventFrame
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	Link	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
QuoteJS	RegisterRecent	RewriteURL	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	ZStripW	addChild	addChildAfter
addChildBefore	cancelPopup	changePassword	childrenMutated
correctIELayering	createComponent	createComponentNS	deleteComponent
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	endModal	exposeComponent
findElement	fireOnLoadEvent	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getEnclosingDiv	getHidden	getHintElement
getLabelElement	getOpener	getProperty	getSettings
getTitleAreaHeight	getType	goHome	goMenu
gotoNamespace	gotoPage	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	removeChild
render	renderContents	renderSVG	resetMsg
searchBlur	searchBoxHandler	searchFocus	searchKeyDown
searchKeyPress	setComponentId	setHidden	setModified
setOverlayMode	setProperty	setPropertyAll	setSortMode
setSortModeHandler	setTraceOption	setViewMode	setViewModeHandler
showAbout	showDocumentation	showHelp	showMsg
startModal	startProgressBar	stopProgressBar	switchNamespace

Subclasses
%CSP.UI.Portal.About	%CSP.UI.Portal.AdvancedSettingsTemplate	%CSP.UI.Portal.CSPSessions
%CSP.UI.Portal.Config.ZenReport	%CSP.UI.Portal.DatabaseFreespace	%CSP.UI.Portal.DatabaseFreespaceCleanup
%CSP.UI.Portal.DatabaseFreespaceCompact	%CSP.UI.Portal.EMS	%CSP.UI.Portal.EncryptionCreate
%CSP.UI.Portal.EncryptionDatabase	%CSP.UI.Portal.EncryptionManage	%CSP.UI.Portal.EncryptionManaged
%CSP.UI.Portal.EnsembleMonitor	%CSP.UI.Portal.FileManTemplate	%CSP.UI.Portal.ISQL
%CSP.UI.Portal.Mappings	%CSP.UI.Portal.NLS	%CSP.UI.Portal.NLSEdit
%CSP.UI.Portal.ObjectGateway	%CSP.UI.Portal.ObjectGatewayActivities	%CSP.UI.Portal.ObjectGatewayStart
%CSP.UI.Portal.ObjectGatewayStop	%CSP.UI.Portal.ObjectGateways	%CSP.UI.Portal.ObjectSettings
%CSP.UI.Portal.OpDatabases	%CSP.UI.Portal.PKI	%CSP.UI.Portal.ProcessDetails
%CSP.UI.Portal.Processes	%CSP.UI.Portal.RoutineCompare	%CSP.UI.Portal.SQL.ExecuteQuery
%CSP.UI.Portal.SSL	%CSP.UI.Portal.SSLList	%CSP.UI.Portal.TaskInfo
%CSP.UI.Portal.TasksOnDemand	%CSP.UI.Portal.ViewLog	%CSP.UI.Portal.X509Credential
%CSP.UI.Portal.X509Credentials	%CSP.UI.Portal.ZenReportServer	%CSP.UI.Portal.ZenReportServers
%CSP.UI.Template.List

Parameters

• parameter APPLICATION = "%CSP.UI.Portal.Application";

Class name of application this page belongs to.

• parameter AUTONS = 1;

Allow pages to auto-switch namespaces if $NAMESPACE is specified

• parameter DOMAIN = "%Utility";

Domain used for localization.

• parameter PAGENAME = "Portal Template";

Name of this page.

• parameter PARENTPAGE;

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 HelpAddress as %ZEN.Datatype.string;

The help address that links to the "Help" (next to the "Logout" link) documentation

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

Indicates whether the page is read only due to EMS control.

• property LocatorHeader as %ZEN.Datatype.caption;

The text that is shown in TitlePane above the license

• property ParentURL as %String [ InitialExpression = ..Link($ZCVT(..#PARENTPAGE,"O","URL")) ];

Parent URL that Cancel and Save should return to

• property StdTitle as %ZEN.Datatype.string [ InitialExpression = ..#PAGENAME ];

Text shown on page or browser tab header

• property home as %ZEN.Datatype.string(ZENURL="home");

home value to return to Home page to.

• property lblTitle as %ZEN.Datatype.string [ InitialExpression = ..#PAGENAME ];

Text shown between locator bar and details pane (form or table)

Methods

• method %AddLocatorLinks(pLocator As %ZEN.Component.locatorBar, pLocalize As %String, pParam As %String = "", pIsNew As %Boolean = 0)

Utility method. Add the locator links defined by the LOCATORINFO parameter to the given locator bar.
pLocalize is an array from calling DocLocalize for a page. (optional)
pParam contains extra parameters for the last or current page link. (optional) pIsNew is the flag indicating this page is for "Add" rather than "Edit". If it's true then we use a different locator text if defined.

• classmethod %GetHomePage() as %String

This method is used by SMP to return home page. Set home to %session if not null for later use.

• method %GetHomeParam() as %String

Used to return "home" parameter for building return home links in sub-classes.

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
Subclasses with extra layers of locator links or other than "Configuration" please override.

• classmethod %GetProductName() as %String

Get the product name for the page.Called from none-Zen classes in SMP.

• method %OnGetPageName() as %String

Get the (localized) name of the page. This should be implemented in a subclass.

• method %OnGetTitle() as %String

Get the (localized) title string for the page. This should be implemented in a subclass.

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

• classmethod GetHomePage() as %String [ ZenMethod ]

This method allows us to get the home page URL from JavaScript.

• classmethod RegisterRecent(pTitle)

Recent item is only registered at the Home level.

• method ZStripW(string As %String) as %String [ Language = javascript ]

Strip surrounding white spaces off of a given string. Equivalent of $ZStrip(string,"<>W")

• method resetMsg() [ Language = javascript ]

Clear message from idRespond html (usually placed above the editing portion of the page, but could be anywhere).

• method showDocumentation(topic, anchor, url) [ Language = javascript ]

• method showMsg(msg) [ Language = javascript ]

Display message in idRespond html (usually placed above the editing portion of the page, but could be anywhere).


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