Skip to main content

%DeepSee.UserPortal.standardPage

Class %DeepSee.UserPortal.standardPage Extends (%ZEN.Component.page, %ZEN.Portal.abstractRefreshable) [ Abstract, System = 4 ]

Base class for pages within the DeepSee user portal.

Parameters

JSINCLUDES

Parameter JSINCLUDES = "zenCSLM.js,zenESVG.js,DeepSee.js";

APPLICATION

Parameter APPLICATION = "%DeepSee.UserPortal.Application";

Set this to the appropriate application class.

FAVORITEICON

Parameter FAVORITEICON = "portal/ISC_IRIS_icon.ico";

DeepSee favorite icon.

DOMAIN

Parameter DOMAIN = "%DeepSee";

Set this to the correct domain.

RESOURCE

Parameter RESOURCE = "%DeepSee_Portal,%DeepSee_PortalEdit";

All DeepSee pages require %DeepSee_Portal USE.

PAGENAME

Parameter PAGENAME = "User Portal";

Name of this page.

HOMEPAGE

Parameter HOMEPAGE = "_DeepSee.UserPortal.Home.zen";

URL of home page (used in links).

WORKLIST1MODE

Parameter WORKLIST1MODE = "html";

Starting mode for worklist 1: html or group.

WORKLIST2MODE

Parameter WORKLIST2MODE = "html";

Starting mode for worklist 2: html or group.

Properties

StdTitle

