Download pdf - DD GettingStarted

7/27/2019 DD GettingStarted

1/43

Avaya Dialog Designer Getting Started with Dialog Designer

August 2005Issue 1


2/43

2005 Avaya Inc.All Rights Reserved.

NoticeWhile reasonable efforts were made to ensure that the information in t hisdocument was complete and accurate at the time of printing, Avaya Inc. canassume no liability for any errors. Changes and corrections to the informationin this document may be incorporated in future releases.

Documentation disclaimer Avaya Inc. is not responsible for any modifications, additions, or deletions tothe original published version of this documentation unless such modifications,additions, or deletions were performed by Avaya. Customer and/or End User agree to indemnify and hold harmless Avaya, Avaya's agents, servants and

employees against all claims, lawsuits, demands and judgments arising out of,or in connection with, subsequent modifications, additions or deletions to thisdocumentation to the extent made by the Customer or End User.

Link disclaimer Avaya Inc. is not responsible for the contents or reliability of any linked Websites referenced elsewhere within this documentation, and Avaya does notnecessarily endorse the products, services, or information described or offeredwithin them. We cannot guarantee that these links will work all of the time andwe have no control over the availability of the linked pages.

Warranty Avaya Inc. provides a limited warranty on this product. Refer to your salesagreement to establish the terms of the limited warranty. In addition, Avayasstandard warranty language, as well as information regarding support for thisproduct, while under warranty, is available through the following Web site:http://www.avaya.com/support

License

USE OR INSTALLATION OF THE PRODUCT INDICATES THE END USER'S ACCEPTANCE OF THE TERMS SET FORTH HEREIN AND THE GENERALLICENSE TERMS AVAILABLE ON THE AVAYA WEB SITE AThttp://support.avaya.com/LicenseInfo/ ("GENERAL LICENSE TERMS"). IFYOU DO NOT WISH TO BE BOUND BY THESE TERMS, YOU MUSTRETURN THE PRODUCT(S) TO THE POINT OF PURCHASE WITHIN TEN(10) DAYS OF DELIVERY FOR A REFUND OR CREDIT.

Avaya grants End User a license within the scope of the license typesdescribed below. The applicable number of licenses and units of capacity for which the license is granted will be one (1), unless a different number of licenses or units of capacity is specified in the Documentation or other materials available to End User. "Designated Processor" means a singlestand-alone computing device. "Server" means a Designated Processor thathosts a software application to be accessed by multiple users. "Software"means the computer programs in object code, originally licensed by Avaya andultimately utilized by End User, whether as stand-alone Products or pre-installed on Hardware. "Hardware" means the standard hardwareProducts, originally sold by Avaya and ultimately utilized by End User.

License Type(s)CopyrightExcept where expressly stated otherwise, the Product is protected by copyrightand other laws respecting proprietary rights. Unauthorized reproduction,transfer, and or use can be a criminal, as well as a civil, offense under theapplicable law.

Third-party ComponentsCertain software programs or portions thereof included in the Product maycontain software distributed under third party agreements ("Third PartyComponents"), which may contain terms that expand or limit rights to usecertain portions of the Product ("Third Party Terms"). Information identifyingThird Party Components and the Third Party Terms that apply to them isavailable on Avaya's web site at:http://support.avaya.com/ThirdPartyLicense/

Avaya fraud intervention

If you suspect that you are being victimized by toll fraud and you need technicalassistance or support, call Technical Service Center Toll Fraud InterventionHotline at +1-800-643-2353 for the United States and Canada. For additionalsupport telephone numbers, see the Avaya Web site:http://www.avaya.com/support

Trademarks Avaya is a trademark of Avaya Inc. All non-Avaya trademarks are the property of their respective owners.

Avaya support Avaya provides a telephone number for you to use to report problems or to askquestions about your product. The support telephone number

is 1-800-242-2121 in the United States. For additional support telephonenumbers, see the Avaya Web site:http://www.avaya.com/support
http://www.avaya.com/supporthttp://support.avaya.com/LicenseInfo/http://support.avaya.com/ThirdPartyLicense/http://support.avaya.com/ThirdPartyLicense/http://www.avaya.com/supporthttp://www.avaya.com/support/http://support.avaya.com/ThirdPartyLicense/http://support.avaya.com/LicenseInfo/http://www.avaya.com/support/http://www.avaya.com/supporthttp://www.avaya.com/support


3/43

Getting Started with Dialog Designer August 2005 3

About the Avaya Dialog Designer Documentation . . . . . . . . . . . . . . . . . . . 5

Purpose. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Intended audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Related resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 1: About Avaya Dialog Designer . . . . . . . . . . . . . . . . . . . . . . . . 11

Chapter 2: Installation and Configuration . . . . . . . . . . . . . . . . . . . . . . . . 13

Dialog Designer required software . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Installing Dialog Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Before you install the software . . . . . . . . . . . . . . . . . . . . . . . . 15Installing the software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Configuring Dialog Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Creating access options. . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Setting up the workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Setting Dialog Designer preferences . . . . . . . . . . . . . . . . . . . . . 17Configuring the Microsoft Speech SDK for microphone input . . . . . . . 19

Installing the sample applications . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Chapter 3: The Dialog Designer GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Viewing the Eclipse Workbench User Guide , "Concepts" section . . . . . . . . . 21

The Dialog Designer workbench . . . . . . . . . . . . . . . . . . . . . . . . . . . 22The Navigator view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

The Editor view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24The Dialog Designer editors . . . . . . . . . . . . . . . . . . . . . . . . . 24Editor view tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

The Outline view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25The Avaya Voice Browser view . . . . . . . . . . . . . . . . . . . . . . . . . . 26

The Call tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26The Input tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27The Log tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29The Script tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

The Problems view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

The Tasks view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30The Avaya Properties view . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30The Console view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31The status bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Dialog Designer menu and toolbar options . . . . . . . . . . . . . . . . . . . . . 32

Contents


4/43

4 Getting Started with Dialog Designer August 2005

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41


5/43


About the Avaya Dialog Designer Documentation

To help you get the most out of the documentation for Avaya Dialog Designer, take a fewmoments to review the following topics:

Purpose on page 5

Intended audience on page 5

Related resources on page 6

Availability on page 8

PurposeThe purpose of this documentation is to provide detailed information about Avaya DialogDesigner. Included in this book is information about:

The Dialog Designer software product offer

For more information, see Chapter 1: About Avaya Dialog Designer on page 11 .

Installation and configuration of the Dialog Designer software

For more information, see Chapter 2: Installation and Configuration on page 13 .

The Dialog Designer graphical user interface (GUI)

For more information, see Chapter 3: The Dialog Designer GUI on page 21 .

Intended audienceThe Dialog Designer documentation is for those who need to:

Install and configure Dialog Designer for their own use or the use of others Use Dialog Designer to design and create speech applications for:

- Avaya Interactive Response (IR), Release 1.3 (or later)- Avaya Voice Portal 3 (or later)


6/43



These users include, among others:

Customers who want to create their own speech applications

Avaya business partners and independent service vendors who create speechapplications for Avaya customers

The primary users of Dialog Designer are likely to be highly knowledgeable and skilled intelecommunications and Internet technologies. Therefore, this documentation does not cover many topics related to those areas. Instead, Avaya assumes that those using Dialog Designer are already proficient and knowledgeable in the following areas:

The operating systems in which they will be developing and deploying Dialog Designer applications

Computer networking concepts and technologies

Telecommunications concepts and technologies, including switches and gateways

Basic programming logic and practice

Note:Note: Although not required to develop applications in Dialog Designer, knowledge of

and experience with Java programming is helpful.

Dialog Designer is built on several existing technologies and tools. Because of this, Avayarecommends that Dialog Designer users familiarize themselves with the following technologies,if they are not already familiar with the technologies:

Eclipse open-source software

Java servlet technology

Servlet engine technologies

Speech recognition and synthesis technologies

Database administration Web service technologies

For more information about and additional resources for these technologies, see Relatedresources on page 6 .

Related resources

Avaya Dialog Designer depends on the use of several closely related software products andtechnologies. When you are using Dialog Designer, Avaya recommends also the use of thedocumentation for these related products and technologies.


7/43

Related resources


Avaya does not reproduce or package the documentation for these related products andtechnologies. However, to help you locate the appropriate documentation more easily, Avayarecommends the following resources:

Note:Note: All effort was made to ensure that the URLs quoted in this topic were valid at the

time this documentation was published. However, Avaya assumes noresponsibility for changed URLs. If you need updated and current URLs, Avayarecommends that you employ a search engine online. If you do so, use the nameof the product for which you want to locate the documentation as your searchterm.

