This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsPortal.ManagedAlerts

EnsPortal.ManagedAlerts

class EnsPortal.ManagedAlerts extends EnsPortal.Template.standardPage

Page focused on allowing users to interact with Managed Alerts that pertain to them, broken down by when action should be taken.

Property Inventory

Method Inventory

Parameters

parameter EDITRESOURCE = %Ens_Alerts:WRITE;
User needs WRITE permissions on the %Ens_Alerts resource to make changes to Managed Alerts.
parameter PAGENAME = Managed Alerts;
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 canViewAllAlerts as %Boolean [ InitialExpression = $system.Security.Check("%Ens_AlertAdministration","USE") ];
Property methods: canViewAllAlertsDisplayToLogical(), canViewAllAlertsGet(), canViewAllAlertsIsValid(), canViewAllAlertsLogicalToDisplay(), canViewAllAlertsLogicalToXSD(), canViewAllAlertsNormalize(), canViewAllAlertsSet(), canViewAllAlertsXSDToLogical()
property msgAlertDetails as %String [ InitialExpression = $$$TextHTML("Alert Details") ];
Property methods: msgAlertDetailsDisplayToLogical(), msgAlertDetailsGet(), msgAlertDetailsIsValid(), msgAlertDetailsLogicalToDisplay(), msgAlertDetailsLogicalToOdbc(), msgAlertDetailsNormalize(), msgAlertDetailsSet()

Methods

method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
classmethod DoUpdateAlert(pFormData As %ZEN.proxyObject) as %String [ ZenMethod ]
Actually update the alert on the server.
classmethod DrawDetailHTML(pID As %String) as %Status
Get the HTML content for the right hand tab. Note that we check for WRITE permissions on the %Ens_Alerts resource in EnsPortal.ManagedAlertViewer.
classmethod GetAlertData(ByRef pParameters, Output pObject As %Library.RegisteredObject) as %Status
Fetch the Managed Alert data that is exposed via JSON.
classmethod GetHyperEventResources(pMethod As %String = "") as %String
Ensure that we check edits to Managed Alerts.
clientmethod addClassToElement(element, addClass) [ Language = javascript ]
Helper function to add a class to an element.
clientmethod adjustSizes() [ Language = javascript ]
Adjust the size of the page to fit the tables in correctly.
clientmethod alphaSort(objA, objB) [ Language = javascript ]
Helper function used as an alphabetical array sort function. Note that if the objects in the array include information about the NextActionTime, the sort will take that into account for equivalent strings, and will sort in ascending ID order if not.
clientmethod buildNextActionIndex() [ Language = javascript ]
Build an index based on NextAction so that we have our time-based buckets.
clientmethod buildSecondaryIndex(propName, base, bucket) [ Language = javascript ]
Helper method to build secondary indices for sorting on other fields defined in the runtime zenPage._secondary object. The sorting happends within the buckets that already exist for the main page, and occurs on demand as a user may not want to sort on any of these fields and there is no need to do the work unless it is explicitly requested.
clientmethod canSelectNewRow(newAlertId) [ Language = javascript ]
Helper method to make sure that the user doesn't unknowingly lose edits to an alert.
clientmethod createBucket() [ Language = javascript ]
Helper method to create a "bucket" for indexing purposes.
clientmethod deselectAlert() [ Language = javascript ]
clientmethod getBucketCaption(bucket) [ Language = javascript ]
Get the localised strings for the buckets we expose.
clientmethod getTableHTML(rootName, bucketName, bucketValue) [ Language = javascript ]
Get the HTML for the table.
clientmethod initTableData(force) [ Language = javascript ]
Initialize the metadata for rendering the table.
clientmethod isOverdue(timestamp, yesterday, now) [ Language = javascript ]
Helper function to determine whether timestamp lies in the past.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.
clientmethod refreshScreen() [ Language = javascript ]
Reload the JSON data from the server and redraw the page.
clientmethod removeClassFromElement(element, remClass) [ Language = javascript ]
Helper function to remove a class from an element.
clientmethod renderData(adjust) [ Language = javascript ]
Re-render the table and inner menus for the page.
clientmethod renderMain() [ Language = javascript ]
Render the menu and table for the page.
clientmethod rowClick(row, tableName, alertId) [ Language = javascript ]
Handle a row being clicked on by the user.
clientmethod selectAlert(tableName, alertId) [ Language = javascript ]
Control the update of the detail pane on the right hand side.
clientmethod selectBucket(menuName, bucketName, bucketValue) [ Language = javascript ]
Handle user selection of a bucket.
clientmethod selectMenu(menuName) [ Language = javascript ]
Handle user click on a menu.
clientmethod showTrace(sessionId, evt) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page.
clientmethod startAutoRefresh(interval) [ Language = javascript ]
Set up timer to refresh the contents of the page. Currently hard-coded to 20 seconds.
clientmethod stopAutoRefresh() [ Language = javascript ]
Stop the timer that triggers automatic refreshes of the data on the page.
clientmethod timeSort(objA, objB) [ Language = javascript ]
Helper function used as an array sort function for timestamps. Note that if the timestamps match, the values will be sorted in ascending ID order.
clientmethod timestampLTEDate(timestamp, date) [ Language = javascript ]
Helper function to determine whether timestamp occurred on or before date.
clientmethod toggleAllCollections(tableId, rowBase, maxRow, show) [ Language = javascript ]
Callback to expand and contract all the previous actions in the alert detail pane.
clientmethod toggleCollectionDisplay(parentId, rowId, forceVal) [ Language = javascript ]
Function to expand and contract the display of a specific action in the alert detail pane.
clientmethod toggleSort(propName) [ Language = javascript ]
Helper method to modify the sort options for the table.
clientmethod updateAlert(alertId) [ Language = javascript ]
Get the data from the form and submit to the server.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window