Home > Class Reference > ENSLIB namespace > %ZEN.Portal.Application
Private  Storage   

%ZEN.Portal.Application


class %ZEN.Portal.Application extends
%ZEN.application

Base Zen application class for portal pages implemented using Zen.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 12


Summary


This is a Zen Application class.

Pages within this Application
%CSP.Portal.Home %CSP.UI.Portal.Contact %CSP.UI.Portal.SQL.QButtons.OpenDetails
%CSP.UI.Portal.SQL.QButtons.RuntimeStatsDetails %DeepSee.PMML.UI.ModelTester %DeepSee.Report.UI.BuildLIDR
%DeepSee.Report.UI.CreateDCR %DeepSee.Report.UI.ExecuteReport %DeepSee.Report.UI.ExtractDSS
%DeepSee.Report.UI.QueryBasedDSS %DeepSee.UI.Analyzer %DeepSee.UI.Architect
%DeepSee.UI.ArchitectSA %DeepSee.UI.CaptionEditor %DeepSee.UI.CubeRegistry
%DeepSee.UI.ErrorPage %DeepSee.UI.FolderManager %DeepSee.UI.ListingGroupManager
%DeepSee.UI.LogViewer %DeepSee.UI.MDXQuery %DeepSee.UI.ModelBrowser
%DeepSee.UI.QualityMeasures %DeepSee.UI.Settings %DeepSee.UI.TermListManager
%DeepSee.UI.WorksheetBuilder %DeepSee.UserPortal.Analyzer %UnitTest.Portal.Home
%UnitTest.Portal.Indices %UnitTest.Portal.TestCase %UnitTest.Portal.TestMethod
%UnitTest.Portal.TestSuite %UnitTest.Portal.standardPage %WebStress.Portal.RecordStatus
%ZEN.Mobile.mobilePage %iKnow.Classification.UI.ClassifierBuilder %iKnow.Classification.UI.ClassifierTester
%iKnow.UI.Architect

Properties
%StatusCode

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawLocatorMenu
%DrawSmallMenu %DrawStyleHTML %DrawTitleHTML %DrawTitleServerHTML
%Extends %GetApplicationName %GetParameter %GetUserPackages
%IsA %IsModified %LinkCSS %LinkScript
%New %NormalizeObject %ObjectModified %OnGetJSResources
%OnGetProductName %OriginalNamespace %PackageName %RemoveFromSaveSet
%SerializeObject %SetModified %ValidateObject CanShowSwitch
ConvertParameter Decrypt DrawServerFlag DrawUsername
Encrypt EscapeHTML EscapeURL GetContextLinks
GetQuickLinks HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate Link
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RewriteURL ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL

Subclasses
%CSP.Portal.Application %DeepSee.UI.Application %WebStress.Portal.Application

Parameters


• parameter APPLICATIONNAME = "InterSystems Portal";
This is the name of this application.
• parameter CSS3INCLUDES = "https://fonts.googleapis.com/css?family=Montserrat,https://fonts.googleapis.com/css?family=Source+Sans+Pro";
Comma-separated list of additional CSS3 include files that should be included for every page within the application.
This is used when the page uses CSS3. The CSS files will be included after any component style sheets and before styles defined by this application class or the page class.
• parameter CSSINCLUDES = "https://fonts.googleapis.com/css?family=Montserrat,https://fonts.googleapis.com/css?family=Source+Sans+Pro";
Comma-separated list of additional CSS include files that should be included for every page within the application.
The CSS files will be included after any component style sheets and before styles defined by this application class or the page class.
• parameter DOMAIN = "%Utility";
The default domain for csp:text, span and div tags. This parameter is used to specify the subset of localized messages to be used on this page.
• parameter HOMEPAGE = "/csp/sys/%25CSP.Portal.Home.zen";
This is the URL of the main starting page of this application.

Methods


• classmethod %DrawLocatorMenu(ByRef pLocatorMenu As %String)
Draw bread-crumb links
• classmethod %DrawSmallMenu(ByRef pMenu As %String, ByRef pLocatorMenu As %String)
Draw small menu at the top of the title area.
• classmethod %DrawTitleHTML(pProduct As %String, pTitle As %String, ByRef pSmallMenu, ByRef pLocatorMenu, ByRef pContextMenu) as %Status
Draw the HTML contents of the title area for portal pages. pProduct may contain specific product logo if passed in as the second piece. pContextMenu is passed in for CSP pages only!
• classmethod %DrawTitleServerHTML(pProduct As %String, pTitle As %String, ByRef pSmallMenu, ByRef pLocatorMenu) as %Status
This method draws the server/namespace/user/license/instance information inside the title pane. pProduct may contain specific server name if passed in as the third piece (for HS debug purposes).
• classmethod %OnGetProductName() as %String
Get the product name for the page. May be called from none-Zen classes in SMP.
• classmethod CanShowSwitch(PageName) as %Boolean
Determine if the "Switch" link for namespace can be shown. Return 1 if yes, and 0 if not.
• classmethod DrawServerFlag()
• classmethod DrawUsername()
Draw username with (or without) link to change password. The link is built only for the Home page.
• classmethod GetContextLinks(Output pLinks) as %Status
Define any context links for the context menu in the header piece 1: caption (if left null, a menu seperator will be built) piece 2: URL (this is required entry) piece 3: JS function name (if defined is a javascript to call such as "zenPage.save()") Note that all security processing is performed in the page's CheckContextLinks() method.
• classmethod GetQuickLinks(Output pLinks) as %Status
Provide any quick links for pages.