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 > %CSP.Portal.Home

%CSP.Portal.Home

class %CSP.Portal.Home extends %ZEN.Portal.standardPage

Home page for the Ensemble Management Portal. If the current user holds the %Admin_Secure resource, then this page can be used to view and define custom resources.

Property Inventory

Method Inventory

Parameters

parameter APPLICATION = %ZEN.Portal.Application;
Set this to the appropriate application class.
parameter DOMAIN = %Utility;
Set this to the correct domain.
parameter FAVORITEICON = portal/home.ico;
Home favorite icon.
parameter PAGENAME = Home;
Name of this page.
parameter RECENT = 0;
If true, register visits to this page in the recent list.

Properties

property HSHomePage as %String (MAXLEN = 256);
This gets computed on after page create
Property methods: HSHomePageDisplayToLogical(), HSHomePageGet(), HSHomePageIsValid(), HSHomePageLogicalToDisplay(), HSHomePageLogicalToOdbc(), HSHomePageNormalize(), HSHomePageSet()
property InstanceGUID as %String [ InitialExpression = ##class(%SYS.System).InstanceGUID() ];
Property methods: InstanceGUIDDisplayToLogical(), InstanceGUIDGet(), InstanceGUIDIsValid(), InstanceGUIDLogicalToDisplay(), InstanceGUIDLogicalToOdbc(), InstanceGUIDNormalize(), InstanceGUIDSet()
property IsEnsembleInstalled as %ZEN.Datatype.boolean [ InitialExpression = ##class(%Library.EnsembleMgr).IsEnsembleInstalled() ];
Property methods: IsEnsembleInstalledDisplayToLogical(), IsEnsembleInstalledGet(), IsEnsembleInstalledIsValid(), IsEnsembleInstalledLogicalToDisplay(), IsEnsembleInstalledLogicalToOdbc(), IsEnsembleInstalledLogicalToXSD(), IsEnsembleInstalledNormalize(), IsEnsembleInstalledSet(), IsEnsembleInstalledXSDToLogical()
property IsHealthShareInstalled as %ZEN.Datatype.boolean [ InitialExpression = ##class(%Library.EnsembleMgr).IsHealthShareInstalled() ];
Property methods: IsHealthShareInstalledDisplayToLogical(), IsHealthShareInstalledGet(), IsHealthShareInstalledIsValid(), IsHealthShareInstalledLogicalToDisplay(), IsHealthShareInstalledLogicalToOdbc(), IsHealthShareInstalledLogicalToXSD(), IsHealthShareInstalledNormalize(), IsHealthShareInstalledSet(), IsHealthShareInstalledXSDToLogical()
property NAMESPACE as %ZEN.Datatype.string;
Current $NAMESPACE. This is the namespace user seleccted from the Switch namespace dialog and will be used in navigate().
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property NSNAME as %ZEN.Datatype.string;
Name of the current namespace (from $ZU(5)).
Property methods: NSNAMEDisplayToLogical(), NSNAMEGet(), NSNAMEIsValid(), NSNAMELogicalToDisplay(), NSNAMELogicalToOdbc(), NSNAMENormalize(), NSNAMESet()
property Username as %ZEN.Datatype.string;
Current login user name.
Property methods: UsernameDisplayToLogical(), UsernameGet(), UsernameIsValid(), UsernameLogicalToDisplay(), UsernameLogicalToOdbc(), UsernameNormalize(), UsernameSet()
property btnGo as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Go") ];
Property methods: btnGoDisplayToLogical(), btnGoGet(), btnGoIsValid(), btnGoLogicalToDisplay(), btnGoLogicalToOdbc(), btnGoNormalize(), btnGoSet()
property currDropdownIndex as %ZEN.Datatype.integer;
Index of current item in search dropdown.
Property methods: currDropdownIndexDisplayToLogical(), currDropdownIndexGet(), currDropdownIndexIsValid(), currDropdownIndexLogicalToDisplay(), currDropdownIndexLogicalToOdbc(), currDropdownIndexNormalize(), currDropdownIndexSet()
property currItemId as %ZEN.Datatype.string [ InitialExpression = "HOME" ];
Indicates the id of which item is selected in the selector pane (on the left).
Property methods: currItemIdDisplayToLogical(), currItemIdGet(), currItemIdIsValid(), currItemIdLogicalToDisplay(), currItemIdLogicalToOdbc(), currItemIdNormalize(), currItemIdSet()
property homeChanged as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, the the "Home" page needs to be refreshed to see new favorites.
Property methods: homeChangedDisplayToLogical(), homeChangedGet(), homeChangedIsValid(), homeChangedLogicalToDisplay(), homeChangedLogicalToOdbc(), homeChangedLogicalToXSD(), homeChangedNormalize(), homeChangedSet(), homeChangedXSDToLogical()
property isGoHome as %ZEN.Datatype.boolean (ZENURL = "isGoHome") [ InitialExpression = 0 ];
If it is 1, it indicates that user clicked the "Home" link in small menu link then show "Home" selector.
Property methods: isGoHomeDisplayToLogical(), isGoHomeGet(), isGoHomeIsValid(), isGoHomeLogicalToDisplay(), isGoHomeLogicalToOdbc(), isGoHomeLogicalToXSD(), isGoHomeNormalize(), isGoHomeSet(), isGoHomeXSDToLogical()
property itemCount as %ZEN.Datatype.integer;
Number of items in the selector pane (this is automatically computed).
Property methods: itemCountDisplayToLogical(), itemCountGet(), itemCountIsValid(), itemCountLogicalToDisplay(), itemCountLogicalToOdbc(), itemCountNormalize(), itemCountSet()
property resourceMode as %ZEN.Datatype.boolean;
If true, then show this page in a special mode where the user can assign resources. User must hold %Admin_Secure for this to be enabled.
Property methods: resourceModeDisplayToLogical(), resourceModeGet(), resourceModeIsValid(), resourceModeLogicalToDisplay(), resourceModeLogicalToOdbc(), resourceModeLogicalToXSD(), resourceModeNormalize(), resourceModeSet(), resourceModeXSDToLogical()
Used by search box to track link of selected item.
Property methods: searchLinkDisplayToLogical(), searchLinkGet(), searchLinkIsValid(), searchLinkLogicalToDisplay(), searchLinkLogicalToOdbc(), searchLinkNormalize(), searchLinkSet()

Methods

method %ApplySearchToArray(pSearchKey As %String, ByRef pArray, Output pResults As %List)
Walk down array; find elements containing search key.
method %DrawDidYouKnow() as %Status
Draw the did you know box.
method %DrawFavorites() as %Status
Draw the favorites box.
Draw the Links list.
method %DrawOptionsBox(pTitle As %String, pSubtitle As %String, ByRef pOptions As %List, pWhich As %String = "") as %Status
Draw contents of one options box (favorites or recent).
method %DrawRecent() as %Status
Draw the recent items list.
classmethod %GetDidYouKnowText() as %String
Return localized "did you know" message.
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
method %GetSearchResults(pSearchKey As %String, Output pResults As %List)
Return an array of search results: pResults(n) = $LB(name,url,title)
method %OnAfterCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
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.
classmethod %OnPreHTTP() as %Boolean
Zen page notification of an HTTP request. This method can be overwritten by subclasses.
This is called before the standard Zen pre-HTTP processing occurs.
classmethod AddToFavorites(pName As %String, pURL As %String, pLink As %String) as %Boolean [ ZenMethod ]
Add item to favorites list.
classmethod CheckSecurity(pResource As %String) as %Boolean
Given a security resource, this method returns 1 if user has privilege, and 0 if the user does not security privilege for using a particular function.
classmethod CheckURL(pURL, pNAMESPACE) as %String [ ZenMethod ]
This method is called when user clicked "Go" after selecting a menu item. The url may be reconstructed based on where you are going.
For example, if you are going to an Ensemble namespace, the url will become /csp/ensnamespace/...
method DrawMessagePanel(pSeed As %String) as %Status
Draw contents of the message panel.
method DrawSearchDropDown(pSeed As %String) as %Status
Draw contents of the search results dropdown.
method DrawSearchResults(pSeed As %String) as %Status
Draw contents of the search results panel.
method DrawSelector(pSeed As %String) as %Status
Draw content of the selector pane.
method DrawSplashContent(pSeed As %String) as %Status
Draw content of the splash pane.
method GetDeepSeeArray(Output pData) as %Status
Provide finder contents for the DeepSee pages.
method GetEnsembleArray(Output pData) as %Status
Provide finder contents for the Ensemble pages.
method GetFinderArray(ByRef pParameters, Output pMetaData, Output pData) as %Status
Provide the source data (as an array) that will drive the finder.
method GetHealthShareArray(Output pData) as %Status
Provide finder contents for the HealthShare pages.
classmethod GetNamespaceList() as %String [ ZenMethod ]
Populate the client-size zenPage._nsList array with a list of available namespace and flags to indicate whether each is Ensemble- and DeepSee-enabled.
method GetSystemConfigArray(Output pData) as %Status
Provide finder contents for the System Config pages.
method GetSystemExplorerArray(Output pData) as %Status
Provide finder contents for the System Explorer pages.
method GetSystemOperationArray(Output pData) as %Status
Provide finder contents for the System Operator pages.
method OnDrawRibbon() as %Status
This is called in the middle of rendering the tool ribbon.
method OnGetRibbonInfo(Output pDisplay As %Library.Boolean, Output pViewIcons As %Library.List, Output pSortOptions As %Library.List, Output pSearchBox As %Library.Boolean, Output pRibbonTitle As %Library.String, Output pCommands As %Library.List) as %Status
Get information to display in the ribbon bar.
classmethod RemoveFavorite(pName As %String) as %Boolean [ ZenMethod ]
Remove a favorite item from the list.
classmethod RemoveRecent(pName As %String) as %Boolean [ ZenMethod ]
Remove a recent item from the list.
clientmethod addFavorite(name, url, link) [ Language = javascript ]
clientmethod assignResource(name, link) [ Language = javascript ]
Launch the assign resource dialog.
clientmethod changeNamespace(ns) [ Language = javascript ]
Change to a new namespace.
clientmethod clearSearchTimer() [ Language = javascript ]
Stop the search timer.
clientmethod clearState() [ Language = javascript ]
This method clears the 'state' cookie which indicates the last selection for the finderPane position on the SMP portal home.
clientmethod drawDetails(item, finder, index) [ Language = javascript ]
Provide HTML for details on selected item in finder.
clientmethod drawEmptyFinder(item) [ Language = javascript ]
Provide HTML for empty finder.
clientmethod enableMirroring() [ Language = javascript ]
clientmethod getCookieValue(cookieName, cookieString) as %String [ Language = javascript ]
Generic method to get a cookie value. cookieName is the name, e.g. "state", cookieString is document.cookie.
clientmethod getNamespaceHTML(cat) [ Language = javascript ]
Provide HTML to select a namespace.
clientmethod goHome() [ Language = javascript ]
Go to the home page.
clientmethod hideSearchDropdown() [ Language = javascript ]
Display the search results drop down.
clientmethod itemDoubleClick(item) [ Language = javascript ]
Item double-clicked within the Finder.
clientmethod itemSelected(item) [ Language = javascript ]
Item selected within the Finder.
clientmethod makeSelectorBig(flag) [ Language = javascript ]
Set size of selector to big (true) or small (false).
Navigate to a new page in the portal.
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 onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod removeItem(which, name) [ Language = javascript ]
Remove the given item from its list.
clientmethod saveState() [ Language = javascript ]
Save current state into cookie so when page is refreshed it goes back to the last selection.
This method is called from navigate()and onPopupAction() for case switchNamespace
clientmethod searchBlur(evt) [ Language = javascript ]
Blur event in search box.
clientmethod searchBoxDown() [ Language = javascript ]
Go to next item in search box dropdown.
clientmethod searchBoxHandler(searchKey) [ Language = javascript ]
Change in search box value. Can be overridden by subclasses.
clientmethod searchBoxUp() [ Language = javascript ]
Go to prev item in search box dropdown.
clientmethod searchKeyDown(evt) [ Language = javascript ]
Key down in search box (override).
clientmethod searchKeyPress(evt) [ Language = javascript ]
Key press in search box (override).
clientmethod searchTimerHandler() [ Language = javascript ]
Action for search timer.
clientmethod selectCategory(cat) [ Language = javascript ]
Item selected within the Selector.
clientmethod setCookieValue(cookieName, cookieValue) as %String [ Language = javascript ]
Generic method to set a cookie name and value pair.
The expiration date is set to 2020 which is the same as in generic SMP pages, which should be changed before end of 2020.
clientmethod setSortModeHandler(mode) [ Language = javascript ]
Do the actual work of updating the view to match the current sort mode.
clientmethod setViewModeHandler(mode, oldmode) [ Language = javascript ]
Do the actual work of updating the view to match the current view mode.
clientmethod showSearchDropdown() [ Language = javascript ]
Display the search results drop down.
clientmethod showSearchResults(flag) [ Language = javascript ]
Hide/show search results.
clientmethod startSearchTimer() [ Language = javascript ]
Start the search timer.
clientmethod toggleResourceMode(iscb) [ Language = javascript ]
Toggle resource edit mode.
clientmethod updateMessagePanel(timer) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window