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

EnsPortal.EventLog


class EnsPortal.EventLog extends EnsPortal.Template.viewerPage

This is the Event Log page of the ZEN Ensemble application.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 13 50 1


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 canPurge
canViewFileSystem canViewTrace cellAlign cellSize
cellStyle cellVAlign children composite
containerStyle cssLevel currSortMode currStep
currViewMode currentPage currentPageStart detailsHidden
detailsWidth disabled dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle endId
error groupClass groupStyle height
hidden hideDetailsMsg hideSearchMsg hint
hintClass hintStyle home homePage
id index isFirstPage isLastPage
keepAliveInterval label labelClass labelDisabledClass
labelPosition labelStyle layout lblDetails
lblTitle limitPopups logCount matchSource
msgCloseDetail msgNotPermitted name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageId pageModified pageNumberId pageSizeId
parent queryAtEnd resultsTableId searchCriteria
searchJob searchKey searchQuery selectedId
sessionLinkTitle showDetailsMsg showLabel showSearchMsg
slice startId tablePaneUsesSQLAttrib tempPortalNode
title tracePage 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
%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 CheckConditions CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt DoExportInBackground DoLogout
DoPurge DrawDetailsContent DrawEventDetails DrawLocalType
DrawLocator DrawMethodCell DrawRibbon DrawSessionCell
DrawTextCell DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult FileExists GetAndUseDefaults
GetCSPURL GetColumnsAndFrom GetContextLinks GetCount
GetDefaultDir GetDirectory GetDocPage GetFilename
GetHomePage GetHyperEventResources GetNewURL GetQuickLinks
GetRemoteSearchJob GetWhereClause GiveAdviceString HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate Link MultiTypeClose MultiTypeExecute
MultiTypeFetch OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page PrepareCancel
QuoteJS RegisterRecent RemoveTempData ResetQuery
RewriteURL SaveDefaults SetDefaultDir ShowError
SignalCancel SimpleKeepAlive StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addPopupSuffix adjustExpanderText
arrowClick cancelPopup cancelSearch changePassword
changeRefresh changeURLNamespace checkEdit childrenMutated
clientKeepAlive correctIELayering countReset createComponent
createComponentNS deleteComponent disableCommandButton doExportToFile
doSearch dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal enterKey executeSearch expandoState
exportToFile exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction formReset
getChildIndex getComponent getComponentById getContentAreaHeight
getEnclosingDiv getHidden getHintElement getLabelElement
getNextData getOpener getProperty getResultsTable
getSearchForm getSettings 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
refreshContents removeChild removePopupSuffix render
renderContents renderSVG searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress selectItem
setComponentId setConnectivityStatusMsg setHidden setModified
setOverlayMode setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showCommandButton showDocumentation showHelp
showQuery showTrace startKeepAlive startModal
startProgressBar startPurge stopKeepAlive stopProgressBar
switchNamespace timeout toggleCancelState toggleDetails
toggleSearch toggleSearchState updateNavigationButtons updatePageData
updatePageNumber updatePageSize

Subclasses
Ens.Enterprise.Portal.MsgBankEventLog

Parameters


• parameter CANCANCELSEARCH = 1;
Indicate if can cancel search.
• parameter JSINCLUDES = "ensemble/Ensemble_Utils.js";
Comma-separated list of additional JS include files for the page.
• parameter PAGENAME = "Event Log";
Displayed name of this page.
• parameter RESOURCE = "%Ens_EventLog:USE";
User needs USE permissions on the %Ens_EventLog resource to view this page.
• parameter SETUPTEMPPORTALNODE = 1;
Indicate if ought to create tempPortalNode when page created. Used by Cancel feature for example.

Properties


• property canPurge as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_Purge","USE") ];
Flag to indicate whether a user may purge Event log entries.
• property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
• property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
• 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 endId as %ZEN.Datatype.string(ZENURL="EndId");
• property logCount as %ZEN.Datatype.integer [ InitialExpression = ..GetCount() ];
• property matchSource as %ZEN.Datatype.string(ZENURL="SOURCE");
• property pageNumberId as %ZEN.Datatype.id [ InitialExpression = "pageTotal" ];
Id of the page number field
• property pageSizeId as %ZEN.Datatype.id [ InitialExpression = "MaxRows" ];
Id of the page size field
• property resultsTableId as %ZEN.Datatype.id [ InitialExpression = "table" ];
Id of the results tablePane
• property sessionLinkTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Click to view a visual trace of the session") ];
• property startId as %ZEN.Datatype.string(ZENURL="StartId");
• property tracePage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.VisualTrace.zen" ];

