IBM WebSphere Voice Toolkit
V6.1
Installation Readme
February 2009
(C) Copyright IBM Corporation 2001, 2009. All Rights Reserved. Note to
U.S. Government Users Restricted Rights - Use, duplication or disclosure
restricted by GSA ADP Schedule Contract with IBM Corp.
Note:
Before using this information and the product it supports, read
the general information under Notices in this document.
Contents
This document contains the following topics about installing the IBM WebSphere Voice Toolkit.
Introduction
This readme provides information on installing the IBM(R) WebSphere(R) Voice Toolkit, which includes the following features:
- An integrated development environment (IDE), a Communication Flow Builder editor, a VoiceXML editor, a CCXML editor, a Lexicon editor, and editors for creating grammars written in SRGS (XML or ABNF)
- VoiceXML 2.0 and VoiceXML 2.1 support
- Conversion tools for VoiceXML, audio, and grammar files.
- A Pronunciation Builder, Audio Prompt Manager, Audio recorder, Grammar Weighting, Transcription tool and Batch Grammar Test tool.
- Voice Trace Analyzer for use with WebSphere Voice Server log files.
- Plug-ins and tools for developing grammars and pronunciations for use with WebSphere Voice Server.
Getting help
Readme files are located in the <Eclipse_install_dir>\eclipse\plugins\com.ibm.voicetools.doc_6.1.0 directory, where <Eclipse_install_dir> is the full path to the
installation directory of your Eclipse workbench.
For additional information about the samples included with the toolkit, see
the sample readme files that are located in each of the sample directories
in <Eclipse_install_dir>\eclipse\plugins\com.ibm.voicetools.samples_6.1.0
For information on using the WebSphere Voice Toolkit, refer to the online Help.
To view Help after starting the Eclipse workbench, click Help > Help Contents.
When the Help window appears, select Developing Voice applications from the Contents pane.
Hardware requirements
- System suitable for running Microsoft(R) Windows(R) XP
- System suitable for running your configuration of Eclipse 3.2 with the Web Tools Platform 1.5.2
- Minimum of an Intel(R) Pentium(R) III 880 MHz processor or equivalent (1.0 GHz recommended)
- 1GB RAM minimum
- A display adapter setting of at least 256 colors and 1024x768 resolution or higher
- Sound card and speakers for audio playback
- 100 MB minimum free disk space
Software requirements
- Microsoft Windows XP (Service Pack 2 or higher)
- Eclipse 3.2 with Web Tools Platform 1.5.2, running in a Java 1.5.0 Runtime Environment (all included in IBM Rational SDP 7.0)
Notes:
- For voice application developers planning to deploy their applications on non-Windows platforms which support the
VoiceXML 2.0 or VoiceXML 2.1 standards, use Windows as the development platform, and then deploy the application to the server on whatever platform you choose.
Installation
This section contains the following topics:
Prerequisites
- Eclipse 3.2 with Web Tools Platform 1.5.2, running in a Java 1.5.0 Runtime Environment (all included in IBM Rational SDP 7.0)
- To use the Communication Flow Builder tool, set your display setting to small
fonts. To do so, click Start > Control Panel and then select Display.
On the Display Properties dialog, select the Appearance tab,
and select the smallest Font Size, Normal.
Installing the WebSphere Voice Toolkit
- Start your Eclipse 3.2 (or IBM Rational SDP 7.0) workbench.
- Click Help > Software Updates > Find and Install.... The Install/Update window is displayed.
- Select the radio button that reads "Search for new features to install", and then press Next.
- Select New Local Site... and select the location of the installation files (the directory that contains the site.xml file).
- In the Edit Local Site window, enter a name for the installation site (such as "Voice Toolkit V6.1") for your future reference, then press OK.
- Press the Finish button on the Install window.
- You must accept all license agreements and choose to Install All features, bypassing any warnings about unsigned JAR files.
Your Eclipse workbench will be restarted automatically once the Voice Toolkit features are installed.
After you install:
- The WebSphere Voice Toolkit has been optimized to work with Rhino JavaScript Interpreter v1.5 release 3.
It is recommended that this version, Rhino JavaScript Interpreter v1.5 release 3, be downloaded from
http://www.mozilla.org/rhino/download.html using the download link rhino15R3.zip.
Important:
Do not install any other version than v1.5 release 3, as this will cause error conditions with this product.
- To install the Rhino JavaScript Interpreter download the rhino15R3.zip, extract the file js.jar, and copy to the following directory:
- For Eclipse: <Eclipse_install_dir>\eclipse\plugins\com.ibm.voicetools.es_6.1.0
- For Rational: <Rational_install_dir>\plugins\com.ibm.voicetools.es_6.1.0
By default the <Rational_install_dir> path is: Program Files\IBM\SDP70
Getting started
To launch the WebSphere Voice Toolkit, start the Eclipse workbench into which you installed the toolkit.
- If you cannot access the Voice Toolkit functions after installation, following these steps:
- Start your Eclipse workbench.
- Click Help > Software Updates > Manage Configuration. The Product Configuration window is displayed.
- Expand the first entry, which points to the eclipse directory. The list displays the toolkit features.
- Select Voice Toolkit Base feature 6.1.0 and from the Available Tasks list, and select Enable.
- Select VoiceXML Application Development feature 6.1.0 and from the Available Tasks list, and select Enable.
- Restart your Eclipse workbench.
- The projects and files that you create using the toolkit are
saved in the workspace location that you select when you open the Eclipse workbench.
If you uninstall the toolkit, the workspace remains on
your system so that the files are still available.
- When running the toolkit, there are temporary .ulw and .pkg files that are placed in the directory
specified in your TMP variable. Sometimes these files are not removed automatically when you close the toolkit or if
the toolkit unexpectedly closes. You will need to remove these files when uninstalling the toolkit or as needed.
- In addition to the toolkit help, this package includes certain related
publications. To view or print these publications, you must use the
Adobe Reader version 4.0.5 or later. For optimum viewing, use
Adobe Reader version 7.0. To download Adobe Reader, go to the Adobe Web site at www.adobe.com.
Click Get Adobe Reader, and follow the directions.
Known installation problems
This section covers known installation problems and limitations on Windows. Refer to the IBM WebSphere Voice Toolkit V6.1 Readme for information about problems and limitations that affect actual use of the product.
- To avoid issues related to a lengthy path, it is recommended that the Eclipse workbench be
installed to a directory such as C:\eclipse32 or similar.
- To avoid issues related to a lengthy path, it is recommended that your Eclipse workspace be
assigned to a directory such as C:\workspace32 or similar.
Uninstallation
Uninstalling the WebSphere Voice Toolkit
- To uninstall the WebSphere Voice Toolkit, follow these steps:
- Start your Eclipse workbench.
- Click Help > Software Updates > Manage Configuration. The Product Configuration window is displayed.
- Expand the first entry, which points to the eclipse directory. The list displays the toolkit features.
- Select VoiceXML Application Development feature 6.1.0 and from the Available Tasks list, and select Uninstall. Do NOT select to restart the workbench.
- Select Voice Toolkit Base feature 6.1.0 and from the Available Tasks list, and select Uninstall. Do NOT select to restart the workbench.
- Close your Eclipse workbench.
- Manually delete the com.ibm.voicetools.* directories (if they were not already removed) from the eclipse\plugins and eclipse\features directories within the Eclipse installation directory.
Notices
The following paragraph does not apply to the United Kingdom or any
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION
"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY
OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer
of express or implied warranties in certain transactions, therefore, this
statement may not apply to you.
This information could include technical inaccuracies or typographical
errors. Changes are periodically made to the information herein; these
changes will be incorporated in new editions of the publication. IBM may
make improvements and\or changes in the product(s) and\or the program(s)
described in this publication at any time without notice.
Any references in this information to non-IBM Web sites are provided
for convenience only and do not in any manner serve as an endorsement
of those Web sites. The materials at those Web sites are not part of the
materials for this IBM product and use of those Web sites is at your own
risk.
Information concerning non-IBM products was obtained from the suppliers
of those products, their published announcements or other publicly available
sources. IBM has not tested those products and cannot confirm the accuracy
of performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed
to the suppliers of those products.
Trademarks
The following terms are trademarks or registered trademarks of the International
Business Machines Corporation in the United States, other countries, or
both:
IBM
Rational
WebSphere
Intel and Pentium are trademarks or registered trademarks of Intel Corporation
in the United States, other countries, or both.
Microsoft and Windows are trademarks of Microsoft Corporation in the
United States, other countries, or both.
Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Sun Microsystems, Inc. in the United States, other countries,
or both.
Other company, product, and service names may be trademarks or service
marks of others.