Class %DeepSee.UserPortal.Home

class %DeepSee.UserPortal.Home extends %DeepSee.UserPortal.standardPage

Home page for the User Portal.
This provides end users a way to access reports, dashboards etc.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
4	17	28

Summary

This is a Zen Page class. It belongs to the application %DeepSee.UserPortal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	StdTitle	alertId	align
aux	backgroundTimerInterval	canWrite	cellAlign
cellSize	cellStyle	cellVAlign	chartSeriesColors
chartSeriesScheme	children	composite	containerStyle
cssLevel	dashboardDescription	dashboardGridCols	dashboardGridRows
dashboardKeywords	dashboardLocked	dashboardModify	dashboardName
dashboardOwner	dashboardPublic	dashboardResize	dashboardResource
dashboardSnapGrid	dashboardSnapTo	dashboardTitle	disabled
dragAndDrop	dragEnabled	dropEnabled	enclosingClass
enclosingStyle	error	folderCategory	folderName
groupClass	groupStyle	height	hidden
hint	hintClass	hintStyle	homePage
id	index	isEmbedded	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	name	noBorder	noModify
noTitle	onafterdrag	onbeforedrag	onclick
ondrag	ondrop	onhide	onrefresh
onshow	onupdate	parent	searchKey
selectedItemName	showLabel	slice	title
tuple	urlWorklistCount	useClientEmail	useSVG
useSoftModals	valign	viewerURL	visible
width	window	worklistCount	zenPersistentPopup

Methods
%%OIDGet	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddImportedComponents	%AddToSaveSet	%ApplyURLParms
%Attr	%BindExport	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%DrawAutoLogout	%DrawClassDefinitions	%DrawComponentHTML	%DrawHTML
%DrawHTMLPage	%DrawJSStrings	%DrawObjectDefinitions	%DrawWorklist
%DrawWorklistHeader	%EnclosingDivId	%EndBackgroundMethod	%EndScript
%Eval	%Extends	%ForceClientRender	%GetChildIndex
%GetComponent	%GetComponentById	%GetComponentByName	%GetEventHandlers
%GetLinks	%GetPageName	%GetParameter	%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	%OnGetSmallMenu	%OnGetTitle	%OnGetWorklistOptions1
%OnGetWorklistOptions2	%OnMonitorBackgroundTask	%OnMutateChildren	%OnObjectSynch
%OnPreHTTP	%OnSubmit	%OnUseSoftModals	%OnZENDeserialize
%OriginalNamespace	%PackageName	%QuoteValue	%QuoteValueL10N
%RemoveChild	%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet
%RunBackgroundMethod	%Self	%SerializeObject	%SetBackgroundMethodStatus
%SetErrorById	%SetErrorByName	%SetModified	%SetValueById
%SetValueByName	%SetValuesByName	%StartScript	%ValidateObject
%ZENVersion	AddFavorite	ConvertParameter	Decrypt
DoLogout	DrawFoldersFooter	DrawFoldersHeader	DrawFoldersList
DrawTitle	DrawWorklist1	DrawWorklist2	DrawWorklistHeader1
DrawWorklistHeader2	DrawWorklistTitle	Encrypt	EscapeHTML
EscapeURL	GetItemDetails	GetQuickLinks	HyperEventBody
HyperEventCall	HyperEventFrame	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	Link
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
QuoteJS	RemoveAlert	RemoveFavorite	RemoveRecentItem
RewriteURL	SaveDashboardToFolder	SendItemToTrash	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	activateSearchBox	addChild	addChildAfter
addChildBefore	addToFavorites	adjustSizes	cancelPopup
childrenMutated	correctIELayering	createComponent	createComponentNS
deleteComponent	deleteItem	doSearch	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	endModal	exposeComponent	findElement
fireOnLoadEvent	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	getChildIndex	getComponent	getComponentById
getDetailsHTML	getEnclosingDiv	getHidden	getHintElement
getLabelElement	getNavigator	getOpener	getProperty
getSettings	getTitleAreaHeight	getType	goHome
gotoAlert	gotoAnalyzer	gotoFavorite	gotoNamespace
gotoPage	gotoSMP	invokeSuper	isOfType
launchPopupWindow	logout	makeId	navDataChange
navExpand	navGetContentForLevel	navSelectItem	navigate
newDashboard	onAdjustSizes	onCreate	onDelete
onDisplayHandler	onEndModalHandler	onPopupAction	onRefreshContents
onSerialize	onServerMethodCall	onServerMethodError	onServerMethodReturn
onStartModalHandler	ondisabledHandler	onkeydownHandler	onkeyupHandler
onlayoutHandler	onloadHandler	onlogoutHandler	onoverlayHandler
onresizeHandler	onunloadHandler	onupdateHandler	popupActionHandler
refreshContents	refreshFolders	registerUser	removeChild
removeFromAlerts	removeFromFavorites	removeFromRecentList	render
renderContents	renderSVG	searchKeyPress	selectItem
sendAlert	sendMail	setComponentId	setFolderCategory
setHidden	setOverlayMode	setProperty	setPropertyAll
setTraceOption	setWorklistView	showAbout	showHelp
startModal	startProgressBar	stopProgressBar	toggleFolder
toggleLayout	toggleWorklists	updateWorklistTitle	updateWorklistType

