This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %DeepSee.UserPortal.Home

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

Property Inventory (Including Private)

Method Inventory (Including Private)

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 (Including Private)

property dashboardCategory as %ZEN.Datatype.string;
Category for the new dashboard.
Property methods: dashboardCategoryDisplayToLogical(), dashboardCategoryGet(), dashboardCategoryIsValid(), dashboardCategoryLogicalToDisplay(), dashboardCategoryLogicalToOdbc(), dashboardCategoryNormalize(), dashboardCategorySet()
property dashboardDescription as %ZEN.Datatype.string;
Description of the new dashboard.
Property methods: dashboardDescriptionDisplayToLogical(), dashboardDescriptionGet(), dashboardDescriptionIsValid(), dashboardDescriptionLogicalToDisplay(), dashboardDescriptionLogicalToOdbc(), dashboardDescriptionNormalize(), dashboardDescriptionSet()
property dashboardGridCols as %ZEN.Datatype.integer [ InitialExpression = 2 ];
If dashboard uses snap grid, then this is then number of grid columns.
Property methods: dashboardGridColsDisplayToLogical(), dashboardGridColsGet(), dashboardGridColsIsValid(), dashboardGridColsLogicalToDisplay(), dashboardGridColsLogicalToOdbc(), dashboardGridColsNormalize(), dashboardGridColsSet()
property dashboardGridRows as %ZEN.Datatype.integer [ InitialExpression = 2 ];
If dashboard uses snap grid, then this is then number of grid rows.
Property methods: dashboardGridRowsDisplayToLogical(), dashboardGridRowsGet(), dashboardGridRowsIsValid(), dashboardGridRowsLogicalToDisplay(), dashboardGridRowsLogicalToOdbc(), dashboardGridRowsNormalize(), dashboardGridRowsSet()
property dashboardKeywords as %ZEN.Datatype.string;
Keywords for the new dashboard.
Property methods: dashboardKeywordsDisplayToLogical(), dashboardKeywordsGet(), dashboardKeywordsIsValid(), dashboardKeywordsLogicalToDisplay(), dashboardKeywordsLogicalToOdbc(), dashboardKeywordsNormalize(), dashboardKeywordsSet()
property dashboardLocked as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Locked state of the currently displayed dashboard.
Property methods: dashboardLockedDisplayToLogical(), dashboardLockedGet(), dashboardLockedIsValid(), dashboardLockedLogicalToDisplay(), dashboardLockedLogicalToOdbc(), dashboardLockedLogicalToXSD(), dashboardLockedNormalize(), dashboardLockedSet(), dashboardLockedXSDToLogical()
property dashboardModify as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Does this dashboard allow the user to modify widgets.
Property methods: dashboardModifyDisplayToLogical(), dashboardModifyGet(), dashboardModifyIsValid(), dashboardModifyLogicalToDisplay(), dashboardModifyLogicalToOdbc(), dashboardModifyLogicalToXSD(), dashboardModifyNormalize(), dashboardModifySet(), dashboardModifyXSDToLogical()
property dashboardName as %ZEN.Datatype.string;
Name of the new dashboard.
Property methods: dashboardNameDisplayToLogical(), dashboardNameGet(), dashboardNameIsValid(), dashboardNameLogicalToDisplay(), dashboardNameLogicalToOdbc(), dashboardNameNormalize(), dashboardNameSet()
property dashboardOwner as %ZEN.Datatype.string;
Owner of the currently displayed dashboard.
Property methods: dashboardOwnerDisplayToLogical(), dashboardOwnerGet(), dashboardOwnerIsValid(), dashboardOwnerLogicalToDisplay(), dashboardOwnerLogicalToOdbc(), dashboardOwnerNormalize(), dashboardOwnerSet()
property dashboardPublic as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Public state of the currently displayed dashboard.
Property methods: dashboardPublicDisplayToLogical(), dashboardPublicGet(), dashboardPublicIsValid(), dashboardPublicLogicalToDisplay(), dashboardPublicLogicalToOdbc(), dashboardPublicLogicalToXSD(), dashboardPublicNormalize(), dashboardPublicSet(), dashboardPublicXSDToLogical()
property dashboardResize as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Does this dashboard allow the user to move and resize widgets.
Property methods: dashboardResizeDisplayToLogical(), dashboardResizeGet(), dashboardResizeIsValid(), dashboardResizeLogicalToDisplay(), dashboardResizeLogicalToOdbc(), dashboardResizeLogicalToXSD(), dashboardResizeNormalize(), dashboardResizeSet(), dashboardResizeXSDToLogical()
property dashboardResource as %ZEN.Datatype.string;
Resource for the currently displayed dashboard.
Property methods: dashboardResourceDisplayToLogical(), dashboardResourceGet(), dashboardResourceIsValid(), dashboardResourceLogicalToDisplay(), dashboardResourceLogicalToOdbc(), dashboardResourceNormalize(), dashboardResourceSet()
property dashboardSnapGrid as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, the dashboard uses the new snapGrid desktop and ignores the the dashboardSnapTo property.
Property methods: dashboardSnapGridDisplayToLogical(), dashboardSnapGridGet(), dashboardSnapGridIsValid(), dashboardSnapGridLogicalToDisplay(), dashboardSnapGridLogicalToOdbc(), dashboardSnapGridLogicalToXSD(), dashboardSnapGridNormalize(), dashboardSnapGridSet(), dashboardSnapGridXSDToLogical()
property dashboardSnapTo as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Is dashboard in "snap to" mode.
Property methods: dashboardSnapToDisplayToLogical(), dashboardSnapToGet(), dashboardSnapToIsValid(), dashboardSnapToLogicalToDisplay(), dashboardSnapToLogicalToOdbc(), dashboardSnapToLogicalToXSD(), dashboardSnapToNormalize(), dashboardSnapToSet(), dashboardSnapToXSDToLogical()
property dashboardTitle as %ZEN.Datatype.string;
Title of the new dashboard.
Property methods: dashboardTitleDisplayToLogical(), dashboardTitleGet(), dashboardTitleIsValid(), dashboardTitleLogicalToDisplay(), dashboardTitleLogicalToOdbc(), dashboardTitleNormalize(), dashboardTitleSet()
property desktopStyle as %ZEN.Datatype.style;
Style applied to coverView background;
Property methods: desktopStyleDisplayToLogical(), desktopStyleGet(), desktopStyleIsValid(), desktopStyleLogicalToDisplay(), desktopStyleLogicalToOdbc(), desktopStyleNormalize(), desktopStyleSet()
property folderCategory as %ZEN.Datatype.string [ InitialExpression = "all" ];
Current folder category (used for filtering).
Property methods: folderCategoryDisplayToLogical(), folderCategoryGet(), folderCategoryIsValid(), folderCategoryLogicalToDisplay(), folderCategoryLogicalToOdbc(), folderCategoryNormalize(), folderCategorySet()
property folderName as %ZEN.Datatype.string;
Current folder name.
Property methods: folderNameDisplayToLogical(), folderNameGet(), folderNameIsValid(), folderNameLogicalToDisplay(), folderNameLogicalToOdbc(), folderNameNormalize(), folderNameSet()
property folderView as %ZEN.Datatype.string [ InitialExpression = "covers" ];
How to display items.
Property methods: folderViewDisplayToLogical(), folderViewGet(), folderViewIsValid(), folderViewLogicalToDisplay(), folderViewLogicalToOdbc(), folderViewNormalize(), folderViewSet()
property namespace as %ZEN.Datatype.string [ InitialExpression = $namespace ];
Current namespace.
Property methods: namespaceDisplayToLogical(), namespaceGet(), namespaceIsValid(), namespaceLogicalToDisplay(), namespaceLogicalToOdbc(), namespaceNormalize(), namespaceSet()
property selectedItemName as %ZEN.Datatype.string;
Name of selected item.
Property methods: selectedItemNameDisplayToLogical(), selectedItemNameGet(), selectedItemNameIsValid(), selectedItemNameLogicalToDisplay(), selectedItemNameLogicalToOdbc(), selectedItemNameNormalize(), selectedItemNameSet()

