Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.HC.UI.Home

class HS.HC.UI.Home extends HS.UI.Base

Home page for the HealthShare Management Portal.

Property Inventory

Method Inventory

Parameters

parameter APPLICATION = HS.UI.Application;
Set this to the appropriate application class.
parameter AUTONS = 0;
If true, auto-switch namespace to whatever $NAMESPACE is passed in.
parameter DEFAULTSORTMODE = name;
If this page has sort options, this is its initial sort mode.
parameter DEFAULTVIEWMODE = columns;
If this page has multiple views, this is its initial display mode.
parameter DOMAIN = HS;
Set this to the correct domain.
parameter FAVORITEICON = $$$ISCFAVORITEICON;
Home favorite icon.
parameter HOMEPAGE = /csp/sys/%25CSP.Portal.Home.zen;
URL of home page (used in links).
parameter PAGENAME = HealthShare Home;
Name of this page.
parameter RECENT = 0;
If true, register visits to this page in the recent list.
parameter SHOWNAMESPACE = 1;
If true, show the Namespace dropdown.

Properties

property ManageEnsemble as %Boolean;
are we in Ensemble management mode
Property methods: ManageEnsembleDisplayToLogical(), ManageEnsembleGet(), ManageEnsembleIsValid(), ManageEnsembleLogicalToDisplay(), ManageEnsembleLogicalToXSD(), ManageEnsembleNormalize(), ManageEnsembleSet(), ManageEnsembleXSDToLogical()
property NAMESPACE as %ZEN.Datatype.string;
Name of the current namespace (from $NAMESPACE).
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property REQUESTNS as %ZEN.Datatype.string;
Current $NAMESPACE. This is the namespace user selected from the Switch namespace dialog and will be used in navigate().
Property methods: REQUESTNSDisplayToLogical(), REQUESTNSGet(), REQUESTNSIsValid(), REQUESTNSLogicalToDisplay(), REQUESTNSLogicalToOdbc(), REQUESTNSNormalize(), REQUESTNSSet()
property Username as %ZEN.Datatype.string;
Current login user name.
Property methods: UsernameDisplayToLogical(), UsernameGet(), UsernameIsValid(), UsernameLogicalToDisplay(), UsernameLogicalToOdbc(), UsernameNormalize(), UsernameSet()
property aboutPage as %ZEN.Datatype.string;
About page URL
Property methods: aboutPageDisplayToLogical(), aboutPageGet(), aboutPageIsValid(), aboutPageLogicalToDisplay(), aboutPageLogicalToOdbc(), aboutPageNormalize(), aboutPageSet()
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 currSortMode as %ZEN.Datatype.string [ InitialExpression = ..#DEFAULTSORTMODE ];
Current sort mode for this page (if applicable).
Property methods: currSortModeDisplayToLogical(), currSortModeGet(), currSortModeIsValid(), currSortModeLogicalToDisplay(), currSortModeLogicalToOdbc(), currSortModeNormalize(), currSortModeSet()
property currStep as %ZEN.Datatype.integer [ InitialExpression = 1 ];
For pages with steps, this is the current step (1-based).
Property methods: currStepDisplayToLogical(), currStepGet(), currStepIsValid(), currStepLogicalToDisplay(), currStepLogicalToOdbc(), currStepNormalize(), currStepSet()
property currViewMode as %ZEN.Datatype.string [ InitialExpression = ..#DEFAULTVIEWMODE ];
If this page has "views", this is the current view type.
Property methods: currViewModeDisplayToLogical(), currViewModeGet(), currViewModeIsValid(), currViewModeLogicalToDisplay(), currViewModeLogicalToOdbc(), currViewModeNormalize(), currViewModeSet()
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 homePage as %ZEN.Datatype.string [ InitialExpression = $S($IsObject($G(%request)):%request.URLPrefix, 1:"")_..#HOMEPAGE ];
Product home page URL with "home" value
Property methods: homePageDisplayToLogical(), homePageGet(), homePageIsValid(), homePageLogicalToDisplay(), homePageLogicalToOdbc(), homePageNormalize(), homePageSet()
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 msgCompleted as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Rebuild Started") ];
Property methods: msgCompletedDisplayToLogical(), msgCompletedGet(), msgCompletedIsValid(), msgCompletedLogicalToDisplay(), msgCompletedLogicalToOdbc(), msgCompletedNormalize(), msgCompletedSet()
property msgConfirm as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Rebuild synchronization data?") ];
Property methods: msgConfirmDisplayToLogical(), msgConfirmGet(), msgConfirmIsValid(), msgConfirmLogicalToDisplay(), msgConfirmLogicalToOdbc(), msgConfirmNormalize(), msgConfirmSet()
property msgResendCompleted as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Request sent. Check RolesAndResources task status.") ];
Property methods: msgResendCompletedDisplayToLogical(), msgResendCompletedGet(), msgResendCompletedIsValid(), msgResendCompletedLogicalToDisplay(), msgResendCompletedLogicalToOdbc(), msgResendCompletedNormalize(), msgResendCompletedSet()
property msgResendConfirm as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Request resend of users and roles?") ];
Property methods: msgResendConfirmDisplayToLogical(), msgResendConfirmGet(), msgResendConfirmIsValid(), msgResendConfirmLogicalToDisplay(), msgResendConfirmLogicalToOdbc(), msgResendConfirmNormalize(), msgResendConfirmSet()
property pageModified as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
True if the contents of this page need to be saved.
Property methods: pageModifiedDisplayToLogical(), pageModifiedGet(), pageModifiedIsValid(), pageModifiedLogicalToDisplay(), pageModifiedLogicalToOdbc(), pageModifiedLogicalToXSD(), pageModifiedNormalize(), pageModifiedSet(), pageModifiedXSDToLogical()
property searchKey as %ZEN.Datatype.string;
Current search key value (if applicable).
Property methods: searchKeyDisplayToLogical(), searchKeyGet(), searchKeyIsValid(), searchKeyLogicalToDisplay(), searchKeyLogicalToOdbc(), searchKeyNormalize(), searchKeySet()
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 %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.
classmethod %OnHSPreHTTP() as %Boolean
Override this instead of %OnPreHTTP for all HS.UI Zen classes
method AddMenuBranch(pName As %String, pTitle As %String = "", pLicense As %String = "", pMethod As %String, pSecurity As %String = "", pIcon As %String = "", ByRef pData, ByRef pN=0, pArgs...)
method AddOption(pName As %String, pTitle As %String = "", pKey As %String = "", pClass As %String = "", pSecurity As %String = "", pIcon As %String = "", pCheckUIVersion As %Boolean = 0, ByRef pData, ByRef pN=0, pArgs...)
pName - option Name (after $$$Text) pTitle - option Title (hover help, after $$$Text) pKey - configuration registry UI key for the class/page for options invoking methods within this class, this goes in pKey, and pClass would be null. Can also be $ListBuild() with two value: the config registry key and a boolean value to indicate whether an item is disabled. pClass - classname (with .cls) of the default class, to be used if not in the configuration registry pSecurity - if filled in, must have Use access to that Role pIcon - reference to icon file (defaults to portal/role_48.gif) pCheckUIVersion - boolean. Used to check for an out of date UI running on a gateway, where the registry has been upgraded, but the gateway hasn't. pData - the array being populated with the menu, where pData(1-n)=top level of menu, pData(x,1-n1)=nested level, etc. pN - the current index into the current level in PData pArgs - subscripts used when for submenu structure within the array
method AddProductsMenu(args...)
Add any customized menu options for a product
method BuildMenu() as %Status
This method rebuilds context menu on the top left corner.
classmethod DoLogout() as %Boolean [ ZenMethod ]
final method DrawHSTitle(pSeed As %String) as %Status
Draw the contents of the title area. Dispatch to application class.
method DrawRibbon(pSeed As %String) as %Status
Draw the contents of the tool ribbon. This is displayed if a subclass implements the OnGetRibbonInfo() callback.
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. This will only be visible if we're not in a HealthShare component namespace
method GetAustralianCustomisations(pN1, pData)
method GetFinderArray(ByRef pParameters, Output pMetaData, Output pData) as %Status
Provide the source data (as an array) that will drive the finder.
method GetFoundationArray(pData) as %Status
method GetIHEConfiguration(pN1, pData)
method GetIHEConfigurationFoundation(pN1, pData)
method GetOIDRegistry(pN1, pN2, pData)
method GetOIDRegistryFoundation(pN1, pData)
method GetSchemaDocumentation(pN1, pData)
method OnDrawRibbon() as %Status
This is called in the middle of rendering the tool ribbon.
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
method RequestUsersRoles() as %Status [ ZenMethod ]
Class method to request resend of user roles and resources
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 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 getTitleAreaHeight() [ Language = javascript ]
Return the height of the title area (titleBar plus locator).
clientmethod goHome() [ Language = javascript ]
Go to the home page.
clientmethod goMenu(link) [ 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 logout() [ Language = javascript ]
End the current session.
clientmethod makeSelectorBig(flag) [ Language = javascript ]
Set size of selector to big (true) or small (false).
Navigate to a new page in the portal.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod resendUsersRoles() [ Language = javascript ]
Request re-send of all user roles / resources and mark task as active
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 searchFocus(evt) [ Language = javascript ]
Blur event in search box.
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 setCookieValue(cookieName, cookieValue) as %String [ Language = javascript ]
Generic method to set a cookie name and value pair.
The expiration date is set to 1 year from now
clientmethod setSortMode(mode) [ Language = javascript ]
Change the current sort mode for the page.
clientmethod setSortModeHandler(mode) [ Language = javascript ]
Do the actual work of updating the view to match the current sort mode.
clientmethod setViewMode(mode) [ Language = javascript ]
Change the current display mode for this page. This is called by the icon buttons on the ribbon. This will call the setViewModeHandler() within a subclass.
clientmethod setViewModeHandler(mode, oldmode) [ Language = javascript ]
Do the actual work of updating the view to match the current view mode.
clientmethod showAbout() [ Language = javascript ]
Go to the home page.
clientmethod showSearchDropdown() [ Language = javascript ]
Display the search results drop down.
clientmethod showSearchResults(flag) [ Language = javascript ]
Hide/show search results.
clientmethod startProductions() [ Language = javascript ]
Start all Productions.
clientmethod startSearchTimer() [ Language = javascript ]
Start the search timer.
clientmethod stopProductions() [ Language = javascript ]
Stop all Productions.
clientmethod updateFinder() [ Language = javascript ]
Update the finder contents and display it.
clientmethod updateProductions(action) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab