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

class EnsPortal.ManagedAlertViewer extends EnsPortal.Template.viewerPage

Viewer page to look at Managed Alerts present on the system.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 5 33


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 contactPage containerStyle cssLevel
currSortMode currStep currViewMode currentPage
currentPageStart designMode detailsHidden detailsWidth
disabled dragAndDrop dragEnabled dropEnabled
dynamic enableAutoRefresh enclosingClass enclosingStyle
error groupClass groupStyle height
hidden hideDetailsMsg hideSearchMsg hint
hintClass hintStyle home homePage
id index inlineSVG isFirstPage
isLastPage isPopup isSoftModal keepAliveInterval
label labelClass labelDisabledClass labelPosition
labelStyle lastModalIndex layout lblDetails
lblTitle limitPopups msgCloseDetail msgNotPermitted
name nextIndex onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onoverlay onrefresh onshow onupdate
overlayMode pageId pageModified pageNumberId
pageSizeId parent popupParent queryAtEnd
renderFlag resultsTableId searchCriteria searchJob
searchKey searchQuery selectedId showDetailsMsg
showLabel showSearchMsg slice source
tablePaneUsesSQLAttrib tempPortalNode 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
%GetRootLink %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 %OnGetTableLinkMenu %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 DrawCurrentOwner
DrawDetailHTML DrawDetailsContent DrawLocator DrawOpenCell
DrawRibbon DrawTextCell DrawTimeCell DrawTitle
DrawUpdateHTML Encrypt EncryptBroker EscapeHTML
EscapeURL EvalResult GetAlertFields GetAndUseDefaults
GetCSPURL GetColumnsAndFrom GetContextLinks GetDisplayValue
GetDocURL GetHomePage GetHyperEventResources GetNewURL
GetQuickLinks GetRemoteSearchJob GetUpdateData GetWhereClause
GiveAdviceString HyperEventBody HyperEventCall HyperEventFrame
HyperEventHead Include InsertHiddenField InsertHiddenFields
InvokeClassMethod InvokeInstanceMethod IsPrivate Link
LoadZenComponent MonitorBackgroundTask OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
PrepareCancel QuoteJS ReallyRefreshContents RegisterRecent
RemoveTempData ResetQuery RewriteURL SaveSearchCriteria
ShowError SignalCancel 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 adjustExpanderText
arrowClick backgroundTimerHandler cancelPopup cancelSearch
changePassword changeRefresh changeURLNamespace checkEdit
childrenMutated clearBackgroundTask clientKeepAlive correctIELayering
createComponent createComponentNS deleteComponent disableCommandButton
doSearch dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal enterKey executeSearch exposeComponent
findElement fireOnLoadEvent fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction formReset getChildIndex
getComponent getComponentById getContentAreaHeight getDetailHTML
getEnclosingDiv getHidden getHintElement getLabelElement
getNextData getOpener getPageTitle getProperty
getResultsTable getSearchForm getSettings getTargetPage
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton inResizeLoop
indicateIfCancelled initPopupSuffix invokeSuper isOfType
launchPopupWindow logout makeId navigate
onAfterPageChange onAfterSearch onChangeResultsPage onCreate
onDelete onDisplayHandler onEndModalHandler onEnsException
onPopupAction onRefreshContents onSearchHandler onSelectItem
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler onToggleDetails onToggleSearch ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler progressBarHandler refreshContents
removeChild removePopupSuffix render renderContents
renderSVG searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress selectItem setBackgroundTask
setComponentId setConnectivityStatusMsg setHidden setModified
setOverlayMode setPageTitle setProperty setPropertyAll
setSortMode setSortModeHandler setTraceOption setViewMode
setViewModeHandler showAbout showCommandButton showContact
showDocumentation showHelp showQuery startKeepAlive
startModal startProgressBar stopKeepAlive stopProgressBar
switchNamespace testConnectivity timeout toggleAllCollections
toggleCancelState toggleCollectionDisplay toggleDetails toggleSearch
toggleSearchState updateControlsInGroup updateNavigationButtons updatePageData
updatePageNumber updatePageSize


Parameters

