Home > Class Reference > %SYS namespace > %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 21 49


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

%condition %import %includeFiles %page
%resource StdTitle aboutPage alertId
align aux backgroundTimerInterval canWrite
cellAlign cellSize cellStyle cellVAlign
chartSeriesColors chartSeriesScheme children companyLogo
companyName companyStyle composite containerStyle
cssLevel dashboardCategory dashboardDescription dashboardGridCols
dashboardGridRows dashboardKeywords dashboardLocked dashboardModify
dashboardName dashboardOwner dashboardPublic dashboardResize
dashboardResource dashboardSnapGrid dashboardSnapTo dashboardTitle
desktopStyle disabled dragAndDrop dragEnabled
dropEnabled enableAutoRefresh enclosingClass enclosingStyle
error folderCategory folderName folderView
groupClass groupStyle height hidden
hint hintClass hintStyle homePage
id index isEmbedded label
labelClass labelDisabledClass labelPosition labelStyle
layout limitPopups name namespace
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
%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
%EvalC %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 DrawTitle
DrawWorklist1 DrawWorklist2 DrawWorklistHeader1 DrawWorklistHeader2
DrawWorklistTitle Encrypt EscapeHTML EscapeURL
GetItemArray GetItemDetails GetQuickLinks HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate Link OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RemoveAlert
RemoveFavorite RemoveRecentItem RewriteURL SaveBookCover
SaveDashboardToFolder SendItemToTrash ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
activateCover activateSearchBox addChild addChildAfter
addChildBefore addNewItem addToFavorites adjustSizes
cancelPopup childrenMutated correctIELayering createComponent
createComponentNS deleteComponent deleteItem designBookCover
doSearch dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler editDashboard
editLink editPivot editReport endModal
exposeComponent findElement fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getCoverContext getCoverDetails getDetailsHTML
getEnclosingDiv getHidden getHintElement getItemList
getLabelElement getNavigator getOpener getProperty
getSettings getTitleAreaHeight getType goHome
gotoAlert gotoAnalyzer gotoFavorite gotoNamespace
gotoPage gotoSMP hasOverrides invokeSuper
isOfType launchPopupWindow logout makeId
navCloseButtonClick navDataArrange navDataChange navExpand
navGetContentForLevel navHeaderButtonClick navPopupAction navSelectItem
navigate newDashboard newLink newReport
onAdjustSizes onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler openDashboard popupActionHandler
refreshContents refreshFolders registerUser reloadPage
removeChild removeFromAlerts removeFromFavorites removeFromRecentList
render renderContents renderFoldersList renderSVG
resetOverrides searchKeyPress selectItem sendAlert
sendMail setCompanyCell setComponentId setConnectivityStatusMsg
setFolderCategory setFolderView setHidden setOverlayMode
setPortalTitleMsg setProperty setPropertyAll setTraceOption
setWorklistView showAbout showHelp startModal
startProgressBar stopProgressBar toggleFolder toggleLayout
toggleWorklists updateCompanyCell updateWorklistTitle updateWorklistType


parameter HOMEPAGE = "_DeepSee.UserPortal.Home.zen";
URL of home page (used in links).
parameter PAGENAME = "UserPortal Home";
Name of this page.
parameter WORKLIST1VIEW;
Starting view for worklist 1.
parameter WORKLIST2VIEW;
Starting view for worklist 2.


property dashboardCategory as %ZEN.Datatype.string;
Category for the new dashboard.
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 desktopStyle as %ZEN.Datatype.style;
Style applied to coverView background;
property folderCategory as %ZEN.Datatype.string [ InitialExpression = "all" ];
Current folder category (used for filtering).
property folderName as %ZEN.Datatype.string;
Current folder name.
property folderView as %ZEN.Datatype.string [ InitialExpression = "covers" ];
How to display items.
property namespace as %ZEN.Datatype.string [ InitialExpression = $namespace ];
Current namespace.
property selectedItemName as %ZEN.Datatype.string;
Name of selected item.


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 DrawWorklistTitle(pSeed As %String) as %Status
Draw the contents of the worklist title area.
method GetItemArray(ByRef pParameters, Output pMetaData, Output pData) as %Status
Get list of items for JSON provider.
classmethod GetItemDetails(pName As %String) as %ZEN.proxyObject [ ZenMethod ]
Get details on selected item.
method SaveBookCover(pName As %String, pSpec As %String) as %String [ ZenMethod ]
Save the bookcover for the given dashboard.
method SaveDashboardToFolder() as %String [ ZenMethod ]
Save the new dashboard.
method activateCover(index, action) [ Language = javascript ]
User action on a book cover.
method activateSearchBox() [ Language = javascript ]
Activate the search text box;
method addNewItem() [ Language = javascript ]
Show add item menu.
method deleteItem(name) [ Language = javascript ]
Delete the given item.
method designBookCover(name, spec) [ Language = javascript ]
Launch the book cover editor.
method doSearch() [ Language = javascript ]
Perform a search.
method editDashboard(info) [ Language = javascript ]
Edit a dashboard.
method editLink(info) [ Language = javascript ]
Edit a link.
method editPivot(info) [ Language = javascript ]
Edit a pivot.
method editReport(info) [ Language = javascript ]
Edit a report shortcut.
method getCoverContext(index) [ Language = javascript ]
Get $var context for a book cover.
method getCoverDetails(index) [ Language = javascript ]
Get popup details for a book cover.
method getDetailsHTML() [ Language = javascript ]
Get contents for the item details box.
method getItemList() [ Language = javascript ]
Get the JSON item list. Apply search filtering.
method gotoAnalyzer() [ Language = javascript ]
Show the analyzer page.
method gotoSMP() [ Language = javascript ]
Show the System Management portal.
method hasOverrides() [ Language = javascript ]
Test if there are background style overrides.
method navDataChange(key, value, final) [ Language = javascript ]
Change of data value in navigator.
method navGetContentForLevel(level, key, value) [ Language = javascript ]
Return an object describing what to display for this level within the navigator.
method navSelectItem(key, value, which) [ Language = javascript ]
Select of item within the navigator.
method newDashboard() [ Language = javascript ]
Create a new dashboard.
method newLink() [ Language = javascript ]
Create a new link.
method newReport() [ Language = javascript ]
Create a new report shortcut.
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 openDashboard() [ Language = javascript ]
Launch the dashboard finder.
method refreshFolders(reload) [ Language = javascript ]
Refresh the folder list.
method registerUser() [ Language = javascript ]
Show the register user dialog.
method renderFoldersList() [ Language = javascript ]
Draw the contents of the Folders area.
method resetOverrides() [ Language = javascript ]
Reset any background style overrides.
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(evt, cat) [ Language = javascript ]
Change the folder category
method setFolderView(evt, view) [ Language = javascript ]
Change the folder view.
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.