For Eclipse:

To view the Eclipse online Help in Dialog Designer, click Help > Help Contents .

For additional documentation about Eclipse, seehttp://www.eclipse.org/documentation/main.html

For the Java SDK (Software Developers Kit):

http://java.sun.com/j2se/1.4.2/docs/index.html For Jakarta Tomcat:

http://jakarta.apache.org/tomcat/tomcat-5.0-doc/

For IBM WebSphere:

http://www-1.ibm.com/support/docview.wss?rs=180&context=SSEQTP&uid=swg27005148

For the Microsoft Speech SDK:

http://www.microsoft.com/speech/download/sdk51/

For your operating system:See the operating system online Help or other documentation that came with your operating system.

For databases and JDBC implementation:

http://www.sql.org/

http://www.firstsql.com/tutor.htm

http://java.sun.com/developer/onlineTraining/Database/JDBCShortCourse/jdbc/sql.html

For Web services:

http://www.w3.org/TR/wsdl http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html

For the W3C VoiceXML Recommendation:

http://www.w3.org/TR/voicexml20/
http://www.eclipse.org/documentation/main.htmlhttp://java.sun.com/j2se/1.4.2/docs/index.htmlhttp://jakarta.apache.org/tomcat/tomcat-5.0-doc/http://www-1.ibm.com/support/docview.wss?rs=180&context=SSEQTP&uid=swg27005148http://www-1.ibm.com/support/docview.wss?rs=180&context=SSEQTP&uid=swg27005148http://www.microsoft.com/speech/download/sdk51/http://www.sql.org/http://www.firstsql.com/tutor.htmhttp://java.sun.com/developer/onlineTraining/Database/JDBCShortCourse/jdbc/sql.htmlhttp://java.sun.com/developer/onlineTraining/Database/JDBCShortCourse/jdbc/sql.htmlhttp://www.w3.org/TR/wsdlhttp://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.htmlhttp://www.w3.org/TR/voicexml20/http://java.sun.com/developer/onlineTraining/Database/JDBCShortCourse/jdbc/sql.htmlhttp://java.sun.com/developer/onlineTraining/Database/JDBCShortCourse/jdbc/sql.htmlhttp://www.w3.org/TR/wsdlhttp://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.htmlhttp://www.firstsql.com/tutor.htmhttp://www.w3.org/TR/voicexml20/http://www.eclipse.org/documentation/main.htmlhttp://www-1.ibm.com/support/docview.wss?rs=180&context=SSEQTP&uid=swg27005148http://www-1.ibm.com/support/docview.wss?rs=180&context=SSEQTP&uid=swg27005148http://jakarta.apache.org/tomcat/tomcat-5.0-doc/http://www.microsoft.com/speech/download/sdk51/http://java.sun.com/j2se/1.4.2/docs/index.htmlhttp://www.sql.org/


8/43



For the Speech Recognition Grammar Specification, Version 1.0:

http://www.w3.org/TR/speech-grammar/#AppJ.5

AvailabilityThe Avaya Dialog Designer documentation consists of four outputs:

Getting Started with Avaya Dialog Designer (this document): This PDF file containsinformation needed to:

Install and configure the software considered prerequisite for Dialog Designer

Install Dialog Designer software

Configure Dialog Designer for initial use

Understand the basics of the Dialog Designer GUI Avaya designed this PDF document to be used while installing and configuring Dialog Designer.You can either view it online using Adobe Acrobat or Acrobat Reader, or print it out. Thisdocument is designed so that all the cross-references and hyperlinks work if you use it online.

Getting Started with Avaya Dialog Designer .

The online Help system: All the information needed to use Dialog Designer effectively isincluded in the online (HTML) Help system. This information is available both as:

Context-sensitive Help:- Position the mouse pointer over the element for which you want help.- Press the F1 key.

General documentation:

Click Help (menu) > Help Contents > Dialog Designer documentation > DialogDesigner Developers Guide .

In addition to the information contained in Getting Started with Avaya Dialog Designer , theonline Help provides:

"Best practices" information to help you create the most effective speech applicationspossible

Detailed information about all Dialog Designer features and options, including the

purposes of each and tips for using them most effectively Procedures for using Dialog Designer features and options in speech applications

Answers to frequently asked questions (FAQs)

Once you install and configure Dialog Designer, the online Help is your most immediate andeasily accessible form of information when using Dialog Designer.
http://www.w3.org/TR/speech-grammar/#AppJ.5http://localhost/var/www/apps/conversion/tmp/scratch_5/DD_GettingStarted.pdfhttp://www.w3.org/TR/speech-grammar/#AppJ.5http://localhost/var/www/apps/conversion/tmp/scratch_5/DD_GettingStarted.pdf


9/43

Availability


When you install the Dialog Designer software, the online Help is installed as an additionalEclipse plug-in.

The Avaya Dialog Designer Developers Guide : With the exception of the informationincluded in Getting Started with Avaya Dialog Designer , this PDF document contains the sameinformation as in the online Help system. This guide is delivered in the form of a PDF file, so that

you can easily print out whatever sections or parts you want. However, the PDF file is alsodesigned so that all the cross-references and hyperlinks work when you view it on a computer using Adobe Acrobat or Acrobat Reader.

View the PDF version of the Avaya Dialog Designer Developers Guide .

The Programmer Reference guide: This online documentation is designed for programmerswho need more detailed information about the underpinnings of Dialog Designer. This guideincludes:

A Constants quick reference guide

A Class Hierarchy reference guide

An API Reference guideThis information is available by clicking Help (menu) > Help Contents > Dialog Designer documentation > Programmer Reference .

Where and how to view this documentationCopies of this documentation are available from several locations. You can:

Locate and open it directly from CD-ROM on which you received the Dialog Designer software.

The two PDF guides are located at the root level of the CD-ROM.

Download or view copies from the Avaya online support Web site:

http://support.avaya.com

View it from within the running Dialog Designer software.

To do so, click Help (menu) > Help Contents > Dialog Designer documentation .
http://localhost/var/www/apps/conversion/tmp/scratch_5/DD_DevGuide.pdfhttp://support.avaya.com/http://localhost/var/www/apps/conversion/tmp/scratch_5/DD_DevGuide.pdfhttp://support.avaya.com/


10/43




11/43


Chapter 1: About Avaya Dialog Designer

The Avaya Avaya Dialog Designer is a Java-based tool for creating speech applications thatcomply with VoiceXML Version 2.0. Designed as an Eclipse plug-in, Dialog Designer providesan integrated GUI for the design and implementation of speech applications that can operatewith Avaya IR and Avaya Voice Portal systems.


12/43

About Avaya Dialog Designer



13/43


Chapter 2: Installation and Configuration

Avaya Dialog Designer is packaged, with all required supporting software, on its own installationCD. To set up Dialog Designer to run properly involves two basic steps:

Installing the software

Configuring the workspace

This chapter covers the entire process of installing and configuring Dialog Designer on your system. It also includes a topic on installing the sample applications that come packaged withDialog Designer.

This chapter includes the following topics:

Dialog Designer required software

Hardware requirements Installing Dialog Designer

Configuring Dialog Designer

Installing the sample applications

Dialog Designer required software

Avaya has designed Dialog Designer to run with the following operating systems: Windows XP, Professional or Home editions, Service Pack 2 or later

Windows 2000, Service Pack 4 or later

Dialog Designer requires the following software packages to be installed on your computer:

Java 2 SDK , Version 1.4.1 or later

Jakarta Tomcat servlet engine, Version 5.0, release 28 or later

Note:Note: Dialog Designer applications do not run with Tomcat Version 5.5. You must have

Version 5.0, release 28 or later.

Dialog Designer applications use Tomcat to generate and serve the VoiceXML pages tothe Avaya Voice Browser.

Note:Note: You must have administrative privileges to run Tomcat.


14/43

Installation and Configuration


Microsoft Speech SDK

Dialog Designer uses the Microsoft Speech SDK during application testing, to performautomated speech recognition (ASR) and Text-to-Speech (TTS) functions.

Eclipse , Version 3.0 (.2 or later)

Eclipse is a Java-based integrated development environment (IDE) for softwaredevelopment. This open-source tool is the basis of Dialog Designer, which runs as anEclipse plug-in.

Dialog Designer software plug-in

GEF (Graphical Editing Framework), Version 3.0 (.1 or later)

GEF is a plug-in to Eclipse. Dialog Designer uses GEF for advanced graphical functions.

