Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsPortal] >  [SuspendedMsg]
Private  Storage   

class EnsPortal.SuspendedMsg extends EnsPortal.Template.listPage

This is the Suspended Messages page of the ZEN application.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 4 13 2


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 canDiscard canEdit
canEditResend canResend canViewFileSystem canViewTrace
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 msgSelectItemToExport name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent searchKey showLabel
showRefresh 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 DeleteMessage DiscardMessage DoLogout
DrawLocator DrawRibbon DrawTitle Encrypt
EnumerateClose EnumerateExecute EnumerateFetch EscapeHTML
EscapeURL EvalResult Export FileExists
GetCSPURL GetContextLinks GetDefaultDir GetDefaultFile
GetDocPage GetHomePage GetHyperEventResources GetNewURL
GetQuickLinks HyperEventCall HyperEventHead Import
Include InsertHiddenField InsertHiddenFields IsPrivate
Link OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent ResubmitMessage RewriteURL SetDefaultDir
ShowError SimpleKeepAlive StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addPopupSuffix arrowClick
cancelPopup changePassword changeRefresh changeURLNamespace
checkEdit childrenMutated clientKeepAlive correctIELayering
createComponent createComponentNS deleteComponent disableCommandButton
doDelete doDiscard doEdit doExport
doImport doRefresh doResubmit 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 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 refreshContents refreshTimeout removeChild
removePopupSuffix render renderContents renderSVG
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showContact showDocumentation showHelp showItem
showTrace startKeepAlive startModal startProgressBar
stopKeepAlive stopProgressBar switchNamespace


Parameters

• parameter PAGENAME = "Suspended Messages";
Displayed name of this page.
• parameter RESOURCE = "%Ens_MessageHeader:USE";
User needs USE permissions on the %Ens_MessageHeader resource to view this page.

Properties

• property canDiscard as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageDiscard","USE") ];
Flag to indicate whether a user may discard or delete messages.
• property canEditResend as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageEditResend","USE") ];
Flag to indicate whether a user may edit and resend messages.
• property canResend as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageResend","USE") ];
Flag to indicate whether a user may resend messages.
• property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
Flag to indicate whether a user may access the Visual Trace pages.

Methods

• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method DeleteMessage(pHeaderId As %String) as %String [ ZenMethod ]
Adapted from the old CSP page
• method DiscardMessage(pHeaderId As %String) as %String [ ZenMethod ]
Adapted from the old CSP page
• 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.
• 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 ResubmitMessage(pHeaderId As %String) as %String [ ZenMethod ]
Adapted from the old CSP page
• method doDelete() [ Language = javascript ]
User selected a new row in the table
• method doDiscard() [ Language = javascript ]
User selected a new row in the table
• method doEdit() [ Language = javascript ]
User selected a new row in the table
• method doResubmit() [ Language = javascript ]
User selected a new row in the table
• method onlayoutHandler(load) [ Language = javascript ]
The layout for this page is different from that for other list pages because of the iframe
• method showItem(msgId) [ Language = javascript ]
show detailTable for a selected task
• method showTrace(session) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page in a popup, so user can click the arrows to go from session to session without losing his/her place in the Event Log.

Queries

• query Enumerate(Filter As %String = "", QueryMethod As %String, QueryClass As %String)
Selects ID, TimeCreated, SessionId, Error, Source
Class query with filter added. Override this in order to add rowspec specific to the list being displayed
• query InitQuery()
SQL Query :
SELECT TOP 2000 ID,TimeCreated,SessionId,
CASE IsError WHEN 1 THEN 'Yes'
ELSE 'No' END As Error,SourceConfigName As Source
FROM Ens.MessageHeader
WHERE Status = 'Suspended'


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