• parameter JSINCLUDES = "ensemble/Ensemble_Utils.js";
Comma-separated list of additional JS include files for the page.
• parameter PAGENAME = "Managed Alert Viewer";
Displayed name of this page.
• parameter RESOURCE = "%Ens_Alerts:READ";
User needs READ permissions on the %Ens_Alerts resource to view this page.

Properties

• property detailsWidth as %ZEN.Datatype.integer(MAXVAL=80,MINVAL=5) [ InitialExpression = 30 ];
Value to indicate the percentage of the horizontal screen which should be devoted to the details panel (if it is visible). This is exposed as a client-side property for the layout code to use the value.
• property pageNumberId as %ZEN.Datatype.id [ InitialExpression = "pageTotal" ];
Id of the page number field
• property pageSizeId as %ZEN.Datatype.id [ InitialExpression = "PageSize" ];
Id of the page size field
• property resultsTableId as %ZEN.Datatype.id [ InitialExpression = "table" ];
Id of the results tablePane
• property source as %ZEN.Datatype.string(ZENURL="SOURCE");

Methods

• method %OnAfterCreatePage() as %Status
Fill search criteria defaults
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• method DrawCurrentOwner(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
• classmethod DrawDetailHTML(pID As %String) as %Status
Render the HTML for the Details tab
• method DrawOpenCell(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
• method DrawTextCell(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
Server-side method to write out the event text both as content and in the hover-text title.
• method DrawTimeCell(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
• method DrawUpdateHTML(pID As %String) as %Status
• method GetAlertFields(ByRef pParms) as %Status
• method GetAndUseDefaults() as %String
Method called from %OnAfterCreatePage to get defaults and build up the initial display
• method GetColumnsAndFrom(timeFormat As %String) as %String
For tablePanes which require a constructed SQL query when paging, this callback supplies the columns and FROM portions of the query.
• classmethod GetDisplayValue(pValue As %String = "", pDataType As %String = "") as %String
• 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 GetUpdateData(ByRef pParms) as %Status
• method GetWhereClause() as %String [ ZenMethod ]
Called from onSearchHandler and %OnAfterCreatePage to build the where clause.
• method GiveAdviceString(pSeed As %String) as %Status
Server-side callback to provide localized string introducing the details table
• 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 ResetQuery(next As %Boolean, pageSize As %String, timeFormat As %String, whereOperator As %String, colValues As %String, orderCols As %String) as %String [ ZenMethod ]
Helper method to construct a query on the server when paging. This method should be invoked from onChangeResultsPage() for tablePanes which use the whereClause, orderbyClause and columns properties to construct queries. next is true for Next, false for Previous; pageSize is the page size; wherePlus gives the ID < or ID > string; idVal gives the id value to compare with ID, outer is either ASC or DESC depending on the current display order.
• method SaveSearchCriteria() as %String [ ZenMethod ]
• method changeRefresh() [ Language = javascript ]
User chose a new Auto-Refresh value; set a new timeout value and start the timer
• method enterKey() [ Language = javascript ]
Use with certain fields so user can hit Enter to indicate that an entry in the field is done and ready to use
• method formReset() [ Language = javascript ]
Reset the "Search Events By..." form fields to blank, reset other fields to defaults
• method getDetailHTML(detailHTML) [ Language = javascript ]
• method onAfterPageChange() [ Language = javascript ]
Callback invoked after the next/previous page has been loaded.
• method onChangeResultsPage(next, pageSize, currentPage) [ Language = javascript ]
Callback to set up the resultset/query for paging.
• method onSearchHandler() [ Language = javascript ]
User clicked the Search button, user changed a Quick Search or Event Type criterion, or we have completed a non-zero Purge.
• method onSelectItem() [ Language = javascript ]
toggle detailTable for a selected row.
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page. Do this differently for Event Log than for other children of EnsPortal.Template.viewerPage (hence the override). In this case the details pane does NOT get large when the search pane is minimized.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method timeout(timer) [ Language = javascript ]
If auto-refresh is still on, refresh table and restart the timer
• method toggleAllCollections(tableId, rowBase, maxRow, show) [ Language = javascript ]
• method toggleCollectionDisplay(tableId, rowId, forceVal) [ Language = javascript ]


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