Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsPortal] >  [Template] >  [standardPage]
Private  Storage   

abstract class EnsPortal.Template.standardPage extends %CSP.Portal.Template, EnsPortal.Template.base

Base class for generic InterSystems IRIS Interoperability pages.
This is used for pages that do fit into one of the other base class categories.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 3 26


Summary

This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL StdTitle aboutPage align
aux backgroundTimerInterval canEdit cellAlign
cellSize cellStyle cellVAlign children
composite contactPage containerStyle cssLevel
currSortMode currStep currViewMode disabled
dragAndDrop dragEnabled dropEnabled enableAutoRefresh
enclosingClass enclosingStyle error groupClass
groupStyle height hidden hint
hintClass hintStyle home homePage
id index keepAliveInterval label
labelClass labelDisabledClass labelPosition labelStyle
layout lblTitle limitPopups msgNotPermitted
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate pageModified parent
searchKey showLabel slice title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup

Methods
%AddCSPShareHyperevents %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddEnsExceptionHandler %AddImportedComponents %AddLocatorLinks
%AddToSaveSet %ApplyURLParms %Attr %BindExport
%ClassIsLatestVersion %ClassName %ConstructClone %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions
%DrawComponentHTML %DrawHTML %DrawHTMLPage %DrawJSStrings
%DrawObjectDefinitions %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GetChildIndex %GetComponent %GetComponentById %GetComponentByName
%GetEventHandlers %GetHomePage %GetHomeParam %GetLinks
%GetLocatorLinks %GetPageName %GetParameter %GetProductName
%GetRootLink %GetValueById %GetValueByName %GetXMLName
%IsA %IsModified %Link %LinkCSS
%LinkScript %MakeId %New %NormalizeObject
%ObjectModified %OnAddToPageAfter %OnAddToPageBefore %OnAfterCreatePage
%OnBeforeCreatePage %OnCreateApplication %OnCreatePage %OnDetermineCSSLevel
%OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead %OnDrawHTMLMeta
%OnDrawObjectProperties %OnFinishBackgroundTask %OnGetPageName %OnGetProductName
%OnGetSmallMenu %OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren
%OnObjectSynch %OnPreHTTP %OnSubmit %OnUseSoftModals
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %Register %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod %Self
%SerializeObject %SetBackgroundMethodStatus %SetErrorById %SetErrorByName
%SetModified %SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %ZENVersion BuildMenu
CheckAllBlanks CheckContextLinks CheckEnterpriseManager ConvertParameter
Decrypt DoLogout DrawLocator DrawRibbon
DrawTitle Encrypt EscapeHTML EscapeURL
EvalResult GetCSPURL GetContextLinks GetDocURL
GetHomePage GetHyperEventResources GetNewURL GetQuickLinks
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate JavaInstalled Link
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RegisterRecent
RewriteURL ShowError SimpleKeepAlive StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addPopupSuffix
arrowClick cancelPopup changePassword changeURLNamespace
checkEdit childrenMutated clientKeepAlive correctIELayering
createComponent createComponentNS createTimeWarning deleteComponent
disableCommandButton displayCountDown dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableCommandButton endModal exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getPageTitle getProperty getSettings getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage hideCommandButton hideTimeoutWarning hideWarnContinue
inResizeLoop initPopupSuffix invokeSuper isOfType
launchPopupWindow logout makeId manualKeepAlive
navigate onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler popupActionHandler
refreshContents removeChild removePopupSuffix render
renderContents renderSVG searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
setWarnInnerHTML showAbout showCommandButton showContact
showDocumentation showHelp showTimeoutWarning startKeepAlive
startModal startProgressBar stopKeepAlive stopProgressBar
switchNamespace warnclickListener

Subclasses
Ens.Enterprise.Portal.MonitorRoleList Ens.Enterprise.Portal.MsgBankPurgeAll Ens.Enterprise.Portal.SystemList
EnsPortal.ActivityVolumeAndDuration EnsPortal.ArchiveManager EnsPortal.AutoStartProduction
EnsPortal.BusinessPartners EnsPortal.CSVRecordWizard EnsPortal.CompileClass
EnsPortal.Configuration.Settings EnsPortal.Credentials EnsPortal.DefaultSetting
EnsPortal.Deployment.DeployProductionChanges EnsPortal.Dialog.ImportResults EnsPortal.Dialog.SAPJCO.BaseConfiguration
EnsPortal.Dialog.SourceControlManager EnsPortal.EDI.Template EnsPortal.EDIDocumentView
EnsPortal.FindMsgBank EnsPortal.ManagedAlerts EnsPortal.MessageResend
EnsPortal.MessageResendEdit EnsPortal.ProductionDelete EnsPortal.ProductionDocument
EnsPortal.ProductionShutdownGroup EnsPortal.PubSub.PageContainer EnsPortal.PurgeAll
EnsPortal.PurgeSettings EnsPortal.Queues EnsPortal.ScheduleEditor
EnsPortal.Setting.Report.Configuration EnsPortal.StartStopFrame EnsPortal.Template.devPage
EnsPortal.Template.listPage EnsPortal.Template.viewerPage EnsPortal.TestingService
EnsPortal.WFRoles EnsPortal.WFUsers

