Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsPortal.VisualTrace
Private  Storage   

EnsPortal.VisualTrace


class EnsPortal.VisualTrace extends
EnsPortal.Dialog.standardDialog

This is the Message Trace page of the ZEN application.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 23 44


Summary


This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%ComponentClasses %ComponentNames %Components %CompositeList
%DeletedIds %NotifyList %RenderList %UserPackageList
%condition %import %includeFiles %page
%partial %resource %xmlOutputMode FirstFailed
InvalidParam IsEMSReadOnly SVGClassList UserSVGPackageList
ValidationErrorMsg align aux backgroundTimerInterval
canEdit canViewContents canViewRules cellAlign
cellSize cellStyle cellVAlign children
closeOnEnter closeOnEsc composite containerStyle
cssLevel currPage currentClass currentId
currentLine currentSVGId currentType designMode
dialogTitle disabled disabledStyle dragAndDrop
dragEnabled dropEnabled dynamic enclosingClass
enclosingStyle error eventLogClass groupClass
groupStyle hasButtons headerClass height
hidden hideApplyButton hideCancelButton hideOKButton
hint hintClass hintStyle id
index inlineSVG isPopup isSoftModal
itemsPerPage keepAliveInterval label labelClass
labelDisabledClass labelPosition labelStyle lastModalIndex
layout msgNotPermitted name nextIndex
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onoverlay onrefresh
onshow onupdate overlayMode parent
popupParent printable renderFlag ruleLogClass
sessionId showContent showEvents showInternalItems
showLabel showRelated showTrace slice
studioMode svgFilterText svgHeight svgItemCount
svgWidth title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

Methods
%%OIDGet %AddCSPShareHyperevents %AddChild %AddChildAfter
%AddChildBefore %AddComponent %AddEnsExceptionHandler %AddImportedComponents
%AddToSaveSet %ApplyURLParms %Attr %BindExport
%BuildObjectGraph %ClassIsLatestVersion %ClassName %Close
%ConstructClone %CreateApplication %CreatePage %DetermineCSSLevel
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinition %DrawClassDefinitions %DrawComponentHTML %DrawHTML
%DrawHTMLPage %DrawJSGetSettings %DrawJSSerialize %DrawJSStrings
%DrawObjectDefinitions %DrawObjectProperties %DrawSVGDef %DrawStyleDefinitions
%DrawStyleHTML %DrawStyleSVG %DrawTitle %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GenerateCode %GetChildIndex
%GetClassCRC %GetClassDepth %GetComponent %GetComponentById
%GetComponentByName %GetComponentPropertyById %GetDependentComponents %GetEventHandlers
%GetIncludeFiles %GetIncludeInfo %GetLinks %GetPageName
%GetPaneContents %GetParameter %GetSuperClassList %GetValueById
%GetValueByName %GetXMLName %IncrementCount %IsA
%IsEmbedded %IsModified %Link %LinkCSS
%LinkScript %MakeId %New %NormalizeObject
%ObjectModified %ObjectSynch %OnAddToPage %OnAddToPageAfter
%OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication
%OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody
%OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask
%OnGetPageName %OnGetSubtitle %OnGetTitle %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnUseSoftModals %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %ReallyAddChild %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetErrorById
%SetErrorByName %SetModified %SetValueById %SetValueByName
%SetValuesByName %StartScript %ValidateObject %XMLGenerate
%ZENDeserialize %ZENVersion CheckViewContents ConvertParameter
Decrypt DrawBodyInfo DrawDetailsContent DrawFullContentLinks
DrawRibbon DrawTraceTop Encrypt EncryptBroker
EscapeHTML EscapeURL EvalResult GetActualSessionId
GetClassName GetContentMessages GetHyperEventResources GetItemsPerPage
GetShowContents GetShowEvents GetShowInternalItems HyperEventBody
HyperEventCall HyperEventFrame HyperEventHead Include
InsertHiddenField InsertHiddenFields InvokeClassMethod InvokeInstanceMethod
IsPrivate Link LoadZenComponent MonitorBackgroundTask
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page QuoteJS ReallyRefreshContents RewriteURL
SetItemsPerPage SetShowContents SetShowEvents SetShowInternalItems
ShowError SimpleKeepAlive StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL XMLAfterExport
XMLBeforeExport XMLDTD XMLExport XMLExportInternal
XMLExportToStream XMLExportToString XMLGetSchemaImports XMLImport
XMLImportInternal XMLIsObjectEmpty XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore addPopupSuffix adjustSize backgroundTimerHandler
btnApply btnOK cancelPopup checkEdit
childrenMutated clearBackgroundTask clientKeepAlive correctIELayering
createComponent createComponentNS ctrlKeyDown deleteComponent
dialogApply dialogCancel dialogFinish dialogTitleGet
disableButtons doSearch dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler drawBody drawDetails
dropHandler dropStartHandler endModal exposeComponent
findElement findNumberInSVG fireOnLoadEvent fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getDialogValue getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getTargetPage getType
goToSession gotoPage hideSVGCell inResizeLoop
initPopupSuffix invokeSuper isOfType launchPopupWindow
makeId onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
onTraceSVGLoad ondialogCancel ondialogFinish ondialogStart
ondisabledHandler onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler openPage popupActionHandler
progressBarHandler refreshContents removeChild removePopupSuffix
render renderContents renderSVG resetMsg
setBackgroundTask setComponentId setHidden setOverlayMode
setProperty setPropertyAll setTraceOption showFullContent
showLegend showMsg showPrintableVersion showRule
startKeepAlive startModal startProgressBar stopKeepAlive
stopProgressBar toggleArrow toggleContents updateControlsInGroup
updateTabs validateRequired

