{{tag>testing}}
====== Trace Display ======

TraceDisplay allows you not only to view the various system logs but also to view system logging in real-time.

The figure below shows the main TraceDisplay window with a single child window displaying data from the hospitality service log.

{{:images:vs7:manual:trace-display.png?nolink|}}

The data displayed is largely intended to aid technical support in troubleshooting system problems and will not be discussed in any detail here.  However, an onsite technician may also find these logs useful for troubleshooting on occasion.  The following table provides a basic overview of the fields contained in each log entry:

|< 85% 15% >|
^Column^Description^
|//Log//|The base name that identifies which log the entry was logged to.|
|//Date-Time//|The date and time when the log entry was logged.  Format is ''YYYY/MM/DD-hh:mm:ss.msec''.  //All values are padded with leading zeros; the millisecond value is padded to three digits and all others to two digits.  The hour value is always in 24-hour clock notation.//|
|//Data//|The actual log statement generated by the service.|

Log statements can be a little cryptic and are generally intended as a debugging aid for the manufacturer's technicians and developers.  Still, they can sometimes be useful even to on-site technicians to verify or troubleshoot certain issues.

===== Viewing Logs in Real-time =====

To view one or more logs in real-time, use the tree view pane on the left to select which log(s) to view. The logs are grouped in broad categories such as //Telephony// and //Hospitality//; click on the '+' or '-' symbols to expand or collapse each category. To open a log, double-click on it.

==== Taking a Snapshot ====

Sometimes the logging statements may accrue faster than you can read them.  If you are viewing the log(s) to catch a particular event, you can wait for the event to occur and then take a "snapshot" of the log by clicking on the camera icon on the toolbar (the next-to-last icon).

This will open a new window that will contain all the log statements from the active window up until the point you clicked the icon.  You can then peruse those statements at your leisure while the main window continues to accrue log statements in real-time.

==== Resetting the View ====

If you are viewing one or more logs live in order to debug a particular event, you may end up combing through dozens (if not hundreds) of log statements looking for the ones that specifically relate to the event you are debugging.  To help alleviate this problem, an erase option is available on the toolbar (the eraser icon).  While the log is running, you can click that icon to instantly delete all data from the window.  **This does not delete the statements from the log file, only from the window.**

So for a typical debugging session, you could open a window set to display the appropriate log(s) in real-time, wait until just before the event occurs that you are trying to debug, click the erase icon, wait for the event to occur (and finish), and then click the camera icon to open a window that displays all the log statements from the active window up to the point you clicked the icon (as discussed in the Taking a Snapshot section above).

To clear all windows displaying real-time data, click the Clear All icon on the toolbar (the one to the left of the eraser icon).

===== Viewing Existing Log Files =====

To open a log file to view past logging statements, select **File | Open**, press ''Ctrl-O'', or click on the File Open icon on the toolbar.  This will open a standard Windows File Open dialog from which you can select the file you want to view.  Select the file and click **Open** to open it in a new window.

===== Enable the Debug Filter =====

Normally, only a very minimal amount of log statements are generated, including error statements.  However, when a technical support agent is trying to debug a particular problem, he or she may need to increase the amount of logging in order to better track what is occurring within the system.  This can be done by toggling the debug filter on.

To enable or disable the debug filter, click the Filter icon on the toolbar, the one at the far right that looks like a funnel.

When the debug filter is enabled, all live log windows will have ''(debug)'' added to the title bar next to the log name and those windows will start including debug log statements in the display.

====== Log Files ======
Most PBXLinks use the filename as a prefix in case multiple profiles use the same PBXLink method, in this case the log file name is shown on the Profile General page which uses that PBXLink.

