Type
Tracking item
Available from
Purpose
The primary use of the Trace item is as a debugging tool during application development. You can use the Trace item to:
- Check the value of variables or variable fields at different points during application simulation and execution.
- Track application progress, to make sure it is reaching certain points at run time.
- Define different levels of criticality when unexpected or error-type events occur.
Behavior
During simulation or run time, the Trace item takes the value of the Text field and any selected Variable or Variable Field and writes the value to a log file. The application locates this log file in the ProjectName/data/log directory, where ProjectName represents the name of the speech application project.
To view the log file contents in Dialog Designer, locate the appropriate log file in this directory and double-click it. To view the log file contents in a run-time environment, locate the appropriate log file on the application server, and view it with your text viewer or word processor of choice.
The name of the log file for the current day is always trace.log. Each time you run
a simulation, Dialog Designer appends the log data to the end of this file. At the
end of each day, Dialog Designer renames the log file to: trace.log.yyyy-mm-dd,
where yyyy-mm-dd represents the date on which the log file was compiled.
During simulation, Dialog Designer also displays tracing data in the Console view display, and you can review it there.
Note:
Trace log data is written using log4j logging technology. Because this is a new
technology and information available is constantly changing, for more information
about log4j technology, Avaya recommends that you perform an Internet search
with the search term "log4j".
The Trace item requires that you enable it before the system recognizes it during simulation or run time. For this reason, if you use a Trace item in a call flow, and if you do not enable tracing output during simulation or run time, the system ignores it and does not write any trace data to the log file.
To enable tracing during simulation:
- From the Window menu, click Preferences.
- Dialog Designer displays the Preferences dialog box.
- In the navigation pane on the left, click the plus [+] symbol next to the Dialog Designer entry. The Dialog Designer entry expands to show its subentries.
- In the expanded subentry list, click Avaya Application Simulator.
- Dialog Designer displays the preferences options for the Avaya Application Simulator.
- Enable both the following options (among others displayed, as desired):
- Enable Dialog Designer logging of tracing output
- Enable Application logging of tracing output
- These and other Avaya Application Simulator preferences are described Application Simulation Preferences.
- Click OK.
Because the Trace item is considered primarily a development and debugging tool, it is not normally used with a deployed application during run time. The log files that are generated during run time can consume large amounts of drive space. However, they may be useful when testing or troubleshooting an application deployment.
To enable or disable tracing in a run-time environment:
- Deploy and configure the speech application on the application server.
- Edit the ddrt.properties file in the /data directory. A ddrt.properties file is available in the project /data directory that controls logging parameters.
- In the development environment, these parameters can be controlled through Avaya Application Simulator Preferences settings. In a deployed system, by editing the ddrt.properties file, the next run session will pick up the settings. The configuration settings are described in the following table.
ddrt.properties file Configurable Parameters
Parameter
|
Description
|
---|
localddtrace
| Dialog Designer built-in tracing. Valid values are enabled or disabled.
|
localapptrace
| Application tracing. Valid values are enabled or disabled.
|
showvxml
| Enables the local report.log on platforms (Voice Portal) when they are normally disabled. Valid values are enabled or disabled.
|
showvxmlroot
| Enables display of the generated VXML output for the AppRoot in the trace.log. [once|always|never]. The default is once if this property is not specified.
|
localreportlog
| Enables the local report.log on platforms (Voice Portal) when the local log is normally disabled. Valid values are enabled or disabled.
|
skeletonreporting
| Enables application skeleton reporting. This is reporting that tracks the path a caller takes through an application. Valid values are enabled or disabled.
|
Properties
- Priority - Select the priority level to assign to this Trace item.
- The priority level you select is written to the log file as part of the tracing data. This makes it easy to search the log file for specific problems based on the priority of the trace entry.
- The following table lists the priority levels for Trace items, shows how they appear in the log file, and provides a brief description of what each level means.
Priority
|
Log Entry
|
Description
|
---|
Fatal
| FATAL
| A situation in which the application would crash.
|
Error
| ERROR
| A situation that would cause the application to generate an error.
|
Warning
| WARN
| A situation that would cause the application to generate a warning.
|
Info
| INFO
| A situation that would cause the application to generate an informational message.
|
Debug
| DEBUG
| A situation that would cause the application to generate debugging data.
|
- Text - Enter in this field any text that you want the system to record as part of the Trace item entry in the log file. The system enters the text in the log file verbatim.
- Variable - Select the variable whose value you want to record to the log file as part of the Trace item entry.
- If this variable is a complex variable, you must also select a Variable Field.
- Variable Field - If the Variable you selected is a complex variable, select the variable field whose value you want to record to the log file as part of the Trace item entry.