IBM WebSphere Voice Toolkit
V6.0 Preview
Installation Readme

December 2004

(C) Copyright IBM Corporation 2001, 2004. 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.

IBM^(R) WebSphere^(R) Voice Toolkit is the new name of the previously released software entitled Voice Toolkit for WebSphere Studio. Also, for users familiar with Voice Toolkit for WebSphere Studio software and documentation, the term call flow is now referred to as communication flow.

Contents

This document contains the following topics about installing the IBM WebSphere Voice Toolkit.

• Introduction
• Hardware requirements
• Software requirements
• Installation
• Getting started
• Known installation problems
• Uninstallation
• Notices
• Trademarks

Introduction

This readme provides information on installing the IBM WebSphere Voice Toolkit, which includes the following features:

• VoiceXML Application Development and Debug includes the following tools:
  • An integrated development environment (IDE), a Communication Flow Builder editor, a VoiceXML editor, a VoiceXML 2.0 browser, a CCXML editor, a CCXML interpreter, and editors for creating grammars written in SRGS (XML or ABNF)
  • A pronunciation builder and an audio recorder
  • A speech recognition engine and data, Text-to-Speech (TTS) engines, grammar compiler, and other modules necessary for the desktop runtime environment.

• Voice Portlet Application Development and Debug includes the following tools:
  • An integrated development environment (IDE), a Communication Flow Builder editor, a VoiceXML editor, a VoiceXML 2.0 browser, a CCXML editor, a CCXML interpreter, and editors for creating grammars written in SRGS (XML or ABNF)
  • A pronunciation builder, an audio recorder, a set of VoiceXML reusable dialog components, and all of the Java tools needed to build portlets deployable on a voice portal server

  Note: Installation of the Rational(R) Application Developer (RAD) "Portal Tools" feature is required.

• Natural Language Understanding (NLU) Development includes a user interface that can minimize both the skills and time needed to develop natural language call routing applications. The tools available in the NLU perspective provide the ability to visually design a call routing application as well as build and test the statistical models used by a natural language call routing application.
• Voice Tools for MRCP Server includes plugins and tools for developing grammars and pronunciations for use with MRCP servers.

Getting help

Readme files are located in the <rational_dir>\VoiceToolkit\Readme directory, where <rational_dir> is the full path to the IBM Rational Software Development (SDP) Platform. By default, this path is as follows: Program Files\IBM\Rational\SDP\6.0\VoiceToolkit\Readme

For information on using the Voice Toolkit, refer to the online Help. To view Help after starting the IBM Rational Software Development Platform, click Help > Help Contents. When the Help window appears, select VoiceXML developer information from the Contents pane. You can also view help for Voice Portlet developer information, NLU developer information, and Voice Tools for MRCP Server.

Hardware requirements

• System suitable for running Microsoft(R) Windows(R) 2000 or Microsoft Windows XP
• System suitable for running the Rational Software Development Platform [installed with Rational Application Developer (RAD) or Rational Web Developer (RWD)]
• Minimum of an Intel(R) Pentium(R) III 880 MHz processor or equivalent (1.0 GHz recommended)
• 768 MB RAM minimum (1GB recommended)
• A display adapter setting of at least 256 colors and 1024x768 resolution or higher
• Sound card and speakers for audio playback
• 250 MB minimum free disk space (in addition to the disk space requirement for RAD/RWD), plus additional space for the installation options selected by the user
• For installation, an additional 250 MB temporary space on the drive specified in your user TMP environment variable

Software requirements

• Microsoft Windows 2000 (Service Pack 4 or higher), or Microsoft Windows XP (Service Pack 1 or higher)
• Rational Application Developer (RAD), Version 6.0, or Rational Web Developer (RWD), Version 6.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 deploy the application to the server on whatever platform you choose.
• If you plan to develop applications for WVAA (Portlets), you must install the Portal Tools, which is an optional feature when installing RAD. If you plan to install the IBM Aggregator product, the WebSphere Portal V5.0 test environment is also required. This test environment is available for installation from the Rational Software Development Platform Launchpad.