You can use the Dialog Designer installation CD to install all these software packages on your computer. If you already have some of these packages installed, you do not need to install themfrom the CD. Instead, use the Custom installation option.

Hardware requirementsThe following table lists the minimum and recommended hardware requirements for DialogDesigner:

Installing Dialog Designer

The Dialog Designer installation CD contains all the software you need to install and use DialogDesigner. For the complete list and brief descriptions of the required software, see DialogDesigner required software on page 13 .

Required hardware Minimum Recommended

CPU speed 1 GHz 2 GHz

RAM 512 MB 1 GB

Hard disk drive 40 GB n/a

Monitor resolution 1024 x 768 pixels n/a


15/43

Installing Dialog Designer


Before you install the software

Before you install the software, Avaya recommends that you:

Close any applications that might be open on your computer.

Temporarily disable antivirus software.

Installing the software

To start the software installation:

1. Insert the Dialog Designer installation CD into your CD drive.

After the CD drive door is closed, the InstallShield Wizard should start automatically. If itdoes not, use Windows Explorer to navigate to your CD drive. Locate the file setup.exe at the root level of the CD and double-click the file name. The InstallShield Wizard shouldthen start.

2. Follow the prompts.

When prompted for the type of installation you want to perform, select from among thefollowing options:

Typical - If you select this option, the InstallShield Wizard installs all the requiredsoftware packages.

Custom - With this option, you can select which software packages to install. If youknow that you have some of the required software already installed, and you do notwant to reinstall it, select this option.

The InstallShield Wizard proceeds to copy and install the software packages.

If you choose to install the Java SDK software, the InstallShield Wizard starts a separate

installation wizard for that package. Follow the prompts until the software is installed.If you choose to install the Jakarta Tomcat software, the InstallShield Wizard starts aseparate installation wizard for that package. Follow the prompts until the software isinstalled.

The InstallShield Wizard installs the software, but before you can use it, you must still configurethe Dialog Designer settings. For the procedure to do so, see Configuring Dialog Designer onpage 16 .

Tip:Tip: Avaya recommends that you read the Eclipse "readme" file, as it includes some

valuable information and tips for configuring Eclipse. The readme file is located inthe readme subdirectory of the directory in which you installed Eclipse.


16/43



Configuring Dialog Designer After the Dialog Designer software packages are installed, there are still several steps to take toconfigure the software and make Dialog Designer fully functional:

Create access options. For more information, see Creating access options on page 16 .

Set up the workspace. For more information, see Setting up the workspace on page 17 .

Set Dialog Designer preferences. For more information, see Setting Dialog Designer preferences on page 17 .

If you want to use a microphone to simulate ASR responses, configure the SDK for microphone input. For more information, see Configuring the Microsoft Speech SDK for microphone input on page 19 .

Creating access options

If you chose to have the InstallShield Wizard create a desktop icon during installation, you nowhave an Eclipse icon on your desktop. To open Dialog Designer, which is an Eclipse plug-in,double-click this icon. Eclipse opens to the Welcome page.

Note:Note: If Eclipse fails to start, verify that a Java 1.4 run-time environment (RTE) is being

used to try to start Eclipse. An older version of the Java RTE, such as Java 1.3,can cause Eclipse to fail. To verify that a Java 1.4 run-time environment is beingused:

1. Open an MS DOS Command prompt window.

2. Change directories to the home directory where Eclipse is installed.

3. Enter the command java -version

4. If the RTE is not 1.4 or later, you must change it so that the RTE is Java 1.4 or later.

For more information, see the documentation for the Java RTE.

If you did not have the InstallShield Wizard create a desktop icon, you must navigate to theapplication file to start Eclipse. To do this, use Windows Explorer to locate the directory in whichyou installed the Eclipse software. In this directory, locate the file named eclipse.exe . Thisfile is the program file for Eclipse. To start the Eclipse software, and thus open Dialog Designer,double-click this file. This file is also the file you must use to create your own desktop icon,Quick Launch icon, or other custom access options.


17/43



Setting up the workspace

When you first start Eclipse, the Eclipse Workspace Launcher asks you to select a workspace.Use the Browse button to navigate to the workspace directory where you installed Eclipse. If you used the default installation location for Eclipse, the path to this directory is:

C :\Eclipse\workspace where C: is the drive letter of your primary drive.

If you do not want the Workspace Launcher to query you for a workspace whenever you openDialog Designer, select the check box labeled: Use this as the default and do not ask again .

Tip:Tip: Eclipse first opens in a sized window. Avaya recommends that, to enhance your

use of the workspace and the specialized Dialog Designer views, you maximizethe window.

To open the Dialog Designer perspective and workspace:

1. From the Window menu, select Open Perspective > Speech .

2. (Optional but recommended) To close the Welcome view, click the X on the Welcome tab.

Note:Note: If you want to explore the welcome options later, you can always view them from

the Help menu, Welcome item.

Setting Dialog Designer preferences

To set Dialog Designer preferences:

1. From the Window menu, select Preferences .

Dialog Designer opens the Preferences dialog box.

2. Set workbench options:

a. In the selection pane on the left, double-click Workbench .

Dialog Designer expands the Workbench options list.

b. In the options on the right, verify that the Build automatically option is selected.

c. In the selection pane on the left, select Perspectives .

d. In the options on the right, verify that the following options are selected:

Open a new perspective - In the same window

Open a new view - Within the perspective

Switch to associated perspective when creating a new project - Prompt

e. In the options on the right, in the Available perspectives pane:


18/43



1. Select Speech .

2. Click Make default .

3. Set Avaya Dialog Designer options:

Note:Note: This step is required only if you are behind a firewall and use a proxy server to

gain access to the Internet. If you do not use a proxy server, skip to Step 4. If youdo use a proxy server for Internet access, you must perform the following actions,even if you have proxy options set in Microsoft Internet Explorer or other Webbrowser.

a. In the selection pane on the left, select Avaya Dialog Designer .

b. Select the check box labeled Enable HTTP proxy connection .

c. (Optional) Select the check box labeled Bypass proxy server for local addresses .

d. In the field labeled HTTP proxy host address , enter the address of your proxy server.

e. In the field labeled HTTP proxy host port , enter the port to use for the proxy server.

Tip:Tip: If you do not know the address and port to use for your proxy server, you can

usually find them by examining the proxy settings you use for your standard Webbrowser. If not, contact your local network administrator for assistance.

4. Set Tomcat options:

a. In the selection pane on the left, select Tomcat .

b. In the options on the right, set the path for Dialog Designer to find Tomcat, byperforming one of the following actions:

If you know the path to the Tomcat software, enter it in the Tomcat home field. If you do not know the path to enter, click Browse . Then navigate to the directory

where Tomcat is installed and select it in the Browse for Folder dialog.

If you used the default installation location, the path is:

C :\Program Files\Apache Software Foundation\Tomcat 5.0

where C: is the drive letter of your primary drive.

Click OK .

c. Verify that the Tomcat home and the Contexts directory fields are now populatedwith the correct paths.

If the Contexts directory field has not been populated with the correct path, clickBrowse to navigate to the correct path.


19/43



If you used the default installation location, the path is:

C :\Program Files\Apache Software Foundation\Tomcat 5.0\conf\Catalina\localhost

where C: is the drive letter of your primary drive.

Note:Note: The correct path must take you to the ... \Catalina\localhost directory.

5. Set Java options:

a. In the selection pane on the left, double-click Java and then, in the expanded list,select Installed JREs .

b. In the options on the right, verify that the jre1.4. x option is selected. If not, select it.

Note:Note: If the jre1.4. x option does not appear in this list, you must locate it. You can also

select another jre* option, as long as it is version 1.4 or later. If no such optionappears in the list, you must either install the JRE software, or locate where you

have it installed already. Then add it to the list.6. To save your preferences and exit the Preferences dialog box, click OK .

Configuring the Microsoft Speech SDK for microphone input

Dialog Designer uses the Microsoft Speech SDK to handle ASR input from a microphone duringapplication simulation. Before you can use the Microsoft Speech SDK for ASR input, you mustconfigure the SDK to use the microphone. This process needs to be done only once.

The procedure to configure the Microsoft Speech SDK to handle microphone input is the same,whether your operating system is Windows XP or Windows 2000.

To configure the Microsoft Speech SDK:

1. Open the Control Panel.

2. Double-click the Speech option.

Windows opens the Speech Properties dialog box.

3. With your microphone plugged in and turned on, speak into the microphone.

The Level indicator should show that the system is receiving microphone input. If it doesnot, click Audio Input and correct your audio input source settings.

