Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsPortal.ManagedAlerts
Private  Storage   

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.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 3 36


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 canEdit canViewAllAlerts
cellAlign cellSize cellStyle cellVAlign
children composite containerStyle cssLevel
currSortMode currStep currViewMode disabled
dragAndDrop dragEnabled dropEnabled enclosingClass
enclosingStyle error groupClass groupStyle
height hidden hint hintClass
hintStyle home homePage id
index keepAliveInterval label labelClass
labelDisabledClass labelPosition labelStyle layout
lblTitle limitPopups msgAlertDetails msgNotPermitted
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate pageModified parent
searchKey showLabel 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
%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
DoLogout DoUpdateAlert DrawDetailHTML DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetAlertData GetCSPURL
GetContextLinks GetDocPage GetHomePage GetHyperEventResources
GetNewURL GetQuickLinks HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
Link OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent RewriteURL ShowError SimpleKeepAlive
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
addClassToElement addPopupSuffix adjustSizes alphaSort
arrowClick buildNextActionIndex buildSecondaryIndex canSelectNewRow
cancelPopup changePassword changeURLNamespace checkEdit
childrenMutated clientKeepAlive correctIELayering createBucket
createComponent createComponentNS deleteComponent deselectAlert
disableCommandButton dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getBucketCaption
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getTableHTML getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage hideCommandButton inResizeLoop initPopupSuffix
initTableData invokeSuper isOfType isOverdue
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 refreshScreen
removeChild removeClassFromElement removePopupSuffix render
renderContents renderData renderMain renderSVG
rowClick searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress selectAlert selectBucket
selectMenu setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setProperty setPropertyAll
setSortMode setSortModeHandler setTraceOption setViewMode
setViewModeHandler showAbout showCommandButton showDocumentation
showHelp showTrace startAutoRefresh startKeepAlive
startModal startProgressBar stopAutoRefresh stopKeepAlive
stopProgressBar switchNamespace timeSort timestampLTEDate
toggleAllCollections toggleCollectionDisplay toggleSort updateAlert


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 msgAlertDetails as %String [ InitialExpression = $$$TextHTML("Alert Details") ];

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.
• method addClassToElement(element, addClass) [ Language = javascript ]
Helper function to add a class to an element.
• method adjustSizes() [ Language = javascript ]
Adjust the size of the page to fit the tables in correctly.
• method 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.
• method buildNextActionIndex() [ Language = javascript ]
Build an index based on NextAction so that we have our time-based buckets.
• method 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.
• method canSelectNewRow(newAlertId) [ Language = javascript ]
Helper method to make sure that the user doesn't unknowingly lose edits to an alert.
• method createBucket() [ Language = javascript ]
Helper method to create a "bucket" for indexing purposes.
• method deselectAlert() [ Language = javascript ]
• method getBucketCaption(bucket) [ Language = javascript ]
Get the localised strings for the buckets we expose.
• method getTableHTML(rootName, bucketName, bucketValue) [ Language = javascript ]
Get the HTML for the table.
• method initTableData(force) [ Language = javascript ]
Initialize the metadata for rendering the table.
• method isOverdue(timestamp, yesterday, now) [ Language = javascript ]
Helper function to determine whether timestamp lies in the past.
• method onlayoutHandler(load) [ Language = javascript ]
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.
• method refreshScreen() [ Language = javascript ]
Reload the JSON data from the server and redraw the page.
• method removeClassFromElement(element, remClass) [ Language = javascript ]
Helper function to remove a class from an element.
• method renderData(adjust) [ Language = javascript ]
Re-render the table and inner menus for the page.
• method renderMain() [ Language = javascript ]
Render the menu and table for the page.
• method rowClick(row, tableName, alertId) [ Language = javascript ]
Handle a row being clicked on by the user.
• method selectAlert(tableName, alertId) [ Language = javascript ]
Control the update of the detail pane on the right hand side.
• method selectBucket(menuName, bucketName, bucketValue) [ Language = javascript ]
Handle user selection of a bucket.
• method selectMenu(menuName) [ Language = javascript ]
Handle user click on a menu.
• method showTrace(sessionId, evt) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page.
• method startAutoRefresh(interval) [ Language = javascript ]
Set up timer to refresh the contents of the page. Currently hard-coded to 20 seconds.
• method stopAutoRefresh() [ Language = javascript ]
Stop the timer that triggers automatic refreshes of the data on the page.
• method 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.
• method timestampLTEDate(timestamp, date) [ Language = javascript ]
Helper function to determine whether timestamp occurred on or before date.
• method toggleAllCollections(tableId, rowBase, maxRow, show) [ Language = javascript ]
Callback to expand and contract all the previous actions in the alert detail pane.
• method toggleCollectionDisplay(parentId, rowId, forceVal) [ Language = javascript ]
Function to expand and contract the display of a specific action in the alert detail pane.
• method toggleSort(propName) [ Language = javascript ]
Helper method to modify the sort options for the table.
• method updateAlert(alertId) [ Language = javascript ]
Get the data from the form and submit to the server.