AAOD GettingStarted
AAOD GettingStarted
Designer
Getting Started with Orchestration
Designer
Release 6.0
© 2011 Avaya Inc. Avaya Support
All Rights Reserved. Avaya provides a telephone number for you to use to report problems or to ask
questions about your product. The support telephone number
Notice
is 1-800-242-2121 in the United States. For additional support telephone
While reasonable efforts were made to ensure that the information in this numbers, see the Avaya Web site:
document was complete and accurate at the time of printing, Avaya Inc. can
http://support.avaya.com
assume no liability for any errors. Changes and corrections to the information
in this document may be incorporated in future releases.
Documentation disclaimer
Avaya Inc. is not responsible for any modifications, additions, or deletions to
the 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 this
documentation 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 Web
sites referenced elsewhere within this documentation, and Avaya does not
necessarily endorse the products, services, or information described or offered
within them. We cannot guarantee that these links will work all of the time and
we have no control over the availability of the linked pages.
Warranty
Avaya Inc. provides a limited warranty on this product. Refer to your sales
agreement to establish the terms of the limited warranty. In addition, Avaya’s
standard warranty language, as well as information regarding support for this
product, while under warranty, is available through the following Web site:
http://support.avaya.com
License
USE OR INSTALLATION OF THE PRODUCT INDICATES THE END USER'S
ACCEPTANCE OF THE TERMS SET FORTH HEREIN AND THE GENERAL
LICENSE TERMS AVAILABLE ON THE AVAYA WEB SITE AT
http://support.avaya.com/LicenseInfo/ (“GENERAL LICENSE TERMS”). IF
YOU DO NOT WISH TO BE BOUND BY THESE TERMS, YOU MUST
RETURN 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 types
described 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 single
stand-alone computing device. “Server” means a Designated Processor that
hosts a software application to be accessed by multiple users. “Software”
means the computer programs in object code, originally licensed by Avaya and
ultimately utilized by End User, whether as stand-alone Products or
pre-installed on Hardware. “Hardware” means the standard hardware
Products, originally sold by Avaya and ultimately utilized by End User.
License Type(s)
Copyright
Except where expressly stated otherwise, the Product is protected by copyright
and other laws respecting proprietary rights. Unauthorized reproduction,
transfer, and or use can be a criminal, as well as a civil, offense under the
applicable law.
Third-party Components
Certain software programs or portions thereof included in the Product may
contain software distributed under third party agreements (“Third Party
Components”), which may contain terms that expand or limit rights to use
certain portions of the Product (“Third Party Terms”). Information identifying
Third Party Components and the Third Party Terms that apply to them is
available on Avaya's web site at:
http://support.avaya.com/ThirdPartyLicense/
Trademarks
Avaya is a trademark of Avaya Inc.
All non-Avaya trademarks are the property of their respective owners.
Contents
About Avaya Aura ® Orchestration Designer documentation . . . . . . . . . . . . . . . . v
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Pre-requisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Documentation availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
Orchestration Designer documentation location . . . . . . . . . . . . . . . . . . . ix
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 iii
Outline view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Avaya Application Simulator view . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Problems view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Tasks view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Snippets view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Properties view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Console view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Enabling the debug output for tracing function . . . . . . . . . . . . . . . . . . 31
Orchestration Designer Menu and Toolbar options . . . . . . . . . . . . . . . . . . . . 31
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
iv Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
About Avaya Aura ® Orchestration
Designer documentation
Avaya Aura ® Orchestration Designer is a suite for combination of self-service products and
Avaya Contact Center products, namely, Avaya Aura ® Experience Portal (AAEP), Avaya
Interactive Response (IR), Media Processing Server (MPS), and Avaya Aura ® Contact Center.
As a single tool, you can use Orchestration Designer to design, simulate, and maintain contact
routing scripts along with inbound and outbound self-service support. Orchestration Designer
accelerates the service design and deployment, reduces the cost, and enhances the customer
experience.
Orchestration Designer documentation provides an insight to the Orchestration Designer tool.
The documentation contains information about installing and configuring Orchestration
Designer. This documentation also contains information about the various features of
Orchestration Designer.
This chapter contains the following topics:
● Audience
● Pre-requisites
● Resources
● Documentation availability
Audience
The intended audience of this documentation are users who need to:
● Install and configure Orchestration Designer.
● Use Orchestration Designer to design and create speech applications for:
- Avaya Interactive Response (IR) 3.0 or later.
- Avaya Voice Portal 4.0 or later. The Avaya Voice Portal 6.0 is referred to as Avaya
Aura ® Experience Portal (AAEP) 6.0.
- Avaya Media Processing Server (MPS) 3.5 FP2 or later.
These users include, among others:
● Customers who want to create their own speech applications.
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 v
About Avaya Aura ® Orchestration Designer documentation
● Avaya business partners and independent service vendors who create speech
applications for Avaya customers.
Pre-requisites
The primary users of Orchestration Designer are likely to be highly knowledgeable and skilled in
telecommunications and Internet technologies. Therefore, this documentation does not cover
topics related to those areas. The users must be proficient and knowledgeable in the following
areas:
● The operating systems on which the users develop and deploy Orchestration 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 Orchestration Designer,
knowledge and experience of Java programming is helpful.
Orchestration Designer is built on several existing technologies and tools. Hence, Orchestration
Designer users must become familiar with the following 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 additional resources for these technologies, see Resources.
Resources
Orchestration Designer depends on the use of several closely related software products and
technologies. When using Orchestration Designer, review the documentation of these related
products and technologies.
Avaya does not reproduce or package the documentation for these related products and
technologies. However, to help locate the appropriate documentation, review the following
resources:
vi Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Resources
Note:
Note: The following URLs were valid at the time of publication of this document. Avaya
is not responsible if these URLs have changed. For more updated URLs, perform
a search operation online.
● For Eclipse and supporting Eclipse components (GEF and WTP), go to:
http://www.eclipse.org/documentation/
To view the Eclipse online Help in Orchestration Designer, on the Help menu > click
Help Contents.
● For the Java SDK (Software Developer’s Kit), go to:
http://java.sun.com/j2se/1.5.0/docs/index.html
● For Tomcat: 5.5 or 6.0, go to:
http://tomcat.apache.org/tomcat-5.5-doc/index.html
http://tomcat.apache.org/tomcat-6.0-doc/index.html
● For IBM WebSphere or WebSphere Express, go to:
http://www.ibm.com/websphere
● For WebLogic, go to:
http://www.oracle.com/appserver/weblogic/weblogic-suite.html
● For the Microsoft Speech SDK, go to:
http://www.microsoft.com/speech/speech2007/downloads.mspx
● For databases and JDBC implementation, go to:
http://www.sql.org/
http://www.firstsql.com/tutor.htm
http://java.sun.com/developer/onlineTraining/Database/JDBCShortCourse/jdbc/
sql.html
● For Web services, go to:
http://www.w3.org/TR/wsdl
http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html
● For the W3C VoiceXML 2.0 Recommendation, go to:
http://www.w3.org/TR/voicexml20/
● For the W3C VoiceXML 2.1 Recommendation, go to:
http://www.w3.org/TR/voicexml21/
● For the W3C CCXML 1.0 Recommendation (January 19, 2007), go to:
http://www.w3.org/TR/ccxml/
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 vii
About Avaya Aura ® Orchestration Designer documentation
Documentation availability
The Orchestration Designer documentation consists of four outputs:
● Getting Started with Avaya Aura ® Orchestration Designer. This PDF document contains
the information needed to install and configure Orchestration Designer for initial use, as
well as to understand the basics of Orchestration Designer graphical user interface (GUI).
● Avaya Aura ® Orchestration Designer online Help. The online Help provides detailed
information and procedures for using Orchestration Designer features and options to
create speech and call control applications.
When installing Orchestration Designer, the online Help is installed as an additional Eclipse
plug-in.
To view the online Help, perform one of the following actions:
- With the cursor over an item within the interface, press the F1 key to display the help.
- On the Help menu, click Help Contents > Avaya Aura ® Orchestration Designer -
Self Service > Orchestration Designer Developer’s Guide.
● Avaya Aura ® Orchestration Designer Developer’s Guide. This PDF document contains
the same information as available in the online Help, but in a format that can be printed or
viewed using Adobe Acrobat Reader.
● Programmer Reference Guide. This online documentation is designed for the
programmers of Orchestration Designer. This documentation includes:
- A Constants (Quick reference) guide.
- A Class Hierarchy reference guide.
- An API Reference guide.
To view the preceding documentation, on the Help menu, click Help Contents > Avaya Aura ®
Orchestration Designer - Self Service > Programmer Reference.
viii Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Documentation availability
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 ix
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 1
Overview
Overview
Orchestration Designer is a Java-based tool that you can use to create speech and call control
applications that comply with VoiceXML version 2.1 or CCXML version 1.0 January 19, 2007,
specification. Designed as an Eclipse plug-in, Orchestration Designer provides an integrated
GUI for the design and implementation of speech applications that can operate with Interactive
Response, Voice Portal, Media Processing Server, and Avaya Aura ® Experience Portal
systems.
Orchestration Designer is based on the widely accepted Eclipse.org development framework. It
provides a drag-and-drop environment for development and maintenance of speech and
touchtone applications.
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 2
3 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Chapter 2: Installation and configuration
This chapter contains information about installing and configuring Orchestration Designer. In
addition, this chapter includes procedures for installing sample applications and upgrading
Orchestration Designer by installing patches and updates.
Before installing Orchestration Designer, ensure that the hosting system meets the
requirements described in the following sections:
● License requirements
● Hardware requirements
● Software requirements
License requirements
You need a valid license to run Orchestration Designer applications on Avaya Aura ®
Experience Portal (AAEP), Avaya Voice Portal (VP), Avaya Interactive Response (IR), and
Avaya Media Processing Server (MPS), or other supported VXML platform. Orchestration
Designer licenses are free. You can contact an Avaya sales representative or channel manager
to get the license file. Avaya partners can log on to the Partner Portal to find information on
ordering additional licenses.
Orchestration Designer does not require a separate WebLM server. Avaya recommends that
you install the Orchestration Designer license on the existing WebLM license server that is
installed with Voice Portal, Avaya Aura ® Experience Portal, IR, or another Avaya product
utilizing WebLM license server.
You do not require a license to install or run the Eclipse-based Orchestration Designer
development and simulation environment. You can purchase the license for the value added
features of the Eclipse-based Orchestration Designer development and simulation environment
from Avaya. Contact your business partner or Avaya Channel Manager for ordering related
information.
Note:
Note: You require a valid license to enable the Application Simulator to work with
third-party speech servers (TTS/ASR) over Media Resource Control Protocol
(MRCP). Contact your business partner or Avaya Channel Manager for acquiring
the license.
After you acquire the license, an XML file is generated which has the license related
information.
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 4
Installation and configuration
Hardware requirements
The system that hosts the Orchestration Designer development environment must meet or
exceed the following hardware requirements:
Software requirements
The system that hosts the Orchestration Designer development environment must have the
following software packages installed. You must install these packages before installing and
configuring Orchestration Designer. The software required to host the Orchestration Designer
development environment is available on the Orchestration Designer 6.0 distribution DVD.
! Important:
Important: If you want to upgrade Orchestration Designer, see Upgrading Dialog Designer to
Orchestration Designer.
5 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Supporting software requirements (continued)
J2SE Development Kit 6.0 (JDK Yes The JDK includes the Java Run-Time Environment
6.0) (JRE) and command-line tools, compilers, and
debuggers used in developing applets and applications.
(existing JDK 1.5 or JDK 1.6 are
also supported)
To install JDK 6.0:
1. Locate the JDK installer on the Orchestration
Designer 6.0 DVD. This file is located in the following
directory:
<DVD_drive>:\Installation\Java\
2. Double-click the downloaded executable file to install
the JDK.
Eclipse-3.6-Prereq-AAOD.zip Yes Eclipse is a Java-based open-source integrated
which includes: development environment (IDE) for software
● Eclipse 3.6 SDK
development. Orchestration Designer runs as an
Eclipse plug-in.
● GEF 3.6 SDK
Orchestration Designer uses the Eclipse Graphical
● WTP SDK 3.2 Editing Framework plug-ins for Eclipse (GEF) for
● emf-xsd 2.6 advanced graphical functions. It also includes the
● DTP 1.9
support files for Call Control (CCXML) development.
To install the Orchestration Designer Eclipse
Note: Prerequisite files, perform the following actions:
Orchestration
1. Locate the package file on the Orchestration
Note:
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 6
Installation and configuration
Tomcat 5.5 or Tomcat 6.0 Yes Tomcat generates and serves VoiceXML pages to the
Avaya Application Simulator.
Note:
● You must have administrative privileges when
running Tomcat.
● If you upgrade to Tomcat 6.0, you may need to
make small adjustments the first time you run
Tomcat. If your applications have manually
configured build paths or have resources in
common/lib or common/classes, then you must
manually update the build path to point to
<tomcat_installpath>/lib and also put any
resources, such as libraries, in that folder.
To install Tomcat, perform the following actions:
1. Locate the Tomcat distribution package on the
Orchestration Designer 6.0 DVD. These files are
located in the following directory:
<DVD_drive>:\Installation\Tomcat\
2. Extract the .zip file in a temporary folder.
3. Review the RUNNING.txt file for additional
installation instructions.
! Important:
Important: Do not install Tomcat as an NT service.
Orchestration Designer does not support
this configuration because Tomcat does
not start and stop appropriately when
developing applications.
Note:
Note: If more than one Java SDK is installed,
then you must set the Tomcat JVM
Settings preferences option to
JRE1.5.x. The JRE1.5.x must be
available in Java before you select it in
the Tomcat JVM Settings.
7 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Supporting software requirements (continued)
Microsoft Speech SDK 5.1 Yes Orchestration Designer uses Microsoft Speech SDK
(SpeechSDK51.exe) during application testing to perform automated speech
recognition (ASR) and text-to-speech (TTS) functions.
Note:
Note: If Microsoft Speech SDK 5.1 is already
installed, verify if the Speech
Recognition and Text-to-Speech tabs
are available in Control Panel >
Speech. If so, you need not install
Microsoft Speech SDK.
To install the Microsoft Speech SDK 5.1, perform the
following actions:
1. Locate the Microsoft Speech SDK file on the
Orchestration Designer 6.0 DVD. This file is located
in the following directory:
<DVD_drive>:\Installation\MSSpeech\
2. Double-click the Setup.exe file. The system displays
the Microsoft SDK InstallShield wizard.
3. In the Welcome dialog box, click Next.
4. Accept the license terms, and click Next.
5. Enter a User Name and Organization in the
Customer Information dialog box, then click Next.
6. Accept the default installation folder, when prompted,
or navigate to another, if applicable. Then click Next.
7. Click Install to begin the Microsoft Speech SDK
installation.
8. Click Finish when the installation is complete.
Storm Codec 7.01.19 You need to install Storm Codec 7.01.19 only if you
intend to use 3GP video files for media.
To launch the Storm Codec installer, see the installation
notes available on the DVD.
1. Though specific locations on the DVD are described here, it is intended that users simply launch the DVD, and use
the displayed HTML index page to navigate to the required resources.
By following these instructions, installation will be smoother because the online navigation documentation leads the
developer along the correct installation path. This is the preferred methodology for using the DVD and installing
Orchestration Designer efficiently.
2. Requires Eclipse 3.3
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 8
Installation and configuration
! Important:
Important: The procedure described in this section is for new installations of the
Orchestration Designer software. To upgrade Orchestration Designer, see
Upgrading Dialog Designer to Orchestration Designer.
To install Orchestration Designer:
1. Insert the Orchestration Designer installation DVD into the DVD drive. The Install wizard
starts automatically.
Note:
Note: If the Install wizard does not start automatically, browse to the root directory of the
DVD and double-click autorun.exe.
2. An Avaya Software License Agreement is displayed. Review the license agreement, and
click I accept. Please continue to accept it.
3. A “start.html” file is displayed. This file provides an overview of the following available
resources on the DVD:
● Getting Started with Avaya Aura ® Orchestration Designer: A link to a copy of this
document on the DVD.
● Installation Notes: A link to additional installation notes. These notes include
information about installing Orchestration Designer and prerequisite software, and
localization bundles available in the current release.
● Sample Applications: A link to a page with information about accessing and using
sample applications in Orchestration Designer. Sample applications provide tangible
ideas on how to use Orchestration Designer most effectively.
Note:
Note: If you are installing Orchestration Designer on Windows 7, the Internet Explorer
browser may not display "start.html" file. You can browse the DVD to locate this
file and double-click to view it.
4. Install Orchestration Designer software and supporting software by following the
instructions and links in the Installation Notes on the DVD.
9 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Configuring basic settings
5. Optionally, install the Storm Codec 7.01.19. To launch the Storm Codec 7.01.19, refer the
Installation Notes on the DVD.
Orchestration Designer is now installed, but before you use Orchestration Designer, you
must configure the basic settings. For information about how to configure your
development environment settings, see Configuring basic settings.
To determine the installed Orchestration Designer version, click Help > About Eclipse
SDK > Feature Details.
Note:
Note: After you complete the installation procedure, read the Eclipse “readme” file
located in the /readme subdirectory where Eclipse is installed. The Eclipse
readme file includes valuable information and tips for configuring Eclipse.
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 10
Installation and configuration
! Important:
Important: If you are configuring a new version of Orchestration Designer, create backup
copies of all files in the original installation directory before configuring a new
directory.
The default directory is relative to the installation path of Eclipse. For example,
C:\Eclipse\workspace. You can click Browse to navigate to a different directory.
To stop the Workspace Launcher dialog box from prompting for this directory with every
launch of Eclipse, select the Use this as the default and do not ask again option in the dialog
box.
Perspectives In the selection pane on the left, select General > Perspectives.
Follow these steps to configure the options:
● In the Open a new perspective panel, select In the same
window.
● In the Open a new view panel, select Within the perspective.
11 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Configuring basic settings
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 12
Installation and configuration
13 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Configuring basic settings
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 14
Installation and configuration
! Important:
Important: Included sample applications are intended to be used as technical samples for
reference only, and not production-ready applications.
15 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Upgrading Dialog Designer to Orchestration Designer
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 16
Installation and configuration
The following example installation paths are recommended for multiple Dialog Designer /
Eclipse versions. In these paths, (base) means any parent directory.
c:\(base)\DD5.1\
eclipse\ (Eclipse 3.4 or 3.5 install, with GEF 3.4 or 3.5 respectively, and
Dialog Designer 5.1 features)
tomcat\ (Tomcat 5.5 or 6.0 for running Dialog Designer 5.1 applications)
workspace\ (Dialog Designer 5.1 projects)
c:\(base)\OD6.0\
eclipse\ (Eclipse 3.6 install, with GEF 3.6, WTP SDK 3.2, EMF-SDO-XSD
2.6, with Orchestration Designer 6.0 features, Eclipse 3.4 or 3.5
install, with GEF 3.4 or 3.5 respectively, and Dialog Designer 5.1
features)
tomcat\ (Tomcat 5.5 or 6.0 for running Orchestration Designer 6.0
applications)
workspace\ (Orchestration Designer 6.0 projects)
This is a convenient installation structure that keeps the Dialog Designer 5.1 and Orchestration
Designer 6.0 environments and prerequisite software separate.
Note:
Note: After creating a new workspace during an upgrade, click Window > Preferences
to configure your preferences before importing old projects. See Setting
Orchestration Designer Preferences for more details.
17 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Installing Orchestration Designer patch updates
5. Import each project into Orchestration Designer 6.0. The project is then converted for
Orchestration Designer 6.0.
6. If you use a source control system, create a branch or store the 6.0 application in a
different location so that the old 5.1 application can be maintained in the future.
Note:
Note: After creating a new workspace during an upgrade, click Window > Preferences
to configure your preferences before importing the old projects. For more
information, see Setting Orchestration Designer Preferences.
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 18
Installation and configuration
! CAUTION:
CAUTION: When opening an application created with a prior release of Orchestration
Designer, Orchestration Designer prompts you to update the project to the new
version. For project conversion considerations, refer to the Release Notes.
! CAUTION:
CAUTION: The Eclipse Install/Update mechanism can be used by other features besides
Orchestration Designer. To ensure that you install compatible features, Avaya
recommends that you update only the Orchestration Designer features.
If you are not sure which updates to install or if you have questions about the
installation procedure, contact Avaya Support at http://support.avaya.com.
19 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Accessing the Concepts section of the Eclipse Workbench User Guide
This chapter contains information about accessing the Eclipse Workbench User Guide. This
chapter contains more details on Eclipse development environment concepts and terminology
used by Orchestration Designer.
In addition, this chapter contains information about the Orchestration Designer GUI, within the
Eclipse framework, including the different areas of the Orchestration Designer workbench,
menus, and toolbar options.
For more information, see the following sections:
● Accessing the Concepts section of the Eclipse Workbench User Guide
● Orchestration Designer workbench
● Orchestration Designer Menu and Toolbar options
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 20
Getting familiar with the Orchestration Designer user interface
21 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Orchestration Designer workbench
● Restore: Restores the default settings of the selected tab view. Alternatively, you can click
Reset Perspective on the Window menu to restore the tab view settings to the default
position and size.
● Move: Allows the tab view or the complete tab group, if more than one, to be moved
outside the perspective. For example, to the Desktop area outside the Eclipse window.
● Size: Adjusts the size of the panel border relative to the option selected. Only borders that
can be adjusted, per selected tab, are active options. Options are Left, Right, Top, and
Bottom. For example, on the Speech Navigator tab, to make the area wider, select Size >
Right, and then drag the dark blue highlighted border to make the view wider.
● Minimize: Minimizes the size of the tab view that you select.
● Maximize: Maximizes the size of the tab view that you select.
● Close: Closes the tab view that you select.
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 22
Getting familiar with the Orchestration Designer user interface
23 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Orchestration Designer workbench
You can expand any resource group such as, grammars, phrases, phrasesets, prompts, to view
the actual resources within the resource group. When you right-click a resource and click
Properties, Orchestration Designer displays a context-sensitive properties dialog box.
To customize the view further, click the <down arrow> on the toolbar of the tab and click
Customize View.
Navigator view
The Navigator view is a standard Eclipse view that provides a hierarchical view of the
resources in the Orchestration Designer speech project. For greater control over your resources
while designing applications, see Speech Navigator view.
The following are the main features of the Navigator view:
● When you create a speech project in Orchestration Designer, Orchestration Designer
automatically creates the following element folders within the project folder:
Element folders in the Project folder
connectivity Contains the database and Web service operation files that you create as
part of your project.
data Contains mostly files that are derived from other files. For example, when
you create a grammar file, the Grammar File Editor creates a *.gram file
that contains the metadata for the grammar. When you generate the
project, Orchestration Designer creates a *.grxml file that contains the
actual XML grammar file. This *.grxml file is derived from the *.gram file.
Usually, the derived files in this folder are hidden, and are not shown in the
Navigator view.
! Important:
Important: Do not manually edit these files.
This folder also contains:
● log folder. The system writes the log files that are created during
application testing to the log folder. You can view these log files for
debugging your applications.
● temp folder. A temp folder stores any messages you record during
application testing.
flow Contains the main.flow file. This file is the core of your call flow
application, that is, the speech project. This file is built and edited using the
Call Flow Editor.
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 24
Getting familiar with the Orchestration Designer user interface
● You can open the editors for the project resources, such as phrases, prompts, and
grammars by double-clicking the file in the Navigator view. For example, to open a phrase
in the Phrase File Editor, double-click the *.phrase file.
● You can also perform other actions on the project resources by right-clicking the
resources, and then selecting the appropriate action from the context menu.
Tip:
Tip: You can use the Generate option to generate individual files and project
resources. For example, to regenerate a project grammar without regenerating
the entire project, in the Navigator view, right-click the *.gram file, and then click
Orchestration Designer > Generate.
For more information about the Navigator view in Eclipse, see “Navigator view” in the Eclipse
Workbench User Guide.
25 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Orchestration Designer workbench
Editor view
By default, the Editor view is located in the upper-right area of the window. The main area of this
view is called the workspace. The workspace is where you do most of the development work for
building a speech application project.
Within the Editor view, you can launch numerous sub-editors to create, update, and manage
your speech application.
For more information about the Editor view, see the following sections:
● Orchestration Designer editors
● Editor view tabs
Editor Description
Call Flow Editor Add nodes to this editor and connect the nodes for
creating call flows that direct the caller experience. Call
Flow Editor is the primary editor of Orchestration
Designer.
Phraseset File Editor Use this editor to modify phraseset metadata such as
phrase text, relevant comments, and search keywords.
You can also record a phraseset and save it in a .wav
file format.
Prompt File Editor Use this editor to define and modify prompts, from very
simple announcements to very complex prompts
involving variables, conditions, and logic.
Variable Editor Use this editor to create, define, and modify variables.
You can also use this editor to view the variables that
exist in the current project.
Grammar File Editor Use this editor to define custom grammar files or select
built-in grammar files.
Database Operation File Editor Use this editor to define and modify the way a project
works with databases that you select.
Web Service Operation File Editor Use this editor to define and modify the way a project
works with Axis Web services that you select.
Web Service Operation File Use this editor to define and modify the way a project
(Axis2) Editor works with Axis2 Web services that you select.
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 26
Getting familiar with the Orchestration Designer user interface
Editor Description
Event Type Editor Use this editor to define and modify custom events and
(available only from within the Call Flow their implementation within a project. This editor is
Editor) available only from within the Call Flow Editor.
CCXML File Editor Use this editor to modify the CCXML files that are part of
the Call Control projects.
JSP File Editor Use this editor to modify JSP files that are part of the
Call Control projects. This is a text-based editor.
Audio Editor Use this editor to record audio. You can also use this
editor to define and view file properties, file locations,
setup an external location, and preview and edit the
contents of the audio files.
Video Editor Use this editor to preview videos. You cannot use this
editor to record videos.
Image Editor Use this editor to preview images. You cannot use this
editor to capture images.
Text Editor Use this editor to view and modify text files.
27 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Orchestration Designer workbench
Outline view
By default, the Outline view is located in the lower-left corner of the window. The Outline view
is a standard Eclipse view. In Orchestration Designer, the Outline view is available only in the
following conditions:
● When the Call Flow Editor is the active editor.
● When you edit a Java (*.java) file.
You can select any of the three views in the upper-right corner of the Outline view:
● The Node List view shows the nodes of a call flow in an alphabetical order and also
shows all symbolic node references.
● The Thumbnail view allows you to navigate around easier within a call flow if the call
flow is complicated. You can drag the shaded area in the Outline view. The system
updates the main workspace simultaneously to show the full size view of the shaded area.
● The Bookmark view shows a list of all the bookmarks in a call flow. You can use this list
to navigate between bookmarks in a call flow, which is useful in large and complex call
flows.
To navigate to a bookmarked node, click the bookmark in the Bookmark view. The system
highlights the bookmarked node in the main workspace of the Call Flow Editor.
Field/Feature Description
name
Available Shows a list of projects to simulate. You can select only one project at a
Projects time.
Input Simulates the input expected from another application module. The format
Parameters of the simulated input must match the expected format.
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 28
Getting familiar with the Orchestration Designer user interface
Field/Feature Description
name
Run Click this button to start the simulation. This button is available only when
Application you select a project for simulation in Available Projects.
Note: If there are any errors in the project to be simulated, this button is
unavailable.
Debug Click this button to debug the application. This button is available only
Application when you select a project in Available Projects.
Note: Ensure that you set the Debug perspective for running the debugger
in Windows > Preferences > Run/Debug > Perspectives to Debug.
End Click this button to end the simulation before the simulation is complete.
Application This button is available only when a project is in the simulation mode.
Note: This action is different from that of the Hang Up simulation. When
you click the End Application button, the system stops the application
wherever it is. The Hang Up button on the Input tab simulates a
situation in which the caller gets disconnected before reaching the end of
the call flow either by hanging up or by some other means.
Do Not Run As Select this check box to run Orchestration Designer applications that are
Module modules, as standalone applications. If you clear this check box, the
system generates a default VXML page to invoke the Orchestration
Designer application as a subdialog.
Problems view
The Problems view tab shows the errors, warnings, and informational messages that are
generated while saving a project or any of its elements. At the same time, Orchestration
Designer displays a Code Generation error message, unless you click Do not show me this
message in the future. This view also shows any errors that are generated while compiling the
Java code.
If you double-click the error, warning, or informational message in this view, Orchestration
Designer navigates to the exact location where the problem occurs. This feature makes it easier
to debug an application and resolve the problem.
By default, Orchestration Designer shows the Problems view in a tabbed notebook, along with
the Tasks view and the Application Simulator view, in the center of the lower area of the
window.
29 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Orchestration Designer workbench
Tasks view
The Tasks view is a standard Eclipse view. The Tasks view shows the tasks related to various
types of errors that might occur, such as Java syntax errors. You can also manually add tasks to
this list for things you want to remember to take care of.
For more information about the Tasks view in Eclipse, see the “Tasks view” section in the
Eclipse Workbench User Guide.
By default, Orchestration Designer shows the Tasks view in a tabbed notebook, along with the
Problems view and the Application Simulator view, in the center of the lower area of the
window.
Snippets view
The Snippets view contains shortcut snippets in JSP or CCXML that you can add onto your
CCXML or JSP page while building call control projects.
Properties view
The Eclipse Properties view is a modification of the standard Eclipse Properties view. In a
layout optimized for Orchestration Designer, it displays property names and values for nodes,
palette options, 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 a
particular 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 “Properties view”
section in the Eclipse Workbench User Guide.
Note:
Note: By default, Orchestration Designer shows the Properties view in a tabbed
notebook, along with the Console view, in the lower-right area of the window.
Console view
The Console view shows information about the status and activity of the Tomcat server.
● If you run simulations, the system writes the CCXML, VXML, and connector logs to the
Console view window.
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 30
Getting familiar with the Orchestration Designer user interface
● If you enable the debug output for the tracing function, then the Console view shows the
VoiceXML output generated by the application. This information is read only, but it can be
helpful in debugging applications, especially if you can read and understand VoiceXML
code. To enable the debug output for tracing function, see Enabling the debug output for
tracing function.
By default, Orchestration Designer shows the Console view in a tabbed notebook, along with
the Properties view, in the lower-right area of the window. The Console view appears in the
foreground if you start Tomcat or click the Console tab.
Tip:
Tip: When you enable the Enable Orchestration Designer logging of tracing
output option, Orchestration Designer shows the VoiceXML output in the
Console view and writes the output to a trace log file. For more information, see
Console view. This file is located at applicationName/data/log/
trace.log-yyyy-mm-dd.log, where applicationName represents the top level
application directory, and yyyy-mm-dd represents “today’s” simulation runs
generated. To view this log file, locate the file in the Navigator pane and
double-click the file name.
31 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Orchestration Designer Menu and Toolbar options
Note:
Note: This table shows the options that are specific to Orchestration Designer. This
table does not include generic Eclipse options.
Speech Project Speech Perspective only. Opens ● File menu > New
the wizard to create a speech ● Main toolbar
project.
● Right-click anywhere
in the Navigator view
or in the Speech
Navigator view
CCXML File Call Control Perspective only. ● File menu > New
Editor Opens an editor to edit CCXML ● Main toolbar
files.
● Right-click anywhere
in the Navigator view
or in the Speech
Navigator view
JSP File Editor Call Control Perspective only. ● File menu > New
Opens an editor to edit JSP files. ● Main toolbar
● Right-click anywhere
in the Navigator view
or in the Speech
Navigator view
Call Control Call Control Perspective only. ● File menu > New
Project Opens a wizard to create a call ● Main toolbar
control project.
● Right-click anywhere
in the Navigator view
or in the Speech
Navigator view
Database Call Control or Speech ● File menu > New
Operation File Perspective. Opens the wizard ● Main toolbar
to create a database operation
file, and can be used in either a ● Right-click anywhere
speech application or a call in the Navigator view
control application. or in the Speech
Navigator view
Grammar File Speech Perspective only. Opens ● File menu > New
the wizard to create a grammar ● Main toolbar
file.
● Right-click anywhere
in the Navigator view
or in the Speech
Navigator view
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 32
Getting familiar with the Orchestration Designer user interface
Media file Speech Perspective only. Opens ● File menu > New
a wizard to create media files ● Main toolbar
such as SMIL file containing
audio, video, prompts, text, and ● Right-click anywhere
graphics. The media elements in the Navigator view
can also be used in call control or in the Speech
applications. Navigator view
Phraseset file Speech Perspective only. Opens ● File menu > New
the wizard to create a phraseset ● Main toolbar
file.
● Right-click anywhere
in the Navigator view
or in the Speech
Navigator view
Prompt File Speech Perspective only. Opens ● File menu > New
the wizard to create a prompt ● Main toolbar
file.
● Right-click anywhere
in the Navigator view
or in the Speech
Navigator view
Web Service Call Control or Speech ● File menu > New
Operation File Perspective. Opens the wizard ● Main toolbar
to create an Axis Web service
operation file, and can be used ● Right-click anywhere
in either a speech application or in the Navigator view
a call control application. or in the Speech
Navigator view
Web Service Call Control or Speech ● File menu > New
Operation File Perspective. Opens the wizard ● Main toolbar
(Axis2) to create an Axis2 Web service
operation file, and can be used ● Right-click anywhere
in either a speech application or in the Navigator view
a call control application. or in the Speech
Navigator view
Start Tomcat Call Control or Speech ● Tomcat menu
Perspective. Starts the Tomcat ● Main toolbar
servlet engine. The Tomcat
servlet engine is required to
simulate applications in
Orchestration Designer.
33 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Orchestration Designer Menu and Toolbar options
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 34
Getting familiar with the Orchestration Designer user interface
35 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
Orchestration Designer Menu and Toolbar options
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 36
37 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
CCXML
Glossary
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 38
Computer Telephony Integration (CTI)
Computer Software technology that integrates the use of telephones and computers
Telephony without the need for special telephones, connectors, computer circuit packs, or
Integration (CTI) other specialized hardware.
CTI See Computer Telephony Integration (CTI).
dialed number A service that identifies for the receiving system what telephone number was
identification dialed by the caller. In the Avaya Experience Portal system this is often used to
service (DNIS) direct the call to a particular speech application, which is identified with that
dialed number.
DNIS See dialed number identification service (DNIS).
DTMF See dual tone multi-frequency (DTMF).
dual tone The system used by touchtone telephones, DTMF assigns a specific frequency
multi-frequency (consisting of two separate tones) to each telephone key on the keypad, so that
(DTMF) it can easily be identified by a microprocessor.
Eclipse A Java-based open-source extensible IDE (integrated development
environment) that provides application developers a feature-rich interface to
develop their applications. Orchestration Designer is designed as a set of
Eclipse plug-in modules that make it possible for application developers to
design 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
Orchestration 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 Orchestration Designer, a grammar is are speech elements
used in conjunction with automated speech recognition (ASR) technology.
Grammars are lists of possible responses that callers make when responding to
the prompts by using spoken replies. Grammars define which words or phrases
the ASR engine can recognize and respond to.
H.323 A hierarchical, IP-based telephony standard for connecting IP telephones and
speech applications to switches.
IC See Interaction Center (IC).
IDE See integrated development environment (IDE).
integrated A software application that usually provides a GUI environment, a text and/or
development code editor, a compiler and/or interpreter, and a debugger. This environment
environment (IDE) means that application or web developers can develop, test, and build their
applications or Web sites within a single integrated space.
Interaction Center A multichannel contact management platform that enables businesses to align
(IC) real-time contact center operations with business objectives.
interactive voice A system, such as Avaya Experience Portal or Avaya IR, in which callers
response (IVR) interact with a self-service application to get information, conduct transactions,
system or help with problems.
IVR system See interactive voice response (IVR) system.
39 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
SIP
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 40
speech user interface (SUI)
speech user Any software interface in which the user interacts with the system using speech
interface (SUI) commands 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. By
convention, URLs that use SSL require a connection using the HTTPS protocol,
rather than just HTTP.
SSML Speech Synthesis Markup Language.
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 as
pronunciation, volume, pitch, rate, and so forth, across different
synthesis-capable platforms.
stacked notebook See notebook.
Structured Query A standard interactive and programming language for getting data to and from a
Language (SQL) database.
SUI See speech user interface (SUI).
tabbed notebook See notebook.
TDD See Telecommunications Display Device (TDD).
Telecommunications Sometimes designated as a teletypewriter (TTY) device, a telephone equipped
Display Device with a keyboard and display, used by hearing-impaired or speech-impaired
(TDD) callers to send and receive typed messages.
telephone user Any software interface in which the user interacts with the system using a
interface (TUI) telephone or similar device.
teletypewriter (TTY) See Telecommunications Display Device (TDD).
device
text-to-speech (TTS) Technology by which information in text format is rendered as audio output
using 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.
41 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011
A specification which provides for a user to interact with Internet-based
resources using voice recognition technology. Instead of a typical Web browser
that requires a combination of HTML, keyboard, and mouse device, VoiceXML
relies on an Internet voice browser and/or telephone. Using VoiceXML, the user
interacts with the Web “page” by listening to audio outputs (either pre-recorded
or using a technology such as TTS) and by submitting input in the form of the
user’s natural speaking voice and/or manual responses, such as telephone key
presses.
Web service A standardized way of offering Web-based applications or services. Because
Web services are Web-based and standards-based applications, delivered over
the Internet, Web services make it possible for organizations to communicate
and share data that use different file formats and programming languages.
workspace In Orchestration Designer, the area within the Editor view used to build the
functionality for the selected editor. For example, in the Call Flow Editor, this is
the space to the right of the palette, in which you place the nodes that represent
application functions.
WSDL Web Services Description Language.
An XML-formatted language used to describe a Web service’s capabilities.
XML eXtensible Markup Language.
A specification for the presentation of Internet documents, one which expands
on the capabilities of HTML. A pared down version of SGML (Standard
Generalized Markup Language), XML makes it possible for designers to create
their own customized tags, which in turn makes it possible to do things over the
Internet that cannot be done using simple HTML.
Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011 42
43 Getting Started with Avaya Aura ® Orchestration Designer, Release 6.0 August 2011