Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [CSPX] >  [EnsMsgTraceSVG]
Private  Storage   

class CSPX.EnsMsgTraceSVG extends %CSP.Page

Ensemble Message Trace diagram

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
9 12


Summary

Methods
%ClassIsLatestVersion %ClassName %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%New %OriginalNamespace %PackageName %SetModified
ArrayOfInternalItems BuildTraceInfo ClearTraceData ConvertParameter
Decrypt DrawHeader Encrypt EscapeHTML
EscapeURL EventsMaxRows EventsWindow HyperEventCall
HyperEventHead Include IncludeEvents IncludeIOLogEntries
InsertHiddenField InsertHiddenFields IsPrivate Link
MessagesPerPage OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page QuoteJS RewriteURL ShowError
ShowInternalItems StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL

Subclasses
CSPX.Enterprise.Portal.MsgTraceSVG

Parameters

• parameter CACHETIMEOUT = 5;
Number of seconds that the cached Trace Temp File is valid
• parameter CONTENTTYPE = "image/svg-xml";
Specifies the default content type for the page. This can be overriden using the <CSP:CONTENT TYPE=> tag, or by setting the %response.ContentType property in the OnPreHTTP method. The default value if this parameter is not set is text/html.
• parameter DOMAIN = "Ensemble";
Use our own domain for localization
• parameter EVENTSMAXROWS = 1000;
Maximum number of event log entries to be scanned to look for events
• parameter EVENTSWINDOW = 30;
Additional time in seconds after processed time of last message in trace to scan for events
• parameter INCLUDEEVENTS = 1;
Enable inclusion of Event Log entries
• parameter INCLUDEIOLOG = 1;
Include IOLog Entries in display
• parameter MSGPERPAGE = 100;
Number of messages displayed on a page
• parameter SHOWINTERNALITEMS = 0;
Enable display of internal messages and related events

Methods

• classmethod ArrayOfInternalItems(Output v As %String)
• classmethod BuildTraceInfo(sessionId As %String, startTime As %String, endTime As %String, startId As %Integer, endId As %Integer, ByRef showId="") as %Integer
Construct arrays containing the trace info for this message session:
^IRIS.TempMsgTrace(%session.SessionId) contains info about each message.
cls contains info about the Business classes used.
• classmethod ClearTraceData()
• classmethod DrawHeader() as %Status
• classmethod EventsMaxRows()
• classmethod EventsWindow()
• classmethod IncludeEvents()
• classmethod IncludeIOLogEntries()
• classmethod MessagesPerPage()
• classmethod OnPage() as %Status
Event handler for PAGE event: this is invoked in order to generate the content of a csp page.
• classmethod OnPreHTTP() as %Boolean
Event handler for PreHTTP event: this is invoked before the HTTP headers for a CSP page have been sent. All changes to the %CSP.Response class, such as adding cookies, HTTP headers, setting the content type etc. must be made from within the OnPreHTTP() method. Also changes to the state of the CSP application such as changing %session.EndSession or %session.AppTimeout must be made within the OnPreHTTP() method. It is prefered that changes to %session.Preserve are also made in the OnPreHTTP() method as this is more efficient, although it is supported in any section of the page. Return 0 to prevent OnPage from being called.
• classmethod ShowInternalItems()


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.