Property StdTitle As %ZEN.Datatype.string [ InitialExpression = {..#PAGENAME} ];

Define the title that will be displayed within subclasses

homePage

Property homePage As %ZEN.Datatype.string [ InitialExpression = {..#HOMEPAGE} ];

URL of the Home Page.

aboutPage

Property aboutPage As %ZEN.Datatype.string [ InitialExpression = {..Link("_CSP.UI.Portal.About.zen?USERPORTAL=1")} ];

About page URL

alertId

Property alertId As %ZEN.Datatype.string(ZENURL = "ALERT");

ID of alert that launched this page, if any.

searchKey

Property searchKey As %ZEN.Datatype.string;

Current search key.

viewerURL

Property viewerURL As %ZEN.Datatype.uri;

URL of viewer page.

worklistCount

Property worklistCount As %ZEN.Datatype.integer(MAXVAL = 2, MINVAL = 0) [ InitialExpression = 2 ];

Number of worklist panels to display: 0,1,or 2.

useClientEmail

Property useClientEmail As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, send e-mail using client-side mailto application.

isEmbedded

Property isEmbedded As %ZEN.Datatype.boolean(ZENURL = "EMBED");

Convenience property. Setting this true is equivalent to NOTITLE=1,NOBORDER=1,NOMODIFY=1,WORKLISTS=0

noTitle

Property noTitle As %ZEN.Datatype.boolean(ZENURL = "NOTITLE");

If true, then do not display the title area of this page.

noBorder

Property noBorder As %ZEN.Datatype.boolean(ZENURL = "NOBORDER");

If true, then do not display the outer border around the desktop area of this page.

noModify

Property noModify As %ZEN.Datatype.boolean(ZENURL = "NOMODIFY");

If true, then do not allow user to modify this page (this is only a convenience, it is not enforced by privileges).

urlWorklistCount

Property urlWorklistCount As %ZEN.Datatype.integer(ZENURL = "WORKLISTS");

If set override the worklist count (number of worklist boxes on side of page). This can be 0,1, or 2.

canWrite

Property canWrite As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

If true, user can modify this page.

chartSeriesScheme

Property chartSeriesScheme As %ZEN.Datatype.string;

Chart series color scheme.

chartSeriesColors

Property chartSeriesColors As %ZEN.Datatype.string;

Chart series color list.

companyName

Property companyName As %ZEN.Datatype.string;

Local override of company name.

Property companyLogo As %ZEN.Datatype.string;

Local override of company logo.

companyStyle

Property companyStyle As %ZEN.Datatype.string;

Local override of company cell style.

limitPopups

Property limitPopups As %ZEN.Datatype.boolean [ InitialExpression = {##class(%CSP.Portal.Utils).%IsConnectivityPopupDisabled()} ];

Set to true to suppress hyperevent error pop-ups in the event of a connectitivity failure.

XDatas

Style

XData Style

Contents

XData Contents [ XMLNamespace = "http://www.intersystems.com/zen" ]

Contents of this page:

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

DrawTitle

Method DrawTitle(pSeed As %String) As %Status

Draw the contents of the title area. Dispatch to application class.

%OnDrawHTMLHead

Method %OnDrawHTMLHead() As %Status

Add include files to support color schemes.

DrawWorklistTitle

Method DrawWorklistTitle(pSeed As %String) As %Status

Draw the contents of the worklist title area.

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

DrawWorklistHeader1

Method DrawWorklistHeader1(pSeed As %String) As %Status

Draw the header for worklist 1.

DrawWorklist1

Method DrawWorklist1(pSeed As %String) As %Status

Draw the contents of the worklist 1.

DrawWorklistHeader2

Method DrawWorklistHeader2(pSeed As %String) As %Status

Draw the the header for worklist 2.

DrawWorklist2

Method DrawWorklist2(pSeed As %String) As %Status

Draw the contents of the worklist 2.

ClassMethod GetQuickLinks(Output pLinks) As %Status

Define any quick links for the page

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

%OnGetSmallMenu

Method %OnGetSmallMenu(Output pMenu)

Get the contents of the small menu in the title area.

goHome

ClientMethod goHome() [ Language = javascript ]

Go to the home page.

showAbout

ClientMethod showAbout() [ Language = javascript ]

Go to the home page.

showHelp

ClientMethod showHelp() [ Language = javascript ]

Show documentation.

logout

ClientMethod logout() [ Language = javascript ]

End the current session.

DoLogout

ClassMethod DoLogout() As %Boolean [ ZenMethod ]

getTitleAreaHeight

ClientMethod getTitleAreaHeight() [ Language = javascript ]

Return the height of the title area (titleBar plus locator).

ClientMethod navigate(url) [ Language = javascript ]

Navigate to a new page in the portal.

gotoNamespace

ClientMethod gotoNamespace(url) [ Language = javascript ]

Navigate to a new namespace in the portal.

gotoAlert

ClientMethod gotoAlert(url) [ Language = javascript ]

View the given alert.

gotoFavorite

ClientMethod gotoFavorite(url) [ Language = javascript ]

View the given favorite.

addToFavorites

ClientMethod addToFavorites(name) [ Language = javascript ]

Add item to favorites

removeFromFavorites

ClientMethod removeFromFavorites(name) [ Language = javascript ]

Remove item from favorites

removeFromRecentList

ClientMethod removeFromRecentList(name) [ Language = javascript ]

Remove item from recent list.

removeFromAlerts

ClientMethod removeFromAlerts(alertId) [ Language = javascript ]

Remove item from alerts.

updateWorklistType

ClientMethod updateWorklistType(mode) [ Language = javascript ]

Update the all worklists showing the given type.

setWorklistView

ClientMethod setWorklistView(id, mode, type) [ Language = javascript ]

Called when user updates or clicks on an icon in a worklist.

AddFavorite

ClassMethod AddFavorite(pName As %String) As %Boolean [ ZenMethod ]

RemoveFavorite

ClassMethod RemoveFavorite(pName As %String) As %Boolean [ ZenMethod ]

RemoveAlert

ClassMethod RemoveAlert(pAlertId As %String) As %Boolean [ ZenMethod ]

RemoveRecentItem

ClassMethod RemoveRecentItem(pName As %String) As %Boolean [ ZenMethod ]

updateWorklistTitle

ClientMethod updateWorklistTitle() [ Language = javascript ]

Update the title for the worklist.

onlayoutHandler

ClientMethod onlayoutHandler(load) [ Language = javascript ]

Adjust sizes of components on the page.

adjustSizes

ClientMethod adjustSizes(load) [ Language = javascript ]

Adjust sizes of components on the page.

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.

%DrawWorklistHeader

ClassMethod %DrawWorklistHeader(pMode As %String, pPanelId As %String, pPanelNo As %Integer, ByRef pOptions As %List) As %Status [ Final ]

Draw the contents of a worklist panel within the user portal.
pMode indicates the type of contents to display.
pPanelId is the id of the html component displaying the panel.
pPanelNo is the worklist number.
pOptions is a list of the available options:
pOptions(n) = $LB(name,type,class)

%DrawWorklist

ClassMethod %DrawWorklist(pMode As %String, pPanelId As %String, pPanelNo As %Integer, ByRef pOptions As %List) As %Status [ Final ]

Draw the contents of a worklist panel within the user portal.
pMode indicates the type of contents to display (which item in the options list).
pPanelId is the id of the html component displaying the panel.
pPanelNo is the worklist number.
pOptions is a list of the available options:
pOptions(n) = $LB(name,type,class)

SendItemToTrash

Method SendItemToTrash(pName As %String) As %String [ ZenMethod ]

Move the given folder item to the trash folder.

toggleWorklists

ClientMethod toggleWorklists() [ Language = javascript ]

Toggle display of work lists.

sendAlert

ClientMethod sendAlert() [ Language = javascript ]

Launch the send alert dialog.

sendMail

ClientMethod sendMail(url, title) [ Language = javascript ]

Launch the send email dialog.

ClientMethod navExpand() [ Language = javascript ]

Expand or contract of navigator.

ClientMethod navGetContentForLevel(level, key) [ Language = javascript ]

Return an object describing what to display for this level within the navigator.

ClientMethod navDataChange(key, value, final) [ Language = javascript ]

Change of data value in navigator.

ClientMethod navDataArrange(key, swap, final) [ Language = javascript ]

Re-arrange of a list in navigator.

ClientMethod navHeaderButtonClick(key) [ Language = javascript ]

Click on header button in navigator.

ClientMethod navCloseButtonClick(key) [ Language = javascript ]

Click on close button in navigator.

ClientMethod navPopupAction(key, value) [ Language = javascript ]

Popup action in navigator.

ClientMethod navSelectItem(key, value, which) [ Language = javascript ]

Select of item within the navigator.

getNavigator

ClientMethod getNavigator() [ Language = javascript ]

Get the navigator component.

setProperty

ClientMethod setProperty(property, value, value2) [ Language = javascript ]

Set the value of a named property.

%OnDrawHTMLMeta

Method %OnDrawHTMLMeta() As %Status

setPortalTitleMsg

ClientMethod setPortalTitleMsg(msg) [ Language = javascript ]

Set the contents of the small message box in the title.

setCompanyCell

ClientMethod setCompanyCell(content) [ Language = javascript ]

Set the HTML contents of the company logo cell in the title. If content is null, restore original content.

updateCompanyCell

ClientMethod updateCompanyCell(load) [ Language = javascript ]

Update the contents of the company cell in the title (if present) to match the local settings of this page.

reloadPage

ClientMethod reloadPage() [ Language = javascript ]

Reload this page in an IE-friendly way!

onServerMethodError

ClientMethod onServerMethodError(err, errObject) [ Language = javascript ]

Custom handler for hyperEvent handlers to be (optionally) less intrusive if the cause of the error was an auto-refresh timer losing commectivity with the host.

testConnectivity

ClientMethod testConnectivity() [ Internal, Language = javascript ]

setConnectivityStatusMsg

ClientMethod setConnectivityStatusMsg(msg) [ Language = javascript ]