Class Reference
EnsPortal.SVG.VisualTrace
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [EnsPortal] >  [SVG] >  [VisualTrace]
Private  Storage

class EnsPortal.SVG.VisualTrace extends EnsPortal.SVG.templatePage

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
15 8 24


Summary

Properties
currPage endId endTime mode noSelect
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
CalculateDimensions ClearTraceData ConvertParameter Decrypt
DrawMessageTrace Encrypt EscapeHTML EscapeURL
EventsMaxRows EventsWindow HyperEventCall HyperEventHead
Include IncludeAcks IncludeEvents IncludeIOLogEntries
InsertHiddenField InsertHiddenFields IsPrivate Link
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RewriteURL ShowError ShowInternalItems
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL UseOldData getCurrentHeight getCurrentWidth
onSVGLoad selectItem setMenuItemOption setZoom
showLegend

Subclasses
Ens.Enterprise.Portal.SVG.VisualTrace

Parameters

• parameter CACHETIMEOUT = 5;
Number of seconds that the cached Trace Temp File is valid.
• parameter DELTAY = 40;
Difference between rows
• 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 HOSTLINEWIDTH = 16;
Host line width
• parameter HOSTWIDTH = 170;
Lane width
• parameter INCLUDEACKS = 1;
Include EDI ACKs in display
• parameter INCLUDEEVENTS = 1;
Enable inclusion of Event Log entries
• parameter INCLUDEIOLOG = 1;
Include IOLog Entries in display
• parameter MSGPERPAGE = 40;
Number of messages displayed on a page
• parameter RESOURCE = "%Ens_MessageTrace:USE";
User needs USE permissions on the %Ens_MessageTrace resource to view this page.
• parameter SHOWINTERNALITEMS = 0;
Enable display of internal messages and related events
• parameter TOPY = 100;
Vertical space used by header and footer
• parameter TRACETYPE = "VisualTrace";

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 mode as %Integer(ZENURL="MODE");
Property to control whether mini-mode is in use - this should only be used for the display in the message viewer. Set to 1 to use the mini-mode.
• property noSelect as %Boolean(ZENURL="NOSELECT");
Property to disable selection of items other than the requested ID in sessionId.
• 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 CalculateDimensions(n As %String = "0", rows As %String = "0", cols As %String = "0", startN As %String = "", ByRef noHeight)
• classmethod ClearTraceData()
• method DrawMessageTrace() as %Status
Draw the SVG message trace
• classmethod EventsMaxRows()
• classmethod EventsWindow()
• classmethod IncludeAcks()
• classmethod IncludeEvents()
• classmethod IncludeIOLogEntries()
• classmethod ShowInternalItems()
• classmethod UseOldData(spec As %String = "", timeCreated As %String = "", currPage As %String = 1, msgPerPage As %Integer, Output returnValue As %String) as %Boolean
• method getCurrentHeight() [ Language = javascript ]
• method getCurrentWidth() [ Language = javascript ]
• method onSVGLoad() [ Language = javascript ]
This method is called when this svgPage is loaded.
• method selectItem(evt, type, svgId, itemId, extraType, lineId) [ Language = javascript ]
Consolidated function to select a new item from the diagram (and unselect any previously selected items).
• 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 showLegend() [ Language = javascript ]
Called from context menu - Show legend window


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