4. To further adjust the settings for your microphone, click Configure Microphone and followthe Microphone Wizard prompts.

5. In the Speech Properties dialog box, click OK .


20/43



Installing the sample applicationsDialog Designer includes several sample applications that you can use both to:

See how finished applications look and operate.

Examine how the many features of Dialog Designer work.

To install and run the sample applications:

1. Locate the sample applications directory on your Dialog Designer installation CD.

2. In that directory, locate and double-click the ZIP file labeled SampleApplications.zip .

3. In the ZIP file, locate and double-click the Word file named Dialog Designer SampleApplications.doc .

4. Use the instructions in that document to finish installing and configuring the sampleapplications.


21/43


Chapter 3: The Dialog Designer GUI

Because Avaya Dialog Designer is designed as a set of Eclipse plug-ins, it uses the Eclipsedevelopment environment and GUI. For this reason, Avaya recommends that, before you startto use Dialog Designer to create speech applications, you:

Familiarize yourself with Eclipse GUI concepts and terminology, if you have not alreadydone so.

To learn about Eclipse GUI concepts and terminology, Avaya recommends that you readthrough the "Concepts" section of the Eclipse Workbench User Guide . For the procedureto view this information, see Viewing the Eclipse Workbench User Guide, "Concepts"section .

Understand the ways in which Dialog Designer applies and expands on Eclipse conceptsand terminology.

For more information, see The Dialog Designer workbench on page 22 .

Learn about the menu and toolbar items that are specifically applicable to Dialog Designer.

For more information, see Dialog Designer menu and toolbar options on page 32 .

Viewing the Eclipse Workbench User Guide , "Concepts"section

To view the Eclipse Workbench User Guide online Help:

1. Open Dialog Designer.

2. On the Help menu, click Help Contents .

The system displays the Help - Eclipse Platform window.

3. In the Contents navigation pane, click Workbench User Guide .

4. Double-click Concepts .


22/43

The Dialog Designer GUI


The Dialog Designer workbench

Note:Note: This section assumes you are already familiar with Eclipse concepts and

terminology. If you are not, Avaya recommends that you review them now. For theprocedure to view that information, see Viewing the Eclipse Workbench User Guide, "Concepts" section on page 21 .

The Dialog Designer workbench was designed as a speech project perspective in Eclipse. Thelayout of the views and workspace are optimized to assist you in the creation of speechapplication projects. The following descriptions can give you a clear understanding of how theseenvironmental elements are arranged in Dialog Designer and why.

Of course, as with any Eclipse perspective, you are free to arrange perspective elements anyway you want and you can save those changes. If you do so, the following descriptions might nolonger be applicable.

Note:Note: The following descriptions include only the views and editors available in the

standard Dialog Designer speech perspective. They do not include the menusand toolbar items. For a discussion of the menu and toolbar items, see DialogDesigner menu and toolbar options on page 32 .

Starting in the upper-left corner of the window and working left-to-right and top-to-bottom, theDialog Designer speech perspective consists of the following major elements:

The Navigator view on page 22

The Editor view on page 24

The Outline view on page 25

The Avaya Voice Browser view on page 26 The Problems view on page 30

The Tasks view on page 30

The Avaya Properties view on page 30

The Console view on page 31

The status bar on page 31

The Navigator viewLocated by default in the upper-left corner of the window, the Navigator view is a standardEclipse view. It provides a hierarchical view of the resources in the Dialog Designer speechproject.


23/43



Of special interest to Dialog Designer users:

When you create a speech project in Dialog Designer, it automatically creates thefollowing standard folders in the project folder:- connectivity - This folder contains any database or Web service operations files you

create as part of your project.

- data - This folder contains mostly files that are derived from other files. For example,when you create a grammar, the Grammar File Editor creates a *.gram file thatcontains the metadata for the grammar. When you generate the project, DialogDesigner creates a *.grxml file that contains the actual XML grammar file. This *.grxmlfile is derived from the *.gram file.

Usually, the derived files in this folder are hidden, and you do not see them in theNavigator view.

! Important:Important: Do not attempt to manually edit these files.

This folder also contains the log folder. The log folder is where log files created duringapplication testing are written. You can view these log files, if necessary, as an aid indebugging your applications.

Finally, this folder also contains a temp folder where any messages you record duringapplication testing are stored.

- flow - This folder contains the main.flow file. This file is the core of your call flowapplication (speech project). It is built and edited using the Call Flow Editor. For information about the Call Flow Editor, see Chapter 5: Working with the Call FlowEditor on page 57 .

- icons - This folder contains several icons used for Dialog Designer. Do not delete or alter these icons.

- languageName - This folder contains all the phrase, prompt, and grammar definitionfiles for your speech project. Whenever you create or import a phrase file, a promptfile, or a grammar file, Dialog Designer places the file in the appropriate subfolder of this folder.

The actual name of this folder is the name assigned to the project primary language.- WEB-INF - This folder contains all the output files created whenever you generate or

build the project. Essentially, these files are what get packaged when preparing theapplication for deployment.

- work - This folder is used as a temporary folder by the Tomcat servlet engine. Do notattempt to manually edit the contents of this folder.

You can open the editors for many project resources, such as phrases, prompts, andgrammars by double-clicking the file in the Navigator view. For example, to open aspecific phrase in the Phrase File Editor, you can double-click the *.phrase file.
http://dd05_callfloweditor.pdf/http://dd05_callfloweditor.pdf/http://dd05_callfloweditor.pdf/http://dd05_callfloweditor.pdf/http://dd05_callfloweditor.pdf/


24/43



You can also perform many other actions on selected project resources by right-clickingthe desired resource. Then, select the appropriate action from the pop-up context menu.

Tip:Tip: One especially useful option of these context menus is the ability to generate

individual files or project resources. For example, to regenerate a projectgrammar without having to regenerate the entire project, right-click on the *.gramfile in the Navigator view. Then click Generate from the pop-up context menu.

For more information about the Navigator view in Eclipse see the topic "Navigator view" in theEclipse Workbench User Guide online Help.

The Editor view

By default, the Editor view is located in the upper-right area of the window. The main area of thisview is called the workspace . The workspace is where most of the real work of developing andbuilding a speech application project takes place. Because of this, the Editor view is the largestview in Dialog Designer. What you see and what you can do in this view depends largely onwhat editor you have open at the time. For more information, see The Dialog Designer editors on page 24 .

Using the Editor view tabs, you can switch back and forth quickly and easily between openeditors and between pages within editors. For more information, see Editor view tabs onpage 25 .

The Dialog Designer editors

The following list offers a high-level overview of the editors available in Dialog Designer:

Call Flow Editor - The primary editor for Dialog Designer. In the Call Flow Editor, youplace nodes and connect them, to create the call flows that direct the caller experience.For more information, see Chapter 5: Working with the Call Flow Editor on page 57 .

Phrase File Editor - Use this editor to modify phrase meta data, such as phrase text,relevant comments, and search keywords. You can also record phrases, saving them in*.wav file format. For more information, see Using the Phrase File Editor on page 80 .

Prompt File Editor - Use this editor to define and modify prompts, from very simpleannouncements to very complex prompts involving variables, conditions, and logic. For more information, see Using the Prompt File Editor on page 94 .

Variable Editor - Use this editor to create, define, and modify variables, and to viewthe variables that exist in the current project. For more information see Using the VariableEditor on page 113 .

Grammar File Editor - Use this editor to define and modify grammars, using a rangeof parameters and options. For more information, see Defining and modifyinggrammars on page 124 .
http://dd05_callfloweditor.pdf/http://dd05_callfloweditor.pdf/http://dd06_phrases.pdf/http://dd06_phrases.pdf/http://dd07_prompts.pdf/http://dd07_prompts.pdf/http://dd08_variables.pdf/http://dd08_variables.pdf/http://dd08_variables.pdf/http://dd09_grammars.pdf/http://dd09_grammars.pdf/http://dd09_grammars.pdf/http://dd09_grammars.pdf/http://dd09_grammars.pdf/http://dd08_variables.pdf/http://dd08_variables.pdf/http://dd07_prompts.pdf/http://dd06_phrases.pdf/http://dd05_callfloweditor.pdf/


25/43



Database Operation File Editor - Use this editor to define and modify the way your project works with selected databases. For more information, see Using the DatabaseOperation File Editor on page 158 .

Web Service Operation File Editor - Use this editor to define and modify the wayyour project works with selected Web services. For more information, see Using the WebService Operation File Editor on page 171 .