Methods (Including Private)

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.
clientmethod activateCover(index, action) [ Language = javascript ]
User action on a book cover.
clientmethod activateSearchBox() [ Language = javascript ]
Activate the search text box;
clientmethod addNewItem() [ Language = javascript ]
Show add item menu.
clientmethod deleteItem(name) [ Language = javascript ]
Delete the given item.
clientmethod designBookCover(name, spec) [ Language = javascript ]
Launch the book cover editor.
clientmethod doSearch() [ Language = javascript ]
Perform a search.
clientmethod editDashboard(info) [ Language = javascript ]
Edit a dashboard.
Edit a link.
clientmethod editPivot(info) [ Language = javascript ]
Edit a pivot.
clientmethod editReport(info) [ Language = javascript ]
Edit a report shortcut.
clientmethod getCoverContext(index) [ Language = javascript ]
Get $var context for a book cover.
clientmethod getCoverDetails(index) [ Language = javascript ]
Get popup details for a book cover.
clientmethod getDetailsHTML() [ Language = javascript ]
Get contents for the item details box.
clientmethod getItemList() [ Language = javascript ]
Get the JSON item list. Apply search filtering.
clientmethod gotoAnalyzer() [ Language = javascript ]
Show the analyzer page.
clientmethod gotoSMP() [ Language = javascript ]
Show the System Management portal.
clientmethod hasOverrides() [ Language = javascript ]
Test if there are background style overrides.
Change of data value in navigator.
Return an object describing what to display for this level within the navigator.
Select of item within the navigator.
clientmethod newDashboard() [ Language = javascript ]
Create a new dashboard.
Create a new link.
clientmethod newReport() [ Language = javascript ]
Create a new report shortcut.
clientmethod onAdjustSizes(load, contentWidth, contentHeight) [ Language = javascript ]
Adjust sizes of content area.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod openDashboard() [ Language = javascript ]
Launch the dashboard finder.
clientmethod refreshFolders(reload) [ Language = javascript ]
Refresh the folder list.
clientmethod registerUser() [ Language = javascript ]
Show the register user dialog.
clientmethod renderFoldersList() [ Language = javascript ]
Draw the contents of the Folders area.
clientmethod resetOverrides() [ Language = javascript ]
Reset any background style overrides.
clientmethod searchKeyPress(evt) [ Language = javascript ]
Key press in search box (work-around for ie).
clientmethod selectItem(name) [ Language = javascript ]
Select the given item.
clientmethod setFolderCategory(evt, cat) [ Language = javascript ]
Change the folder category
clientmethod setFolderView(evt, view) [ Language = javascript ]
Change the folder view.
clientmethod toggleFolder(index) [ Language = javascript ]
Hide/show folders in list.
clientmethod toggleLayout() [ Language = javascript ]
Toggle display of worklist area.
clientmethod updateWorklistTitle() [ Language = javascript ]
Update the title for the dashboard.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window