IBM WebSphere Voice Toolkit V6.1.0
IceCream Sample Readme

November 2008

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

This Readme is organized into the following sections:


Introduction

The IBM(R) WebSphere(R) Voice Toolkit sample included in this directory (icecream_alt.vxml) represents a typical file written in the VoiceXML editor, without using the Communication Flow Builder. It produces a similar application as the one described in the Getting started with developing voice applications, located in the Toolkit online help, in Help > Help Contents > Developing Voice applications > Getting started.

If you prefer writing your application directly in the VoiceXML editor, you can import this sample code (icecream_alt.vxml) as an example of an application written just in VoiceXML. You can then compare the code to the VoiceXML generated by the application from the Communication Flow Builder.

  • icecream_alt.vxml - A simple VoiceXML program that creates a virtual ice cream parlor (without starting in the Communication Flow Builder), with simple inline grammars.
     
  • mainChoice.grxml - A simple SRGS XML grammar that you can reference from the icecream_alt.vxml file, or you can import it to familiarize yourself with the grammar test tool.

Importing and running the samples

To import this sample:

  1. Make sure that you are in the Voice perspective (Window > Open Perspective > Voice).
     
  2. You must have a voice project that you can import the sample into. To create a new voice project, select File > New > Voice Project, and enter a voice project name.
     
  3. To import the sample into your voice project, click File > Import.
     
  4. Select File System, and click Next.
     
  5. Browse to the installation directory, locate the sample, and click OK.
    • for Eclipse: <eclipse_dir>\plugins\com.ibm.voicetools.samples_6.1.0\Samples\IceCreamSample\<language> (such as en_US for US English).

    • for Rational: <rational_dir>\plugins\com.ibm.voicetools.samples_6.1.0\Samples\IceCreamSample\<language> (such as en_US for US English).
      By default, the <rational_dir> path is: Program Files\IBM\SDP70

To run the sample use a Voice XML browser and follow the instructions included in the application.


Modifying the sample to reference an external grammar

You can modify the sample code to reference the SRGS XML grammar included in the sample folder (mainChoice.grxml), instead of using an inline grammar. Be sure that the grammar is imported in the same project directory location as the icecream_alt.vxml file.

To add the reference:

  1. With icecream_alt.vxml open in the editor, locate the <grammar> element that includes the ice cream choices (where the rule id="rule2"), and delete that <grammar> element and its contents.
     
  2. Add the following line at the location of the deleted code, between the ending </prompt> tag and the ending </field> tag: 
    <grammar src="mainChoice.grxml" />
     
  3. Save the file.
     
  4. Run the application again.

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

Other company, product, and service names may be trademarks or service marks of others.