Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsPortal] >  [SVG] >  [MessageTrace]
Private  Storage   

class EnsPortal.SVG.MessageTrace extends %ZEN.SVGComponent.svgPage

Visual Trace SVG Page
This page renders the SVG needed to display a visual trace.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
9 6 28


Summary

Properties
currPage endId endTime sessionId startId
startTime

Methods
%AddToSaveSet %ApplyURLParms %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawClassDefinition %DrawClassDefinitions %DrawObjectDefinitions %DrawObjectProperties
%DrawSVGDef %DrawSVGDefs %DrawSVGPage %DrawStyleSVG
%EndScript %Extends %GetParameter %GetSuperClassList
%InvokeCallback %IsA %IsModified %LinkCSS
%LinkScript %New %NormalizeObject %ObjectModified
%OnDrawSVGDef %OnDrawSVGPage %OnDrawSVGScript %OnDrawStyleSVG
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %StartScript %ValidateObject ArrayOfInternalItems
BuildTraceInfo ClearTraceData ConvertParameter Decrypt
DrawMessageTrace Encrypt EscapeHTML EscapeURL
EventsMaxRows EventsWindow HyperEventCall HyperEventHead
Include IncludeEvents IncludeIOLogEntries InsertHiddenField
InsertHiddenFields IsPrivate Link OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RewriteURL ShowError ShowInternalItems StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
clickACK clickCanvas clickEvent clickHost
clickIOEntry clickMsg onSVGLoad selectHost
selectItem selectOtherItem setMenuItemOption setZoom
showDetailsBox showLegend showMsgContents showMsgDetails


Parameters

• parameter CACHETIMEOUT = 5;
Number of seconds that the cached Trace Temp File is valid.
• 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 RESOURCE = "%Ens_MessageTrace";
User needs USE privilege on the %Ens_MessageTrace resource to view this page.
• parameter SHOWINTERNALITEMS = 0;
Enable display of internal messages and related events

Properties

• property currPage as %String(ZENURL="PAGE");
Curr page of trace
• property endId as %String(ZENURL="ENDID");
End Id for trace
• property endTime as %String(ZENURL="ENDTIME");
End time for trace
• property sessionId as %String(ZENURL="SESSIONID");
Session to trace
• property startId as %String(ZENURL="STARTID");
Start Id for trace
• property startTime as %String(ZENURL="STARTTIME");
Start time for trace

Methods

• classmethod %OnDrawSVGDef() as %Status
Callback method called when drawing the SVG defs for this page.
• method %OnDrawSVGPage() as %Status
Callback method. If defined, this provides a way for a subclass to add static SVG content to the svgPage.
• classmethod %OnDrawStyleSVG() as %Status
Callback method called when drawing the SVG CSS style for this page.
• classmethod ArrayOfInternalItems(Output v As %String)
• classmethod BuildTraceInfo(sessionId As %String = "", currPage As %String = "1") as %String
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.
This method returns the number of items (messages / events/ IOLog entries), the number of rows, the number of columns.
• classmethod ClearTraceData()
• method DrawMessageTrace() as %Status
Draw the SVG message trace
• classmethod EventsMaxRows()
• classmethod EventsWindow()
• classmethod IncludeEvents()
• classmethod IncludeIOLogEntries()
• classmethod ShowInternalItems()
• method clickACK(evt, ackClassname, ackId, ackRectId) [ Language = javascript ]
• method clickCanvas(evt) [ Language = javascript ]
Mouse click on canvas
• method clickEvent(evt, eventId) [ Language = javascript ]
• method clickHost(evt) [ Language = javascript ]
• method clickIOEntry(evt, ioLogId, ioRectId) [ Language = javascript ]
• method clickMsg(evt, back) [ Language = javascript ]
Mouse click on message
• method onSVGLoad() [ Language = javascript ]
This method is called when this svgPage is loaded.
• method selectHost(id) [ Language = javascript ]
Select a host (to hilite)
• method selectItem(id, back) [ Language = javascript ]
Select a new item
• method selectOtherItem(itemId) [ Language = javascript ]
• method setMenuItemOption(pOption, pItemId, pSubMenuId, value) [ Language = javascript ]
set the option for the given menu item
• method setZoom(zoom) [ Language = javascript ]
Set the zoom level
• method showDetailsBox(itemNo) [ Language = javascript ]
• method showLegend() [ Language = javascript ]
Called from context menu - Show legend window
• method showMsgContents() [ Language = javascript ]
Called from context menu
• method showMsgDetails() [ Language = javascript ]
Called from context menu


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