TraceViewer User Guide

TraceViewer is an external tool used to activate Components Technical Trace.


Location of Trace Files

You are strongly advised to use a specific subdirectory of your AppData LocalLow directory, as that directory is guaranteed to be:

  • Write-enabled, even for a low level privilege process such as Internet Explorer in protected mode
  • Local (tracing on a network drive is not recommended)

Unfortunately, there is no simple, standard way of knowing where that directory is located.
The CxTraceViewer.exe tool lets you locate it (see Specify the Trace Directory).

Usually, the directory is %userprofile%\AppData\LocalLow.
We recommend naming the subdirectory 'Desktop Studio'.

Note:

  • The Trace directory must exist; it will not be created by the Desktop Studio Trace tools.


Tracing by Component

You need to choose which components will effectively trace, as tracing everything would be too slow and would produce too much data.

Each component is identified by a trigram code. The available trigrams are:

Trigram Component
RUN Launching and initializing Desktop Agent
SCR The Scripting Host
DBG JavaScript debugging from Studio
WRK The Core: The “Work Manager”
SWG Java Applications
WIN Windows Applications
WEB Web Applications
HTM Some Desktop Studio HTML Popups
ACT The ICtxActApp interface
HLL HLLAPI Applications
BAR Desktop Studio AppBar
STU Desktop Studio
RIX Citrix and RDP Applications
UIA UI Automation Applications
BAE Desktop Studio Discovery
DES Desktop
NSD NSDK Applications


The CxTraceViewer.exe program is located in the Desktop Agent directory, which is typically C:\Program Files (x86)\Desktop\Agent

Use the Trace–>Parameters menu option to access the Trace Parameters Dialog box:


Specify the Trace Directory

The Trace Directory must be entered in the Trace Directory input box.
We recommend using the Set To Temp Push Button (which should be labeled Set To AppData LocalLow) and adding \Agent to the string.

Note:

  • You must ensure that the directory exist. If not, the tools will not create.


Specify the Component List

For each component:

  1. Select the component trigram from the List Box
  2. Check the File Only Radio Button

Here is an example for the Java Applications component:

When you have selected each component (and checked File Only for that component), click OK to close the Parameters Dialog Box.

Note:

  • Do not close the Trace Viewer program during your trace session.
    The program can be minimized, though.


You need to specify the trace directory and the list of components:

  • trace directory: -r “< path >”
  • Component list: -c < concatenated trigrams, without spaces >

Notes:

  • Certain components (such as IE Web connector on protected sites) require low-level privilege folders to generate traces: Aou can use the “%userprofile%\LocalLow\” folder to generate these traces. For other components, any folder with write access can be used.
  • You may use environment variables, as in:
... -r "%userprofile%\AppData\LocalLow\Agent" ...
  • You must surround the path with quotes if it contains spaces, as in:
... -r "c:\temp\My Folder" ...
  • The '-r' parameter is mandatory; there is no default value.
  • The directory must exist, CtxtRun.exe will not create it.

Example:

"...\CtxtRun.exe" -c WRKWEB -r "%userprofile%\LocalLow\" // traces for Work Manager and the Web components
"...\CtxtRun.exe" -c WRKRUN -r "%userprofile%\LocalLow\" // traces for Work Manager and CtxtRun components