^ File ^ Description ^
|  **ACM** | Avaya Communication link. |
|  **AEONIX** | Aeonix PBXLink.  |
|  **ALCATELOXE** | Alcatel OXE PBXLink.  |
|  **ALCATELXO** | Alcatel XO PBXLink.  |
|  **CISCO** | Cisco PBXLink. |
|  **COMTROL** | Comtrol link. |
|  **GRANDSTREAM** | Grandstream PBXLink. |
|  **HITACHI** | Hitachi PBXLink. |
|  **HTNGSRVR** | Responsible for the HTNG PMS interface. |
|  **HTTPPOST** | HTTPPost PBXLink. |
|  **INTEG** | Integration decoding and debugging. |
|  **INTEGTAPI** | TAPI integration. |
|  **INTERFACE** | REST server responsible for all web based applications. |
|  **IPITOMY** | ipItomy PBXLink. |
|  **IPOHSM** | IP Office Hook State Monitor. |
|  **IPOPBXLINK** | IP Office PBXLink. |
|  **IPPUSH** | IP Office push server. |
|  **ISI** | Inventory server. |
|  **KANDY** | Kandy PBXLink. |
|  **MAINT** | Maintenance application responsible for clearing reports and logs. |
|  **MARTEC** | Martec interface. |
|  **MBADMIN** | Mailbox Administration. |
|  **MESSAGESERVER** | Mailbox interface server. |
|  **METASWITCH** | Metaswitch PBXLink. |
|  **MITEL** | Mitel PBXLink. |
|  **MTA** | Message transport agent server. |
|  **NECKTSI** | NEC KTSI PBXLink.  |
|  **NECMCILAN** | NEC MCI Lan PBXLink. |
|  **NECNEAX** | NEC NEAX PBXLink.  |
|  **NETSAPIENS** | netsapiens PBXLink.  |
|  **NORTEL** | Nortel PBXLink.  |
|  **PANASONCIFOSI** | Panasonic FOSI PBXLink. |
|  **PANASONIC** | Panasonic PBXLink. |
|  **PBXLINK** | Generic PBXLink. |
|  **PLUGINADMIN** | Telephony logging for administrator actions. |
|  **PLUGINEMS** | Martec telephony interface. |
|  **PLUGINFEATURES** | Telephony features. |
|  **PLUGINFILEIO** | Telephony file management. |
|  **PLUGINMBOXDIR** | Mailbox directory requests. |
|  **PLUGINMSGDETAILS** | Message details for users. |
|  **PLUGINMWI** | Message Waiting services. |
|  **PLUGINPARSEQA** | QA Mailbox parser. |
|  **PLUGINTRANS** | Telephony transfers. |
|  **PLUGINUSER** | Telephony user menus. |
|  **PLUGINZIPCODE** | Telephony location IVR. |
|  **POP3** | All VeMail POP3 logs. |
|  **RINGCENTRAL** | RingCentral SMS interface. |
|  **RSI** | Room status server. |
|  **RUNTIMEHOST** | Application responsible for controlling the telephony interface. |
|  **SAMSUNG** | Samsung PBXLink. |
|  **SAMSUNGSCM** | Samsung SCM Express. |
|  **SERIAL** | Serial integration interface. |
|  **SERVICE** | DuVoice Windows service responsible for starting and controlling the system. |
|  **SHORTEL** | Shortel PBXLink. |
|  **SIEMENS** | Siemens PBXLink. |
|  **SIP** | Low level SIP Integration decoder. |
|  **SMTP** | All VeMail SMTP logs. |
|  **SNMPEAS** | SNMP server for EAS alerts. |
|  **SYSCONFIG** | System Configuration. |
|  **TAPI** | Lower level TAPI driver. |
|  **TOSHIBA** | Toshiba PBXLink. |
|  **UNIVERGE** | Univerge 3C PBXLink. |
|  **UPDATE** | Log created during upgrades/updates. |
|  **VISITANT** | Hospitality test application. |
|  **VOICE** | Voice interface responsible for both SIP and Analog/Digital interfaces. |
|  **ZIPCODEDB** | Used for zip code locations. |