Installation

This section contains the following topics:

• Prerequisites
• VoiceXML Application Development and Debug prerequisites
• Voice Portlet Application Development and Debug prerequisites
• Natural Language Understanding (NLU) Development prerequisites
• Installing the Voice Toolkit
• Installing speech technologies

Prerequisites

VoiceXML Application Development and Debug prerequisites

• If you have any of the following products installed, you must remove these programs before installing this release:
  • IBM Voice Toolkit for WebSphere Studio
  • WebSphere Voice Application Access (WVAA) Toolkit
  • IBM Multimodal Toolkit for WebSphere Studio
  • Any IBM product that has text-to-speech (TTS)
  • WebSphere Voice Server SDK or other previously-installed speech runtime engines
    Notes:
    • You must have the JRE 1.3.1 installed to uninstall this SDK.
    • After uninstalling the speech runtime engine, you might need to manually delete the speech root environment variables. To do so, follow these steps:

      1. Right-click the My Computer desktop icon and select Properties.
      2. On the System Properties dialog, click the Advanced tab, and then click the Environment Variables button.
      3. In the Environment Variables window, under System variables, scroll to find the SPCH_ROOT, SPCH_BIN, and IBMVS environment variables. Select these variables, and then click Delete.
      4. Click OK to close the dialog.
      5. For the changes to take effect, restart your system.

• To use the Communication Flow Builder tool, set your display setting to small fonts. To do so, do one of the following:
  • On Windows 2000, click Start > Settings > Control Panel and then select Display. On the Display Properties dialog select the Settings tab, and click Advanced. In the Font Size box, select Small Fonts.
  • On Windows XP, click Start > Control Panel and then select Display. On the Display Properties dialog, select the Appearance tab, and select the smallest Font Size, Normal.
    

Voice Portlet Application Development and Debug prerequisites

Prerequisites associated with the Voice Portlet Development and Debug feature are as follows:

• IBM Rational Application Developer, Version 6.0
  Note: If you plan to debug and test voice portlets in the local test environment, RAD must be installed with a short path name, without spaces, periods, or dollar signs in the directory name.
• The Portal Tools feature available with RAD installation
• The Voice Aggregator V5.0 product, available with WVAA

  This product also requires the WebSphere Portal V5.0 test environment, which is available for installation from the Rational Software Development Platform Launchpad.

  To install the Voice Aggregator, follow these steps:

  1. Insert the WebSphere Voice Application Access V5.0 CD in the drive.
  2. Unzip <d:>\install\<lang>\voice.zip into the <rational_dir>\runtimes\wvaa directory.
  3. Edit install.properties to specify the correct user ID, password, port, and host information. For host name, use localhost. Also, specify the correct paths to:

     appserver.dir = <RAD_dir>/ runtimes/portal_base_v5

     portalserver.dir = <RAD_dir>/ runtimes/portal_v50

  4. Make sure that the directory specified by temp.dir exists.
  5. Run install.bat.

Natural Language Understanding (NLU) Development prerequisites

• To use the NLU feature, you must install, at a minimum, the DB2^(R) 8.1 Runtime Client. For more information, refer to the Getting started with developing and building natural language models guide.
• If you plan to use the NLU feature for parser model development, you must install a copy of TCL 8.4.x or higher after DB2 product installation. This library is open source code, available from the http://www.tcl.tk Web site.

  This site offers source code as well as a binary download. To install TCL 8.4.x from the ActiveState Tcl installation binary, download the ActiveTcl product at: http://aspn.activestate.com/ASPN/ and specify the following options:

  • Install for all users (requires administrative privilege)
  • Check both registry settings options

  Note: If you do not use the ActiveState installation, ensure that your PATH includes the directory where the Tcl executable (for example, tclsh84.exe) is located.

Installing the Voice Toolkit

Follow the instructions in the installation wizard to install the Voice Toolkit.

Before you install:

• If your system is running low on resources, you might notice a delay between the progress indicator and the first installation panel.
   
• Errors that occur during the installation will be logged in the voicetools_log.txt file, located in the directory location identified by your TMP environment variable.
   
• Once the installation process has started, the cancel button might be unresponsive and require you to click the button several times before it reappears.
   
• If you are installing on a Windows 2000 system and you get a warning during installation that your PATH variable is too big (the variable is limited to 1024 characters), you can remove duplicated paths from your path variable using the following steps:
  1.  Right click on My Computer on the desktop, and select Properties.
  2. On System Properties window, click the Advanced tab.
  3. Click Environment Variables to open the Environment Variables dialog.
  4. Under System variables, select the Path variable, and click Edit. The Edit System Variable dialog is displayed.
  5. In the Variable Value field, remove duplicated paths. To do this, look for semicolons (;), which are the separators between paths. If paths are duplicated, remove them, and click OK.
     Note:  For easier editing, you might want to copy the variable information from the field into Notepad, and after removing duplicate paths, paste the contents of the variable back into the Variable Value field.
  6. On Environment Variables dialog, click OK. The System Properties dialog is displayed.
  7. Click OK, and continue with the installation.

• When files are downloaded during installation, they unpack to the VoiceToolkit folder in the directory specified in your TMP variable. The files are required for the install process, and after installation they can be deleted if you do not plan to install again. If you might install again, you can add the executable (Voicetools_Setup.exe) to the directory with the files, and keep the files with the executable, or copy them to a CD. Then if you decide to install additional features or speech technologies at a later time, use the executable to automatically connect to the Internet download site to access the required files.

  Note: If you want to refresh your installation, you must remove the VoiceToolkit directory.

Installing speech technologies

Use the installation wizard to install the languages (Speech Technologies) for each feature that you install: VoiceXML Application Development and Debug, Voice Portlet Application Development and Debug, or Voice Tools for MRCP Server. You must select at least one speech technology for each feature. If you select one that is common for the two features, that speech technology is selected and installed for both.

To install a CTTS speech technology, which can be up to 700 MB, you will automatically be connected to the download site during the installation. Note that only one set of engines (TTS or CTTS) can be installed per language. If you select both the TTS and CTTS speech technology for the same language, only the CTTS engines will be installed and used. Then, if you want to use the TTS engines, you must reinstall the TTS speech technology, which will automatically uninstall CTTS.

You can install other Speech Technologies at any time. To do this, run the installation wizard again using Voicetools_Setup.exe. On the feature panel, click Next, and on the speech technology panel, select the new language to install.

Getting started

To launch the Voice Toolkit, click the Start button, and point to Programs (in Windows XP, point to All Programs), and then IBM Rational. Next, click your base product, such as IBM Rational Application Developer V6.0 > Rational Application Developer.

• If you cannot access the Voice Toolkit after installation, following these steps:
  1. Start RAD.
  2. Click Help > Software Updates > Manage Configuration. The Product Configuration window is displayed.
  3. Expand the first entry, which points to the eclipse directory.
  4. Click the Show Disabled Features icon. This displays the Voice Toolkit features.
  5. Select each Voice Toolkit feature that you installed and then select the Enable option, which is listed under Available Tasks in the right pane. Voice Toolkit features include one or more of the following:
     • Natural Language Understanding (NLU) 6.0.0
     • Voice Portlet Tools 6.0.0
     • Voice Toolkit Product Feature 6.0.0
     • Voice Tools for MRCP Server 6.0.0
  6. Restart RAD.
  
   
• To view the Welcome pages, from the Help menu, click Welcome, and select either Voice Portlet Tools or IBM WebSphere Voice Toolkit. They contain information to help you begin working with the toolkit. The Welcome pages contain a link to more detailed Getting Started information. You can also find the Getting Started information in the Contents list of the Help windows for either Voice Portlet developer information or VoiceXML developer information. To access the Welcome pages from the Help menu, click Help Contents, and then select either Voice Portlet developer information or VoiceXML developer information.
   
