This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsPortal.VisualTrace


class EnsPortal.VisualTrace extends EnsPortal.Dialog.standardDialog

This is the Message Trace page of the ZEN Ensemble application.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter CANCELBUTTON = 0;
Inherited description: If true, then this dialog displays a Cancel button.
parameter JSINCLUDES = ensemble/Ensemble_Utils.js;
Comma-separated list of additional JS include files for the page - for Event Log popup.
parameter OKBUTTON = 0;
parameter PAGENAME = Visual Trace;
Name of this page.
parameter RESOURCE = %Ens_MessageTrace:USE;
User needs USE permissions on the %Ens_MessageTrace resource to view this page.
parameter SVGTraceClass = EnsPortal.SVG.VisualTrace;

Properties (Including Private)

property canViewContents as %ZEN.Datatype.boolean;
Flag to indicate whether the user may view the contents of messages.
Property methods: canViewContentsDisplayToLogical(), canViewContentsGet(), canViewContentsIsValid(), canViewContentsLogicalToDisplay(), canViewContentsLogicalToOdbc(), canViewContentsLogicalToXSD(), canViewContentsNormalize(), canViewContentsSet(), canViewContentsXSDToLogical()
property canViewRules as %ZEN.Datatype.boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList("%Ens_Code:READ,%Ens_Rules:READ,%Ens_RoutingRules:READ,%Ens_BusinessRules:READ") ];
Property methods: canViewRulesDisplayToLogical(), canViewRulesGet(), canViewRulesIsValid(), canViewRulesLogicalToDisplay(), canViewRulesLogicalToOdbc(), canViewRulesLogicalToXSD(), canViewRulesNormalize(), canViewRulesSet(), canViewRulesXSDToLogical()
property currPage as %String (ZENURL = "PAGE") [ InitialExpression = 1 ];
Curr page of trace
Property methods: currPageDisplayToLogical(), currPageGet(), currPageIsValid(), currPageLogicalToDisplay(), currPageLogicalToOdbc(), currPageNormalize(), currPageSet()
property currentClass as %ZEN.Datatype.string;
If applicable, the server-side class of the currently selected item.
Property methods: currentClassDisplayToLogical(), currentClassGet(), currentClassIsValid(), currentClassLogicalToDisplay(), currentClassLogicalToOdbc(), currentClassNormalize(), currentClassSet()
property currentId as %ZEN.Datatype.string;
Server-side ID of currently selected item
Property methods: currentIdDisplayToLogical(), currentIdGet(), currentIdIsValid(), currentIdLogicalToDisplay(), currentIdLogicalToOdbc(), currentIdNormalize(), currentIdSet()
property currentLine as %ZEN.Datatype.string;
The HTML ID of the currently selected line object, if any.
Property methods: currentLineDisplayToLogical(), currentLineGet(), currentLineIsValid(), currentLineLogicalToDisplay(), currentLineLogicalToOdbc(), currentLineNormalize(), currentLineSet()
property currentSVGId as %ZEN.Datatype.string;
HTML ID of currently selected item
Property methods: currentSVGIdDisplayToLogical(), currentSVGIdGet(), currentSVGIdIsValid(), currentSVGIdLogicalToDisplay(), currentSVGIdLogicalToOdbc(), currentSVGIdNormalize(), currentSVGIdSet()
property currentType as %ZEN.Datatype.string;
Type of currently selected item
Property methods: currentTypeDisplayToLogical(), currentTypeGet(), currentTypeIsValid(), currentTypeLogicalToDisplay(), currentTypeLogicalToOdbc(), currentTypeNormalize(), currentTypeSet()
property eventLogClass as %ZEN.Datatype.className [ InitialExpression = "Ens.Util.Log" ];
Property methods: eventLogClassDisplayToLogical(), eventLogClassGet(), eventLogClassIsValid(), eventLogClassLogicalToDisplay(), eventLogClassLogicalToOdbc(), eventLogClassNormalize(), eventLogClassSet()
property headerClass as %ZEN.Datatype.className [ InitialExpression = "Ens.MessageHeader" ];
Property methods: headerClassDisplayToLogical(), headerClassGet(), headerClassIsValid(), headerClassLogicalToDisplay(), headerClassLogicalToOdbc(), headerClassNormalize(), headerClassSet()
property itemsPerPage as %Integer [ InitialExpression = ..GetItemsPerPage() ];
Number of items to display on each page of the trace
Property methods: itemsPerPageDisplayToLogical(), itemsPerPageGet(), itemsPerPageIsValid(), itemsPerPageLogicalToDisplay(), itemsPerPageNormalize(), itemsPerPageSet(), itemsPerPageXSDToLogical()
property printable as %Boolean (ZENURL = "PRINTABLE");
Flag indicating if this is the regular screen version or printer-friendly version
Property methods: printableDisplayToLogical(), printableGet(), printableIsValid(), printableLogicalToDisplay(), printableLogicalToXSD(), printableNormalize(), printableSet(), printableXSDToLogical()
property ruleLogClass as %ZEN.Datatype.className [ InitialExpression = "Ens.Rule.Log" ];
Property methods: ruleLogClassDisplayToLogical(), ruleLogClassGet(), ruleLogClassIsValid(), ruleLogClassLogicalToDisplay(), ruleLogClassLogicalToOdbc(), ruleLogClassNormalize(), ruleLogClassSet()
property sessionId as %String (ZENURL = "SESSIONID");
Session (or message within session) to trace
Property methods: sessionIdDisplayToLogical(), sessionIdGet(), sessionIdIsValid(), sessionIdLogicalToDisplay(), sessionIdLogicalToOdbc(), sessionIdNormalize(), sessionIdSet()
property showContent as %ZEN.Datatype.boolean [ InitialExpression = ..GetShowContents() ];
Flag to indicate whether content pane should be shown. The property is "sticky" for the session.
Property methods: showContentDisplayToLogical(), showContentGet(), showContentIsValid(), showContentLogicalToDisplay(), showContentLogicalToOdbc(), showContentLogicalToXSD(), showContentNormalize(), showContentSet(), showContentXSDToLogical()
property showEvents as %Boolean [ InitialExpression = ..GetShowEvents() ];
Flag to indicate whether Events should be included in the trace.
Property methods: showEventsDisplayToLogical(), showEventsGet(), showEventsIsValid(), showEventsLogicalToDisplay(), showEventsLogicalToXSD(), showEventsNormalize(), showEventsSet(), showEventsXSDToLogical()
property showInternalItems as %Boolean [ InitialExpression = ..GetShowInternalItems() ];
Flag to indicate whether internal items should be shown.
Property methods: showInternalItemsDisplayToLogical(), showInternalItemsGet(), showInternalItemsIsValid(), showInternalItemsLogicalToDisplay(), showInternalItemsLogicalToXSD(), showInternalItemsNormalize(), showInternalItemsSet(), showInternalItemsXSDToLogical()
property showRelated as %ZEN.Datatype.string;
Property methods: showRelatedDisplayToLogical(), showRelatedGet(), showRelatedIsValid(), showRelatedLogicalToDisplay(), showRelatedLogicalToOdbc(), showRelatedNormalize(), showRelatedSet()
property showTrace as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Flag to indicate whether trace should be shown.
Property methods: showTraceDisplayToLogical(), showTraceGet(), showTraceIsValid(), showTraceLogicalToDisplay(), showTraceLogicalToOdbc(), showTraceLogicalToXSD(), showTraceNormalize(), showTraceSet(), showTraceXSDToLogical()
property svgFilterText as %ZEN.Datatype.string;
Property methods: svgFilterTextDisplayToLogical(), svgFilterTextGet(), svgFilterTextIsValid(), svgFilterTextLogicalToDisplay(), svgFilterTextLogicalToOdbc(), svgFilterTextNormalize(), svgFilterTextSet()
property svgHeight as %ZEN.Datatype.integer;
Diagram height
Property methods: svgHeightDisplayToLogical(), svgHeightGet(), svgHeightIsValid(), svgHeightLogicalToDisplay(), svgHeightLogicalToOdbc(), svgHeightNormalize(), svgHeightSet()
property svgItemCount as %ZEN.Datatype.integer;
Total number of items in the trace
Property methods: svgItemCountDisplayToLogical(), svgItemCountGet(), svgItemCountIsValid(), svgItemCountLogicalToDisplay(), svgItemCountLogicalToOdbc(), svgItemCountNormalize(), svgItemCountSet()
property svgWidth as %ZEN.Datatype.integer;
Diagram width
Property methods: svgWidthDisplayToLogical(), svgWidthGet(), svgWidthIsValid(), svgWidthLogicalToDisplay(), svgWidthLogicalToOdbc(), svgWidthNormalize(), svgWidthSet()

