EnsPortal.EventLog

class EnsPortal.EventLog extends EnsPortal.Template.viewerPage

This is the Event Log page of the ZEN application.

Property Inventory (Including Private)

Method Inventory (Including Private)

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 methods: canPurgeDisplayToLogical(), canPurgeGet(), canPurgeIsValid(), canPurgeLogicalToDisplay(), canPurgeLogicalToOdbc(), canPurgeLogicalToXSD(), canPurgeNormalize(), canPurgeSet(), canPurgeXSDToLogical()
property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
Property methods: canViewFileSystemDisplayToLogical(), canViewFileSystemGet(), canViewFileSystemIsValid(), canViewFileSystemLogicalToDisplay(), canViewFileSystemLogicalToXSD(), canViewFileSystemNormalize(), canViewFileSystemSet(), canViewFileSystemXSDToLogical()
property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
Property methods: canViewTraceDisplayToLogical(), canViewTraceGet(), canViewTraceIsValid(), canViewTraceLogicalToDisplay(), canViewTraceLogicalToOdbc(), canViewTraceLogicalToXSD(), canViewTraceNormalize(), canViewTraceSet(), canViewTraceXSDToLogical()
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 endId as %ZEN.Datatype.string (ZENURL = "EndId");
Property methods: endIdDisplayToLogical(), endIdGet(), endIdIsValid(), endIdLogicalToDisplay(), endIdLogicalToOdbc(), endIdNormalize(), endIdSet()
property logCount as %ZEN.Datatype.integer [ InitialExpression = ..GetCount() ];
Property methods: logCountDisplayToLogical(), logCountGet(), logCountIsValid(), logCountLogicalToDisplay(), logCountLogicalToOdbc(), logCountNormalize(), logCountSet()
property matchSource as %ZEN.Datatype.string (ZENURL = "SOURCE");
Property methods: matchSourceDisplayToLogical(), matchSourceGet(), matchSourceIsValid(), matchSourceLogicalToDisplay(), matchSourceLogicalToOdbc(), matchSourceNormalize(), matchSourceSet()
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 = "MaxRows" ];
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 sessionLinkTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Click to view a visual trace of the session") ];
Property methods: sessionLinkTitleDisplayToLogical(), sessionLinkTitleGet(), sessionLinkTitleIsValid(), sessionLinkTitleLogicalToDisplay(), sessionLinkTitleLogicalToOdbc(), sessionLinkTitleNormalize(), sessionLinkTitleSet()
property startId as %ZEN.Datatype.string (ZENURL = "StartId");
Property methods: startIdDisplayToLogical(), startIdGet(), startIdIsValid(), startIdLogicalToDisplay(), startIdLogicalToOdbc(), startIdNormalize(), startIdSet()
property tracePage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.VisualTrace.zen" ];
Property methods: tracePageDisplayToLogical(), tracePageGet(), tracePageIsValid(), tracePageLogicalToDisplay(), tracePageLogicalToOdbc(), tracePageNormalize(), tracePageSet()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Fill search criteria defaults
method %OnDrawHTMLHead() as %Status [ Language = objectscript ]
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) [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
Get the (localized) name of the page.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page.
classmethod %OnMonitorBackgroundTask(pTaskID As %String, pStatus As %String, pPercentComplete As %Float) [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
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 [ Language = objectscript, ZenMethod ]
Save ID values for Resend.
classmethod DoPurge(keep As %Integer) as %String [ Language = objectscript, 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 DownloadStream(pExportTempFilename As %String = "", pDocName) as %String [ Language = objectscript ]
classmethod DrawEventDetails(pSeed As %String) as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript ]
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 [ Language = objectscript ]
Server-side method to write out the event text both as content and in the hover-text title.
method FileExists(pFilename) as %Boolean [ Language = objectscript, ZenMethod ]
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 GetCount() as %Integer [ Language = objectscript, ZenMethod ]
classmethod GetDefaultDir() as %String [ Language = objectscript, ZenMethod ]
method GetDirectory(pFilename) as %String [ Language = objectscript, ZenMethod ]
method GetFilename(pFilename) as %String [ Language = objectscript, ZenMethod ]
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.
private method GetSearchCriteria() as %String [ Language = objectscript ]
classmethod GetTempFileName(pDocName As %String = "") as %String [ Language = objectscript, ZenMethod ]
method GetWhereClause(Defaults, EventType) 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
classmethod MultiTypeClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod MultiTypeExecute(ByRef qHandle As %Binary, pTypes As %String = "", pDescending As %Boolean = 1, pSelectMode As %Integer = 2, pConditions As %ZEN.proxyObject = "") as %Status [ Language = objectscript ]
classmethod MultiTypeFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
method OnDrawRibbon() as %Status [ Language = objectscript ]
Add export refresh icon
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.
classmethod SaveDefaults(SortOrder, TimeFormat, Defaults, EventType, MaxRows, States, AutoRefresh) [ Language = objectscript, ZenMethod ]
Save user's last search criteria into global for page default
classmethod SetDefaultDir(pPathname As %String) [ Language = objectscript, ZenMethod ]
private classmethod SetDefaultString(pDefaults As %String = "") [ Language = objectscript ]
clientmethod changeRefresh() [ Language = javascript ]
User chose a new Auto-Refresh value; set a new timeout value and start the timer
clientmethod countReset() [ Language = javascript ]
Reset the current count of Event Log entries
clientmethod doExportStatus() [ Language = javascript ]
This method calls server method to get current background event log export job status and update the UI Used if auto refresh off
clientmethod doExportToFile(value) [ Language = javascript ]
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 expandoState() [ Language = javascript ]
Build the current expando state into a string concatenated with commas
clientmethod exportToFile() [ Language = javascript ]
clientmethod formReset() [ Language = javascript ]
Reset the "Search Events By..." form fields to blank, reset other fields to defaults
clientmethod onAfterPageChange() [ Language = javascript ]
Inherited description: Callback invoked after the next/previous page has been loaded.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when a popup page launched from this page fires an action.
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 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.
clientmethod startPurge() [ Language = javascript ]
User clicked the Purge button
clientmethod 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

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Subclasses

Feedback