%DeepSee.UserPortal.Home
Class %DeepSee.UserPortal.Home Extends %DeepSee.UserPortal.standardPage [ System = 4 ]
Home page for the User Portal.
This provides end users a way to access reports, dashboards etc.
Parameters
PAGENAME
Parameter PAGENAME = "UserPortal Home";
Name of this page.
HOMEPAGE
Parameter HOMEPAGE = "_DeepSee.UserPortal.Home.zen";
URL of home page (used in links).
WORKLIST1VIEW;
Parameter WORKLIST1VIEW;
Starting view for worklist 1.
WORKLIST2VIEW;
Parameter WORKLIST2VIEW;
Starting view for worklist 2.
Properties
folderName
Property folderName As %ZEN.Datatype.string;
Current folder name.
dashboardName
Property dashboardName As %ZEN.Datatype.string;
Name of the new dashboard.
dashboardTitle
Property dashboardTitle As %ZEN.Datatype.string;
Title of the new dashboard.
dashboardDescription
Property dashboardDescription As %ZEN.Datatype.string;
Description of the new dashboard.
dashboardOwner
Property dashboardOwner As %ZEN.Datatype.string;
Owner of the currently displayed dashboard.
dashboardResource
Property dashboardResource As %ZEN.Datatype.string;
Resource for the currently displayed dashboard.
dashboardSnapGrid
Property dashboardSnapGrid As %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, the dashboard uses the new snapGrid desktop and ignores the the dashboardSnapTo property.
dashboardSnapTo
Property dashboardSnapTo As %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Is dashboard in "snap to" mode.
dashboardGridRows
Property dashboardGridRows As %ZEN.Datatype.integer [ InitialExpression = 2 ];
If dashboard uses snap grid, then this is then number of grid rows.
dashboardGridCols
Property dashboardGridCols As %ZEN.Datatype.integer [ InitialExpression = 2 ];
If dashboard uses snap grid, then this is then number of grid columns.
dashboardResize
Property dashboardResize As %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Does this dashboard allow the user to move and resize widgets.
dashboardModify
Property dashboardModify As %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Does this dashboard allow the user to modify widgets.
dashboardKeywords
Property dashboardKeywords As %ZEN.Datatype.string;
Keywords for the new dashboard.
dashboardLocked
Property dashboardLocked As %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Locked state of the currently displayed dashboard.
dashboardPublic
Property dashboardPublic As %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Public state of the currently displayed dashboard.
dashboardCategory
Property dashboardCategory As %ZEN.Datatype.string;
Category for the new dashboard.
selectedItemName
Property selectedItemName As %ZEN.Datatype.string;
Name of selected item.
folderCategory
Property folderCategory As %ZEN.Datatype.string [ InitialExpression = "all" ];
Current folder category (used for filtering).
folderView
Property folderView As %ZEN.Datatype.string [ InitialExpression = "covers" ];
How to display items.
desktopStyle
Property desktopStyle As %ZEN.Datatype.style;
Style applied to coverView background;
namespace
Property namespace As %ZEN.Datatype.string [ InitialExpression = {$namespace} ];
Current namespace.
XDatas
Style
XData Style
menuPane
XData menuPane [ XMLNamespace = "http://www.intersystems.com/zen" ]
This XML defines the menu for this page.
contentsRightPane
XData contentsRightPane [ XMLNamespace = "http://www.intersystems.com/zen" ]
This XML defines the main display area.
Methods
DrawWorklistTitle
Method DrawWorklistTitle(pSeed As %String) As %Status [ Final ]
Draw the contents of the worklist title area.
DrawFoldersHeader
Method DrawFoldersHeader(pSeed As %String) As %Status [ Final ]
Draw the contents of the Folders Header area.
DrawFoldersFooter
Method DrawFoldersFooter(pSeed As %String) As %Status [ Final ]
Draw the contents of the Folders Footer area.
renderFoldersList
ClientMethod renderFoldersList() [ Language = javascript ]
Draw the contents of the Folders area.
%OnAfterCreatePage
Method %OnAfterCreatePage() As %Status
Decorate the page.
%OnGetTitle
Method %OnGetTitle() As %String
Get the (localized) title string for the page. This should be implemented in a subclass.
%OnGetPageName
Method %OnGetPageName() As %String
Get the (localized) name of the page. This should be implemented in a subclass.
refreshFolders
ClientMethod refreshFolders(reload) [ Language = javascript ]
Refresh the folder list.
activateSearchBox
ClientMethod activateSearchBox() [ Language = javascript ]
Activate the search text box;
searchKeyPress
ClientMethod searchKeyPress(evt) [ Language = javascript ]
Key press in search box.
doSearch
ClientMethod doSearch() [ Language = javascript ]
Perform a search.
toggleFolder
ClientMethod toggleFolder(index) [ Language = javascript ]
Hide/show folders in list.
onAdjustSizes
ClientMethod onAdjustSizes(load, contentWidth, contentHeight) [ Language = javascript ]
Adjust sizes of content area.
onPopupAction
ClientMethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
newDashboard
ClientMethod newDashboard() [ Language = javascript ]
Create a new dashboard.
editDashboard
ClientMethod editDashboard(info) [ Language = javascript ]
Edit a dashboard.
newLink
ClientMethod newLink() [ Language = javascript ]
Create a new link.
editLink
ClientMethod editLink(info) [ Language = javascript ]
Edit a link.
editPivot
ClientMethod editPivot(info) [ Language = javascript ]
Edit a pivot.
newReport
ClientMethod newReport() [ Language = javascript ]
Create a new report shortcut.
editReport
ClientMethod editReport(info) [ Language = javascript ]
Edit a report shortcut.
SaveBookCover
Method SaveBookCover(pName As %String, pSpec As %String) As %String [ ZenMethod ]
Save the bookcover for the given dashboard.
SaveDashboardToFolder
Method SaveDashboardToFolder() As %String [ ZenMethod ]
Save the new dashboard.
deleteItem
ClientMethod deleteItem(name) [ Language = javascript ]
Delete the given item.
selectItem
ClientMethod selectItem(name) [ Language = javascript ]
Select the given item.
gotoAnalyzer
ClientMethod gotoAnalyzer() [ Language = javascript ]
Show the analyzer page.
gotoSMP
ClientMethod gotoSMP() [ Language = javascript ]
Show the System Management portal.
registerUser
ClientMethod registerUser() [ Language = javascript ]
Show the register user dialog.
updateWorklistTitle
ClientMethod updateWorklistTitle() [ Language = javascript ]
Update the title for the dashboard.
%OnGetWorklistOptions1
Method %OnGetWorklistOptions1(Output pOptions, Output pDefaultMode) As %Status
Return list of options for work list 1.
%OnGetWorklistOptions2
Method %OnGetWorklistOptions2(Output pOptions, Output pDefaultMode) As %Status
Return list of options for work list 2.
getDetailsHTML
ClientMethod getDetailsHTML() [ Language = javascript ]
Get contents for the item details box.
GetItemDetails
ClassMethod GetItemDetails(pName As %String) As %ZEN.proxyObject [ ZenMethod ]
Get details on selected item.
setFolderCategory
ClientMethod setFolderCategory(evt, cat) [ Language = javascript ]
Change the folder category
setFolderView
ClientMethod setFolderView(evt, view) [ Language = javascript ]
Change the folder view.
toggleLayout
ClientMethod toggleLayout() [ Language = javascript ]
Toggle display of worklist area.
getCoverDetails
ClientMethod getCoverDetails(index) [ Language = javascript ]
Get popup details for a book cover.
getCoverContext
ClientMethod getCoverContext(index) [ Language = javascript ]
Get $var context for a book cover.
activateCover
ClientMethod activateCover(index, action) [ Language = javascript ]
User action on a book cover.
getItemList
ClientMethod getItemList() [ Language = javascript ]
Get the JSON item list. Apply search filtering.
GetItemArray
Method GetItemArray(ByRef pParameters, Output pMetaData, Output pData) As %Status
Get list of items for JSON provider.
storeCookie
ClientMethod storeCookie(property, value) [ Internal, Language = javascript ]
Store a persistent cookie.
designBookCover
ClientMethod designBookCover(name, spec) [ Language = javascript ]
Launch the book cover editor.
navGetContentForLevel
ClientMethod navGetContentForLevel(level, key, value) [ Language = javascript ]
Return an object describing what to display for this level within the navigator.
navSelectItem
ClientMethod navSelectItem(key, value, which) [ Language = javascript ]
Select of item within the navigator.
addNewItem
ClientMethod addNewItem() [ Language = javascript ]
Show add item menu.
navDataChange
ClientMethod navDataChange(key, value, final) [ Language = javascript ]
Change of data value in navigator.
hasOverrides
ClientMethod hasOverrides() [ Language = javascript ]
Test if there are background style overrides.
resetOverrides
ClientMethod resetOverrides() [ Language = javascript ]
Reset any background style overrides.
openDashboard
ClientMethod openDashboard() [ Language = javascript ]
Launch the dashboard finder.