Parameters

• parameter APPLICATION = "EnsPortal.Application";
Set this to the appropriate application class.
• parameter AUTONS = 0;
Do not switch namespace for the page based on $NAMESPACE; will stay in the original namespace.
• parameter CHECKMODIFIEDBEFORELOGOUT = 1;
If true and AUTOLOGOUT is true then call onhandleAutoLogout 30 seconds prior to AUTOLOGOUT. This allows the page to handle client page modifications while the session is still valid before the page is reloaded.
• parameter DOMAIN = "Ensemble";
Domain used for localization.
• parameter EDITRESOURCE;
Resource for subclasses to indicate whether further resources are needed to perform actions on pages.
• parameter FAVORITEICON = "$$$ISCFAVORITEICON";
favorite icon.
• parameter JSINCLUDES = "zenMenusSMPEns.js";
Comma-separated list of additional JS include files for the page.

Properties

• property HelpAddress as %ZEN.Datatype.string [ InitialExpression = $select(..#PAGENAME '= "": "Ensemble, "_..#PAGENAME, 1: "") ];
The help address that links to the "Help" (next to the "Logout" link) documentation
• property canEdit as %ZEN.Datatype.boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(..#EDITRESOURCE) ];
Flag to indicate whether the user is permitted to make any changes on a given page.
• property msgNotPermitted as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("You are not permitted to perform this action") ];
Message to inform the user they may not perform a given action.

Methods

• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
• method %GetRootLink(Output pLink) as %Status
• method %OnDrawHTMLHead() as %Status
Add the EnsException error handling on the client.
• method %OnGetSmallMenu(Output pMenu)
Get the contents of the small menu in the title area.
• classmethod %OnPreHTTP() as %Boolean
Ensure that the user has the required privileges for the Portal application.
• classmethod GetContextLinks(Output pLinks) as %Status
Define any context links for the page. Sub-class to override.
• classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
• classmethod GetNewURL(pNS As %String, pPage As %String = "%25CSP.Portal.Home.zen") as %String [ ZenMethod ]
Overrides super class method to be able to set custom web application if applicable when switching namespace.
• classmethod OnPage() as %Status
Render the contents trapping for permission issue
• classmethod OnPreHyperEvent(class As %String, method As %String) as %Status
Invoke the base OnPreHyperEvent() method, and then check whether the user is permitted to invoke the specified method by checking the resource returned by the GetHyperEventResources callback.
• method arrowClick(from, to) [ Language = javascript ]
*******************************************************************/// Used to move an item from one listbox to the other. The listboxes are side-by-side. The action moves a list item from one box to the next, then remove it from the original box. This method was originally in CSPX.Portal.Template which is no longer used. *******************************************************************///
• method changeURLNamespace(nsVal) [ Language = javascript ]
The input value is the name of the new namespace to switch to. This method only works for EnsPortal classes whose URL is simple (no URL parameters). This method will need to be overridden for classes such as EnsPortal.EDIDocumentView which cannot work without a URL parameter provided.
• method checkEdit() [ Language = javascript ]
• method createTimeWarning() [ Language = javascript ]
• method displayCountDown() [ Language = javascript ]
• method hideTimeoutWarning() [ Language = javascript ]
• method hideWarnContinue(hide) [ Language = javascript ]
• method manualKeepAlive() [ Language = javascript ]
• method onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from dialogs
• method onServerMethodError(err, errObject) [ Language = javascript ]
Override onServerMethodError to funnel HyperEvent errors through the central Ensemble exception handling code. If session pollution occurs while in Studio mode, alert the user to the problem instead of reloading. The method sets zenPage._staleStudioSession to true to ensure that an alert is displayed only once and subsequent hyperevent failures will not trigger a reload of the page.
• method onhandleAutoLogoutWarn() [ Language = javascript ]
Prior to auto logout allow time to see if user needs to continue Session.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method setModified(flag) [ Language = javascript ]
Set the modified flag for the page.
• method setWarnInnerHTML(warningDiv) [ Language = javascript ]
• method showTimeoutWarning() [ Language = javascript ]
• method warnclickListener(event) [ Language = javascript ]


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.