Print

Overview of the TSAPI Spy for Windows interface

Use this section to familiarize yourself with the TSAPI Spy for Windows interface.

Name Description
Tracing..
  • Enabled - the default setting. When Tracing is enabled, message tracing information is displayed in the two display areas of the TSAPI Spy main window.

  • Disabled - Select Disabled to disable message tracing. Tracing can be disabled at any time while TSAPI Spy is running. If you disable tracing, and then exit TSAPI Spy (File > Exit), the next time you start TSAPI Spy, it will be Disabled.

Open Streams (+) Indicates the number of streams currently open from the TSLIB to all Telephony servers. This number is updated in real time as applications open and close connections.
Closed Streams (-) Indicates the number of streams previously open from the TSLIB to all AE Services Servers, which are now closed. This number is updated in real time as applications close streams.
Streams list (white background) Displays information about currently and previously open connections from the TSLIB to all telephony servers. For more information see, Streams list.
Handle The internal ID for a stream. All the message lines in the trace file are prefixed with the handle of the connection to which the message belongs. The handle is generated by the TSLIB. Currently open connections are indicated with a + prefix on the Handle. Streams that were previously open but are now closed are indicated with a - prefix on the Handle
Server ID The Tlink to which this connection has been opened. This information is provided to the TSLIB by the application when a request is made to open a connection.
Appl The name of the application that has opened this connection. This information is provided to the TSLIB by the application when a request is made to open a connection.
Login The login ID under which the application has opened this connection. Multiple applications may be opened under the same or different login ID(s) at a single client. This information is provided to the TSLIB by the application when a request is made to open a connection.
Output display window (grey background) Displays the trace output in real time as messages are passed through TSLIB. This output window can display approximately 30,000 characters of trace history. Once the output limit has been reached, the oldest trace information is deleted in favor of the newer trace information. For long trace outputs, it is recommended that the trace be logged to a file. For more information, see Usage of the Log to File option to direct output to a trace file.
Trace file status This line, below the Output window, indicates whether the Log To File option has been selected, and tracing. The default is “No trace file.” When file logging is active, this line indicates the file name (with full path) and file size.
File
  • Exit - Use menu item is used to exit TSAPI Spy. The system menu may also be used to exit the application.

Edit
  • Copy - copies the selected text (if any) from the Output window onto the Clipboard. The text is then available to be pasted into any application of your choosing. If no text is selected in the Output window, this menu item is grayed and disabled.

  • Clear Buffer - clears out the contents of the Output window. Once this is done, the original contents are lost (the data is NOT copied to the Clipboard).

  • Select All - selects all of the text in the Output window. The Copy menu item can then be used.

  • Purge Closed Streams - deletes all closed connections (indicated with a “-” prefix) from the streams list and resets the Closed Streams count to 0, leaving only currently open connections in the Streams List.

Options All options, except Auto-Trace New Streams, are disabled by default
  • Always On Top - causes the TSAPI Spy window to be topmost on the screen display. This setting is disabled by default (a check mark does not appear next to it).

  • Auto-Trace New Streams - causes newly opened connections (which open after TSAPI Spy is started) to be traced automatically. This option is described in more detail in Streams list. This setting is enabled by default (a check mark appears next to it).

  • Show Internal Events - causes non-application messages to be traced. The majority of messages normally traced through the CSTA32.DLL are application-to-telephony server and telephony server-to-application messages. There are, however, a small number of messages that the TSLIB generates to facilitate application/telephony server communications. This setting is disabled by default (a check mark does not appear next to it).

  • Log To File - causes all trace messages to be logged to a file specified by the user. See Usage of the Log to File option to direct output to a trace file. This setting is disabled by default (a check mark does not appear next to it).