Subclasses
Ens.Enterprise.Portal.VisualTrace

Parameters


• parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
• parameter CANCELBUTTON = 0;
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


• property canViewContents as %ZEN.Datatype.boolean;
Flag to indicate whether the user may view the contents of messages.
• property canViewRules as %ZEN.Datatype.boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList("%Ens_Code:READ,%Ens_Rules:READ,%Ens_RoutingRules:READ,%Ens_BusinessRules:READ") ];
• property currPage as %String(ZENURL="PAGE") [ InitialExpression = 1 ];
Curr page of trace
• property currentClass as %ZEN.Datatype.string;
If applicable, the server-side class of the currently selected item.
• property currentId as %ZEN.Datatype.string;
Server-side ID of currently selected item
• property currentLine as %ZEN.Datatype.string;
The HTML ID of the currently selected line object, if any.
• property currentSVGId as %ZEN.Datatype.string;
HTML ID of currently selected item
• property currentType as %ZEN.Datatype.string;
Type of currently selected item
• property eventLogClass as %ZEN.Datatype.className [ InitialExpression = "Ens.Util.Log" ];
• property headerClass as %ZEN.Datatype.className [ InitialExpression = "Ens.MessageHeader" ];
• property itemsPerPage as %Integer [ InitialExpression = ..GetItemsPerPage() ];
Number of items to display on each page of the trace
• property printable as %Boolean(ZENURL="PRINTABLE");
Flag indicating if this is the regular screen version or printer-friendly version
• property ruleLogClass as %ZEN.Datatype.className [ InitialExpression = "Ens.Rule.Log" ];
• property sessionId as %String(ZENURL="SESSIONID");
Session (or message within session) to trace
• 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 showEvents as %Boolean [ InitialExpression = ..GetShowEvents() ];
Flag to indicate whether Events should be included in the trace.
• property showInternalItems as %Boolean [ InitialExpression = ..GetShowInternalItems() ];
Flag to indicate whether internal items should be shown.
• property showRelated as %ZEN.Datatype.string;
• property showTrace as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Flag to indicate whether trace should be shown.
• property svgFilterText as %ZEN.Datatype.string;
• property svgHeight as %ZEN.Datatype.integer;
Diagram height
• property svgItemCount as %ZEN.Datatype.integer;
Total number of items in the trace
• property svgWidth as %ZEN.Datatype.integer;
Diagram width

Methods


• 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.
• classmethod DrawFullContentLinks(pSeed As %String) as %Status
Write out the links to view the full content for the message.
• private classmethod DrawMenuItem(pText As %String, pImage As %String, pDisabled As %Boolean = 0, pOnClick As %String)
• 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 ]
• private classmethod NextSession(pSessionId="", pDirection As %Integer = 1) as %Integer
Get next session Id; pDirection should be 1 or -1
• 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 ]
• method adjustSize() [ Language = javascript ]
Adjust size and position of components on this page.
• method doSearch() [ Language = javascript ]
Invoke a search using values from the search form.
• method drawBody(headerId) [ Language = javascript ]
Update the body information for a given message header.
• method drawDetails(messageId, messageClass) [ Language = javascript ]
Update the details for a selected item.
• method findNumberInSVG(svgDoc) [ Language = javascript ]
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• method goToSession(id) [ Language = javascript ]
Go to the Trace page for the previous or next session.
• method hideSVGCell() [ Language = javascript ]
• method onRefreshContents() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method 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.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method openPage(pageNum, msgPerPage, showInternal, showEvents, showRelated) [ Language = javascript ]
• method showFullContent(showRaw) [ Language = javascript ]
• method showLegend() [ Language = javascript ]
Show the legend as a popup.
• method showPrintableVersion() [ Language = javascript ]
Show the printable trace in its own tab/window.
• method 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.
• method toggleArrow(isTrace) [ Language = javascript ]
• method toggleContents(isTrace, noAdjust) [ Language = javascript ]
• method updateTabs(selected) [ Language = javascript ]
Update the tab display to match the currently selected items.