Methods (Including Private)

method %OnAfterCreatePage() as %Status
This method is used to calculate the SVG canvas dimensions and create a svgFrame component with these dimensions.
method %OnDrawHTMLHead() as %Status
Add the style information for the Event Log information.
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
method CheckViewContents() as %Boolean
method DrawBodyInfo(pHeaderID As %String) as %Status
Write out contents of body details panel. pHeaderID is the message id.
classmethod DrawDetailsContent(pID As %String) as %Status
Write out contents of details tab. pID is the item ID concatenated with $c(0,0) and then the message class.
Write out the links to view the full content for the message.
method DrawRibbon(pSeed As %String) as %Status
Draw the contents of the tool ribbon.
method DrawTraceTop(pSeed As %String) as %Status
classmethod GetActualSessionId(pId As %String = "") as %String
Helper method to obtain the session id given the SESSIONID URL parameter which may be a session id or a message id
classmethod GetClassName(id As %String) as %String [ ZenMethod ]
Get the class name (in case what's been selected is an alias, which is invalid as a class name). If the id is already a class name, that class name will be returned as the return value.
classmethod GetContentMessages(messages As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Get localized messages for the message contents pane.
classmethod GetItemsPerPage() as %Integer [ ZenMethod ]
classmethod GetShowContents() as %Boolean
classmethod GetShowEvents() as %Boolean [ ZenMethod ]
classmethod GetShowInternalItems() as %Boolean [ ZenMethod ]
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String) as %Status
Get information to display in the ribbon bar.
classmethod SetItemsPerPage(items As %Integer) as %String [ ZenMethod ]
classmethod SetShowContents(pValue As %Boolean = 1) as %String [ ZenMethod ]
classmethod SetShowEvents(flag As %Boolean = 0) as %String [ ZenMethod ]
classmethod SetShowInternalItems(flag As %Boolean = 0) as %String [ ZenMethod ]
clientmethod adjustSize() [ Language = javascript ]
Adjust size and position of components on this page.
clientmethod doSearch() [ Language = javascript ]
Invoke a search using values from the search form.
clientmethod drawBody(headerId) [ Language = javascript ]
Update the body information for a given message header.
clientmethod drawDetails(messageId, messageClass) [ Language = javascript ]
Update the details for a selected item.
clientmethod findNumberInSVG(svgDoc) [ Language = javascript ]
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod goToSession(id) [ Language = javascript ]
Go to the Trace page for the previous or next session.
clientmethod hideSVGCell() [ Language = javascript ]
clientmethod onRefreshContents() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod onTraceSVGLoad() [ Language = javascript ]
Callback from the Trace SVG onSVGLoad() callback. The callback is used to ensure that we have the loaded SVG diagram available before we attempt to resize the diagram or highlight the currently selected message.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod openPage(pageNum, msgPerPage, showInternal, showEvents, showRelated) [ Language = javascript ]
clientmethod showFullContent(showRaw) [ Language = javascript ]
clientmethod showLegend() [ Language = javascript ]
Show the legend as a popup.
clientmethod showPrintableVersion() [ Language = javascript ]
Show the printable trace in its own tab/window.
clientmethod showRule(rule, evt, ruleSet, path) [ Language = javascript ]
User clicked a link for Definition. Display the Rule View page. Display the rule definition in a popup, so the user doesn't lose the current page in the rule list.
clientmethod toggleArrow(isTrace) [ Language = javascript ]
clientmethod toggleContents(isTrace, noAdjust) [ Language = javascript ]
clientmethod updateTabs(selected) [ Language = javascript ]
Update the tab display to match the currently selected items.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)


FeedbackOpens in a new window