Event Type Editor (available only from within the Call Flow Editor) - Use this editor todefine and modify custom events and how your project implements them. For moreinformation, see Using the Event Type Editor on page 178 .

Editor view tabs

Dialog Designer (Eclipse) uses two types of tabs in the Editor view:

Editor tabs (or top tabs) - Whenever you open an editor, the Editor view displays a tab for that editor in the view toolbar. You can switch quickly and easily between open editors byclicking these tabs. Each tab displays an icon representing which type of editor isassociated with that tab, along with the name of the project element currently open.

You can close the editor associated with a given tab by clicking the X on the tab. When theeditor closes, the Editor view no longer displays the tab for that editor.

Note:Note: One exception to this rule of thumb is the Event Type Editor. This editor operates

a little differently, because it actually opens within the Call Flow Editor. To closethis editors, click the small x in the upper-right corner of the Call Flow Editor workspace.

Page tabs (or bottom tabs) - Some editors are multiple page editors. That is, they havemore than one workspace page associated with them. When this is the case, the Editor

view displays a page tab at the bottom of the view for each workspace page available inthe active editor.

For example, when the Phrase File Editor is active, the Phrase and Audio page tabs bothbecome available along the bottom toolbar of the Editor view.

The Outline view

Located by default in the lower-left corner of the window, the Outline view is a standard Eclipseview. In Dialog Designer, the Outline view functions only when the Call Flow Editor is the activeeditor.

Note:Note: The Outline view is active also when a Java ( *.java ) file is being edited. That,

however, is considered part of the Eclipse framework and not specifically DialogDesigner.
http://dd11_databases.pdf/http://dd11_databases.pdf/http://dd11_databases.pdf/http://dd12_webservices.pdf/http://dd12_webservices.pdf/http://dd12_webservices.pdf/http://dd13_eventtypes.pdf/http://dd13_eventtypes.pdf/http://dd13_eventtypes.pdf/http://dd12_webservices.pdf/http://dd12_webservices.pdf/http://dd11_databases.pdf/http://dd11_databases.pdf/


26/43



When the Call Flow Editor is active, the Outline view displays a thumbnail presentation of thecall flow. If the call flow is a large and complex one, you can use the thumbnail presentation tomove quickly to the part of the call flow you want to see in the main workspace. As you click anddrag the shaded area in the Outline view, the main workspace simultaneously updates topresent the full size view of the shaded area.

The Outline view also provides an option to see a list of all the bookmarks in your call flow. Youcan use this list to navigate between bookmarks in a call flow. This can be useful when youhave a very large and complex call flow.

To use the Bookmark option in the Outline view, click the Bookmark icon in the Outline viewtoolbar. Dialog Designer displays a list of all the bookmarks in your call flow. To navigate to aparticular bookmark, click the bookmark you want to view in the main workspace. The focus inthe main workspace of the Call Flow Editor shifts to display the bookmark you clicked. For moreinformation about the Bookmark item, see Bookmark on page 66 .

For more information about the Outline view in Eclipse, see the topic "Outline view" in theEclipse Workbench User Guide online Help.

The Avaya Voice Browser view

Unique to Dialog Designer, the Avaya Voice Browser view offers the display and controls for the Avaya Voice Browser. The Avaya Voice Browser is a VoiceXML interpreter program. DialogDesigner uses the Avaya Voice Browser to test applications by simulation. The Avaya VoiceBrowser view includes three tabbed secondary views that present different aspects of thebrowsers operation:

The Call tab

The Input tab

The Log tab The Script tab

By default, Dialog Designer displays the Avaya Voice Browser view in a tabbed notebook, ontop of the Problems view and the Tasks view, in the lower-center area of the window.

The Call tab

The Call tab is the primary (default) tab for the Avaya Voice Browser. Use this tab to start or endthe simulation of the project and to set presimulation conditions.

This tab includes the following options:

Available Projects - Click to select the project you want to simulate. If multiple projectsare available, you can select only one at a time.

Calling Number - Simulates ANI. Enter the number that represents the originatingtelephone number in this field. Use numbers only.
http://dd05_callfloweditor.pdf/http://dd05_callfloweditor.pdf/http://dd05_callfloweditor.pdf/


27/43



Note:Note: If you use characters other than numbers, the Avaya Voice Browser passes them

along exactly as you enter them in this field. However, in a live system with adeployed application, only numbers are passed to the application. For thisreason, Avaya recommends that you use only numbers in this field duringsimulations.

Called Number - Simulates DNIS. Enter the number that represents the telephonenumber the caller must dial to get to this application. Use numbers only.

Note:Note: If you use characters other than numbers, the Avaya Voice Browser passes them

along exactly as you enter them in this field. However, in a live system with adeployed application, only numbers are passed to the application. For thisreason, Avaya recommends that you use only numbers in this field duringsimulations.

Input Parameters - Used to simulate input expected from another application module.The format of this simulated input must match the expected format.

Start Call - Click to start the simulation. This button is active only when a project isselected for simulation.

Note:Note: If there are any errors in the project you want to simulate, this button is inactive.

End Call - Click to end the simulation before it is finished running. This button is activeonly when a project is in simulation mode.

Note:Note: This action is different from that of the Hang Up simulation button on the Input

tab. This button stops the application wherever it is when you click it. The HangUp button on the Input tab simulates a caller being disconnected either by

hanging up or some other means.

The Input tab

The Avaya Voice Browser (AVB) uses the Input tab to display progress and collect responseinput during application simulations. Use this tab to provide simulated caller responses and setup run-time error conditions. Error conditions include incorrect or no responses from callers,unexpected caller hang-ups, and other potential problem situations.

This tab includes the following options:

Telephone keypad - Use the twelve keys on the left side of the view to simulate caller DTMF (touchtone) input. When you click the keys you want to respond with, AVB displaysthe characters in the field just beneath the keypad. After clicking the keys you want torespond with, you must click Send for the simulation to continue.

Send - Click to submit simulated DTMF responses to the browser for processing. Youmust click this button after clicking the desired keys on the telephone keypad for thesimulation to continue.


28/43



Call Active - When the "LED" is green, it means that a call simulation is in progress. Redmeans that a call simulation is not in progress.

Waiting ASR - When the "LED" is green, it means that the simulation is waiting for aspoken response. To simulate a spoken response, you must have the Microsoft SpeechSDK installed and configured properly.

Note:Note: The Microsoft Speech SDK should have been installed during the Dialog

Designer installation process. To configure the SDK for microphone input, seeConfiguring the Microsoft Speech SDK for microphone input on page 19 .

Waiting DTMF - When the "LED" is green, it means that the simulation is waiting for aDTMF response. To simulate a DTMF response, click the keys on the keypad thatcorrespond with the response expected from the caller, and then click Send .

No Input - Click this button to simulate a situation in which there is no response from thecaller.

No Match - Click this button to simulate a situation in which the response of the caller

does not match any expected input. Record End - This button is active only when the simulation requires a caller to respond

by recording something. The Dialog Designer of Avaya Voice Browser does not detect aterminating silence. Use this button to simulate a terminating silence and signal the VoiceBrowser that you are finished recording.

Tip:Tip: You can also simulate the use of DTMF key presses to end recordings. To do this,

set the DTMF Terminate property of the Record item to True . Then, to simulatethis, use the telephone keypad to click touchtone keys and click Send . For information about the Record item, see Record on page 327 .

Hang Up - Click this button to simulate a caller hanging up. In this case, the applicationproceeds to the next node.

Xfer Status - Simulates the results of a call transfer action. This drop-down list becomesavailable only when the application contains a Bridged Transfer node. Result options youcan simulate include:- No Answer - Simulates a situation in which there was no answer from the party being

called. In this case, Dialog Designer assigns a value of noanswer to the Value field of the applicable Bridged Transfer variable. You can then use the value of that variablefield to redirect the call flow.

In deployed applications, the Connect Timeout property of the Bridged Transfer item

determines the amount of time the system waits for an answer before it returns controlof the call to the application. For more information about the Bridged Transfer itemand its associated variable, see Bridged Transfer on page 239 .
http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/


29/43



- Busy - Simulates a situation in which the line of the party being called is busy. In thiscase, Dialog Designer assigns a value of busy to the Value field of the applicableBridged Transfer variable. You can then use the value of that variable field to redirectthe call flow. For more information about the Bridged Transfer item and its associatedvariable, see Bridged Transfer on page 239 .

