This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %DeepSee.UserPortal.standardPage


abstract class %DeepSee.UserPortal.standardPage extends

Base class for pages within the DeepSee user portal.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter APPLICATION = %DeepSee.UserPortal.Application;
Set this to the appropriate application class.
parameter DOMAIN = %DeepSee;
Set this to the correct domain.
parameter FAVORITEICON = portal/deepsee.ico;
DeepSee favorite icon.
parameter HOMEPAGE = _DeepSee.UserPortal.Home.zen;
URL of home page (used in links).
parameter JSINCLUDES = zenCSLM.js,zenESVG.js,DeepSee.js;
Inherited description: Comma-separated list of additional JS include files for the page.
parameter PAGENAME = DeepSee User Portal;
Name of this page.
parameter RESOURCE = %DeepSee_Portal;
All DeepSee pages require %DeepSee_Portal USE.
parameter WORKLIST1MODE = html;
Starting mode for worklist 1: html or group.
parameter WORKLIST2MODE = html;
Starting mode for worklist 2: html or group.

Properties (Including Private)

property StdTitle as %ZEN.Datatype.string [ InitialExpression = ..#PAGENAME ];
Define the title that will be displayed within subclasses
Property methods: StdTitleDisplayToLogical(), StdTitleGet(), StdTitleIsValid(), StdTitleLogicalToDisplay(), StdTitleLogicalToOdbc(), StdTitleNormalize(), StdTitleSet()
property aboutPage as %ZEN.Datatype.string [ InitialExpression = ..Link("_CSP.UI.Portal.About.zen?USERPORTAL=1") ];
About page URL
Property methods: aboutPageDisplayToLogical(), aboutPageGet(), aboutPageIsValid(), aboutPageLogicalToDisplay(), aboutPageLogicalToOdbc(), aboutPageNormalize(), aboutPageSet()
property alertId as %ZEN.Datatype.string (ZENURL = "ALERT");
ID of alert that launched this page, if any.
Property methods: alertIdDisplayToLogical(), alertIdGet(), alertIdIsValid(), alertIdLogicalToDisplay(), alertIdLogicalToOdbc(), alertIdNormalize(), alertIdSet()
property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify this page.
Property methods: canWriteDisplayToLogical(), canWriteGet(), canWriteIsValid(), canWriteLogicalToDisplay(), canWriteLogicalToOdbc(), canWriteLogicalToXSD(), canWriteNormalize(), canWriteSet(), canWriteXSDToLogical()
property chartSeriesColors as %ZEN.Datatype.string;
Chart series color list.
Property methods: chartSeriesColorsDisplayToLogical(), chartSeriesColorsGet(), chartSeriesColorsIsValid(), chartSeriesColorsLogicalToDisplay(), chartSeriesColorsLogicalToOdbc(), chartSeriesColorsNormalize(), chartSeriesColorsSet()
property chartSeriesScheme as %ZEN.Datatype.string;
Chart series color scheme.
Property methods: chartSeriesSchemeDisplayToLogical(), chartSeriesSchemeGet(), chartSeriesSchemeIsValid(), chartSeriesSchemeLogicalToDisplay(), chartSeriesSchemeLogicalToOdbc(), chartSeriesSchemeNormalize(), chartSeriesSchemeSet()
Local override of company logo.
Property methods: companyLogoDisplayToLogical(), companyLogoGet(), companyLogoIsValid(), companyLogoLogicalToDisplay(), companyLogoLogicalToOdbc(), companyLogoNormalize(), companyLogoSet()
property companyName as %ZEN.Datatype.string;
Local override of company name.
Property methods: companyNameDisplayToLogical(), companyNameGet(), companyNameIsValid(), companyNameLogicalToDisplay(), companyNameLogicalToOdbc(), companyNameNormalize(), companyNameSet()
property companyStyle as %ZEN.Datatype.string;
Local override of company cell style.
Property methods: companyStyleDisplayToLogical(), companyStyleGet(), companyStyleIsValid(), companyStyleLogicalToDisplay(), companyStyleLogicalToOdbc(), companyStyleNormalize(), companyStyleSet()
property homePage as %ZEN.Datatype.string [ InitialExpression = ..#HOMEPAGE ];
URL of the Home Page.
Property methods: homePageDisplayToLogical(), homePageGet(), homePageIsValid(), homePageLogicalToDisplay(), homePageLogicalToOdbc(), homePageNormalize(), homePageSet()
property isEmbedded as %ZEN.Datatype.boolean (ZENURL = "EMBED");
Convenience property. Setting this true is equivalent to NOTITLE=1,NOBORDER=1,NOMODIFY=1,WORKLISTS=0
Property methods: isEmbeddedDisplayToLogical(), isEmbeddedGet(), isEmbeddedIsValid(), isEmbeddedLogicalToDisplay(), isEmbeddedLogicalToOdbc(), isEmbeddedLogicalToXSD(), isEmbeddedNormalize(), isEmbeddedSet(), isEmbeddedXSDToLogical()
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.
Property methods: limitPopupsDisplayToLogical(), limitPopupsGet(), limitPopupsIsValid(), limitPopupsLogicalToDisplay(), limitPopupsLogicalToOdbc(), limitPopupsLogicalToXSD(), limitPopupsNormalize(), limitPopupsSet(), limitPopupsXSDToLogical()
property noBorder as %ZEN.Datatype.boolean (ZENURL = "NOBORDER");
If true, then do not display the outer border around the desktop area of this page.
Property methods: noBorderDisplayToLogical(), noBorderGet(), noBorderIsValid(), noBorderLogicalToDisplay(), noBorderLogicalToOdbc(), noBorderLogicalToXSD(), noBorderNormalize(), noBorderSet(), noBorderXSDToLogical()
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).
Property methods: noModifyDisplayToLogical(), noModifyGet(), noModifyIsValid(), noModifyLogicalToDisplay(), noModifyLogicalToOdbc(), noModifyLogicalToXSD(), noModifyNormalize(), noModifySet(), noModifyXSDToLogical()
property noTitle as %ZEN.Datatype.boolean (ZENURL = "NOTITLE");
If true, then do not display the title area of this page.
Property methods: noTitleDisplayToLogical(), noTitleGet(), noTitleIsValid(), noTitleLogicalToDisplay(), noTitleLogicalToOdbc(), noTitleLogicalToXSD(), noTitleNormalize(), noTitleSet(), noTitleXSDToLogical()
property searchKey as %ZEN.Datatype.string;
Current search key.
Property methods: searchKeyDisplayToLogical(), searchKeyGet(), searchKeyIsValid(), searchKeyLogicalToDisplay(), searchKeyLogicalToOdbc(), searchKeyNormalize(), searchKeySet()
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.
Property methods: urlWorklistCountDisplayToLogical(), urlWorklistCountGet(), urlWorklistCountIsValid(), urlWorklistCountLogicalToDisplay(), urlWorklistCountLogicalToOdbc(), urlWorklistCountNormalize(), urlWorklistCountSet()
property useClientEmail as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, send e-mail using client-side mailto application.
Property methods: useClientEmailDisplayToLogical(), useClientEmailGet(), useClientEmailIsValid(), useClientEmailLogicalToDisplay(), useClientEmailLogicalToOdbc(), useClientEmailLogicalToXSD(), useClientEmailNormalize(), useClientEmailSet(), useClientEmailXSDToLogical()
property viewerURL as %ZEN.Datatype.uri;
URL of viewer page.
Property methods: viewerURLDisplayToLogical(), viewerURLGet(), viewerURLIsValid(), viewerURLLogicalToDisplay(), viewerURLLogicalToOdbc(), viewerURLNormalize(), viewerURLSet()
property worklistCount as %ZEN.Datatype.integer (MAXVAL = 2, MINVAL = 0) [ InitialExpression = 2 ];
Number of worklist panels to display: 0,1,or 2.
Property methods: worklistCountDisplayToLogical(), worklistCountGet(), worklistCountIsValid(), worklistCountLogicalToDisplay(), worklistCountLogicalToOdbc(), worklistCountNormalize(), worklistCountSet()

Methods (Including Private)

final classmethod %DrawWorklist(pMode As %String, pPanelId As %String, pPanelNo As %Integer, ByRef pOptions As %List) as %Status
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)
final classmethod %DrawWorklistHeader(pMode As %String, pPanelId As %String, pPanelNo As %Integer, ByRef pOptions As %List) as %Status
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)
method %OnAfterCreatePage() as %Status
Decorate the page.
method %OnDrawHTMLHead() as %Status
Add include files to support color schemes.
method %OnDrawHTMLMeta() as %Status
Ensure that we force Internet Explorer to use its most recent rendering engine.
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
method %OnGetSmallMenu(Output pMenu)
Get the contents of the small menu in the title area.
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.
classmethod AddFavorite(pName As %String) as %Boolean [ ZenMethod ]
classmethod DoLogout() as %Boolean [ ZenMethod ]
method DrawTitle(pSeed As %String) as %Status
Draw the contents of the title area. Dispatch to application class.
method DrawWorklist1(pSeed As %String) as %Status
Draw the contents of the worklist 1.
method DrawWorklist2(pSeed As %String) as %Status
Draw the contents of the worklist 2.
method DrawWorklistHeader1(pSeed As %String) as %Status
Draw the header for worklist 1.
method DrawWorklistHeader2(pSeed As %String) as %Status
Draw the the header for worklist 2.
method DrawWorklistTitle(pSeed As %String) as %Status
Draw the contents of the worklist title area.
Define any quick links for the page
classmethod RemoveAlert(pAlertId As %String) as %Boolean [ ZenMethod ]
classmethod RemoveFavorite(pName As %String) as %Boolean [ ZenMethod ]
classmethod RemoveRecentItem(pName As %String) as %Boolean [ ZenMethod ]
method SendItemToTrash(pName As %String) as %String [ ZenMethod ]
Move the given folder item to the trash folder.
clientmethod addToFavorites(name) [ Language = javascript ]
Add item to favorites
clientmethod adjustSizes(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod getNavigator() [ Language = javascript ]
Get the navigator component.
clientmethod getTitleAreaHeight() [ Language = javascript ]
Return the height of the title area (titleBar plus locator).
clientmethod goHome() [ Language = javascript ]
Go to the home page.
clientmethod gotoAlert(url) [ Language = javascript ]
View the given alert.
clientmethod gotoFavorite(url) [ Language = javascript ]
View the given favorite.
clientmethod gotoNamespace(url) [ Language = javascript ]
Navigate to a new namespace in the portal.
clientmethod logout() [ Language = javascript ]
End the current session.
Click on close button in navigator.
Re-arrange of a list in navigator.
Change of data value in navigator.
Expand or contract of navigator.
Return an object describing what to display for this level within the navigator.
Click on header button in navigator.
Popup action in navigator.
Select of item within the navigator.
Navigate to a new page in the portal.
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 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.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod reloadPage() [ Language = javascript ]
Reload this page in an IE-friendly way!
clientmethod removeFromAlerts(alertId) [ Language = javascript ]
Remove item from alerts.
clientmethod removeFromFavorites(name) [ Language = javascript ]
Remove item from favorites
clientmethod removeFromRecentList(name) [ Language = javascript ]
Remove item from recent list.
clientmethod sendAlert() [ Language = javascript ]
Launch the send alert dialog.
clientmethod sendMail(url, title) [ Language = javascript ]
Launch the send email dialog.
clientmethod setCompanyCell(content) [ Language = javascript ]
Set the HTML contents of the company logo cell in the title. If content is null, restore original content.
clientmethod setConnectivityStatusMsg(msg) [ Language = javascript ]
clientmethod setPortalTitleMsg(msg) [ Language = javascript ]
Set the contents of the small message box in the title.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod setWorklistView(id, mode, type) [ Language = javascript ]
Called when user updates or clicks on an icon in a worklist.
clientmethod showAbout() [ Language = javascript ]
Go to the home page.
clientmethod showHelp() [ Language = javascript ]
Show documentation.
clientmethod toggleWorklists() [ Language = javascript ]
Toggle display of work lists.
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.
clientmethod updateWorklistTitle() [ Language = javascript ]
Update the title for the worklist.
clientmethod updateWorklistType(mode) [ Language = javascript ]
Update the all worklists showing the given type.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)


FeedbackOpens in a new window