• The projects and files that you create using the Voice Toolkit are saved in the workspace location that you select when you open the IBM Rational Software Development Platform. If you uninstall the Voice Toolkit, the workspace remains on your system so that the files are still available.
   
• 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 6.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.0 Preview Readme for information about problems and limitations that affect actual use of the product.

• You must uninstall any products that contain IBM TTS before installing the Voice Toolkit. If you have uninstalled those IBM TTS products, but you are still seeing the error message "Found IBM TTS installed in different location" while installing the Voice Toolkit, you should follow these steps:

1. Run regedit.exe. To do so, click Start > Run.
2. Find the registry value for the key:
   

   HKEY_LOCAL_MACHINE\ SOFTWARE\ Microsoft\ Windows\ CurrentVersion\ App Paths\ ibmtts50.dll\ Path

   Next, verify that the TTS engine has been uninstalled from the referenced path on your machine.
3. Delete the registry key:
   

   HKEY_LOCAL_MACHINE\ SOFTWARE\ Microsoft\ Windows\ CurrentVersion\ App Paths\ ibmtts50.dll

4. Retry the installation of the Voice Toolkit.

• During installation you might receive an Unhandled Exception error message stating Setup will now terminate. If you receive this message, click OK and uninstall this program. Close all applications running on your system and try installing this program again.
   
• The TTS/CTTS portion of the install might produce a "Catastrophic Failure" error message. Close all applications running on your system and try installing this program again.
   
• If you have Windows XP installed with Service Pack 1 and Windows XP Hotfix Q328310 applied, you might encounter an InstallShield Ikernel Application Error during installation. If this occurs while installing the Voice Toolkit, you can find the resolution for your problem at:

  http://support.installshield.com/kb/view.asp?articleid=q108020

• Your microphone can pick up output from your computer speakers and interpret it as words in a grammar. To avoid this, turn down the volume on your speakers or use a headset.

Uninstallation

Uninstalling the Voice Toolkit

To uninstall this product on Windows, click Start > Settings > Control Panel and then select Add/Remove Programs. Select the IBM WebSphere Voice Toolkit program. Click Change/Remove and follow the uninstallation wizard instructions.

Files saved in the following <rational_dir>/eclipse subdirectories are deleted when uninstalling the Voice Toolkit. If you create files in these directories, copy them to another folder before uninstalling the Voice Toolkit:

/plugins/ com.ibm.voicetools.engines.wvs_6.0.0
/features/ com.ibm.wpstools_6.0.0
/plugins/ com.ibm.voicetools.browser.wvrsim_6.0.0
/logs

Uninstalling a Speech Technology

From the uninstallation wizard of the Voice Toolkit, select the speech technology to uninstall. Note that at least one speech technology must remain installed for each installed feature. You might have to install the second speech technology before you can uninstall the first speech technology.

Uninstall Failure

If you attempt to uninstall the toolkit, in rare circumstances (such as uninstalling the IBM Rational Software Development Platform before uninstalling the toolkit) the uninstall might fail and you will get an Uninstaller Error. The error message dialog lets you choose whether to remove the toolkit entry from the Add/Remove Programs list.

• If you select Yes (preferred), the toolkit entry is removed from the Add/Remove Programs list. If you select No, the toolkit entry remains on the Add/Remove Programs list.
   
• You will then need to remove any remaining entries in the Windows Registry. To do this:
  1. Run the Registry Editor (REGEDIT.EXE or REGEDT32.EXE)
  2. Delete the following keys:

  HKEY_LOCAL_MACHINE\ SOFTWARE\ IBM\ IBM WebSphere Voice Toolkit

  HKEY_LOCAL_MACHINE\ SOFTWARE\ Microsoft\ Windows\ CurrentVersion\ Uninstall\ f8ea7098568963e941a11a81e7d5a9d5

At this point, you can manually remove the remaining folders and files installed by the toolkit.

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
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.