Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsPortal.Template.standardPage
Private  Storage   

EnsPortal.Template.standardPage


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

Base class for generic Ensemble 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
6 3 14


Summary


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

Properties
%ComponentClasses %ComponentNames %Components %CompositeList
%DeletedIds %NotifyList %RenderList %UserPackageList
%condition %import %includeFiles %page
%partial %resource %xmlOutputMode HelpAddress
ISREADONLY LocatorHeader ParentURL SVGClassList
StdTitle UserSVGPackageList aboutPage align
aux backgroundTimerInterval canEdit cellAlign
cellSize cellStyle cellVAlign children
composite containerStyle cssLevel currSortMode
currStep currViewMode designMode disabled
dragAndDrop dragEnabled dropEnabled dynamic
enclosingClass enclosingStyle error groupClass
groupStyle height hidden hint
hintClass hintStyle home homePage
id index inlineSVG isPopup
isSoftModal keepAliveInterval label labelClass
labelDisabledClass labelPosition labelStyle lastModalIndex
layout lblTitle limitPopups msgNotPermitted
name nextIndex onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onoverlay onrefresh onshow onupdate
overlayMode pageModified parent popupParent
renderFlag searchKey showLabel slice
title tuple useSVG useSoftModals
valign visible width window
zenPersistentPopup

Methods
%%OIDGet %AddCSPShareHyperevents %AddChild %AddChildAfter
%AddChildBefore %AddComponent %AddEnsExceptionHandler %AddImportedComponents
%AddLocatorLinks %AddToSaveSet %ApplyURLParms %Attr
%BindExport %BuildObjectGraph %ClassIsLatestVersion %ClassName
%Close %ConstructClone %CreateApplication %CreatePage
%DetermineCSSLevel %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawAutoLogout %DrawClassDefinition %DrawClassDefinitions %DrawComponentHTML
%DrawHTML %DrawHTMLPage %DrawJSGetSettings %DrawJSSerialize
%DrawJSStrings %DrawObjectDefinitions %DrawObjectProperties %DrawSVGDef
%DrawStyleDefinitions %DrawStyleHTML %DrawStyleSVG %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GenerateCode %GetAllNamespaces
%GetChildIndex %GetClassCRC %GetClassDepth %GetComponent
%GetComponentById %GetComponentByName %GetComponentPropertyById %GetDependentComponents
%GetEventHandlers %GetHomePage %GetHomeParam %GetIncludeFiles
%GetIncludeInfo %GetLinks %GetLocatorInfo %GetLocatorLinks
%GetPageName %GetPaneContents %GetParameter %GetProductName
%GetSuperClassList %GetValueById %GetValueByName %GetXMLName
%IncrementCount %IsA %IsEmbedded %IsModified
%Link %LinkCSS %LinkScript %MakeId
%New %NormalizeObject %ObjectModified %ObjectSynch
%OnAddToPage %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 %ReallyAddChild %Register %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetErrorById
%SetErrorByName %SetModified %SetValueById %SetValueByName
%SetValuesByName %StartScript %ValidateObject %XMLGenerate
%ZENDeserialize %ZENVersion BuildMenu CheckAllBlanks
CheckContextLinks CheckEnterpriseManager ConvertParameter Decrypt
DoLogout DrawLocator DrawRibbon DrawTitle
Encrypt EscapeHTML EscapeURL EvalResult
GetCSPURL GetContextLinks GetDocPage GetHomePage
GetHyperEventResources GetNewURL GetQuickLinks HyperEventBody
HyperEventCall HyperEventFrame HyperEventHead Include
InsertHiddenField InsertHiddenFields InvokeClassMethod InvokeInstanceMethod
IsPrivate Link LoadZenComponent MonitorBackgroundTask
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS ReallyRefreshContents
RegisterRecent RewriteURL ShowError SimpleKeepAlive
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL XMLAfterExport XMLBeforeExport XMLDTD
XMLExport XMLExportInternal XMLExportToStream XMLExportToString
XMLGetSchemaImports XMLImport XMLImportInternal XMLIsObjectEmpty
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addPopupSuffix
arrowClick backgroundTimerHandler cancelPopup changePassword
changeURLNamespace checkEdit childrenMutated clearBackgroundTask
clientKeepAlive correctIELayering createComponent createComponentNS
deleteComponent disableCommandButton dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableCommandButton endModal exposeComponent findElement
fireOnLoadEvent fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getProperty getSettings getTargetPage
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton inResizeLoop
initPopupSuffix invokeSuper isOfType launchPopupWindow
logout makeId navigate onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler progressBarHandler refreshContents removeChild
removePopupSuffix render renderContents renderSVG
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setBackgroundTask setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showDocumentation showHelp startKeepAlive startModal
startProgressBar stopKeepAlive stopProgressBar switchNamespace
testConnectivity updateControlsInGroup

Subclasses
Ens.Enterprise.Portal.MonitorRoleList Ens.Enterprise.Portal.MsgBankPurgeAll Ens.Enterprise.Portal.SystemList
EnsLib.ITK.DTS.UI.DTSTransferLog EnsLib.ITK.Setup.UI.EditFaultCodes EnsLib.ITK.Setup.UI.EditFaultMap
EnsLib.ITK.Setup.UI.EditServiceDefinitions EnsPortal.ActivityVolumeAndDuration EnsPortal.ArchiveManager
EnsPortal.AutoStartProduction EnsPortal.BusinessPartners EnsPortal.CSVRecordWizard
EnsPortal.Credentials EnsPortal.DICOM.ASList EnsPortal.DICOM.Dictionary
EnsPortal.DICOM.Setting 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.ProductionConfig EnsPortal.ProductionDelete EnsPortal.ProductionDocument
EnsPortal.PubSub.PageContainer EnsPortal.PurgeAll EnsPortal.Queues
EnsPortal.ScheduleEditor 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 AUTOLOGOUT = 0;
Don't use the Zen AutoLogout feature. Instead, we trigger a simple hyperevent reasonably often to ensure that users won't lose any work. We use the USEKEEPALIVE to control whether the KeepAlive is used.
• parameter AUTONS = 0;
Do not switch namespace for the page based on $NAMESPACE; will stay in the original namespace.
• 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 = "portal/ensemble.ico";
Ensemble favorite icon.

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 %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 Ensemble 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 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 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 onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.