Home > Class Reference > ENSLIB namespace > EnsPortal.MessageViewer
Private  Storage   

EnsPortal.MessageViewer


class EnsPortal.MessageViewer extends EnsPortal.Template.filteredViewer

Message viewer page for Ensemble portal.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 5 13


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
assistantClass aux backgroundTimerInterval canEdit
canResend canViewContents canViewTrace cellAlign
cellSize cellStyle cellVAlign children
composite containerStyle criteriaDialog cssLevel
currSortMode currStep currViewMode currentPage
currentPageStart currentSearch detailsHidden detailsWidth
disabled dragAndDrop dragEnabled dropEnabled
enclosingClass enclosingStyle error filterClass
groupClass groupStyle headerClass height
hidden hideDetailsMsg hideSearchMsg hint
hintClass hintStyle home homePage
id ignoreSearchWarnings index isFirstPage
isLastPage keepAliveInterval label labelClass
labelDisabledClass labelPosition labelStyle layout
lblDetails lblTitle limitPopups matchSourceOrTarget
msgCloseDetail msgNotPermitted msgViewTrace msgViewTraceHover
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate pageId pageModified
pageNumberId pageSizeId parent queryAtEnd
resendPage resultsTableId savedSearchClass searchCriteria
searchJob searchKey searchQuery searchWarnings
selectedId sessionLinkTitle showDetailsMsg showLabel
showSearchMsg slice tablePaneUsesSQLAttrib tempPortalNode
tipAddCriterion tipAddCriterionTitle tipAddOR tipAddORTitle
tipDelete tipSave tipSaveAs 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
%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 %OnGetDetailsLinkMenu %OnGetPageName %OnGetProductName
%OnGetSmallMenu %OnGetTableLinkMenu %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
Condition ConvertParameter CreateResultSet Decrypt
DoLogout DoSearchDelete DoSearchSave DrawBodyInfo
DrawDetailsContent DrawFullContentLinks DrawLocator DrawRibbon
DrawSessionCell DrawStatusCell DrawTitle Encrypt
EscapeHTML EscapeURL EvalResult Filter
GetAssistantClass GetCSPURL GetColumnsAndFrom GetContentMessages
GetContextLinks GetDocPage GetHomePage GetHyperEventResources
GetNewURL GetQueryHistory GetQuickLinks GetRemoteSearchJob
GetSavedSearch HyperEventCall HyperEventHead Include
InitSearchCriteria InsertHiddenField InsertHiddenFields IsPrivate
Link LoadFilter OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
PrepareCancel QuoteJS RegisterRecent RemoveTempData
ResetQuery RewriteURL SaveResendIDs SetSavedSearch
SetSearchCriteria ShowError SignalCancel SimpleKeepAlive
StartTimer StopTimer SubmitFilter Term
ThrowError UnescapeHTML UnescapeURL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addCriterion addOR
addPopupSuffix adjustExpanderText arrowClick cancelPopup
cancelSearch changePassword changeURLNamespace checkEdit
checkSearchWarnings childrenMutated clientKeepAlive clone
correctIELayering createArray createComponent createComponentNS
createCondition deleteComponent deleteSearch disableCommandButton
doResend doSearch dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler drawDetails drawExtendedCriteria
dropHandler dropStartHandler editCriterion enableCommandButton
endModal executeSearch exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getContentAreaHeight
getEnclosingDiv getFilter getHidden getHintElement
getLabelElement getNextData getOpener getProperty
getResendURL getResultsTable getSearchForm getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton inResizeLoop
indicateIfCancelled initPopupSuffix invokeSuper isOfType
launchPopupWindow layoutTabGroup loadSearch logout
makeId navigate onAfterPageChange onAfterSearch
onChangeResultsPage onCreate onDelete onDisplayHandler
onEndModalHandler onEnsException onPopupAction onRefreshContents
onSearchHandler onSelectItem onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler onTabChange
onToggleDetails onToggleSearch onTraceSVGLoad ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents removeChild
removeCriterion removePopupSuffix render renderContents
renderSVG saveSearch scaleSVGTrace searchBlur
searchBoxHandler searchFocus searchIfValidPageSize searchKeyDown
searchKeyPress selectItem sequenceSearch setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setProperty setPropertyAll setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler shiftTerm
showAbout showCommandButton showDocumentation showFullContent
showHelp showQuery showTrace startKeepAlive
startModal startProgressBar stopKeepAlive stopProgressBar
submitFilterUpdate switchNamespace toggleCancelState toggleCriterion
toggleDetails toggleSaveAs toggleSearch toggleSearchState
updateFilterFromForm updateFormFromFilter updateNavigationButtons updatePageData
updatePageNumber updatePageSize updateSearchState


Parameters


• parameter CANCANCELSEARCH = 1;
Indicate if can cancel search. This defines whether tempPortalNode is set.
• parameter PAGENAME = "Message Viewer";
Name of this page.
• parameter RESOURCE = "%Ens_MessageHeader:USE";
User needs USE permissions on the %Ens_MessageHeader resource to view this page.
• parameter SETUPTEMPPORTALNODE = 1;
Indicate if ought to create tempPortalNode when page created. Used by Cancel feature for example.
• parameter VALUECOLUMN = "ID";
Name of column in query that supplies ID values.

Properties


• property canResend as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageResend","USE") ];
Flag to indicate whether a user may resend messages.
• property canViewContents as %ZEN.Datatype.boolean;
Flag to indicate whether the user is permitted to view body contents.
• property canViewTrace as %ZEN.Datatype.boolean;
Flag to indicate whether the user is permitted to view the message trace tab.
• property matchSourceOrTarget as %ZEN.Datatype.string(ZENURL="SOURCEORTARGET");
• property msgViewTraceHover as %ZEN.Datatype.caption [ InitialExpression = $$$Text("View Full Trace including Events, ACKs, IO entries and message contents") ];

Methods


• method %OnAfterCreatePage() as %Status
Show/hide the toggle buttons
• method %OnGetDetailsLinkMenu(Output pMenu2)
Get the contents of the Details' link menu.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTableLinkMenu(Output pMenu)
Get the contents of the link menu in the table.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• method DrawStatusCell(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
Server-side method to write out localized content for the Status column
• classmethod GetContentMessages(messages As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Get localized messages for the message contents pane.
• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String) as %Status
Get information to display in the ribbon bar.
• method SetSearchCriteria() as %String [ ZenMethod ]
• method onChangeResultsPage(next, pageSize, currentPage) [ Language = javascript ]
Callback to set up the resultset/query for paging
• method onlayoutHandler(load) [ Language = javascript ]
Ensure we don't call onlayoutHandler() reentrantly under older versions of IE8
• method sequenceSearch(searchType) [ Language = javascript ]
Helper method to trigger Sequence Manager searches.
• method showTrace(sessionId, evt) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page.