- Disconnect - Simulates a situation in which the party being called hangs up but theoriginal caller stays on the line. In this case, Dialog Designer assigns a value of far_end_disconnect to the Value field of the applicable Bridged Transfer variable.You can then use the value of that variable field to redirect the call flow. For moreinformation about the Bridged Transfer item and its associated variable, see BridgedTransfer on page 239 .

- Maxtime - Simulates a situation in which the bridged call exceeds the maximumallowable time for the conversation and the system disconnects the transfer call. In thiscase, Dialog Designer assigns a value of maxtime_disconnect to the Value field of the applicable Bridged Transfer variable. You can then use the value of that variablefield to redirect the call flow.

In deployed applications, the Maximum Time property of the Bridged Transfer itemdetermines the maximum amount of time that a bridged transfer call can last beforethe system returns control of the call to the application. For more information about theBridged Transfer item and its associated variable, see Bridged Transfer onpage 239 .

Avaya Voice Browser progress display - On the right side of this browser tab, there is adisplay-only pane which shows progress messages that are generated as the simulationproceeds. These messages tell you what the Avaya Voice Browser is doing as it simulatesthe execution of the application. This can be particularly helpful when debuggingapplications.

The Log tabThe Log tab is a read-only display of the activity log created during simulations. This activity logrecords the output from the Avaya Voice Browser (AVB). You can use this to help debugapplications, particularly if you are creating custom VoiceXML code in your application.

The Script tab

If you do not want to simulate caller responses and other inputs during simulation, you cancreate an XML script to simulate them automatically when you run the simulation. You can alsouse scripts to simulate IC and CTI connector functions.

For more information about creating and using scripts, including guidelines, instructions, andsamples, see Appendix E: Creating Scripts for Testing on page 383 .
http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddae_scripts.pdf/http://ddae_scripts.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/http://ddae_scripts.pdf/http://ddaa_paletteoptions.pdf/http://ddaa_paletteoptions.pdf/


30/43



The Problems view

The Problems view automatically displays any errors, warnings, or informational messagesgenerated while saving a project or any of its elements. At the same time, Dialog Designer displays a Code Generation error message, unless you click Do not show me this message inthe future. This view also shows any errors generated while compiling the Java-code.

In most cases, if you click the error, warning, or informational message entry in this view, DialogDesigner directs the focus to the exact location where the problem occurs. This feature makes iteasier for you to debug your application and fix the problem.

By default, Dialog Designer displays the Problems view in a tabbed notebook, along with theAvaya Voice Browser view and the Tasks view, in the lower-center area of the window.

The Tasks view

The Tasks view is a standard Eclipse view. It automatically displays tasks related to varioustypes of errors that might occur, such as Java syntax errors. You can also manually add tasks tothis list, for things you do not want to forget to take care of.

For more information about the Tasks view in Eclipse, see the topic "Tasks view" in the EclipseWorkbench User Guide online Help.

By default, Dialog Designer displays the Tasks view in a tabbed notebook, along with theAvaya Voice Browser view and the Problems view, in the lower-center area of the window.

The Avaya Properties viewThe Avaya Properties view is a modification of the standard Eclipse Properties view. In alayout optimized for Dialog Designer, it displays property names and values for nodes, paletteoptions, or other items. The properties available for editing vary according to the editor, node, or item you are working with. For more information about the properties you can edit for aparticular node, option, or other item, see the online Help topic for that node, option, or item.

For more information about the standard Properties view in Eclipse, see the topic "Propertiesview" in the Eclipse Workbench User Guide online Help.

By default, Dialog Designer displays the Avaya Properties view in a tabbed notebook, alongwith the Console view, in the lower-right area of the window. Dialog Designer brings it to the

foreground whenever: You click a node or item that requires or allows properties to be set here.

You open a workspace page for a node or other item.

You click the Avaya Properties tab.


31/43



The Console view

The Console view displays information about the Tomcat server status and activity. If you havethe debug output for tracing function turned on, this view also displays the VoiceXML outputgenerated by the application. This information is read only, but it might be helpful in debuggingapplications, especially if you can read and understand VoiceXML code.

To turn on the debug output for tracing function:

1. In the Window menu, click Preferences .

The system displays the Preferences window.

2. In the navigation pane on the left, click Avaya Dialog Designer > Avaya Voice Browser .

3. Among the options on the right side of the Preferences window, verify that the check boxlabeled Enable logging of tracing output is selected.

4. Click OK .

Tip:Tip: With this function turned on, Dialog Designer not only displays the VoiceXML

output in the Console view, but also writes the output to a trace log file. This file islocated at applicationName /data/log/tracelog- yyyy-mm-dd .log ,where applicationName represents the top level application directory, andyyyy-mm-dd represents the year-month-date that the file was generated. Notethat each new entry in this log file is appended to the end of whatever is alreadythere. So, if you are doing many simulations, the log file can become quite large.To view the contents of this log file, locate the file in the Navigator pane anddouble-click the file name.

By default, Dialog Designer displays the Console view in a tabbed notebook, along with theProperties view, in the lower-right area of the window. The Console view is brought to theforeground whenever you start Tomcat or click the Console tab.

The status bar

The status bar runs along the bottom of the Dialog Designer workbench window. You can usethis bar to create "fast views". For more information about fast views, see the topic "Fast views"in the Eclipse Workbench User Guide online Help.

The right side of the status bar also displays a progress indicator whenever you generate andbuild a project. This can be a helpful guide when compiling a large project, especially.


32/43



Dialog Designer menu and toolbar optionsThere are several main menu and toolbar options that are specific to Dialog Designer. Thefollowing table presents a quick reference and summary of these options.

Note:Note: This table presents only the options that are specific to Dialog Designer. Generic

Eclipse options are not included.

Icon Descriptor Function/Comments Where available

Speech projectwizard

Opens the wizard to create aspeech project.

File > New menu Main toolbar Navigator view context

(right-click) menu

Databaseoperation filewizard

Opens the wizard to create adatabase operation file. File > New menu Main toolbar Navigator view context

(right-click) menu

Grammar filewizard

Opens the wizard to create agrammar file.


(right-click) menu

Phrase filewizard

Opens the wizard to create aphrase file.

File > New menu Main toolbar Navigator view context(right-click) menu

Prompt filewizard

Opens the wizard to create aprompt file.


(right-click) menu

Web serviceoperation filewizard

Opens the wizard to create aWeb service operation file.


(right-click) menu

Restart Tomcat Restarts the Tomcat servletengine, which is required tosimulate applications in DialogDesigner.

Tomcat menu Main toolbar


33/43

Dialog Designer menu and toolbar options


Start Tomcat Starts the Tomcat servletengine, which is required tosimulate applications in DialogDesigner.


Stop Tomcat Stops the Tomcat servletengine, which is required tosimulate applications in DialogDesigner.


Noicon

Update contextdefinition option

Updates the Tomcat server with the current applicationinformation, known as thecontext definition. This actionis sometimes required whenyou update the application butchanges do not getcommunicated to the Tomcatserver. One indication that thismight be required is if you geta "General Error 404"message.

Navigator view context(right-click) menu when theproject is selected

Noicon

Generate option Generates the project code. Project menu Navigator view context

(right-click) menu whenthe project is selected

Event Type

Editor

Opens the Event Type Editor. Main toolbar, Call Flow Editor

only

Add row after Adds a row to a grammar table, inserting the new rowafter the selected row.

Grammar File Editor only,Grammar menu

Add row before Adds a row to a grammar table, inserting the new rowbefore the selected row.


Add column after Adds a column to a grammar table, inserting the newcolumn after the selectedcolumn.




34/43



Add columnbefore

Adds a column to a grammar table, inserting the newcolumn before the selectedcolumn.


Delete row Deletes the selected row froma grammar table.


Delete column Deletes the selected columnfrom a grammar table.




35/43


Glossary

ADR See application detail record (ADR) .ANI See automatic number identification (ANI) .

API See application program interface (API) .

application detailrecord (ADR)

Data records which contain historical information about an application used aspart of a session. These records include information such as the session IDnumber, a timestamp, and a "friendly name" string determined by the developer who created the application.

application programinterface (API)

A set of routines, protocols, and tools for building software applications. A good API makes it easier to develop a program by providing all the building blocks.

application server A computer on which the Avaya Dialog Designer speech application resides

and runs. This computer is also where the Dialog Designer run-time librariesare installed, thus making it possible to run Dialog Designer applications on thatserver. The IVR system must be configured to start the speech application fromthis location.

ASR See automated speech recognition (ASR) .

automatic number identification (ANI)

A service that provides the originating telephone number of a call coming in tothe system.

automated speechrecognition (ASR)

