Table of Contents
About Avaya Dialog Designer Documentation
Audience
Resources
Documentation Availability
About Avaya Dialog Designer
Installation and Configuration
Ensuring System Requirements Are Met
Hardware Requirements
Software Requirements
Installing Dialog Designer
Configuring Basic Settings
Creating Eclipse Shortcut
Setting Up the Workspace
Setting Dialog Designer Preferences
Configuring the Microsoft Speech SDK for Microphone Input
Installing Sample Applications
Upgrading Dialog Designer
If Maintaining a 4.1 Environment Is Necessary
If Preserving a 4.1 Environment Is Not Necessary
Installing Dialog Designer Patch Updates
Before Installing a Patch Update
Installing a Patch Update
Getting Familiar with the Dialog Designer User Interface
Accessing the Eclipse Workbench User Guide, "Concepts" Section
Dialog Designer Workbench
Speech Navigator View
Navigator View
Editor View
Dialog Designer Editors
Editor View Tabs
Outline View
Avaya Application Simulator View (Tab)
Problems View (Tab)
Tasks View (Tab)
Snippets View (Tab)
Eclipse Properties View
Console View
Dialog Designer Menu and Toolbar Options
Creating Speech Applications with Dialog Designer
Planning Before You Build
Envision the User Experience
Anticipate Potential Problems and Issues
Map the Flow
Make It Modular
Identify and List Application Resources
Naming Java Components
Using the Speech Project Wizard
Accessing the Speech Project Wizard
New Speech Project Page (Required)
Project Options Page (Optional)
Specify Language Parameters Page (Optional)
Building Applications
Using Application Resources
Cut, Copy, and Paste Operations
Testing Applications
Deploying Applications
Checklist for Developing Applications with Dialog Designer
Creating Call Control Applications with Dialog Designer
About CCXML, Dialog Designer, and Call Control Applications
Using the Call Control Project Wizard
Accessing the Call Control Project Wizard
New Call Control Project Page (Required)
Specify Project Parameters Page (Optional)
Select CCXML Template Page (Optional)
Building Call Control Applications
Working in the CCXML Editor
Using Database and Web Service Operations
Using the JSP Wizard
Deploying Call Control Applications
Working with the Call Flow Editor
Accessing the Call Flow Editor
Overview of the Call Flow Editor
Setting Global Application Properties: AppRoot Node
AppRoot Node Application Items
AppRoot Node Event Handlers
Getting Familiar with Nodes to Build Applications
Templates (Composite Nodes)
Application Items (Basic Nodes)
Module Nodes
Call Flow Editor Palette Action Options
Using the Select Option
Using the Connection Option
Item Separator
Using the Label Option
Quickly Creating Nodes
Using the Bookmark Option
Working with Nodes and Node Editors
Naming Nodes
Modifying Nodes/Opening Node Editors
Adding Items to a Node (in Node Editor)
Closing a Node Editor
Working with Sub Flows (vs. Modules)
Creating a Sub Flow Using the Sub Flow Wizard
Invoking a Sub Flow
Copying, Cutting, and/or Pasting Sub Flows
Refactoring Projects to Use Sub Flows
Using the Reusable Module Import Wizard
Working with Phrases and Phrasesets
About Phrases
How Phrases Are Used
Where Phrases Are Used
Types of Phrases
About Standard Phrases
About Custom Phrases
About Phrasesets
Using the Phraseset File Wizard to Create Phraseset
Accessing the Phraseset File Wizard
Create a Phraseset Page
Specify Audio File Directory Page
Using the Phraseset Editor
Accessing the Phraseset Editor
Phraseset Editor-Add New Phrase Dialog
Phraseset Editor-Phrase Data Tab
Phraseset Editor-Audio Tab
Using the Recording Script Wizard
Accessing the Recording Script Wizard
Creating a Recording Script Page
Specifying Script Parameters Page
Exporting and Importing Phrase Files
Exporting a Phrases Zip File
Importing a Phrases Zip Files
Importing a Delimited Phrase Data Text File
Working with Prompts
About Prompts in Dialog Designer
Prompt Segment Types
Prompt Controls
Understanding Prompt Levels
About Play Order for Prompt Levels
About Conditions in Prompts
About SSML Controls in Prompts
About Transitional Audio Prompts
Creating Transitional Audio Prompts
Differences in Transitional Audio Prompts
Using Transitional Audio Prompts
Using the Prompt File Wizard to Create Prompt Files
Create a Prompt Page
Using the Prompt File Editor
Accessing the Prompt File Editor
Prompt File Editor-Level Tabs
Prompt File Editor-Prompt Main Tab
Exporting and Importing Prompt Files
Exporting a Prompts Zip File
Importing a Prompts Zip File
Importing a Delimited Prompt Data File
Building Prompts
Before Building the Prompt
Building the Prompt
Working with Media
About Media
Why Media is Used
Media Page
Previewing a Media Page
Creating a Media File
Using Media Editor
Accessing the Media Editors
Audio Editor
Video Editor
Image Editor
Text Editor
Media Simulation
Working with Variables
About Variables in Dialog Designer
Types of Variables in Dialog Designer
Use of Variables in Dialog Designer
About Passing Variable Values
Between Applications and Modules
Between Applications and VoiceXML Objects
Between Applications and IC Systems
Between Applications and CTI Systems
Between Speech and Call Control Applications
Using the Variable Editor
Accessing the Variable Editor
Creating Variables
Deleting Variables
Employing Variables in Applications
Using Node Items to Employ Variables
Using the Prompt File Editor to Employ Variables
About Rendering Audio Variables
About Rendering Text Variables
Programmatically Accessing Call Session Variables
General Approach to Accessing Variables
Getting Call Session Variable Values
Setting Call Session Variable Values
About IProjectVariables
Variables Generated by Dialog Designer
Working with Grammars
About Grammars in Dialog Designer
Types of Grammars
Planning and Designing Grammars
Using Multiple Grammars
Compatibility and Compliance
Basic Process of Using Grammars in Dialog Designer
Using the Grammar File Wizard to Create Grammar Files
Accessing the Grammar File Wizard
New Grammar Page
Using the Grammar File Editor
Accessing the Grammar File Editor
Editing Static Grammars
Adding (or Deleting) Rows to a Static Grammar Table
Adding (or Deleting) Columns to a Static Grammar Table
Using the TAG Option
Setting Static Entry Properties
Setting Column Properties
Editing the Dynamic Grammar Java Class
Editing External Grammar Access Properties
Selecting Built-in Grammar Types
Importing Grammar Files
Importing a Delimited Grammar File
Using External Grammars
Language and Localization Considerations
Language Implementation in Dialog Designer
Administering Project Languages
Adding a Project Language
Editing or Uninstalling a Project Language
Deleting a Project Language
Changing the Project Default Language
Changing the Default Language within an Application
Administering Automated Speech Recognition (ASR) Languages
Adding an ASR Language
Editing a Project Language to Use a Different ASR Language
Deleting an ASR Language
Administering Text-to-Speech (TTS) Languages
Adding a TTS Language
Editing a Project Language to Use a Different TTS Language
Deleting a TTS Language
Administering Localization Bundles
Adding a Localization Bundle
Deleting a Localization Bundle
Installing a Localization Bundle
Uninstalling a Localization Bundle
Using a Localization Bundle's Standard Phrasesets
Working with Database Operations
Configuring Data Sources
Using the Database Operation Wizard to Create a Database Operation File
Accessing the Database Operation Wizard
Create a Database Operation Page
Select Data Objects Page
Map to Variables Page
Using the Database Operation File Editor
Accessing the Database Operation File Editor
Database Operation Tab
Viewing Basic Information
Remapping Variables to Columns
Determining Order for Return Results
Predicate Tab
Setting Conditions for a Simple Database Operation
Setting Conditions for a Compound Database Operation
SQL Query Tab
Employing Database Operations in Call Flows
Database Connector BLOB Support
Working with Event Types
About Events
Event Handlers and Scope
Types of Event Handlers
Built-in Event Handlers
Custom Events
Try Catch Event Handling
Using the Event Type Editor
Events in Applications
Using Built-in Event Handlers for Default Events
Using and Handling Custom Events
Working with Web Services
About Web Services
Creating a Web Service Operation File
Viewing or Editing a Web Service Operation File
Web Service Headers
Employing Web Services in Dialog Designer Applications
Re-generating Web Services Client Code
Consuming Web Services over HTTPS
Application Testing by Simulation
About Testing Applications by Simulation
What Can Be Tested by Simulation
Limitations When Testing by Simulation
Debugging Features
Using the Avaya Application Simulator to Simulate Applications
Simulating Run-time Scenarios
Caller Inputs and Telephony System Responses
Responses from Scripts
Other Inputs
Simulating Events
Application Deployment
Deploying the Application
Using the Export Dialog Designer Project Wizard
Select a Project Page
Specify Export Parameters Page
Specify Platform Details Page
Specify Deployment Parameters
Configure Web Application Descriptor
Using the Export Runtime Support Files Wizard
Installing Required Files on the Application Server
Requirements for the Application Server
Configuring the Application Server to Use a Proxy Server
Installing Project Files on Tomcat Servers
Installing Project Files on WebSphere Servers
Installing Project Files on WebLogic Servers
Installing the Runtime Support Files
Installing IC or CTIC
Preparing the Application Server to Run Dialog Designer Applications
Configuring the Dialog Designer Admin (ddadmin) Web Application
Configuring the IVR System to Use the Speech Application
Running a Dialog Designer Application under SSL Control
Hot Deployment: Updating Applications without Bringing the System Down
Deploying Projects as Dialog Designer Modules
About the Application Execution Environment
Checking the Application Deployment
Accessing the Application Deployment Utilities
Accessing Utilities on a Tomcat Application Server
Accessing Utilities on an Application Server
Validating the Application Deployment
Viewing the Application in HTML Mode
Monitoring Application Performance
Viewing Application Trace and Report Logs
Example Application Deployment
Nodes and Palette Options
Detailed Node Descriptions
Announce Node
Blind Transfer Node
Bridged Transfer Node
Consultation Transfer Node
Data Node
Disconnect Node
Form Node
Menu Node
Prompt and Collect Node
Record Node
Return Node
Servlet Node
Sub Flow Begin Node
Sub Flow Reference Node
Sub Flow Return Node
Symbolic Node
Tracking Node
VXML Servlet Node
Detailed Palette Option Descriptions
Alarm
Audio Variable
Blind Transfer
Boolean
Break
Bridged Transfer
Capture Expression
Catch (Exception)
Catch (VXML Events)
Choice
Column Operand
Comparison Operator
Complex Variable
Condition
Consultation Transfer
Add Conference Party (CTI)
Blind Call (CTI)
Call Info (CTI)
Conference (CTI)
Conference Party (CTI)
Constant Audio
Consultation Call (CTI)
Coordination Parallel
Coordination Sequence
Dial (CTI)
Disconnect (CTI)
Hold (CTI)
Remove Conference Party (CTI)
Retrieve (CTI)
Separator
Transfer (CTI)
Database Operation
Database Transaction
Else
Else if
Emphasis
Exit
Expression
External Property
Field
Flush Prompts
Get VDU Fields
Goto
Grammar
If
Input
Input Parameter
Invoke Workflow
Join Condition
Link
Mark
Media
Media Page
Module Input
Module Output
Next
No Input
No Match
Object
Object Input
Object Output
On Disconnect
Operation
Output Parameter
Parallel
Phrase
Phrase Variable
Prompt
Property
Prosody
Record
Region
Report
Report Alarm
Return Event
Say As
Set VDU Fields
Sequence
Simple Variable
SMIL Link
Supervised Transfer
Text
Text Block
Text Variable
Throw
Trace
Transfer
Transfer Call
Try
TTS
Value Operand
Variable Operand
Voice
Voice Portal Configurable Complex Variable
Voice Portal Configurable Variable
Web Service (Operation)
Project Properties
Setting Project Properties
Dialog Designer Project Properties
General Tab
Importing an Icon File
Speech Tab
Languages Tab
Pluggable Connectors Tab
Database Tab
Web Descriptor Tab
Application Tab
Servlets Tab
Tomcat Properties
Configuring Preference Settings
Accessing Preferences
Avaya Preferences
Application Simulation Preferences
Dialog Designer Preferences
Tomcat Preferences
System Variables
System Variable Fields and Properties
Variable Formats in Localization Bundles
Audio Field Properties
Creating Scripts for Testing
Using Scripts to Simulate Caller Responses
Creating a Response Script
Sample Response Script
Using Scripts to Simulate IC and CTI Connectors
Creating a Connector Script
Connector Script Guidelines
Additional Configuration Options in Connector Scripts
Sample Connector Scripts
Summary of Connector Commands
Conditional Operators
CTI and IC Connectors
About CTI Connectors
CTI Connectors in Dialog Designer
Using CTI Connectors in Applications
Enabling CTI Functionality in Dialog Designer
Constructing a Call and Data Transfer Using CTI Connectors
About the cticallinfo Variable
Configuring Dialog Designer CTI Applications to Work with Avaya IVR Systems
Configuring Channel to Extension Mapping Script for Avaya IR Systems
About the IC Connector
vdu and vdu_cache Variables
IC Connector at Runtime
Virtual Channel Mapping in IR
About IC Failover
Glossary