Methods


• method %OnAfterCreatePage() as %Status
Fill search criteria defaults
• method %OnDrawHTMLHead() as %Status
This callback is called at the end of the HTML HEAD section of the page.
(default implementation is a simple expression).
• classmethod %OnFinishBackgroundTask(pTaskID As %String)
This server-side callback method is called whenever the client calls to monitor the current background task and the task is complete. Typically a subclass uses this to send back JavaScript to update the page.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• classmethod %OnMonitorBackgroundTask(pTaskID As %String, pStatus As %String, pPercentComplete As %Float)
This server-side callback method is called whenever the client calls to monitor the current background task. Typically a subclass uses this to send back JavaScript to update a progress bar.
• method CheckConditions(Output pSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Callback that is executed when creating the resultset for the main table. The method's main purpose is to determine whether the MultiType class query should be used in cases where we have the following:
  • more than one Type selected,
  • not all Types selected, and
  • no conditions on other indexed fields
When all of these conditions are met, we hand off responsibility for the data retrieval to the class query.
• classmethod DoExportInBackground(filename As %String = "", sortOrder As %String = "", val As %String = "", Defaults As %String = "", EventType As %String = "") as %String [ ZenMethod ]
Save ID values for Resend.
• classmethod DoPurge(keep As %Integer) as %String [ ZenMethod ]
Perform the purge operation and if there is an error, return the message to JavaScript by prepending the message with a '-'. If no error then return the zero or positive number of entries deleted, as a string.
• classmethod DrawEventDetails(pSeed As %String) as %Status
Server-side callback to provide data for the details table
• method DrawLocalType(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
Server-side method to write out the content for the event Type column Draw localized event type name
• method DrawMethodCell(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
Server-side method to write out the content and SourceClass:SourceMethod() in the hover-text title.
• method DrawSessionCell(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
Server-side method to write out the content for the SessionId column. The main purpose is to ensure that links to the Visual Trace diagram are only included for events which occurred as part of a session.
• 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 FileExists(pFilename) as %Boolean [ ZenMethod ]
• 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 GetCount() as %Integer [ ZenMethod ]
• classmethod GetDefaultDir() as %String [ ZenMethod ]
• method GetDirectory(pFilename) as %String [ ZenMethod ]
• method GetFilename(pFilename) as %String [ ZenMethod ]
• 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 GetWhereClause(Defaults, EventType) 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
• classmethod MultiTypeClose(ByRef qHandle As %Binary) as %Status
• classmethod MultiTypeExecute(ByRef qHandle As %Binary, pTypes As %String = "", pDescending As %Boolean = 1, pSelectMode As %Integer = 2, pConditions As %ZEN.proxyObject = "") as %Status
• classmethod MultiTypeFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• 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.
• classmethod SaveDefaults(SortOrder, TimeFormat, Defaults, EventType, MaxRows, States, AutoRefresh) [ ZenMethod ]
Save user's last search criteria into global for page default
• classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]
• method changeRefresh() [ Language = javascript ]
User chose a new Auto-Refresh value; set a new timeout value and start the timer
• method countReset() [ Language = javascript ]
Reset the current count of Event Log entries
• method doExportToFile(streamFilenameForExport) [ Language = javascript ]
• 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 expandoState() [ Language = javascript ]
Build the current expando state into a string concatenated with commas
• method exportToFile() [ Language = javascript ]
• method formReset() [ Language = javascript ]
Reset the "Search Events By..." form fields to blank, reset other fields to defaults
• method onAfterPageChange() [ Language = javascript ]
Callback invoked after the next/previous page has been loaded.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when a popup page launched from this page fires an action.
• 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 showTrace(session, stopEvent, evt) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page in a popup, so user can click the arrows to go from session to session without losing his/her place in the Event Log.
• method startPurge() [ Language = javascript ]
User clicked the Purge button
• method timeout(timer) [ Language = javascript ]
If auto-refresh is still on, refresh table and restart the timer

Queries


• query MultiType(pTypes As %String = "", pDescending As %Boolean = 0, pSelectMode As %Integer = 2, pConditions As %ZEN.proxyObject = "")
Selects Type As Ens.DataType.LogType, ID As %String, TimeLogged As %String, SessionId As %String, Job As %String, ConfigName As %String, Text As %String, TraceCat As %String, SourceClass As %String, SourceMethod As %String, TimeLogged999 As %String, TimeLogged12 As %String