Technology that employs a computer to recognize spoken words and respondappropriately.

call flow As implemented in speech applications, the call flow determines how a call is

handled when it enters an interactive voice response system, based on optionsoffered to callers and their responses to those options.

CCXML Call Control eXtensible Markup Language.

An emerging XML specification, being developed to work in conjunction withVoiceXML and which addresses some of the technical limitations of VoiceXML.It enables the processing of asynchronous events, filtering and routing of incoming calls, and placement of outbound calls. Note that it is not intended toreplace VoiceXML but rather to supplement it. For more information, see IanMoraess excellent article, "VoiceXML, CCXML, SALT: Architectural Tools for Enabling Speech Applications," on the Internet.

Computer

TelephonyIntegration (CTI)

Software technology that integrates the use of telephones and computers

without the need for special telephones, connectors, computer circuit packs, or other specialized hardware.

CTI See Computer Telephony Integration (CTI) .


36/43

dialed number identification service (DNIS)


dialed number identificationservice (DNIS)

A service that identifies for the receiving system what telephone number wasdialed by the caller. In the Voice Portal system this is often used to direct thecall to a particular speech application, which is identified with that dialednumber.

DNIS See dialed number identification service (DNIS) .

DTMF See dual tone multi-frequency (DTMF) .dual tonemulti-frequency(DTMF)

The system used by touchtone telephones, DTMF assigns a specific frequency(consisting of two separate tones) to each telephone key on the keypad, so thatit can easily be identified by a microprocessor.

Eclipse A Java-based open-source extensible IDE (integrated developmentenvironment) that provides application developers a feature-rich interface todevelop their applications. Avaya Dialog Designer is designed as a set of Eclipse plug-in modules that make it possible for application developers todesign and build speech applications without having to write the code manually.

gateway A network point that acts as an entry point to another network. In the context of Avaya Dialog Designer and VoIP applications, a gateway is the entry point,often associated with one or more switches, to the interactive voice response(IVR) system application environment.

grammar In the context of Dialog Designer, a grammar is .

H.323 A hierarchical, IP-based telephony standard for connecting IP telephones andspeech applications to switches.

IC See Interaction Center (IC) .

IDE See integrated development environment (IDE) .

integrateddevelopmentenvironment (IDE)

A software application that usually provides a GUI environment, a text and/or code editor, a compiler and/or interpreter, and a debugger. This environmentmeans that application or web developers can develop, test, and build their applications or Web sites within a single integrated space.

Interaction Center (IC)

A multichannel contact management platform that enables businesses to alignreal-time contact center operations with business objectives.

interactive voiceresponse (IVR)system

A system, such as Avaya Voice Portal or Avaya IR, in which callers interact witha self-service application to get information, conduct transactions, or help withproblems.

IVR system See interactive voice response (IVR) system .

JDBC An application program interface (API) specification in which programs writtenin Java connect with and gain access to data contained in popular databaseprograms using Structured Query Language (SQL) .

localization The process of modifying an application to operate and be understood in adifferent language, or locale. This usually involves modifying any phrases,prompts, and grammars associated with an application.


37/43

SSML


notebook (Also known as a tabbed or stacked notebook) In the Eclipse context, anotebook is a set of views "stacked" on top of one another as a space savingmeasure. The views in the notebook are accessible by clicking tabs arrangedalong the top of the notebook. For more information, see the Eclipsedocumentation.

Open Speech DialogModule (OSDM)

Speech application modules produced by ScanSoft software products, similar to those you can produce with Avaya Dialog Designer. You can use OSDMs inDialog Designer applications.

OSDM See Open Speech Dialog Module (OSDM) .

palette In the Avaya Dialog Designer Editor views, this is the pane to the left of theview, in which editor options are displayed and selected.

Real-time Transfer Protocol (RTP)

A protocol for transmitting "real-time" data, such as audio or video data, acrossthe Internet. This protocol does not guarantee "real-time" delivery of such data,but it does provide mechanisms to support data "streaming."

RTP See Real-time Transfer Protocol (RTP) .

SCE See service creation environment (SCE) .service creationenvironment (SCE)

A set of software tools used to develop, test, and debug speech applications. Avaya Dialog Designer is an SCE.

servlet A small program that runs on a server, often Java-based.

servlet engine A program that coordinates the overall operation and integration of a number of servlets. In the context of Avaya Dialog Designer, the supported servlet enginesare Apache Jakarta Tomcat and IBM WebSphere.

Session InitiationProtocol (SIP)

A signaling protocol for the Internet that makes it possible to set upconferencing, telephony, events notification, and instant messaging. Within aVoIP framework, it initiates call setup, routing, authentication, to endpointswithin an IP domain.

SIP See Session Initiation Protocol (SIP) .

speech user interface (SUI)

Any software interface in which the user interacts with the system using speechcommands and audio prompts.

speech recognition See automated speech recognition (ASR) .

speech synthesis See text-to-speech (TTS) .

SQL See Structured Query Language (SQL) .

SSL Secure Sockets Layer.

A protocol for transmitting private data securely over the Internet. Byconvention, URLs that use SSL require a connection using the HTTPS protocol,rather than just HTTP.

SSML Speech Synthesis Markup Language.


38/43

stacked notebook


A W3C standard designed to provide an XML-based markup language for assisting with the generation of synthetic speech in Web and other applications.The essential role of the markup language is to provide authors of synthesizable content a standard way to control aspects of speech such aspronunciation, volume, pitch, rate, and so forth, across differentsynthesis-capable platforms.

stacked notebook See notebook .

Structured QueryLanguage (SQL)

A standard interactive and programming language for getting data to and from adatabase.

SUI See speech user interface (SUI) .

tabbed notebook See notebook .

TDD See Telecommunications Display Device (TDD) .

TelecommunicationsDisplay Device(TDD)

Sometimes designated as a teletypewriter (TTY) device, a telephone equippedwith a keyboard and display, used by hearing- or speech-impaired callers tosend and receive typed messages.

telephone user interface (TUI)

Any software interface in which the user interacts with the system using atelephone or similar device.

teletypewriter (TTY)device

See Telecommunications Display Device (TDD) .

text-to-speech (TTS) Technology by which information in text format is rendered as audio outputusing a speech synthesis engine to simulate human speech.

TTS See text-to-speech (TTS) .

TTY See Telecommunications Display Device (TDD) .

TUI See telephone user interface (TUI) .

VoiceXML (Sometimes presented as VXML) Voice eXtensible Markup Language. A specification which provides for a user to interact with Internet-basedresources using voice recognition technology. Instead of a typical Web browser that requires a combination of HTML, keyboard, and mouse device, VoiceXMLrelies on an Internet voice browser and/or telephone. Using VoiceXML, the user interacts with the Web "page" by listening to audio outputs (either pre-recordedor using a technology such as TTS) and by submitting input in the form of theusers natural speaking voice and/or manual responses, such as telephone keypresses.

Web service A standardized way of offering Web-based applications or services. Since theyare Web- and standards-based applications, delivered over the Internet, Web

services make it possible for organizations to communicate and share data thatuse different file formats and programming languages.

workspace In Avaya Dialog Designer, the area within the Editor view used to build thefunctionality for the selected editor. For example, in the Call Flow Editor, this isthe space to the right of the palette , in which you place the nodes that representapplication functions.


39/43


WSDL Web Services Description Language.

An XML-formatted language used to describe a Web services capabilities.

XML eXtensible Markup Language.

A specification for the presentation of Internet documents, one which expandson the capabilities of HTML. A pared down version of SGML (StandardGeneralized Markup Language), XML makes it possible for designers to createtheir own customized tags, which in turn makes it possible to do things over theInternet that cannot be done using simple HTML.


40/43



41/43


Index

Index

Aaccess options

creating . . . . . . . . . . . . . . . . . . . . 16accessing

Eclipse documentationWorkbench User Guide , "Concepts" section . . 21

ANI, see automatic number identification (ANI)audience, intended for Dialog Designer documentation . 5automated speech recognition (ASR)

simulating responses . . . . . . . . . . . . . . 27 Avaya Properties view . . . . . . . . . . . . . . . 30 Avaya Voice Browser

Call tab . . . . . . . . . . . . . . . . . . . . 26Input tab . . . . . . . . . . . . . . . . . . . . 27Log tab . . . . . . . . . . . . . . . . . . . . . 29Script tab . . . . . . . . . . . . . . . . . . . . 29scripts for simulations . . . . . . . . . . . . . . 27view . . . . . . . . . . . . . . . . . . . . . . 26