Parameters

• parameter HOMEPAGE = "_DeepSee.UserPortal.Home.zen";

URL of home page (used in links).

• parameter PAGENAME = "DeepSee Home";

Name of this page.

• parameter WORKLIST1VIEW;

Starting view for worklist 1.

• parameter WORKLIST2VIEW;

Starting view for worklist 2.

Properties

• property dashboardDescription as %ZEN.Datatype.string;

Description of the new dashboard.

• property dashboardGridCols as %ZEN.Datatype.integer [ InitialExpression = 2 ];

If dashboard uses snap grid, then this is then number of grid columns.

• property dashboardGridRows as %ZEN.Datatype.integer [ InitialExpression = 2 ];

If dashboard uses snap grid, then this is then number of grid rows.

• property dashboardKeywords as %ZEN.Datatype.string;

Keywords for the new dashboard.

• property dashboardLocked as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Locked state of the currently displayed dashboard.

• property dashboardModify as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Does this dashboard allow the user to modify widgets.

• property dashboardName as %ZEN.Datatype.string;

Name of the new dashboard.

• property dashboardOwner as %ZEN.Datatype.string;

Owner of the currently displayed dashboard.

• property dashboardPublic as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Public state of the currently displayed dashboard.

• property dashboardResize as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Does this dashboard allow the user to move and resize widgets.

• property dashboardResource as %ZEN.Datatype.string;

Resource for the currently displayed dashboard.

• property dashboardSnapGrid as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, the dashboard uses the new snapGrid desktop and ignores the the dashboardSnapTo property.

• property dashboardSnapTo as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Is dashboard in "snap to" mode.

• property dashboardTitle as %ZEN.Datatype.string;

Title of the new dashboard.

• property folderCategory as %ZEN.Datatype.string [ InitialExpression = "all" ];

Current folder category (used for filtering).

• property folderName as %ZEN.Datatype.string;

Current folder name.

• property selectedItemName as %ZEN.Datatype.string;

Name of selected item.

Methods

• method %OnAfterCreatePage() as %Status

Decorate the page.

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

• method %OnGetWorklistOptions1(Output pOptions, Output pDefaultMode) as %Status

Return list of options for work list 1.

• method %OnGetWorklistOptions2(Output pOptions, Output pDefaultMode) as %Status

Return list of options for work list 2.

• final method DrawFoldersFooter(pSeed As %String) as %Status

Draw the contents of the Folders Footer area.

• final method DrawFoldersHeader(pSeed As %String) as %Status

Draw the contents of the Folders Header area.

• final method DrawFoldersList(pSeed As %String) as %Status

Draw the contents of the Folders area.

• final method DrawWorklistTitle(pSeed As %String) as %Status

Draw the contents of the worklist title area.

• classmethod GetItemDetails(pName As %String) as %ZEN.proxyObject [ ZenMethod ]

Get details on selected item.

• method SaveDashboardToFolder() as %String [ ZenMethod ]

Save the new dashboard.

• method activateSearchBox() [ Language = javascript ]

Activate the search text box;

• method deleteItem(name) [ Language = javascript ]

Delete the given item.

• method doSearch() [ Language = javascript ]

Perform a search.

• method getDetailsHTML() [ Language = javascript ]

Get contents for the item details box.

• method gotoAnalyzer() [ Language = javascript ]

Show the analyzer page.

• method gotoSMP() [ Language = javascript ]

Show the System Management portal.

• method newDashboard() [ Language = javascript ]

Create a new dashboard.

• method onAdjustSizes(load, contentWidth, contentHeight) [ Language = javascript ]

Adjust sizes of content area.

• method onPopupAction(popupName, action, value) [ Language = javascript ]

This client event is fired when the a popup page launched from this page fires an action.

• method refreshFolders() [ Language = javascript ]

Reload the folder list.

• method registerUser() [ Language = javascript ]

Show the register user dialog.

• method searchKeyPress(evt) [ Language = javascript ]

Key press in search box (work-around for ie).

• method selectItem(name) [ Language = javascript ]

Select the given item.

• method setFolderCategory(cat) [ Language = javascript ]

Change the folder category

• method toggleFolder(index) [ Language = javascript ]

Hide/show folders in list.

• method toggleLayout() [ Language = javascript ]

Toggle display of worklist area.

• method updateWorklistTitle() [ Language = javascript ]

Update the title for the dashboard.


[BASEXML] > [%DeepSee] > [UserPortal] > [Home]		Private Storage