EnsPortal.ManagedAlertViewer

class EnsPortal.ManagedAlertViewer extends EnsPortal.Template.viewerPage

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

Property Inventory

Method Inventory

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 ];
Inherited description: 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 methods: detailsWidthDisplayToLogical(), detailsWidthGet(), detailsWidthIsValid(), detailsWidthLogicalToDisplay(), detailsWidthLogicalToOdbc(), detailsWidthNormalize(), detailsWidthSet()
property pageNumberId as %ZEN.Datatype.id [ InitialExpression = "pageTotal" ];
Inherited description: Id of the page number field
Property methods: pageNumberIdDisplayToLogical(), pageNumberIdGet(), pageNumberIdIsValid(), pageNumberIdLogicalToDisplay(), pageNumberIdLogicalToOdbc(), pageNumberIdNormalize(), pageNumberIdSet()
property pageSizeId as %ZEN.Datatype.id [ InitialExpression = "PageSize" ];
Inherited description: Id of the page size field
Property methods: pageSizeIdDisplayToLogical(), pageSizeIdGet(), pageSizeIdIsValid(), pageSizeIdLogicalToDisplay(), pageSizeIdLogicalToOdbc(), pageSizeIdNormalize(), pageSizeIdSet()
property resultsTableId as %ZEN.Datatype.id [ InitialExpression = "table" ];
Inherited description: Id of the results tablePane
Property methods: resultsTableIdDisplayToLogical(), resultsTableIdGet(), resultsTableIdIsValid(), resultsTableIdLogicalToDisplay(), resultsTableIdLogicalToOdbc(), resultsTableIdNormalize(), resultsTableIdSet()
property source as %ZEN.Datatype.string (ZENURL = "SOURCE");
Property methods: sourceDisplayToLogical(), sourceGet(), sourceIsValid(), sourceLogicalToDisplay(), sourceLogicalToOdbc(), sourceNormalize(), sourceSet()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Fill search criteria defaults
method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page.
method DrawCurrentOwner(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status [ Language = objectscript ]
classmethod DrawDetailHTML(pID As %String) as %Status [ Language = objectscript ]
Render the HTML for the Details tab
method DrawOpenCell(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status [ Language = objectscript ]
method DrawTextCell(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
method DrawUpdateHTML(pID As %String) as %Status [ Language = objectscript ]
method GetAlertFields(ByRef pParms) as %Status [ Language = objectscript ]
method GetAndUseDefaults() as %String [ Language = objectscript ]
Method called from %OnAfterCreatePage() to get defaults and build up the initial display
method GetColumnsAndFrom(timeFormat As %String) as %String [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
classmethod GetHyperEventResources(pMethod As %String = "") as %String [ Language = objectscript ]
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 [ Language = objectscript ]
method GetWhereClause() as %String [ Language = objectscript, ZenMethod ]
Called from onSearchHandler() and %OnAfterCreatePage() to build the where clause.
method GiveAdviceString(pSeed As %String) as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript, 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 [ Language = objectscript, ZenMethod ]
clientmethod changeRefresh() [ Language = javascript ]
User chose a new Auto-Refresh value; set a new timeout value and start the timer
clientmethod 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
clientmethod formReset() [ Language = javascript ]
Reset the "Search Events By..." form fields to blank, reset other fields to defaults
clientmethod getDetailHTML(detailHTML) [ Language = javascript ]
clientmethod onAfterPageChange() [ Language = javascript ]
Inherited description: Callback invoked after the next/previous page has been loaded.
clientmethod onChangeResultsPage(next, pageSize, currentPage) [ Language = javascript ]
Callback to set up the resultset/query for paging.
clientmethod 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.
clientmethod onSelectItem() [ Language = javascript ]
toggle detailTable for a selected row.
clientmethod 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.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod timeout(timer) [ Language = javascript ]
If auto-refresh is still on, refresh table and restart the timer
clientmethod toggleAllCollections(tableId, rowBase, maxRow, show) [ Language = javascript ]
clientmethod toggleCollectionDisplay(tableId, rowId, forceVal) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

Feedback