AVB, see Avaya Voice Browser

BBookmark

option in Outline view . . . . . . . . . . . . . . 25build indicator . . . . . . . . . . . . . . . . . . . 31

CCall Active display, Avaya Voice Browser . . . . . . 27Call tab, Avaya Voice Browser . . . . . . . . . . . 26code generation indicator . . . . . . . . . . . . . . 31Compact installation . . . . . . . . . . . . . . . . 14configuring

Java Runtime Environment (JRE) . . . . . . . . 17Microsoft Speech SDK for microphone input . . . 19Tomcat . . . . . . . . . . . . . . . . . . . . . 17workspace . . . . . . . . . . . . . . . . . . . 16

connectivity folder Navigator view . . . . . . . . . . . . . . . . . 22

Console view . . . . . . . . . . . . . . . . . . . 31context-sensitive Help for Dialog Designer . . . . . . . 8creating

access options for Eclipse-Dialog Designer . . . . 16Custom installation . . . . . . . . . . . . . . . . . 14

Ddata folder, Navigator view . . . . . . . . . . . . . 22database operations

documentation support . . . . . . . . . . . . . . 6debugging

using the Problems view . . . . . . . . . . . . . 30using the Tasks view . . . . . . . . . . . . . . 30

desktop icon, creating . . . . . . . . . . . . . . . . 16dialed number identification service (DNIS)

simulating in tests . . . . . . . . . . . . . . . . 26Dialog Designer Developers Guide PDF file . . . . . . 9Dialog Designer, about the documentation . . . . . . . 5DNIS, see dialed number identification service (DNIS)documentation

about the Dialog Designer documentation . . . . . . 5context-sensitive Help . . . . . . . . . . . . . . . 8Dialog Designer Developers Guide PDF file . . . . 9Dialog Designer outputs . . . . . . . . . . . . . . 8Getting Started with Dialog Designer PDF guide . . . 8intended audience . . . . . . . . . . . . . . . . . 5online Help . . . . . . . . . . . . . . . . . . . . 8other resources . . . . . . . . . . . . . . . . . . 6Programmer Reference guide . . . . . . . . . . . 9purpose . . . . . . . . . . . . . . . . . . . . . . 5where and how to access documentation . . . . . . 9

DTMF

simulating responses . . . . . . . . . . . . . . 27dual-tone multi-frequency, see DTMF

EEclipse

documentation . . . . . . . . . . . . . . . . . . 6documentation, accessing . . . . . . . . . . . . 21version required . . . . . . . . . . . . . . . . . 13

Editor view . . . . . . . . . . . . . . . . . . . . . 24editors available . . . . . . . . . . . . . . . . . 24tabs and sub-tabs . . . . . . . . . . . . . . . . 25

editorsavailable in Dialog Designer . . . . . . . . . . . 24closing . . . . . . . . . . . . . . . . . . . . . 25

Ffast views . . . . . . . . . . . . . . . . . . . . . 31flow folder, Navigator view . . . . . . . . . . . . . 22


42/43


Index

GGEF (Graphical Editing Framework), version required 13Getting Started with Dialog Designer PDF guide . . . . 8Glossary . . . . . . . . . . . . . . . . . . . . . 35

HHang Up button, Avaya Voice Browser . . . . . . . 27hardware required for installation of Dialog Designer . 14

IIBM WebSphere, documentation support . . . . . . . 6icons

folder in Navigator view . . . . . . . . . . . . . 22specific to Dialog Designer . . . . . . . . . . . 32

indicator, build and code generation . . . . . . . . . 31Input Parameters

Avaya Voice Browser, Call tab . . . . . . . . . . 26Input tab

Avaya Voice Browser . . . . . . . . . . . . . . 27installation and configuration . . . . . . . . . . . 13 -20

access options, creating . . . . . . . . . . . . . 16initial configuration . . . . . . . . . . . . . . . 16installing the software . . . . . . . . . . . . . . 14Microsoft Speech SDK

configuring for microphone input . . . . . . . 19options for installation

Compact . . . . . . . . . . . . . . . . . . 14Custom . . . . . . . . . . . . . . . . . . . 14Typical . . . . . . . . . . . . . . . . . . . 14

overview . . . . . . . . . . . . . . . . . . . . 13

required hardware . . . . . . . . . . . . . . . 14required software . . . . . . . . . . . . . . . . 13sample applications . . . . . . . . . . . . . . . 20setting Dialog Designer preferences . . . . . . . 17setting up the workspace . . . . . . . . . . . . 17

installingDialog Designer . . . . . . . . . . . . . . . . 14sample applications . . . . . . . . . . . . . . . 20

JJakarta Tomcat . . . . . . . . . . . . . . . . . . 13

see also TomcatJava

2 SDK . . . . . . . . . . . . . . . . . . . . . 13SDK, documentation support . . . . . . . . . . . 6

Java Runtime Environment (JRE) . . . . . . . . . . 17JDBC

documentation support . . . . . . . . . . . . . . 6

LlanguageName , Navigator view . . . . . . . . . . . 22Log tab

Avaya Voice Browser . . . . . . . . . . . . . . 29

Mmenu options (specific to Dialog Designer) . . . . . . 32microphone input

configuring Microsoft Speech SDK . . . . . . . . 19Microsoft Speech SDK . . . . . . . . . . . . . . . 13

configuring for microphone input . . . . . . . . . 19documentation support . . . . . . . . . . . . . . 6

Nnavigation

call flow, using Bookmark option in Outline view . . 25Navigator view . . . . . . . . . . . . . . . . . 22No Input

Avaya Voice Browser option, Input tab . . . . . . 27No Match

Avaya Voice Browser option, Input tab . . . . . . 27

Ooperating systems supported for Dialog Designer . . . 13options

specific to Dialog Designer . . . . . . . . . . . . 32Outline view . . . . . . . . . . . . . . . . . . . . 25

bookmark navigation . . . . . . . . . . . . . . 25thumbnail presentation . . . . . . . . . . . . . . 25

overviews Avaya Voice Browser . . . . . . . . . . . . . . 26Dialog Designer . . . . . . . . . . . . . . . . . 11Dialog Designer editors . . . . . . . . . . . . . 24Dialog Designer GUI . . . . . . . . . . . . . . . 21Dialog Designer workbench . . . . . . . . . . . 22installation and configuration of Dialog Designer . . 13

PPDF guides

Dialog Designer Developers Guide . . . . . . . . . 9

Getting Started with Dialog Designer . . . . . . . . 8perspective overview, speech project (Dialog Designer) 22preferences

setting initial . . . . . . . . . . . . . . . . . . . 17workbench . . . . . . . . . . . . . . . . . . . 17

Problems view . . . . . . . . . . . . . . . . . . . 30Programmer Reference guide for Dialog Designer . . . 9


43/43

Index

proxy settingssetting in Preferences window . . . . . . . . . . 17

purpose of Dialog Designer documentation . . . . . . 5

QQuick Launch icon, creating . . . . . . . . . . . . 16

RRecord End button, Avaya Voice Browser . . . . . . 27requirements

hardware, for installation . . . . . . . . . . . . 14software, for installation . . . . . . . . . . . . . 13

Ssample applications, installing and running . . . . . 20Script tab, Avaya Voice Browser . . . . . . . . . . 29scripts

using to simulate inputs . . . . . . . . . . . . . 29selectingprojects for simulation . . . . . . . . . . . . . . 26

Send button, Avaya Voice Browser . . . . . . . . . 27setting up workspace . . . . . . . . . . . . . . . . 16simulating

applications . . . . . . . . . . . . . . . . . . 26automatic number identification (ANI) . . . . . . 26caller hang-ups . . . . . . . . . . . . . . . . . 27caller input . . . . . . . . . . . . . . . . . . . 27caller recordings . . . . . . . . . . . . . . . . 27dialed number identification service (DNIS) . . . . 26DTMF inputs . . . . . . . . . . . . . . . . . . 27input parameters . . . . . . . . . . . . . . . . 26no input . . . . . . . . . . . . . . . . . . . . 27no match . . . . . . . . . . . . . . . . . . . . 27spoken (ASR) responses . . . . . . . . . . . . 27transfers of calls . . . . . . . . . . . . . . . . 27

simulationsusing scripts . . . . . . . . . . . . . . . . . . 29

software required for installation of Dialog Designer . 13speech project

Editor view . . . . . . . . . . . . . . . . . . . 24folders . . . . . . . . . . . . . . . . . . . . . 22Navigator view . . . . . . . . . . . . . . . . . 22perspective overview (Dialog D