You are on page 1of 5

Avaya DevConnect Developer Know-how Article

Avaya Dialog Designer Know-how 1:

How to Enable Logging and Tracing for Dialog Designer Speech Applications
Logging and tracing must be enabled to support the successful debugging of Dialog Designer applications. Based on the logs and traces collected, information can be obtained to help troubleshoot generated errors. Additionally, the call flow can be traced to check whether the desired output is be generated at various stages in the call flow. This know-how article describes how to enable logging and tracing for Dialog Designer applications. Complementary Dialog Designer Know-how articles describe How to Use Trace and Report Items in Dialog Designer Applications, How to Troubleshoot Dialog Designer Application Errors and How to Use Try-catch Blocks to Handle Exceptions in Dialog Designer Applications.

Configuring Logging and Tracing Parameters


To set the parameters that enable logging and tracing for a Dialog Designer application: 1. Edit the ddrt.properties file in the /data directory of the Dialog Designer application. This file contains the logging and tracing parameters. The configuration parameters are described in the table below: Parameter localddtrace localapptrace showvxml localreportlog Description Dialog Designer built-in tracing. Valid values are enabled or disabled. Application tracing in the trace.log file. Valid values are enabled or disabled. Enables display of generated vxml output in the trace.log file. Valid values are enabled or disabled. Enables the local report.log on platforms (Voice Portal) when the local log is normally disabled. Valid values are enabled or disabled. Enables application framework in the report.log file. Valid values are enabled or disabled. Enables display of the generated VXML output for the AppRoot in the trace.log. The valid values are once, always or never. The default is once if this property is not specified

skeletonreporting showvxmlroot

DD Know-how 1: How to Enable Logging and Tracing for DD Speech Applications December 2009

2. As a minimum, the localapptrace, localreportlog and frameworkreporting should be set to enabled.

The ddrt.properties File

The Dialog Designer ddlog4j.properties file allows additional control over logging levels (possible values: Info, Fatal, Error, Warn or Debug - see the Dialog Designer Reference Guide for more information about these levels), logging formats and the directory location of the log files. To update these settings:

DD Know-how 1: How to Enable Logging and Tracing for DD Speech Applications December 2009

3. Edit the ddlog4j.properties file located under the /data directory of the Dialog Designer application.

The ddlog4j.properties File

Enabling Tracing in Dialog Designer Simulation Mode


To enable tracing in Dialog Designer simulation mode, from within the Eclipse IDE: 1. Select Window -> Preferences the Preferences dialog opens. 2. Select Dialog Designer -> Avaya Application Simulator the Avaya Application Simulator panel is displayed.

The Avaya Application Simulator Panel

DD Know-how 1: How to Enable Logging and Tracing for DD Speech Applications December 2009

3. Select the Enable Dialog Designer logging of tracing output and Enable Application logging of tracing output check boxes. 4. Click Apply.

Enabling Tracing in the Development Environment


To enable tracing in the Dialog Designer development environment, from within the Eclipse IDE: 1. Select Window -> Preferences the Preferences dialog opens. 2. Select Dialog Designer -> Debug Tracing the Debug Tracing panel is displayed.

The Debug Tracing Panel

3. Select the Enable Trace Output for Dialog Designer check box. 4. Click Apply.

DD Know-how 1: How to Enable Logging and Tracing for DD Speech Applications December 2009

Enabling Tracing in the Runtime Environment


To enable tracing in the runtime environment, on the Voice Portal platform: 1. Log into the Voice Portal Management System (VPMS) web interface. 2. Browse to System Configuration -> Applications.

The Applications Page

3. Under Reporting Parameters - Application Logging, set the Minimum Level to Info. 4. Set the Call Flow Data Sample Rate to 100%. For more information on the Call Flow Data Sample Rate, see the Voice Portal Documentation Library.

DD Know-how 1: How to Enable Logging and Tracing for DD Speech Applications December 2009