media processing server mps3.5 speech server 6.5 loquendo

Media Processing Server

MPS3.5 Speech Server 6.5 Loquendo Speech Server 7.0 MRCPv1 Supplement

Media Processing Server MPS 3.5 Speech Server 6.5 Loquendo 7.0 MRCPv1 Supplement 2

REVISION HISTORY

June 23, 2010 Linda Zhang Creation


© 2010 Avaya Inc. All Rights Reserved.

Notice

While reasonable efforts were made to ensure that the information in this document was complete and accurate at the time of printing, Avaya Inc. can assume no liability for any errors. Changes and corrections to the information in this document might 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 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 Avaya Support Web site: http://www.avaya.com/support

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

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)

Concurrent User License (CU). End User may install and use the Software on multiple Designated Processors or one or more Servers, so long as only the licensed number of Units are accessing and using the Software at any given time. A "Unit" means the unit on which Avaya, at its sole discretion, bases the pricing of its licenses and can be, without limitation, an agent, port or user, an e-mail or voice mail account in the name of a person or corporate function (e.g., webmaster or helpdesk), or a directory entry in the administrative database utilized by the Product that permits one user to interface with the Software. Units may be linked to a specific, identified Server.

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 the Avaya Support Web site:

http://support.avaya.com/ThirdPartyLicense/

Preventing toll fraud

"Toll fraud" is the unauthorized use of your telecommunications system by an unauthorized party (for example, a person who is not a corporate employee, agent, subcontractor, or is not working on your company's behalf). Be aware that there can be a risk of toll fraud associated with your system and that, if toll fraud occurs, it can result in substantial additional charges for your telecommunications services.

Avaya fraud intervention

If you suspect that you are being victimized by toll fraud and you need technical assistance or support, call Technical Service Center Toll Fraud Intervention Hotline at +1-800-643-2353 for the United States and Canada. For additional support telephone numbers, see the Avaya Support Web site: http://www.avaya.com/support

Trademarks

Avaya and the Avaya logo are either registered trademarks or trademarks of Avaya Inc. in the United States of America and/or other jurisdictions. All other trademarks are the property of their respective owners.

Downloading documents

For the most current versions of documentation, see the Avaya Support Web site: http://www.avaya.com/support

Avaya support

Avaya provides a telephone number for you to use to report problems or to ask questions about your product. The support telephone number is 1-800-242-2121 in the United States. For additional support telephone numbers, see the Avaya Support Web site: http://www.avaya.com/support


Table of Contents

Chapter 1. New in this release ............................................................................................................. 9

Overview ........................................................................................................................................................................................ 9

Features .......................................................................................................................................................................................... 9

Chapter 2. Preface ................................................................................................................................ 10

Scope .............................................................................................................................................................................................. 10

Intended audience ................................................................................................................................................................... 10

How to get help ......................................................................................................................................................................... 10

Finding the latest updates on the Avaya Web Site ...................................................................................................................... 10

Getting help from the Avaya Web Site ............................................................................................................................................. 11

Getting help over the phone from Avaya Solution Center ....................................................................................................... 11

Getting help through a Avaya distributor or reseller ................................................................................................................ 11

How to use this manual ......................................................................................................................................................... 11

Organization of this Manual ................................................................................................................................................. 11

Speech Server Document Family ....................................................................................................................................... 12

Trademark ................................................................................................................................................................................... 13

Chapter 3. Introduction ...................................................................................................................... 15

Documentation .......................................................................................................................................................................... 15

Loquendo documentation...................................................................................................................................................................... 15

Avaya documentation .............................................................................................................................................................................. 16

Speech resource support ....................................................................................................................................................... 16

Speech recognition support ................................................................................................................................................. 16

Speech synthesis support ..................................................................................................................................................... 17

Node architecture..................................................................................................................................................................... 17


Security ......................................................................................................................................................................................... 18

Backup and restore .................................................................................................................................................................. 19

Media Server Node requirement guidelines ................................................................................................................. 19

Web Server configuration ..................................................................................................................................................... 20

Loquendo Media Server management and configuration ....................................................................................... 20

Managing the Loquendo Media Server node ................................................................................................................................. 20

Licensing considerations........................................................................................................................................................................ 21

Configuration on the Loquendo Speech Server node ................................................................................................................ 21

Disable real time antivirus scanning on the Loquendo Media Server node .................................................................... 21

Loquendo Media Server remote support ........................................................................................................................................ 22

Vendor Logging .......................................................................................................................................................................................... 22

Supported standards .............................................................................................................................................................. 22

MRCPv1 protocol ...................................................................................................................................................................... 23

Types of parameters ............................................................................................................................................................... 23

Grammars and Lexicons ........................................................................................................................................................ 24

Unsupported Loquendo Speech Server 7.0 features ................................................................................................. 24

Constraints and support issues .......................................................................................................................................... 24

Loquendo ASR 7.8 and TTS 7.8............................................................................................................................................................ 24

General MRCPv1 support issues ......................................................................................................................................................... 25

VoiceXML support issues ....................................................................................................................................................................... 25

Avaya support on the application and Speech Server nodes ................................................................................. 25

Standard Speech support on the Speech Server node .............................................................................................................. 25

MPS Manager support ............................................................................................................................................................................. 26

MPS Developer support .......................................................................................................................................................................... 26

VoiceXML support ..................................................................................................................................................................................... 26

Chapter 4. Configuration .................................................................................................................... 28


Directory paths and environment variables ................................................................................................................. 28

LSS 7.0 Media Server environment variables ............................................................................................................................... 28

Avaya Speech Server environment variables ............................................................................................................................... 28

Configuration files .................................................................................................................................................................... 30

Loquendo Speech Server node configuration............................................................................................................... 30

Configure the LSS server through Loquendo Management Console .................................................................................. 30

MPS Application Processor node configuration .......................................................................................................... 34

Avaya Speech Server node configuration ....................................................................................................................... 35

vpshosts file ................................................................................................................................................................................................. 37

rcm.tbl file ..................................................................................................................................................................................................... 39

sys-[lvr|extts]-mrcpv1.cfg file .............................................................................................................................................................. 41

vos.cfg file ...................................................................................................................................................................................................... 57

rcm.cfg file .................................................................................................................................................................................................... 58

Configurable parameters ...................................................................................................................................................... 67

Types of Parameters ............................................................................................................................................................... 67

RCM and integration shared library parameters ........................................................................................................................ 68

MRCPv1 parameters ................................................................................................................................................................................ 68

Vendor-specific parameters ................................................................................................................................................................. 68

RTSP parameters ....................................................................................................................................................................................... 69

Configurable parameters table ........................................................................................................................................... 69

Chapter 5. Special Subjects ................................................................................................................ 79

Special subjects ......................................................................................................................................................................... 79

say-as tag ..................................................................................................................................................................................... 79

Lexicons ........................................................................................................................................................................................ 79

Create and edit the lexicon .................................................................................................................................................................... 79

Using the lexicon ........................................................................................................................................................................................ 81

Style Control ............................................................................................................................................................................... 82


Other User Control ................................................................................................................................................................... 83

TTS User Control in Peripro Applications ...................................................................................................................... 84

MultiSpacePause User Control ............................................................................................................................................ 84

Commonly used ports on the Media Server node ....................................................................................................... 84

Language Modeling Recognition Object (LM RO) ....................................................................................................... 85

Builtin Phone Grammar ......................................................................................................................................................... 89

Chapter 6. Install Software ................................................................................................................ 90

Overview ...................................................................................................................................................................................... 90

Introduction ................................................................................................................................................................................ 91

Installation time ........................................................................................................................................................................ 91

Installation prerequisites ...................................................................................................................................................... 91

Requirements .............................................................................................................................................................................................. 91

Administrator logon ................................................................................................................................................................................. 92

Loquendo Speech Server Installation .............................................................................................................................. 92

Loquendo TTS 7.8 Installation ............................................................................................................................................................. 92

Loquendo ASR 7.8 Installation ............................................................................................................................................................ 99

Microsoft SNMP service installation and configuration ......................................................................................................... 102

Loquendo Speech Server 7.0 Installation ..................................................................................................................................... 103

Loquendo License Manager Installation ....................................................................................................................................... 105

Loquendo Patches Installation .......................................................................................................................................................... 108

Post Installation ....................................................................................................................................................................................... 108

Loquendo Software Reinstallation .................................................................................................................................................. 109

Avaya Speech Server Installation ................................................................................................................................... 109

Avaya SelfService 3.5 base package installation ........................................................................................................................ 109

Avaya SelfService 3.5 patch bundle 3 installation .................................................................................................................... 113

Chapter 7. Uninstall Software ........................................................................................................ 115


Uninstalling the Loquendo Software on the Media Server node ....................................................................... 115

Uninstall Loquendo Speech Suite 7.0 ............................................................................................................................................. 115

Uninstall ASR 7.8 ..................................................................................................................................................................................... 115

Uninstall TTS 7.8 ...................................................................................................................................................................................... 115

Uninstalling the Avaya SelfService Software on the Avaya Speech Server node ........................................ 115

Chapter 8. Known Issues .................................................................................................................. 117

Loading .pls lexicon file ......................................................................................................................................................................... 117

Occasional Drop of Beginning of the First Syllable of the First Word in TTS ............................................................... 117

Vendor-specific parameter com.loquendo.beep is not supported .................................................................................... 117

Built-in Phone Grammar Doesn’t Support Phone Number With Extension in Voice Mode ................................... 118

MultiSpacePause configuration parameter ................................................................................................................................. 118

Chapter 9. Troubleshooting ............................................................................................................ 120

Troubleshooting .................................................................................................................................................................... 120

Troubleshooting information ........................................................................................................................................... 120

Vendor logging .......................................................................................................................................................................................... 120

Avaya logging ............................................................................................................................................................................................ 122

Troubleshooting issues ....................................................................................................................................................... 122

Troubleshooting issues ......................................................................................................................................................................... 122


Chapter 1. New in this release

Overview

The following sections describe what is new in MPS 3.5 Speech Server 6.5 Loquendo Speech Server 7.0 MRCPv1 Supplement.

Features

This document is released in support of Loquendo Speech Server 7.0 MRCPv1 on the MPS 3.5 Speech Server 6.5 platform with Loquendo 7.8 speech recognition and Loquendo speech synthesis 7.8 resources.


Chapter 2. Preface

Scope

The following sections describe what is new in MPS 3.5 Speech Server 6.5 Loquendo Speech Server 7.0 MRCPv1 Supplement.

The MPS 3.5 Speech Server 6.5 Loquendo Speech Server 7.0 MRCPv1 Supplement documents the topics that are specific to using the MRCPv1 Loquendo Speech Server (LSS) 7.0 with Loquendo 7.8 speech recognition and 7.8 speech synthesis resources on the MPS 3.5 platform. This document is a supplement to the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132), which describes topics that are generic to all MRCPv1 resources.

You also need the following reference material:

MPS Speech Server 6.5 Installation Guide and Release Notes (NN44100-305) for installation instructions.

MPS Speech Server 6.5 Reference Guide (NN44100-131) for information that is common to all MPS Speech Server 6.5resources.

The Avaya Speech Server product was formerly named the OSCAR (Open Signal Computing and Analysis Resource) product. Beginning with MPS 3.0, the OSCAR 6.0.1 product was renamed Speech Server 6.0.1.

Intended audience

This document is important to any person who develops applications using the MRCPv1-based Loquendo Speech Server 7.0 with Loquendo 7.8 speech recognition and 7.8 speech synthesis resources. There is the underlying expectation that you have completed the appropriate Avaya training programs. You are expected to be competent working with the Windows 2003 operating system.

How to get help

This section explains how to get help for Avaya products and services.

Finding the latest updates on the Avaya Web Site

The content of this documentation was current at the time the product was released. To check for updates to the latest documentation for the MPS 500 and 1000, go to

http://support.nortel.com/go/main.jsp?cscat=DOCUMENTATION&poid=12605&catOID=-9613&viewOptSelect=&viewOpt1=3.5&viewOpt2=ALL&searchText=resource+guide&searchType=title&x=29&y=5





Getting help from the Avaya Web Site

The best way to get technical support for Avaya products is from the Avaya Technical Support Web site: http://support.avaya.com.

This site provides quick access to software, documentation, bulletins, and tools to address issues with Avaya products.

download software, documentation, and product bulletins

search the Technical Support Web site and the Avaya Knowledge Base for answers to technical issues

sign up for automatic notification of new software and Documentation for Avaya equipment

open and manage technical support cases

Getting help over the phone from Avaya Solution Center

If you do not find the information you require on the Avaya Technical Support Web site, and have an Avaya support contract, you can also get help over the phone from an Avaya Solutions Center.

In North America, call 1-800-466-7835.

Outside North America, go to the following Web site to obtain the phone number for your region http://support.avaya.com.

Getting help through a Avaya distributor or reseller

If you purchased a service contract for your Avaya product from a distributor or authorized reseller, contacts the technical support staff for that distributor or reseller.

How to use this manual

This manual uses many standard terms relating to computer systems, software application functions and the Internet. However, it contains some terminology that can be explained only in the context of the MPS Series. See the Glossary of Avaya‟s Media Processing Server Series Terminology for definitions of MPS Series specific terms.

Read this manual from start to finish at least once. When you are familiar with the document, you can use the Table of Contents to locate topics of interest for reference and review.

Periphonics is now part of Avaya. The name Periphonics, and variations thereof, appear in this manual only in reference to a product (for example, the PERImps package, the perirev command, and so on).

Organization of this Manual

This manual describes the topics that are specific to using the MRCPv1-based Loquendo Speech Server (LSS) 7.0 with Loquendo 7.8 speech recognition and 7.8 speech synthesis resources. For information

http://support.avaya.com/

http://support.avaya.com/


common to all MRCPv1-based speech resources, see the MPS Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

Chapter 1 - Introduction

Chapter 1 introduces the MRCPv1-based Loquendo Speech Server 7.0 with Loquendo 7.8 speech recognition and 7.8 speech synthesis resources and describes its special features. See “Introduction”.

Chapter 2 - Configuration

Chapter 2 addresses configuration issues specific to LSS 7.0 with Loquendo 7.8 speech recognition and 7.8 speech synthesis resources, MPS application Server and Avaya Speech Server. Beyond the generic configuration that applies to all MRCP resources. See “Directory paths and environment variables”.

Chapter 3 - Special subjects

Chapter 3 describes special subjects that are specific to LSS 7.0 speech resource processing but are beyond the scope of the other chapters in this document. See “Special subjects”.

Chapter 4 - Install software

Chapter 4 describes how to install LSS 7.0, Loquendo 7.8 speech recognition, 7.8 speech synthesis and Loquendo License Manager software on the LSS 7.0 Media Server node and the MRCPv1 client software on the Avaya Speech Server. See “Overview”.

Chapter 5 - Uninstall software

Chapter 5 describes how to uninstall LSS 7.0, Loquendo 7.8 speech recognition, Loquendo 7.8 speech synthesis and Loquendo License Manager software on the LSS 7.0 Media Server node and the MRCPv1 client software on the Avaya Speech Server. See “Uninstalling the Loquendo Software on the Media Server node”.

Chapter 6 - Troubleshooting

Chapter 6 describes troubleshooting issues related to the Avaya implementation of the LSS 7.0 with Loquendo 7.8 recognition and 7.8 synthesis speech resources. See Troubleshooting”.

Speech Server Document Family

The Speech Server suite of documents include a series of publications that describe the scope of Speech Server resource processing.

An installation document contains software installation procedures, software update procedures, and release notes related to speech vendor software.

A reference guide provides information that is common to all Speech Server resources.

The MRCPv1 resource guide focuses on vendor-independent issues that apply to speech processing with MRCPv1-based recognition and synthesis resources.

Vendor-specific resource guides and MRCPv1 supplements document the implementation of individual vendor‟s speech resources.


Typically, you use the installation guide, reference guide, and all resource guides or supplements that are specific to the vendor‟s resources installed at your site. Review the following summaries to determine which documents to use.

MPS Speech Server 6.5 Installation Guide and Release Notes

This document guides you through installing the software required for Speech Server 6.5 resource processing on the MPS platform. It also contains release notes specific to vendor software issues, software upgrade instructions, and information about configuring the Digital Communications Controller (DCC) board.

MPS Speech Server 6.5 Reference Guide (NN44100-131)

This document applies to all Speech Server 6.5 resource processing on the MPS platform. Use this document in conjunction with all resource guides or supplements that are specific to the vendor‟s resources installed at your site.

MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132)

This document applies only to MRCPv1-based speech resource processing on the MPS 3.x platform. Use this document in conjunction with the MPS Speech Server 6.5 Reference Guide and the MRCPv1 vendor-specific supplements that apply to the vendor‟s resources installed at your site.

Speech Server Vendor-Specific Resource Guides (NN44100-1xx)

Each publication in this series documents a specific vendor‟s speech resource on the MPS 3.x platform. This set of documents does not apply to MRCPv1-based resources. Use the documents in this series that apply to the vendor resources installed at your site, as well as the MPS Speech Server 6.5 Reference Guide, which contains information common to all Speech Server resources.

Speech Server MRCPv1 Vendor Supplements (NN44100-1xx)

Each publication in this series documents a specific vendor‟s MRCPv1-based speech resource on the MPS 3.5 platform. Use the documents in this series that apply to the vendor resources installed at your site. In addition, use the MPS Speech Server 6.5 Reference Guide and MPS3.0 Speech Server 6.0.1 MRCPv1 Resource Guide, which contain information common to speech resources.

Vendor-Distributed Documentation

It is expected that you see the documentation provided by the individual resource vendors. The resource vendor is in control of their product and determines how their product functions. The documentation provided by Avaya is not a substitute for the documentation provided by the resource vendor. The documentation provided by Avaya describes how to implement a specific vendor‟s resource in the Speech Server 6.5 resource processing environment.

Trademark

The following trademark information is presented here and applies throughout for third party products discussed within this manual. Trade marking information is not repeated hereafter.

Loquendo Speech Server, speech recognition 7.8, speech synthesis 7.8 are trademarks of Loquendo.

Microsoft, Windows, Internet Explorer, and the Flying Windows logo are either trademarks or registered trademarks of Microsoft Corporation.


Netscape® and the Netscape N® and Ship‟s Wheel® logos are registered trademarks of Netscape Communications Corporation in the U.S. and other countries. Netscape Navigator is also a trademark of Netscape Communications Corporation and can be registered outside the U.S.

Solaris is a trademark or registered trademark of Sun Microsystems, Inc. in the United States and other countries.


Chapter 3. Introduction

Loquendo Speech Server (LSS) 7.0 is an MRCPv1-based speech processing resource that offers Loquendo ASR 7.8 and Loquendo TTS 7.8 capabilities on the MPS 3.5 Avaya Speech Server 6.5 platform.

The LSS resource is installed on a node dedicated to Media Server processing and not on the Avaya Speech Server node. Loquendo Speech Server and Avaya Speech Server cannot co-exist on the same node. Avaya supports the LSS 7.0 only on Microsoft Windows 2003 nodes.

The LSS 7.0 resource is supported in an environment with MPS 500 and MPS 1000 Application Processors. You can develop applications for the LSS using Avaya MPS Developer 3.0.1 and VoiceXML 2.0 or 2.1.

See MPS Developer support

See VoiceXML support

Avaya assigned the name mrcpv1 to the MRCPv1 resource client. The Avaya MRCPv1 client resides on the Avaya Speech Server node. The MRCPv1 resource on the Avaya platform consists of two separate and independent resources for recognition and synthesis. The name of the recognition resource is lvr-mrcpv1. The name of the synthesis resource is extts-mrcpv1.

The RCM process is designed to support a resource of one type only in a single component on a Speech Server node. Therefore, multiple components must be configured on the Speech Server node to support simultaneous recognition and synthesis processing, one component configured for lvr-mrcpv1 and another component configured for extts-mrcpv1. For additional information, see the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

Documentation

Documentation for the Loquendo Speech Server 7.0 resource is provided by Loquendo and documentation for the Avaya Speech Server is provided by Avaya.

See Loquendo documentation

See Avaya documentation

Loquendo documentation

The documentation that originates from Loquendo provides information about how to work with Loquendo Speech Server 7.0, Loquendo ASR 7.8, Loquendo TTS 7.8 and the Loquendo License Manager. These documents are installed with the Loquendo vendor software, can be opened from the following directory if you use the default installation path:

Loquendo recognition document: C:\Program Files\Loquendo\LASR\documents

Loquendo synthesis document: C:\Program Files\Loquendo\LTTS7\doc

Loquendo Speech Server: C:\Program Files\Loquendo\Suite\doc


Avaya documentation

Avaya documentation provides information about working with the Loquendo Speech Server 7.0 resource in the MPS 3.5 Speech Server 6.5 environment. The documentation that applies to the Loquendo Speech Server 7.0 resource and originates from Avaya includes the following:

MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132) contains information that is common to all Mps3.x Speech Server 6.5 MRCPv1-based speech resource processing.

MPS 3.5 Speech Server 6.5 Loquendo Speech Server 7.0 MRCPv1 Supplement contains information specific to Loquendo Speech Server 7.0 with Loquendo 7.8 recognition and Loquendo 7.8 synthesis resources.

MPS Speech Server 6.5 Reference Guide (NN44100-131) Contains information that is common to all Speech Server 6.5 resources on the MPS platform.

MPS Speech Server 6.5 Installation Guide and Release Notes (NN44100-305) contain information about installing the Avaya and Loquendo speech processing software on the MPS 3.5 platform.

MPS VXML Browser User Guide (NN44100-127) contains Information about developing VoiceXML applications and using the VoiceXML Interpreter on the MPS platform.

MPS 500 Hardware Installation and Maintenance (NN44100- 302) contains information about hardware supported for speech Resource processing in an MPS 500 environment. This includes Information about Backup and Restore procedures.

MPS 1000 Hardware Installation and Maintenance (NN44100-301) contains information about hardware supported for speech resource processing in an MPS 1000 environment. This includes information about Backup and Restore procedures.

MPS Alarm Reference Manual (NN44100-700) contains Information about alarms related to MRCPv1-based resource processing generated on the MPS Application Processor node.

Installing MPS Software on the Windows Platform (NN44100-304) contains information about installing software on a Windows node and implementing security on the Windows platform.

Installing MPS Software on the Solaris Platform (NN44100-303) contains information about installing software on a Solaris node and implementing security on the Solaris platform.

Speech resource support

Loquendo Speech Server 7.0 provides MRCPv1-based speech processing with Loquendo 7.8 recognition and 7.8 synthesis resources for the Avaya Speech Server 6.5 product in the MPS 3.5 environment.

Speech recognition support

Speech recognition (Automatic Speech Recognition or ASR and Large Vocabulary Recognition or LVR) is the process of that converts human speech to text. Most often ASR engines use specific grammars to narrow the possible matches for an audio segment. Most engines include an end pointer that determines the beginning and end of speech, and these signal analyzers train themselves to the acoustic characteristics of the audio


channel to recognize speech and filter noise. After the end pointer has isolated the audio segment, it sends the segment to the recognition engine for analysis.

MPS Developer and VoiceXML applications acquire a Loquendo MRCPv1 LVR resource using the pool name lvr-mrcpv1. Once the application acquires a resource, the application can load and activate SRGS 1.0 grammars with Semantic Interpretation for Speech Recognition (SISR) and perform recognition requests.

VoiceXML applications support ISO-8859-1 and UTF-8 based languages.

Speech synthesis support

Speech synthesis or Text-To-Speech (TTS) is the process that converts text to computer-generated speech.

Loquendo offers male and female voices in several languages.

MPS Developer and VoiceXML applications acquire a Loquendo MRCPv1 TTS resource using the pool name extts-mrcpv1. Once the application acquires a resource, the application can request that the resource play SSML 1.0 text strings.

VoiceXML applications support ISO-8859-1 and UTF-8 based languages.

Node architecture

The Loquendo Speech Server (LSS) 7.0, Loquendo 7.8 ASR, Loquendo 7.8 TTS, and Loquendo License Manager software resides and runs on a Media Server node, which is separate from the Avaya Speech Server node. Avaya recommends that the LSS Media Server node be located on the private LAN to avoid latency issues. Avaya does not prohibit the Media Server from being on an external LAN; however that configuration may encourage latency issues and dropped packets, resulting in poor user response and performance.

MRCPv1 client-side speech resource processing (MRCPv1 Client) occurs on a different Speech Server node, which is configured with a single Speech Server component for each resource installed on the node. A single Avaya Speech Server component can connect with only one Media Server node. MRCPv1 server-side speech resource processing occurs on the LSS Media Server node.

An Avaya Speech Server node can be configured with two components, one for LVR and one for TTS. Each component can connect to a separate LSS Media Server Node. However, a single Speech Server component cannot connect to two Media Server nodes.


For information about the types of MRCPv1 client components you can install on a Speech Server node, see the MPS Speech Server 6.5 Installation Guide and Release Notes (NN44100-305).

Security

It is important that a site-specific security plan is in place where the Avaya Speech Server 6.5 is located and to address security both on the Loquendo Media Server and Avaya Speech Server nodes. For example, you need to know the ports that must remain open on the Media Server node.

For information about security on MPS Application Processor and Speech Server nodes, see the following documents.

MPS Speech Server 6.5 Reference Guide (NN44100-131):

This document addressed the services, processes and ports that are required for speech resource processing on the Speech Server node.

Installing MPS Software on the Windows Platform (NN44100-304):

This document provides information about security on the Windows platform.

Installing MPS Software on the Solaris Platform (NN44100-303):

This document provides information about security on the Solaris platform.

For additional information about virus protection, see “Disable real time antivirus scanning on the Loquendo

Media Server node”

Avaya MPS Application processor

Avaya Speech Server

LVR and TTS components

LSS Media Server

ASR and TTS engines

Web Server

Grammars and lexicons

Telephone

IP network

MRCPv1/RTSP

HTTP

Figure 1: Avaya Implementation of Loquendo Speech Server 7.0 Processing


Backup and restore

It is your responsibility to backup data and be able to restore data (if necessary) on both the Speech Server nodes and the Media Server node.

Speech Server node:

Follow the backup and restore procedures for Windows machines according to the Media Processing Server 500 Hardware Installation and Maintenance manual or the Media Processing Server 1000 Hardware Installation and Maintenance manual.

LSS Media Server node: Use the documentation provided by Loquendo to backup and restore data on the LSS Media Server node.

In addition, backing up the Speech Server and Media Server nodes are expected to be integrated into the customer‟s overall Backup/Restore plan in the interest of securing their computer network.

Media Server Node requirement guidelines

Avaya recommends the following requirement guidelines for the Loquendo Speech Server (LSS) Media Server node.

Specifications:

Windows 2003 installed with Service Pack 2.

Dual Intel Xeon @3.4 GHz

Minimum of 4 GB RAM for the recognition or synthesis resources.

5 GB Free Disk Space

Static IP address.

No antivirus software. Antivirus software contributes to performance issues.

No firewall.

All Loquendo language models and TTS voices must be available to the installer before you begin the installation process.

Install the Loquendo vendor software on the Media Server as indicated in this document. For information about installing the Loquendo software, see Loquendo Speech Server Installation.

Install the Loquendo vendor software in a partition with sufficient space available to collect log audio files and other logging with the full range of trace settings enabled. These files are used for diagnostic purposes. For information about logging see the documentation provided by Loquendo. For additional information about logging, see “Vendor logging”.


Web Server configuration

Grammars and lexicons may reside on a Web server. In this case, the Media Server must retrieve them from the Web server and save them to the Media Server node before it can satisfy a request from the application for recognition or synthesis. See “Grammars and Lexicons”.

The Web server must be configured with the MIME mappings to the file types used for the grammar and lexicon files. The following chart identifies some of the file extensions and their associated MIME type.

File Extension MIME type

.grxml application/srgs+xml

.ulaw audio/basic

.alaw Audio/x-alaw-basic

.wav audio/x-wav

.xml text/xml

.au audio/basic

.pls application/pls+xml

.lex application/lex

Loquendo Media Server management and configuration

The LSS product is configured with default values for all parameters.

Some additional configuration is required after you install the Loquendo vendor software. When you make any configuration changes, you must restart the Management Context service on the Media Server before those changes take effect. For additional information about configuration changes, see “Loquendo Speech Server node configuration”.

Use the documentation provided by Loquendo for information about how to manage and configure the LSS Media Server node.

For information about installing the Avaya MRCPv1 client on the Speech Server node and configuring it for LSS speech recognition and synthesis transaction processing, see “Avaya Speech Server Installation“.

Managing the Loquendo Media Server node

Start and stop Media Server Use the windows service Management Context from windows service tool to start and stop the Media Server. This is a service that manages the MRCP server life. The following is how to access Loquendo Management Context.

Start->Administrative Tool->Services->Loquendo Management Context


Access to Media Server Management Console Management Context must be running before accessing Management Console.

Start->All Programs->Loquendo->Loquendo Speech Suite 7.0->Management Console.

Configuration

You can use Management Console to configure the parameters for MRCP server. After the configuration is done, you can restart only the MRCP server without restarting the Management Context service by doing the following.

Management Console->Administration->lifeCycleCmd->restart(2).

Obtain the current information of the LSS Media Server

Use the Loquendo Info Collector to get information on LSS Media Server.

Management Console->support->Loquendo Info Collector

Perform Log and Trace operations

Use the Loquendo Log Collector to get logs for LSS Media Server.

Management Console->support->Loquendo Log Collector

See “Vendor logging” for details.

For additional information for performing administrative tasks such as the above on the LSS Media Server node, see the documentation provided by Loquendo.

Licensing considerations

For information about installing the Loquendo License Manager, See “Loquendo License Manager Installation”.

Configuration on the Loquendo Speech Server node

After you complete the Loquendo vendor software installation process on the Media Server node, you must configure parameters in the Loquendo Management Console. This configuration is required for Loquendo Speech Server resource processing in the Avaya MPS environment. For additional information about configuring parameters in these files, see “Loquendo Speech Server node configuration”.

Disable real time antivirus scanning on the Loquendo Media Server node

If antivirus software is installed on the Loquendo Speech Server, do not enable scanning during real time operations in a production environment. Real time scanning has a negative impact on system operation and performance.

At best, execute antivirus scanning during maintenance periods, When Loquendo Speech Server processes are shut down


At minimum, limit antivirus scanning to the hours when call traffic Is lowest and exclude all folders that contain Loquendo software from the scan. In the interest of overall network virus protection, it is best to configure the Avaya solution on a separate subnet to isolate it from unnecessary traffic. You can take additional measures to secure the network from unnecessary traffic using firewalls that allow restricted (Virtual Private Network) VPN or remote access. You can also limit communications to only the subnets, IP addresses, or ports that is required for proper operations.

The best way to ensure that a system can cope with the additional CPU, disk, and network bandwidth that virus scanning can consume, is to consider virus scanning, initially, when performing system provisioning and sizing.

Loquendo Media Server remote support

The LSS Media Server node is equipped for remote support. Use remote support software, such as Windows Remote Desktop, to connect with the LSS Media Server node.

Vendor Logging

Loquendo Speech Server (LSS) vendor logging occurs on the Media Server node. Use the documentation provided by Loquendo for information about logging on the Loquendo Speech Server node. Make sure there is enough free disk space available before you enable logging.

For information about logging available on the Avaya Speech Server node, see “Standard Speech support on the Speech Server node”.

Avaya supports the MRCPv1 Logging-Tag parameter. For Information about the Logging-Tag parameter, see the MPS3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

Supported standards

The standards specifications the Loquendo Speech Server 7.0 resource supports are listed in the following.

Standard Version

MRCPv1 A Media Resource Control Protocol (MRCP) Developed by Cisco, Nuance, and Speechworks - IETF – RFC 4463 - Informational - http://www.ietf.org/rfc/rfc4463.txt?number=4463

SRGS Speech Recognition Grammar Specification (SRGS) Version 1.0 W3C Recommendation 16 March 2004 http://www.w3.org/TR/speech-grammar/

SISR Semantic Interpretation for Speech Recognition (SISR) Version 1.0 W3C Candidate

Recommendation 11 January 2006 http://www.w3.org/TR/2006/CR-semantic-interpretation-20060111/

SSML Speech Synthesis Markup Language (SSML) Version 1.0 W3C Recommendation 7

September 2004 http://www.w3.org/TR/speech-synthesis/

PLS Pronunciation Lexicon Specification (PLS) Version 1.0 W3C Recommendation 14

October 2008 http://www.w3.org/TR/pronunciation-lexicon/

http://www.ietf.org/rfc/rfc4463.txt?number=4463

http://www.w3.org/TR/2006/CR-semantic-interpretation-20060111/

http://www.w3.org/TR/2006/CR-semantic-interpretation-20060111/

http://www.w3.org/TR/speech-synthesis/

http://www.w3.org/TR/pronunciation-lexicon/


MRCPv1 protocol

Support for Loquendo Speech Server MRCPv1 Loquendo 7.8 speech recognition and Loquendo 7.8 synthesis resources is implemented by means of the MRCPv1 protocol. The Internet Engineering Task Force (IETF) defines Media Resource Control Protocol version 1 (MRCPv1) as a standard protocol for controlling media server resources, such as a speech recognizer or a speech synthesizer.

The LSS 5.0 resource (which resides on the Media Server node) provides the features of the MRCPv1 server that conform to draft four of the MRCPv1 version 1 specification definition. Avaya provides the MRCPv1 client that communicates with the MRCPv1 server.

The MRCPv1 shared library performs the tasks of an MRCPv1 client (which resides on the Avaya Speech Server node) and relies on protocols such as RTSP (Real-time Streaming Protocol) for initiating and tearing down sessions with a media server and RTP (Real-time Transport Protocol) to send audio data to the media server.

For information about MRCPv1 configuration, see “MRCPv1 parameters”.

This document focuses solely on issues that are unique to using the Loquendo Speech Server 7.0 MRCPv1 recognition and synthesis resources with Avaya‟s MRCPv1 Client. For information about MRCPv1 speech resource processing that is generic to all MRCPv1-based resources, see the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

Types of parameters

There are several types of parameters that can be set from the application and from configuration files. These parameters are categorized as follows:

RCM parameters (platform related) and Integration Shared Library parameters.

The RCM and Integration Shared Library parameters are set in the same way as any other recognition (LVR) or synthesis (TTS) resource that is currently supported on the Avaya Speech Server platform. There is nothing different about setting these parameters for an MRCPv1 resource. See “RCM and integration shared library parameters”.

MRCPv1 parameters.

The MRCPv1 parameters are sent to the Media Server either as part of a header to a method, other than SET-PARAMS, or in the SET-PARAMS method. See “MRCPv1 parameters”.

Vendor-specific resource parameters associated with the recognition or synthesis engines.

The vendor-specific parameters can be set as part of a header to a method or in the SET-PARAMS method according to the MRCPv1 specification. See “Vendor-specific parameters”.

RTSP parameters.

Currently, RTSP parameters are not required to be set. The only methods of RTSP that are used to support MRCPv1 are SETUP, TEARDOWN, ANNOUNCE and DESCRIBE. Thus, Avaya does not support the setting of RTSP parameters. See “RTSP parameters”.

For information about:


The Speech Server node directory structure, see “Directory paths and environment variables”.

Configuring Loquendo Speech Server processing on the Speech Server node, see “(NN44100-131).

Configuration files”.

This document focuses solely on issues that are unique to using the Loquendo MRCPv1 Speech Server software with Avaya‟s MRCPv1 Client. For information about MRCPv1 speech resource processing that is generic to all MRCPv1-based resources, see the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

Grammars and Lexicons

The topics in this section apply to grammars and lexicons. Speech recognition applications use grammars to recognize what the caller says. Speech synthesis applications use lexicons to implement dictionaries when speaking text.

Typically, grammars and lexicons reside on a Web server. The Media Server must retrieve them from the Web server and save them to the Media Server node before it can satisfy a request from the application for recognition or synthesis.

It is important to preload the grammars and lexicons, which an application is expected to use, on the Media Server node before application execution.

Preloading grammar and lexicon files on the LSS Media Server provide for a faster response to application requests for recognition or synthesis. This operation saves the time it would take to retrieve the grammar or lexicon from a Web server when responding to a request from an application. The speech applications that use these grammars have no knowledge of which grammars are loaded on the Media Server. They simply request a grammar in preparation for recognition. Grammar retrieval time is critical successful application execution.

Unsupported Loquendo Speech Server 7.0 features

The messaging between the MRCPv1 Client and MRCPv1 Server is the same (MRCPv1 standard), regardless of the vendor. For this reason, all methods are implemented on the MRCPv1 Client side. If a Media Server does not support a particular MRCPv1 method, it fails that request. It is expected that the Media Server fails unknown requests if the application sends unknown or invalid requests to the Media Server.

Constraints and support issues

This section addresses the constraints and support issues associated with using the Loquendo Speech Server in the Avaya MPS 3.5 environment.

Loquendo ASR 7.8 and TTS 7.8

An Avaya Speech Server component can support only a Recognition resource or a synthesis resource at any point in time.

The RCM process is designed to support a resource of one type only. RCM can support either an input resource (LVR) or an output resource (TTS), not both input and output.


Therefore, two components (two instances of the MRCPv1 Client) are required on a Avaya MRCPv1 Speech Server to connect to an MRCPv1 Media Server in support of the server‟s recognition and synthesis capabilities. One Speech Server component supports LVR and the other Speech Server component supports TTS.

Load balancing is performed by the Pool Manager process on the MPS Application Processor node. Load balancing from the Loquendo Speech Server Media Server node is provided but not supported by Avaya Speech Server.

General MRCPv1 support issues

Avaya supports the MRCPv1 protocol.

The Avaya MRCPv1 client does not support the following:

The MRCPv1 recognition request method GET_RESULT.

The MRCPv1 recognition parameter Recognizer-Context-Block.

The MRCPv1 Client synthesis methods PAUSE, RESUME, and CONTROL to pause, resume, and control the speech output from the Media Server during a synthesis.

VoiceXML support issues

Avaya does support SPEECH-MARKER events. However, some vendors do not support Speech Marker events with MRCPv1. Based on Avaya testing.

Avaya support on the application and Speech Server nodes

Avaya provides the following support for the LSS 7.0 resource on the MPS Application Processor and Speech Server nodes

Standard Speech support on the Speech Server node

The Avaya implementation of the LSS 7.0 speech resource supports the following standard speech server functionality on the Speech Server node.

Barge-in

No speech timeout, Too Much Speech timeout, etc.

Confidence levels

Dynamic Grammars

Pooling of speech resources across Speech Servers using Avaya‟s distributed pooling methodology.

Alarms generated, viewable and filterable by means of MPS Manager


Patching (remote patching) by means of MPS 3.5 Avaya software

RCM DLOG trace logging

RCM Generic Call Logging (GCL)

Integration Shared Library alarm logging.

MPS Manager support

MPS Manager is used for administration and management of the Speech Server node. For information about this graphical set of tools, see the MPS Manager User Guide (NN44100-105) or the Getting Started chapter of the MPS Speech Server 6.5 Reference Guide (NN44100-131).

MPS Developer support

MPS Developer support on the MPS 3.5 platform is provided by the Application Services Environment (ASE runtime) that is distributed by the PERIase package and is installed with Avaya_SelfService software.

The MRCPv1 recognition (lvr-mrcpv1) and synthesis (extts-mrcpv1) names are not defined in the default ppro.conf file.

If you want to use a datacard to specify the resource name, you must enter the names of these

resources into the ppro.conf file and set the length of the datacard that contains the resource

name to 12 for MRCPv1 resources.

Alternatively, you can set the resource name using an expression, as in the sample applications.


Developing MRCPv1-based applications with MPS Developer see the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

MPS Developer, see the MPS Developer User Guide (NN44100- 118).

VoiceXML support

MPS 3.5 supports VoiceXML 2.0 and 2.1 applications with the VXMLI (VoiceXML Interpreter). VoiceXML support requires software installation and configuration on the MPS Application Processor node.

The SBclient.cfg file must be configured to use the following resources:

extts-mrcpv1 to support the TTS resource.

lvr-mrcpv1 to support the LVR resource.

In the case of the:

Windows platform, the SBclient.cfg file is configured during the installation process.

Solaris platform, manual configuration of the SBclient.cfg file is required.


See “MPS Application Processor node configuration”.

For additional information about VoiceXML application development with MRCPv1 resources, see the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

For information about developing VoiceXML applications, see the VXML Browser User Guide (NN44100-127).


Chapter 4. Configuration

Directory paths and environment variables

Environment variable are used to locate files on both of the Loquendo Speech Server node and the Avaya Speech Server (LSS) node.

For information about environment variables on the Loquendo Speech Server (LSS) 7.0 Media Server, see “LSS 7.0 Media Server environment variables”.

For information about environment variables on the Avaya Speech Server, see “Avaya Speech Server environment variables”.

LSS 7.0 Media Server environment variables

The directory paths to the Loquendo software on the Media Server node follow:

Loquendo Speech Server 7.0: C:\Program Files\Loquendo\Suite

Loquendo 7.8 Recognizer: C:\Program Files\Loquendo\LASR

Loquendo 7.8 Synthesizer: C:\Program Files\Loquendo\LTTS7

The default top level directory is: C:\Program Files\

Although this is the default, you can install the software in any other path. For example, if you install Loquendo software in the F partition, the top level directory would point to the following directory path. F:\Program Files\

The environment variable %LOQ_HOME% points to the location of the Loquendo Speech Server 7.0 platform logs and configurations.

The environment variable %HOMEPATH% points to the location of Loquendo log and information collector files.

Avaya Speech Server environment variables

Speech Server resources in the Avaya Media Processing Server (MPS) environment are configured in association with the Solaris or Windows MPS application processor node. The Avaya MRCPv1 client resides on a Windows Speech Server node. The Loquendo MRCPv1 server resides on a Windows Media Server node. Therefore, you can be working on both the Solaris and Windows 2003 platforms when configuring files for Speech Server processing with the Loquendo Speech Server resource.

On the Solaris MPS Application Processor node:

The environment variable MPSHOME points to the location where the Avaya software is installed. The

default directory for MPSHOME on a Solaris MPS Application Processor node is /opt/vps.


Environment variables are specified in the vpsrc.csh and vpsrc.sh files. Use the setenv

command in the C shell to set environment variables. For information about files that apply to all Speech Server resources, see the MPS Speech Server 6.5 Reference Guide (NN44100-131).

On the Windows MPS Application Processor and Speech Server nodes:

The environment variables MPSHOME and OSCARHOME point to the location where the Avaya software is installed. The values for MPSHOME and OSCARHOME are identical.

MPSHOME points to the location where the Avaya software is installed on a node. This environment variable is typically associated with the MPS Application Processor node.

OSCARHOME points to the location where the Avaya software is installed on a node. This environment variable is typically associated with the Speech Server node.

During the installation, the environment variable MPSHOME is created and the value is set to the directory path into which you install the Avaya SelfService software. Then, the environment variable OSCARHOME is created and set to same value as MPSHOME (MPSHOME = OSCARHOME).

When you install an MRCPv1 speech resource, the variable MRCPv1HOME is set to same value as MPSHOME and OSCARHOME (MPSHOME =OSCARHOME = MRCPv1HOME).

The default installation directory path and the default value for MPSHOME is C:\Program Files\Avaya\SelfService.

When MPSHOME is set before installing Avaya_SelfService software, the Avaya_SelfService installer uses the existing value for MPSHOME.

(The existing value is preserved and not overwritten.)

When MPSHOME is not set before installing Avaya_SelfService software, you have the option to change the partition (drive letter) and the directory path where the Avaya_SelfService software is installed.

NOTE:

Do not modify the values for MPSHOME, OSCARHOME and MRCPv1HOME after installing the Avaya_SelfService

software.

MPSHOME must point to the location where the Avaya software is installed. MPSHOME, OSCARHOME and

MRCPv1HOME must be set to the same value.


Installing software on a Windows node, see MPS Speech Server 6.5 Installation Guide and Release Notes (NN44100- 305).

Files that apply to all Speech Server resources see the MPS Speech Server 6.5 Reference Guide (NN44100-131).


Configuration files

The configuration files that affect Loquendo Speech Server resource processing and that you need to be aware of reside on the following nodes:

Loquendo Media Server node:

See “Loquendo Speech Server node configuration”.

MPS Application Processor node:

See “MPS Application Processor node configuration”.

Avaya Speech Server node:

See “Avaya Speech Server node configuration”

Loquendo Speech Server node configuration

The Loquendo MRCP Server installs the Loquendo Management Context, a Windows service that controls and drives the whole platform processes. This service starts automatically during any system reboot. The Loquendo Management Context service starts/stops and controls the MRCPv1Server. So, to start/stop the Server you have to start/stop the Loquendo Management Context service from the service consoles.

The Management Console is a SNMP-based tool that offers the way to perform a platform configuration. Almost everything you need to do for the configuration can be done using this tool.

In order to run Management Console, do the following:

Start->All Programs-> Loquendo -> Loquendo Speech Suite7.0 -> Management Console

For additional information about configuration on the LSS Media Server node, see the documentation provided by Loquendo.

Configure the LSS server through Loquendo Management Console

Ensure that the LSS has enough CPU and memory to sustain the number of licensed channels configured to run Loquendo TTS and LVR sessions.

Maximum number of LVR and TTS channels that can be active simultaneously is in default configuration. In addition, you must ensure that the port on which RTSP communicates MRCP messages between the LSS and the MRCPv1 client is set to the same value. The default port number is 554 for Loquendo.

Set the parameters listed in the following table in the Loquendo Management Console to ensure the LSS is configured properly. These parameters become active at system startup of the Loquendo Speech Server node.

Required configuration changes in Basic Configuration:

To access the basic configuration screen from Management Console, do following:


Loquendo->Local->Configuration->Basic

Make sure the following are set as shown:

Table 1: Basic Configuration

Section parameter value description

dtmfCodecAlwaysOffered enable(1)

mrcpHeader speechLanguage en-US or as required

logLevel select accordingly if the required log levels are activated are

Required configuration changes in Advanced Configuration:

To access the Advanced Configuration screen from Management Console, do following:

Loquendo->Local->Configuration->Advanced->MRCPv1Server

Make sure the following are set as shown:


Table 2: Advanced Configuration

section parameter value description

speechRecognition lasrDefaultAudioCodec u-law(0) or

alaw(8)

need to match MPS setting

lasrLooseSISRSemantic enable(1)

this setting will support both „out‟ and „$‟ in the grammar. If it is set to disable then only „out‟ will be supported in the grammar.

Text to speech lttsDefaultAudioCodec u-law(0) or

a-law(8)

need to match MPS setting

nlsmlResult enableWinnerRORule disable(0)

enableWordInputElements disable(0)

enableMultipleInstances enable(1) enable this if you need to use ambiguous grammar

apConfiguration-> apParametersTable

type batch These settings will prevent TTS from underrun

g711InPacketSize 160

g711OutPacketSize 1000

g711PacketDuration 20

mrcpParser rtspEnableRTCPPort enable (1)

http httpSslVerifyPeer disable (0) This setting will allow you to use secure website to load grammar.

Note:

Make sure the security certificate name matches the URL host name you are using to load grammar from


NOTE:

Configuration parameters not listed in the above tables should not be changed. It is recommended to restart the Loquendo Speech Suite MRCPv1 server once the new configuration has been deployed.

Management Console->Administration->lifeCycleCmd->restart (2).

Typically, the parameters visualized in the Configuration Basic can be modify just typing the value and then move the focus on another field, without any need of a platform restart. The exceptions are signaled by a popup message.

Configuration parameters can also be modified from C:\DocumentsandSettings\Administrator\ApplicationData\Loquendo\Platform\cfg\MRCPv1Server.cfg.

Management Console needs to be in sync with this configuration, so need to restart MC if you changed configuration from the MRCPv1Server.cfg file.

In order to avoid under run issue, you need to configure the TTS engine in "batch" mode. The following three side effects need to be aware when using this configuration:

Irregular distribution of CPU load over time, as synthesized speech is produced as fast as possible and buffered, rather than being produced in real time at a constant and controlled rate;

Increased TTS license usage, as the TTS engine consumes license based on how many synthesized bytes has been output, even if part of them has not been played back (for instance, because of barge-in or hang-up).


Sometimes you don't hear the first word very clear in TTS text. The workaround for this is to add control \pause at the beginning of the text in vxml application.

For example:

<prompt>

\pause This is perfect.

</prompt>

For additional information about the Loquendo Management Console, refer to the documentation provided by Loquendo. See “Loquendo documentation”.

MPS Application Processor node configuration

This section describes the files that apply when you are creating VoiceXML applications.

During the installation of the Avaya VoiceXML software, the following directories and files are created on the MPS Application Processor node, depending on whether you select the TTS resource, the LVR resource or both resources:

%MPSHOME%\PERIvxml\oscar\mrcpv1\sys-lvr-mrcpv1.cfg

%MPSHOME%\PERIvxml\oscar\mrcpv1\sys-extts-mrcpv1.cfg

In addition, on the MPS 3.5 Windows platform only, when you select the:

LVR resource, the file:

%MPSHOME%\PERIvxml\config\SBclient.cfg is updated with the following lvr-mrcpv1 entry.

client.avaya.ivr.rec.recognition.resource.name VXIString lvr-mrcpv1

TTS resource, the file:

%MPSHOME%\PERIvxml\config\SBclient.cfg is updated with the extts-mrcpv1 entry.

client.avaya.ivr.prompt.tts.resource.name VXIString extts-mrcpv1

On the MPS 3.5 Solaris platform only, you must manually edit the $MPSHOME/PERIvxml/config/SBclient.cfg file and modify the following entries.

For the MRCPv1 LVR resource:

locate the entry:

client.avaya.ivr.rec.recognition.resource.name VXIString lvr-s

change it as follows:



For the MRCPv1 TTS resource:

locate the entry:

client.avaya.ivr.prompt.tts.resource.name VXIString extts-s

change it as follows:


add the following entry if not exist:

client.avaya.ivr.prompt.tts.resource.extts-mrcpv1.SSML-Version

VXIString 2002

The following portion of the SBclient.cfg file shows the correct configuration for VoiceXML MRCPv1 synthesis and recognition resources.

For information about VoiceXML application development, see the VXML Browser User Guide(Software Release 3.5.0 on MPS3.5) (NN44100-127).

SBclient.cfg Sample File section for MRCPv1 Resources

#############################################

# Avaya Specific Parameters for mrcpv1 #

#############################################


client.avaya.ivr.prompt.tts.resource.hold VXIInteger 1


client.avaya.ivr.rec.recognition.resource.hold VXIInteger 1

#

# NORMAL indicates Content-Type set to SSML

#

client.avaya.ivr.prompt.tts.resource.lang.default VXIString NORMAL

client.avaya.ivr.prompt.tts.resource.lang.en-US VXIString NORMAL

client.avaya.ivr.rec.recognition.resource.lang.default VXIString DYNAM_001

client.avaya.ivr.rec.recognition.resource.lang.en-US VXIString DYNAM_001

client.avaya.ivr.prompt.tts.resource.extts-mrcpv1.SSML-Version VXIString 2002

Avaya Speech Server node configuration

This section describes the configuration issues associated with Speech Server 6.5 processing with the MRCPv1 resource in a MPS 3.5 environment on Windows 2003 Speech Server nodes. These files are used to obtain information for startup and channel configuration.


The MRCPv1 resource on the Avaya platform consists of two separate and independent resources.

The name of the speech recognition resource (LVR) is lvr-mrcpv1.

The name of the speech synthesis resource (TTS) is extts-mrcpv1.

This implementation of the MRCPv1 resource originates from Avaya.

The MRCPv1 resource is designed to support any vendor‟s implementation of an MRCPv1-based speech resource.

This document focuses solely on issues that are unique to using the MRCPv1-based Loquendo Speech Server (LSS) 7.0 resource.

See the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132) for information about configuration files and parameters those originate from Avaya and are common to all MRCPv1 vendor resources.

For a description of configuration files that are common to all Speech Server resources, see the MPS Speech Server 6.5 Reference Guide (NN44100-131).

The Avaya implementation of the LSS 7.8 speech synthesis (TTS) resource can support 96 channels configured for a Speech Server component. If you require more than 96 TTS channels, install two TTS components on the Speech Server node. This structure allows for enhanced speech synthesis processing and better delivery to the caller.

When two components are installed on a Speech Server node, a complete set of configuration files exist for each TTS component and the files contain component-specific information. For example, a Speech Server node configured with the MRCPv1 TTS components oscar1 and oscar2 contain the following two component-specific rcm.cfg files.

%OSCARHOME%\oscar1\etc\rcm.cfg


The files summarized in the following table originate from Avaya and contain configuration information for the MRCPv1 resource.

Avaya Speech Server Node configuration files

Description Goto

%OSCARHOME%\common\etc

\vpshosts Component hosts file. Identifies the components configured for a node.

“vpshosts file”


Avaya Speech Server Node configuration files

Description Goto

%OSCARHOME%\oscarN\etc\rcm.tbl

Used by RCM to obtain information about the MRCPv1 resource.

LVR resource

(lvr-mrcpv1)

TTS resource

(tts-mrcpv1)

Be aware that one Speech Server component supports only one resource. If both resources are to coexist on the same Speech Server node, you must configure two components, one for each resource.

“rcm.tbl file”

%OSCARHOME%\oscarN\etc

\sys-[lvr|extts]-

mrcpv1.cfg

System level configuration files containing parameters that apply to all channels.

LVR resource

(sys-lvr-mrcpv1.cfg)

TTS resource

(sys-extts-mrcpv1.cfg)

Be aware that one Speech Server component supports only one resource. If both resources are to coexist on the same Speech Server node, you must configure two components, one for each resource.

“sys-[lvr|extts]-mrcpv1.cfg file”

%OSCARHOME%\oscarN\etc\vos.cfg

Lists processes and related information needed by SRP (Startup and Recovery Process) to start-up a Speech Server node.

“vos.cfg file”

%OSCARHOME%\oscarN\etc\rcm.cfg

Provides configuration information needed by the RCM process.

“rcm.cfg file”

vpshosts file

The vpshosts file resides in the directory path %OSCARHOME%\common\etc on the Speech Server node.

It serves as the component hosts file and identifies the Speech Server components configured for the node as well as the MPS application processor nodes with which the Speech Server node is associated.


This file must exist on each node in the network. A component is identified by its component number, the name of the node where it resides, and the component type. This file indicates that the component named oscar1 is configured for this Speech Server node.

The following sample files represent the vpshosts file on a node configured with a single MRCPv1 component (which can be either an LVR or TTS resource) and the vpshosts file on a node configured with two MRCPv1 components (one can be an LVR resource and the other a TTS resource).

vpshosts file sample - One component on Speech Server

$1

#

# vpshosts

#

# This file was automatically generated by vhman.

#

# COMP NODE TYPE

1 - oscar

101 mpsap1-a mps

102 mpsap2-a mps

#

vpshosts file sample - Two components on Speech Server

$1

#

# vpshosts

#

# This file was automatically generated by vhman.

#

# COMP NODE TYPE

1 - oscar

3 - oscar

101 mpsap1-a mps

102 mpsap2-a mps

#

The following table describes parameters in the vpshosts file.


Parameter Description

COMP Component number

NODE Name of the node where the component resides. A dash (-) indicates the component resides on the local node.

TYPE Component type. In this case, it is either mps (Application Processor component) or oscar (Speech Server component).

rcm.tbl file

The rcm.tbl file resides in the directory path %OSCARHOME%\oscarN\etc on the Speech Server node. The RCM process uses this file to obtain resource-specific information. These files are specific to either an LVR or TTS resource.

NOTE: DO NOT modify these files.

The rcm.tbl files indicate that the environment variable (MRCPv1HOME) for the extts-mrcpv1 and lvr-mrcpv1 resources is the same. This allows for similar directory structures to be configured on a single node, as both these resources can coexist on a single Avaya Speech Server.

The vendorName is the same whether the resource is lvr-mrcpv1 or extts-mrcpv1. Both of these resources are installed with the Avaya SelfService software. For information about installing Speech Server resource, see the MPS Speech Server 6.5 Installation Guide and Release Notes (NN44100-305).

Be aware that one Speech Server component (one RCM process) supports only one resource. If both LVR and TTS resources are to coexist on the same Speech Server node, you must configure two components, one for each resource. The sample rcm.tbl files follow, one for an LVR component, the other for a TTS component.

When two components are configured on the Speech Server node for speech synthesis processing there is a complete set of configuration files for each component. For example, a Speech Server node configured with the components oscar1 and oscar2 contains the following two component-specific rcm.tbl files.

%OSCARHOME%\oscar1\etc\rcm.tbl

%OSCARHOME%\oscar2\etc\rcm.tbl

For additional information about this file, see the rcm.tbl file in the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

The following sample rcm.tbl file resides on a component configured for LVR.

rcm.tbl sample file for an LVR resource

# $Id$

#

# Copyright - Avaya.

#

# Vendor Rsc Rsc Blocking/ Sync/ Shared Env Vendor Lib Shared Lib


# / prodt Name Type Non-blocking Async Libraries Var Path Pkg

#

------------------------------------------------------------------------

#

mrcpv1 lvr-mrcpv1 INPUT DEFAULT ASYNC - $MRCPv1HOME lib mrcpv1

#

The following sample rcm.tbl file resides on a component configured for TTS.

rcm.tbl sample file for a TTS resource

# $Id$

#

# Copyright - Avaya.

#

# Vendor Rsc Rsc Blocking/ Sync/ Shared Env Vendor Lib Shared Lib

# / prodt Name Type Non-blocking Async Libraries Var Path Pkg

#

-------------------------------------------------------------------------

#

mrcpv1 extts-mrcpv1 OUTPUT DEFAULT ASYNC - $MRCPv1HOME lib mrcpv1

#

The following table describes parameters in the rcm.tbl file.


Vendor/product Name The Vendor‟s name is used for validation with the vendorName option specified in the rcm.cfg file. The vendor name (mrcpv1) is the same for the MRCPv1 LVR and TTS resources.

Rsc Name The name Avaya gives to this resource.

LVR Resource Name: lvr-mrcpv1

TTS Resource Name: extts-mrcpv1

Rsc Type The type of resource (INPUT or OUTPUT).

Blocking/Non-blocking Internal use only.

Sync/Async Internal use only.

Shared Libraries Name of vendor‟s shared libraries


Env Var Environment variable that points to the MRCPv1 (LVR or TTS) resource home directory (MRCPv1HOME), where the Avaya software resides.

Vendor Lib Path Location of the vendor‟s software shared libraries (where applicable), for explicitly opening these libraries.

Shared Lib Package Name of the software package that contains the Avaya MRCPv1 shared library for LVR and TTS resources (mrcpv1).

sys-[lvr|extts]-mrcpv1.cfg file

The sys-[lvr|extts]-mrcpv1.cfg files are considered the system-level configuration files. They reside in the directory path %OSCARHOME%\oscarN\etc on the Speech Server node.

sys-lvr-mrcpv1.cfg is the recognition resource (LVR) System configuration file.

sys-extts-mrcpv1.cfg is the Synthesis resource (TTS) System configuration file.

When two components are configured on the Speech Server node for speech synthesis processing there is a complete set of configuration files for each component. For example, a Speech Server node configured with the components oscar1 and oscar2 contains the following two component-specific sys-extts-

mrcpv1.cfg files.

%OSCARHOME%\oscar1\etc\sys-extts-mrcpv1.cfg

%OSCARHOME%\oscar2\etc\sys-extts-mrcpv1.cfg

These system configuration files contain system-level parameter specifications that take effect during system startup. For additional information about grammars used by MRCPv1 resources, see the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

The parameters set in this file are common to all channels on the Speech Server component.

Be aware that one Speech Server component supports only one resource. If both LVR and TTS resources are to coexist on the same Speech Server node, you must configure two components one component for TTS and one component for LVR.

The MRCPv1 Integration Shared Library looks for either one of these files in a speech server component. It looks for these file in alphanumeric order. First it looks for is the sys-extts-mrcpv1.cfg then it looks for the sys-lvr-mrcpv1.cfg. Once the Integration Shared Library locates these files, it configures itself for processing as either TTS or LVR.

Do not, accidentally, place a sys-extts-mrcpv1.cfg file and a sys-lvr-mrcpv1.cfg file in the same oscarN/etc directory, as the result will be unpredictable.

The entries in the MRCPv1 system configuration files are in the same format as all other MPS 3.5 Speech Server 6.5 resources. Each Section Label is separated by an asterisk (*). A pound sign (#) indicates a comment.

The sys-lvr-mrcpv1.cfg and sys-extts-mrcpv1.cfg files do not support the use of environment variables included as part of the path to a file name. When an entry includes the name of a file, always specify the full directory path for that file.


Channel level configuration files are not supported for MRCPv1. Some parameters can be set only from configuration files, whereas others may be set from the application.

Setting parameters in these files

The parameters set in these files can originate either from Avaya or the vendor of an MRCPv1 resource serving the speech client that resides on a different node.

When setting parameters that originate from the vendor of an MRCPv1 resource, you must prefix the name of the parameter with mrcpv1 and a period (mrcpv1.).

Parameters that originate from the Avaya MRCPv1 resource are configured with the prefix mrcpv1.

Parameters that originate from vendors that provides MRCPv1 Server resources are configured with the syntax mrcpv1.Vendor-Specific-Parameter

These parameters require this naming convention in the sys-lvr-m rcpv1.cfg and sys-extts-mrcpv1.cfg files and when set in the application. All parameters are set as a single line of text.

For example:

To set the MRCPv1 parameter N-Best-List-Length to 10: mrcpv1.N-Best-List-Length 10

To set a vendor parameter: mrcpv1.Vendor-Specific-Parameter "<vendor_parameter_name>= <value>"

NOTE: Do not modify parameters in the configuration files when the system is up and running. To reset the parameters, you must stop processing on the Speech Server node, edit the sys-lvr-mrcpv1.cfg and sys-extts-mrcpv1.cfg files, change the parameter value, and then restart the system. For information about how to start and stop a speech server, see the MPS Speech Server 6.5 Reference Guide (NN44100-131).

For additional information about setting vendor-specifi configurable parameters, see the documentation provided by Loquendo.

Parameters are set in the Section GlobalParameters and Section Label.

Set parameters in the Section GlobalParameters when the value of a parameter is specific to

the entire system (process), or when it applies to all the Labels (grammars) that are configured for this process.

Set a parameter in the Section Label to indicate that the parameter value applies only to that

label and the set of grammars.

Loquendo Speech Server IP, serverName and serverPort

The Loquendo vendor software (MRCPv1 server) and the Avaya resource processing software (MRCPv1 client) reside on different nodes.

The Loquendo vendor software resides on the Media Server Node (MRCPv1 server).

The Avaya resource processing software resides on the Speech Server node (MRCPv1 client).


You must identify the location of the LSS Media Server node to the Avaya Speech Server node. ServerIP, ServerName and ServerPort will be prompt during Avaya Speech Server installation. You need to enter the correct values for these fields. The MediaServerSpec parameter in the system configuration file on the Speech Server node will be automatically updated during the installation.

If you need to point to a different LSS, then configure the MediaServerSpec parameter in the sys-lvr-mrcpv1.cfg and sys-extts-mrcpv1.cfg files with the values for ServerIP, ServerName and ServerPort to identify the location and port of the Loquendo Speech Server node to the Speech Server node.

ServerPort number must be configured the same as rtspPort number configured on LSS. Loquendo use 554 as default rtspPort number.

Configure RTPBeginPort

This is a starting port number for the first channel of this component. Each channel uses 2 ports, one for RTP and the other for RTCP.

This port number must be unique for every channel. It is sufficient if the starting port number is specified, the port numbers for the subsequent channels are used by adding 2 to this number.

If multiple components are started on the same speech server, whether it is an LVR or TTS component the starting port number should be different and should account for all channels started in that component.

The default RTP base port for Loquendo is 10000. Therefore you should configure RTPBeginPort to be 10000 for the 1st rcm component. The RTPBeginPort for the 2nd rcm component should be 10000 + 2*number of channels configured in 1st component.

VoiceXML resource processing labels

The following labels are configured by default in the system configuration files. These labels are required for processing VoiceXML speech recognition and synthesis applications. Do not change the values of these labels.

Synthesis resource:

Section Label

Label NORMAL

ContentType "application/synthesis+ssml"

*

Section Label

Label NORMALPlain

ContentType "text/plain"

*

Recognition resource:

Section Label


Label DYNAM_001

*

These label names are referenced by the following files on the MPS Application Processor node.

Synthesis resource:

— %MPSHOME%\PERIvxml\config\SBclient.cfg

%MPSHOME%\PERIvxml\oscar\mrcpv1\sys-extts-

mrcpv1.cfg

Recognition resource:

— %MPSHOME%\PERIvxml\config\SBclient.cfg

%MPSHOME%\PERIvxml\oscar\mrcpv1\sys-lvr-

mrcpv1.cfg

MRCPv1 Speech-Language parameter

The MRCPv1 Speech-Language parameter must be set in the sys-lvr-mrcpv1.cfg file or sys-

extts-mrcpv1.cfg file when the application does not explicitly set the parameter. The application can

always set this parameter explicitly to change the language during runtime.

See “sys-[lvr|extts]-mrcpv1.cfg file”.

File sections

The contents of the sys-lvr-mrcpv1.cfg and sys-extts-mrcpv1.cfg files are organized into two

sections in which you set parameters that take effect at system start-up.

The Section GlobalParameters is used to specify the context or environment under which the

entire set of channels operate.

The Section Label is used to specify the context or Environment under which instances of

resource processing occur.

Section GlobalParameters

The parameters set in the Section GlobalParameters apply to the context or environment in which the entire set of channels operate, such as a Grammar specification or a parameter value that can be applicable to all labels (grammars).

These parameter specifications take effect at system start-up and apply to all channels and all labels.

Use the following format to set a parameter in the Section GlobalParameters. Separate the arguments with white space.

RCM and Shared Library parameter format: <parameter_name> <value>


MRCPv1rmat:

mrcpv1. <mrcpv1_parameter_name> <value>

Replace:

<parameter_name> or <mrcpv1_parameter_name> with the name of a parameter.

<value> with the value of the parameter.

For additional information about MRCPv1 parameters, see the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

Section label

The parameters set in the Section Label apply to the context or environment in which resource processing occurs. The parameters you set in a Section Label apply only to a specific Label and do not affect any other Label.

The parameters associated with a Label apply to all channels where the Label active. Parameters set in the Section Label take precedence (when the Label is active) over the values for the same parameters that are set in the GlobalParameters

The values take effect when the Label is allocated and are set for the duration of the Label allocation, unless the parameter is reset from a location with a higher level of precedence. For information about parameters and their order of precedence, see the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

You can configure multiple instances of Section Label to set Label-specific parameters.

The Section Label entry must be followed by a Label <value> entry. List all parameter value pairs after the Label parameter. The Section Label context is terminated by using an asterisk (*). Results are unpredictable if you do not follow this pattern. Use the following format to set parameters in a Section Label. Put a space between each parameter name and value.

Section Label

Label <label_name>

GrammarList <grammar_name>,<grammar_name>,<grammar_name>

<parameter_name> <parameter_value>

*

Replace <label_name> with a name for this Label.

Replace <grammar_name> with the name of a grammar. If Multiple grammars are listed, separate the name of each grammar with a comma.

Replace <parameter_name> with the name of a parameter.

Replace <parameter_value> with the value of the parameter.

For example, the following Section Label allocates the channel with the digitsPin grammar.


Section Label

Label pinCode

GrammarList digitsPin

*

The system configuration files provide support for an empty label (a label that specifies just the label name and no other parameters). Therefore, an entry such as the following is valid.

*

Section Label

Label DYNAM_001

*

Typically, an empty label is used for VoiceXML application support. When an application uses an empty label, grammars must be loaded and activated from the application before the instance recognition where that label is used.

Sample system level TTS configuration file

The following sample system configuration file resides on a node configured for TTS.

#----------------------------------------------------------------------

# $Id$

#

# Copyright - Avaya Inc.

#

# Sample configuration file : sys-extts-mrcpv1.cfg

#

# $Log$

#

# ORIGINAL for MRCPv1 (tts)

#

# ---------------------------------------------------------------------


#

# ---------------------------------------------------------------------

# ServerPingInterval : This is a timer value used to check if we

# have received a response or a message from the server within this #


time period. If we haven't then we wait for the N PingRetries and #

if N * ServerPingInterval time period elapses without a response #

from the server, the client (rcm) is brought down in order to

# remove it from the allocation pool.

# Default value is 5 secs, value must be specified in seconds.

# To disable checking, set the value to 0.

#

ServerPingInterval 5

#

# ---------------------------------------------------------------------

# ServerPingRetries : Value specified for retries times the

# ServerPingInterval time period is how long the client waits to

# receive a response from the server before it brings down the

# client, considering that the server is down.

# Default value is 3

#

ServerPingRetries 3

# ---------------------------------------------------------------------

#

# RTPBeginPort : This is a starting port number for the first

# channel of this component. Each channel uses 2 ports, one for

# RTP and the other for RTCP. ( note not RTSP !).

# This port number must be unique for every channel. It is

# sufficient if the starting port number is specified, the

# port numbers for the subsequent channels are used by adding 2 to

# this number.

#

# Caution : If multiple components are started on the same speech

# server, whether it’s an LVR or TTS component the starting port

# number should be different and should account for all channels

# started in that component.

#

# *** WARNING ***

#


# NOTE : This option need not be enabled unless there is a conflict

# in port numbers. The default numbering by the Avaya software

# starts at 8100 and proceeds in increments of 400 for each

# component with the assumption that no single oscar component will

# have more than 200 channels configured. Please do not specify

# a port number in here UNLESS it is ABSOLUTELY necessary due to a

# conflict.

#

#RTPBeginPort 7700

#

# ---------------------------------------------------------------------

#

# SocketBindPort : This port is used for socket communication

# between worker threads and the main thread.

#

# *** WARNING ***

#

# NOTE : Please do not specify a value for this option UNLESS

# ABSOLUTELY necessary, such as a port conflict.

#

#SocketBindPort 6918

# ---------------------------------------------------------------------

#

#

# MediaServerSpec : This entry indicates the server information

# using which this client will connect to the MRCPv1 media

# server. All entries in this list are a required.

#

# VendorType : <vendor for mrcpv1>

# ServerIP : IP address of the node where the media

# server is running. IP address in dot notation.

# ServerName : Name/hostname of node on which the media

# server is running


# ServerPort : port number on the server to which clients

# connect. If this port is changed on the server side,

# then this must be changed appropriately.

# EngineUrlSuffix : Every resource is accessed using an url

# such as rtsp://<ip addr>:port/<name of

# resource>

# This entry indicates the <name of resource>

# required to access the resource.

#

#

#

MediaServerSpec "((VendorType: GENERIC ) \

(ServerIP : 47.185.25.90 ) \

(ServerName : pdg6-25-90 ) \

(ServerPort : 554 ) \

(EngineUrlSuffix : media/synthesizer) )"

#

# ---------------------------------------------------------------------

*

Section Label

Label mrcpFemale

mrcpv1.Voice-Gender female


*

Section Label

Label mrcpMale

mrcpv1.Voice-Gender male


*

Section Label

Label NormalPlain

ContentType "text/plain"

*


# ---------------------------------------------------------------------

#

# DO NOT REMOVE OR MODIFY THIS LABEL IN ANYWAY. THE FOLLOWING IS USED

# BY VXML APPS

#

Section Label

Label NORMAL


*

# ---------------------------------------------------------------------

Sample system level LVR configuration file

The following sample system configuration file resides on a node configured for LVR.

#----------------------------------------------------------------------

#

# $Id$

#

# Copyright - Avaya Inc.

#

# Sample configuration file : sys-lvr-mrcpv1.cfg

#

# $Log$

#

# ORIGINAL for MRCPv1 (lvr)

#

# ---------------------------------------------------------------------

#


#

# ---------------------------------------------------------------------

# ServerPingInterval : This is a timer value used to check if we

# have received a response or a message from the server within this #

time period. If we haven't then we wait for the N PingRetries and # if

N * ServerPingInterval time period elapses without a response # from the


server, the client (rcm) is brought down in order to

# remove it from the allocation pool.

# Default value is 5 secs, value must be specified in seconds.

# To disable checking, set the value to 0.

#

ServerPingInterval 5

#

# ---------------------------------------------------------------------

# ServerPingRetries : Value specified for retries times the

# ServerPingInterval time period is how long the client waits to

# receive a response from the server before it brings down the

# client, considering that the server is down.

# Default value is 3

#

ServerPingRetries 3

# ---------------------------------------------------------------------

#

# RTPBeginPort : This is a starting port number for the first

# channel of this component. Each channel uses 2 ports, one for

# RTP and the other for RTCP. ( note not RTSP !).

# This port number must be unique for every channel. It is

# sufficient if the starting port number is specified, the

# port numbers for the subsequent channels are used by adding 2 to

# this number.

#

# Caution : If multiple components are started on the same speech

# server, whether it’s an LVR or TTS component the starting port

# number should be different and should account for all channels

# started in that component.

#

#

# *** WARNING ***

#


# NOTE : This option need not be enabled unless there is a conflict

# in port numbers. The default numbering by the Avaya software

# starts at 8100 and proceeds in increments of 400 for each

# component with the assumption that no single oscar component will

# have more than 200 channels configured. Please do not specify

# a port number in here UNLESS it is ABSOLUTELY necessary due to a

# conflict.

#

#RTPBeginPort 7700

#

# ---------------------------------------------------------------------

#

# SocketBindPort : This port is used for socket communication

# between worker threads and the main thread.

#

# *** WARNING ***

#

# NOTE : Please do not specify a value for this option UNLESS

# ABSOLUTELY necessary, such as a port conflict.

#

#SocketBindPort 6928

# ---------------------------------------------------------------------

#

# MediaServerSpec : This entry indicates the server information

# using which this client will connect to the MRCPv1 media

# server. All entries in this list are a required.

#

# VendorType : <vendor for mrcpv1>

# ServerIP : IP address of the node where the media

# server is running. IP addr in dot notation.

# ServerName : Name/hostname of node on which the media

# server is running

# ServerPort : port number on the server to which clients


# connect. If this port is changed on the server side,

# then this must be changed appropriately.

# EngineUrlSuffix : Every resource is accessed using an url

# such as rtsp://<ip addr>:port/<name of

# resource>

# This entry indicates the <name of resource>

# required to access the resource.

#


(ServerIP : 47.185.25.90 ) \

(ServerName : pdg6-25-90 ) \


(EngineUrlSuffix: media/recognizer )"

#

#

# ---------------------------------------------------------------------

#

# GrammarSpec : This parameter describes the information required

# for a grammar in order for it to be loaded properly.

# The grammars that are to be loaded as part of an allocation

# are listed here. These grammars are not typically dynamically

# loaded grammars from the application's perspective.

#

# Syntax is as follows -

#

# GrammarSpec '(GrammarID: <name> GrammarURI: "< >" Language:

# "en-US" )'

#

# GrammarID: this indicates the name for grammar.

# GrammarURI: absolute path to grammar file, URI, or the entire

# grammar as a string.

# GrammarWeight: the relative weight of the grammar. The


# GrammarWeight is optional.

#

# Multiple grammar specifications can be added here.

# ---

#

# GrammarSpec Examples :

#

GrammarSpec '(GrammarID: xcurrency GrammarURI: "builtin:grammar/currency" ) '

GrammarSpec '(GrammarID: xdigits GrammarURI: "builtin:grammar/digits" Language:

"en-US" )'

GrammarSpec '(GrammarID: xdate GrammarURI: "builtin:grammar/date" Language:

"en-US" )'

GrammarSpec '(GrammarID: xtime GrammarURI: "builtin:grammar/time" Language:

"en-US" )'

GrammarSpec '(GrammarID: xnumber GrammarURI: "builtin:grammar/number" Language:

"en-US")'

GrammarSpec '(GrammarID: xphone GrammarURI: "builtin:grammar/phone" Language:

"en-US" )'

#

# ---------------------------------------------------------------------

#

# Setting mrcpv1 parameters.

# The following shows how to set mrcpv1 parameters. These are set

# in the Section GlobalParameters and are therefore applicable to

# all labels defined in this file. They can also be set in the

# Section Label where they will apply only to that specific

# Label/Pool.

#

mrcpv1.Speech-Language en-US

#

# The following parameters are set to 0 as the TMS does the timing

# for interdigit and term timeout.

#

mrcpv1.Dtmf-Term-Timeout 0

mrcpv1.Dtmf-Interdigit-Timeout 0


#

# Example for setting an mrcpv1 parameter in a section GlobalParameters

#

###mrcpv1.Recognition-Timeout 20000

#

#

# ---------------------------------------------------------------------

#

# ContentType : Each grammar loaded must have a content type. Most

# if not all grammars are of the following xml type and therefore

# is set in here as is below. Be cautious when modifying this

# parameter value.

#

ContentType "application/grammar+xml"

*

# ---------------------------------------------------------------------

#

Section Label

Label MRCP_V1_digits

#

#

# GrammarList:

#

# List of grammar names to be used for this label; list must be

# comma separated. Must be the very next entry after Label. All

# other parameters should be set after this specification. (Please

# see example for vxml_grammars below).

#

GrammarList xdigits

#

# Example for setting an mrcpv1 parameter in a section label

#

###mrcpv1.No-Input-Timeout 9000


*

# ---------------------------------------------------------------------

#

# DO NOT REMOVE OR MODIFY THIS LABEL IN ANYWAY. THE FOLLOWING IS USED

# BY VXML APPS

#

Section Label

Label DYNAM_001

*

# ---------------------------------------------------------------------

Section Label

Label MRCP_V1_phone

GrammarList xphone

*

Section Label

Label MRCP_V1_date

GrammarList xdate

*

Section Label

Label MRCP_V1_time

GrammarList xtime

*

Section Label

Label MRCP_V1_currency

GrammarList xcurrency

*

Section Label

Label MRCP_V1_number

GrammarList xnumber

*

# ---------------------------------------------------------------------


vos.cfg file

The vos.cfg file resides in directory path %OSCARHOME%\oscarN\etc on the Speech Server node. It lists processes and related information needed by SRP (Startup and Recovery Process) to start-up a Speech Server node.

MRCPv1 resources require a different version of RCM than is used by other Speech Server 6.5 resources. The command that identifies this process rcmMrcp is case sensitive.

When two components are configured on the Speech Server node for speech synthesis processing. There is a complete set of configuration files for each component. For example, a Speech Server node configured with the components oscar1 and oscar2 contains the following two component-specific vos.cfg files.

%OSCARHOME%\oscar3\etc\vos.cfg

%OSCARHOME%\oscar4\etc\vos.cfg

vos.cfg file sample

#

# $Id$

#

# File: vos.cfg for PERImrcpv1

#

# Copyright – Avaya Inc.

#

# $Log$

#

# NAME HOST PORT PRI COMMAND LINE

# ----------------------------------------------------

#

rcm - - 7 rcmMrcp

The following table describes parameters in the vos.cfg file.


NAME Process name

HOST Name of the node where the process resides. A dash (-) indicates the process resides on the local node.

PORT Port used by process. A dash (-) indicates the port is on the local node.

PRI Priority assigned to process


COMAND LINE Command to start process

rcm.cfg file

The rcm.cfg file resides in the directory %OSCARHOME%\oscarN\etc on the Speech Server node. It contains only RCM parameters and provides the configuration information needed by the RCM process.

When two components are configured on the Speech Server node for speech synthesis processing. There is a complete set of configuration files for each component. For example, a Speech Server node configured with the components oscar1 and oscar2 contains the following two component-specific rcm.cfg files.



NOTE:

Avaya configures Speech Servers with a specific number of channels and sets this value with the rcm numchannels parameter. This must be the first parameter listed in the file. The number is based on system resources and performance.

Some timers are disabled in this file. Do not change this configuration as the results will be unpredictable. All timing for MRCPv1 resources is performed by the MRCPv1 Media Server. Therefore, RCM timers are disabled for an MRCPv1 resource.

The vendor‟s name is used for validation with the vendor/productName option specified in the %OSCARHOME%\oscarN\etc\rcm.tbl file. See “rcm.tbl file”.

Some parameters set in the rcm.cfg file can also be set from the application.

Generic Call Logging (GCL) has the ability to log audio data during a call. When this feature is enabled (gcaudioenable on), audio files are saved in au format by default. The gcaudioformat parameter lets you reconfigure the audio file format. To log audio files in wav format, uncomment the following parameter in the rcm.cfg file (if it is commented out).

chan all gcaudioformat wav

Because rcm.cfg file parameters are generic to all Speech Server resources, they are documented in the MPS Speech Server 6.5 Reference Guide (NN44100-131). Use that document when working with RCM parameters.

In order to enable dlog logging, you must set the log level as indicated in the following section. By default, logging is set disabled (off). Use the following commands to enable logging at the normal level.

log normal

slog normal

chan all log normal

chan all slog normal

dlogdbgon file,sys

dlogdbgon file,lib


dlogdbgon file,chan=all

dlogdbgon file,clib=all

If you only enable dlog (log set to normal) without setting the other entries to normal (as above), no logging will be output in the dlog file. To disable dlog logging, set the entries as follows:

log off

slog off

chan all log off

chan all slog off

dlogdbgoff file,sys

dlogdbgoff file,lib

dlogdbgoff file,chan=all

dlogdbgoff file,clib=all

For additional information about setting logging parameters, see the MPS Speech Server 6.5 Reference Guide (NN44100-131).

Two sample rcm.cfg files follow, one for an LVR component, the other for a TTS component.

The following sample rcm.cfg file resides on a component configured for LVR.

rcm.cfg file sample for LVR component

#

# $Id$

#

# ------------------------------------------------

# File : rcm.cfg for PERImrcpv1

# (For lvr-mrcpv1)

#

# ------------------------------------------------

#

# Number of channels that must be started on oscar

#

# Modify the argument from 8 to appropriate value if required

# please note that the number of channels on an oscar must be

# changed cautiously due to dependency on several parameters

# such as grammar complexity, memory available, cpu utilization


# when all channels are used simultaneously ..etc

#

numchannels 64

#

# ------------------------------------------------------------------

# timing :

#

# Vendor does all timing like nsp, tms, etc and therefore this option

# is needed. Default is "timing rcm".

#

# WARNING : do not alter the following setting.

#

timing vendor

#

#

# Vendor/Product name

# --- DO NOT MODIFY FOLLOWING ENTRY ---

#

vendorName mrcpv1

#

# ------------------------------------------------------------------

# GCL directory :

# To set the GCL log directory to a location other than the default

# use the following option. Please ensure that directory exists.

#

#gcDirectory L:\gclogs\oscar<oscar-comp-no>

#

# ------------------------------------------------------------------

# Generic call logging :

# To turn generic call logging on uncomment the following line.

# ------------------------------------------------------------------

#

gclog off


#

# ------------------------------------------------------------------

# Generic call logging audio enable :

# To turn generic call logging audio enable on uncomment the following

# line.

# ------------------------------------------------------------------

#chan all gcAudioEnable on

#

# ------------------------------------------------------------------

# Generic call logging audio format:

# If generic call logging audio enable is turned on, you can change

# the audio file format using the following command. The valid settings

# are au, wav, def1, and mmf.

# Default: wav

# ------------------------------------------------------------------

#chan all gcAudioFormat wav

#

# ------------------------------------------------------------------

# LVR-Timers :

# To change the value of any timers for an lvr resource, please

# modify the argument to one or more of the following as appropriate.

# The values shown below are default values for the timers.

# ------------------------------------------------------------------

#chan all timer nsp value 6s

#chan all timer tms value 8s

#chan all timer slr value 4s

#chan all timer tsr value 9s

#

#

# ------------------------------------------------------------------

# *** WARNING : PLEASE DO NOT MODIFY THE TIMERS AND TIMER ***

# *** VALUES AS LISTED BELOW. IF MODIFIED RESULTS WILL BE ***

# *** UNPREDICTABLE ! ***


# ------------------------------------------------------------------

chan all timer alloc value disable

chan all timer abort value disable

chan all timer free value disable

chan all timer recog value disable

chan all timer nsp value disable

chan all timer tms value disable

chan all timer startinput value disable

#

# ------------------------------------------------------------------

# TERMINATION :

# The default method of terminating the rcm process is hard,

# indicating that no vendor cleanup will be done. If vendor software

# cleanup is necessary, then the following line should be

# uncommented.

# ------------------------------------------------------------------

#

#termination soft

termination hard

#

# ------------------------------------------------------------------

# Dlog CAPTURE BUFFER mode :

# The default dlog mode is set to CAPTURE BUFFER. To turn off

# CAPTURE BUFFER, uncomment the following lines

# ------------------------------------------------------------------

#

#dlogcapoff sys

#dlogcapoff chan=0-31

#dlogcapoff evt

#dlogcapoff lib

#dlogcapoff clib=0-31

#

#


# Please leave following settings enabled !

#

log normal

slog normal

chan all log normal


dlogfilesize 9999999

# ------------------------------------------------------------------

#

# ------------------------------------------------------------------

# Dlog FILE mode :

# To turn on dlog FILE mode, uncomment the following lines

# ------------------------------------------------------------------

#dlogdbgon STDERR,PROFDBG

#dlogdbgon STDERR,PROFERR

#dlogdbgon file,sys

#dlogdbgon file,chan=all

#dlogdbgon file,evt

#dlogdbgon file,lib

#dlogdbgon file,clib=all

#-----------------------------------------------------------------------

The following sample rcm.cfg file resides on a component configured for TTS.

rcm.cfg file sample for TTS component

#

#$Id$

#

# ------------------------------------------------

# File : rcm.cfg for PERImrcpv1

# (For extts-mrcpv1)

#

# ------------------------------------------------

#


# Number of channels that must be started on oscar

#

# Modify the argument from 8 to appropriate value if required

# please note that the number of channels on an oscar must be

# changed cautiously due to dependency on several parameters

# such as grammar complexity, memory available, cpu utilization

# when all channels are used simultaneously ..etc

#

numchannels 96

#

# ------------------------------------------------------------------

# timing :

#

# Vendor does all timing like nsp, tms, etc and therefore this option

# is needed. Default is "timing rcm".

#

# WARNING : do not alter the following setting.

#

timing vendor

#

# Vendor/Product name

# --- DO NOT MODIFY FOLLOWING ENTRY ---

#

vendorName mrcpv1

#

# ------------------------------------------------------------------

# GCL directory :

# To set the GCL log directory to a location other than the default

# use the following option. Please ensure that directory exists.

#

#gcDirectory L:\gclogs\oscar<oscar-comp-no>

#

# ------------------------------------------------------------------


# Generic call logging :

# To turn generic call logging on uncomment the following line.

# ------------------------------------------------------------------

#

gclog off

#

#

# ------------------------------------------------------------------

# Generic call logging audio enable :

# To turn generic call logging audio enable on uncomment the following

# line.

# ------------------------------------------------------------------

#chan all gcAudioEnable on

#

# ------------------------------------------------------------------

# Generic call logging audio format:

# If generic call logging audio enable is turned on, you can change

# the audio file format using the following command. The valid settings

# are au, wav, def1, and mmf.

# Default: wav

# ------------------------------------------------------------------

#chan all gcAudioFormat wav

#

# ------------------------------------------------------------------

# *** WARNING : PLEASE DO NOT MODIFY THE TIMERS AND TIMER ***

# *** VALUES AS LISTED BELOW. IF MODIFIED RESULTS WILL BE ***

# *** UNPREDICTABLE ! ***

# ------------------------------------------------------------------

#

chan all timer outputdata value disable

#

# ------------------------------------------------------------------

# TERMINATION :


# The default method of terminating the rcm process is hard,

# indicating that no vendor cleanup will be done. If vendor software

# cleanup is necessary, then the following line should be

# uncommented.

# ------------------------------------------------------------------

#

termination hard

#

# ------------------------------------------------------------------

# Dlog CAPTURE BUFFER mode :

# The default dlog mode is set to CAPTURE BUFFER. To turn off

# CAPTURE BUFFER, uncomment the following lines

# ------------------------------------------------------------------

#

#dlogcapoff sys

#dlogcapoff chan=0-31

#dlogcapoff evt

#dlogcapoff lib

#dlogcapoff clib=0-31

#

# ------------------------------------------------------------------

#

# Please leave following settings enabled !

# Values below may be changed from "normal" to "verbose", but must

# ALWAYS remained enabled and not commented.

#

log normal

slog normal

chan all log normal


dlogfilesize 9999999

#

# ------------------------------------------------------------------


# Dlog FILE mode :

# To turn on dlog FILE mode, uncomment the following lines

# ------------------------------------------------------------------

#dlogdbgon STDERR,PROFDBG

#dlogdbgon STDERR,PROFERR

#dlogdbgon file,sys

#dlogdbgon file,chan=all

#dlogdbgon file,evt

#dlogdbgon file,lib

#dlogdbgon file,clib=all

#--------------------------------------------------------------------

Configurable parameters

This section addresses the topic of parameters, how to set and get them from a Media Server, and their order of precedence.

For information about configuration files and the description of individual parameters, see “MRCPv1 parameters”.

This document focuses configuration that is unique to using the Loquendo Speech Server 7.0 resource with the MRCPv1 protocol. For configuration information about MRCPv1 speech resource processing that is generic to all resources, such as duration and precedence of parameters and MRCPv1 parameters, see the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

Types of Parameters

There are several types of parameters that can be set from the application and from configuration files. These fall into the following categories.

RCM parameters (platform related).

See “RCM and integration shared library parameters”.

Integration Shared Library parameters.

See “RCM and integration shared library parameters”.

MRCPv1 parameters. See “MRCPv1 parameters”.

Vendor-specific resource parameters associated with the LVR or TTS engines. See “MRCPv1 parameters”.

RTSP parameters. See “RTSP parameters”.


RCM and integration shared library parameters

The RCM and Integration Shared Library parameters are set in the same way as any other LVR or TTS resource that is currently supported on the Avaya Speech Server platform. There is nothing different about setting these parameters for an MRCPv1 resource.

RCM parameters may be set in the rcm.cfg file or from the application. See “rcm.cfg file”.

Integration Shared Library parameters may be set from the sys-lvr-mrcpv1.cfg or sys-extts-mrcpv1.cfg files or from the application. See “sys-[lvr|extts]-mrcpv1.cfg file”.

These parameters are not sent to the MRCPv1 Media Server. They are processed by the appropriate module in RCM on the Speech Server node.

Note:

If you need to perform change label test, make sure all labels are configured in all LVR components. The reason for this is that during system initialization each component will build its own pool list. When change label request comes in, it will search the label in its own pool list. If label is not found, request will be failed.

MRCPv1 parameters

The MRCPv1 parameters are sent to the Media Server either as part of a header to a method other than SET-PARAMS or in the SET-PARAMS method.

On the MPS platform, all parameters set from the application and those set in the Section GlobalParameters and Section Label of the sys-lvr-mrcpv1.cfg or sys-extts-mrcpv1.cfg files are sent by means of the SET-PARAMS method and not as part of a header.

The MRCPv1 parameters are set using the prefix mrcpv1. For example, the following MRCPv1 parameters or set as follows.

mrcpv1.N-Best-List-Length 10

mrcpv1.N-Speed-Vs-Accuracy 1

For additional information about setting MRCPv1 parameters in the system configuration file, see “sys-[lvr|extts]-mrcpv1.cfg file”.

For additional information about MRCPv1 parameters, see the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

Vendor-specific parameters

The vendor-specific parameters can be set as part of a header to a method or in the SET-PARAMS method according to the MRCPv1 specification.

The Integration Shared Library does not differentiate between an MRCPv1 parameter and a vendor-specific parameter due to the specification (format) used to set these parameters.

Vendor parameters are set in the following format.

mrcpv1.Vendor-Specific-Parameters ‘"parameter=value[;parameter=value]"’


For example, the following setting configures a vendor-specific parameter

mrcpv1.Vendor-Specific-Parameters 'com.loquendo.tts.ProsodicPauses="automatic"'

Note:

For detailed vendor specific parameters, please refer to Vendor document MRCPv1 Server Specification Document.

Loquendo support the parameter com.loquendo.beep but Avaya cannot support this parameter. The reason for this is that Loquendo require ASR and TTS resources for a call must share the same RTSP session-ID in order for this parameter to work. While Avaya's MRCPv1 client implementation does not allow for such an operation because Avaya's TTS and ASR are two independent and separate resources where an input resource ASR and an output resource TTS are treated independently so the ASR and TTS sessions will always be negotiated separately with the server.

RTSP parameters

Currently, RTSP parameters are not required to be set. The only methods of RTSP that are used to support MRCPv1 are SETUP, TEARDOWN, ANNOUNCE and DESCRIBE. Thus, Avaya does not support the setting of RTSP parameters.

Configurable parameters table

The following table summarizes the configurable Avaya parameters that affect MRCPv1 resource processing.

Parameter Value Issue from Description

CallID Default: none

Maximum length:

2048

application Setting the gcCallID or the CallID (RCM) will set the MRCPv1 Logging-Tag parameter. Set this parameter to log Logging-Tag or call ID to the Event Logs.

This uniquely identifies a call in the Event Logs or Call Logs. This option is set from the application only when a call is in process.

Setting the RCM Generic Call Log (GCL) parameter gcCallId also sets this CallID parameter.

RCM sets the CallID parameter When it receives a set parameter for gcCallId.

Set CallID in the either of following formats:

• CallID <value>

• gcCallId <value>



Typically, a call is associated with a session. It is possible to have multiple sessions associated with a single call.

However, this is not recommended when the application is using the same resource, at least with reference to recognition resources.

When multiple sessions are associated with a single call, the recognizer loses adaptation parameters with the start of each new session. There is a reduction in accuracy of recognition. (Avaya does not support Recognizer-Context-Block due to the binary/octet data that is sent with this parameter, which allows for multiple sessions for a single call.)

Whether the sessions are carried over a single TCP connection or multiple connections (for example, one per session per channel) is irrelevant to setting the CallID parameter.

ServerPingInterval Default: 5 sys-lvr-mrcpv1.cfg

sys-extts-mrcpv1.cfg

This parameter is set in Section GlobalParameters.

This is a timer value used to check if we have received a response or a message from the server within this time period. If we haven't then we wait for the N PingRetries and if N * ServerPingInterval time period elapses without a response from the server, the client (rcm) is brought down in order to remove it from the allocation pool.

value must be specified in seconds To disable checking, set the value to 0.

ServerPingRetries Default:

3

sys-lvr-mrcpv1.cfg



Value specified for retries times the ServerPingInterval time period is how long the client waits to receive a response from the server before it brings down the client, considering that the server is down.



RTPBeginPort Loquendo

Default:

10000

Range:

10000-

10512

sys-lvr-mrcpv1.cfg



Specifies the starting RTP port number for the first channel. The port number for subsequent channels is computed.

It is the user‟s responsibility to ensure that the port numbers subsequent to, and consecutive to this starting port number, are available for use by the number of channels specified in the rcm.cfg file. See “rcm.cfg file”.

You only need to change the values for this parameter in case of a conflict with any software on the Avaya Speech Server.

The following example shows that RTPBeginPort is set as one of the parameters in the Section GlobalParameters of the system configuration file.


..

RTPBeginPort 10000

..

*

RTP ports must be even-numbered ports and have a corresponding RTCP port one greater (an even/odd combination per port). Thus, each channel requires two ports: one port for RTP and another port for RTCP.

For example, if an RCM process is configured for 100 channels, 200 ports are required and the RTPBeginPort is set to 10000.

Channel 1 is assigned 10000 and 10001; Channel 2 is assigned 10002 and 10003; Channel 100 is assigned 10198 and 10199.



In the case when there are two RCM processes each configured for 100 channels, the port numbers for each RCM process must not overlap.

For example: The first RCM process is configured as above. The second RCM process is configured for 100 channels, 200 ports are required and the RTPBeginPort is set to 10200:

Channel 1 is assigned 10200 and 10201; Channel 2 is assigned 10202 and 10203; Channel 100 is assigned 10398 and 10399.

SocketBindPort Range:

Valid Port

Number

sys-lvr-mrcpv1.cfg



This parameter is configured during the installation of the Avaya SelfService software. You only need to change the values for this parameter in case of a conflict. This value is computed automatically set with unique port numbers when multiple components are installed on a single Avaya Speech Server node.

Required when more than one recognition (LVR) or synthesis (TTS) component is configured on the Speech Server node.

This port allows for socket communication from the worker threads to the main thread.

Each component requires a unique port number.

Set SocketBindPort in the following format:

SocketBindPort <Port#>

MediaServerSpec Resource-

Specific

sys-lvr-mrcpv1.cfg



Provide a Media Server Specification for each server to which the client can connect with this parameter.



Currently, a client can connect to only one Media Server. (Multiple servers may be implemented in the future.)

Loquendo Defaults:

ServerIP:

ServerName:

Server Port: 554

Set MediaServerSpec in the following format:

For LVR:


(ServerIP : xx.xx.xx.xx ) \

(ServerName : <hostname> ) \


(EngineUrlSuffix : media/recognizer) )"

For TTS:


(ServerIP : xx.xx.xx.xx ) \

(ServerName : <hostname> ) \


(EngineUrlSuffix : media/synthesizer) )"

ServerIP, ServerName and ServerPort will be prompted during MRCPv1 client software installation.

VendorType Default:

GENERIC

sys-lvr-mrcpv1.cfg

Identifies the vendor associated with the Media Server.

Set this parameter only in the Section GlobalParameters of the system



sys-extts-mrcpv1.cfg configuration file as part of the MediaServerSpec parameter.

Resource allocation may take place based on vendor as well. As a server must be identified with a vendor.

ServerIP Range:

Valid IP

address

sys-lvr-mrcpv1.cfg


Specifies the Media Server‟s IP address.

Set this parameter only in the Section GlobalParameters of the system configuration file as part of the MediaServerSpec parameter.

This parameter must be set even if the control messages are routed by means of a proxy server.

Set ServerIP as follows: ServerIP <IP_address>.

ServerName Range:

Valid Media

Server Name

sys-lvr-mrcpv1.cfg


Specifies the name (hostname) of the Media Server to connect with.


Set ServerName in the following format:

ServerName <MediaServerName>

ServerPort Default:

554

sys-lvr-mrcpv1.cfg


Indicates the Media Server‟s port, the TCP port or the port which will be used by the RTSP protocol to establish a connection with the Media Server.


Set ServerPort in the following format:

ServerIP <Port#>

EngineUrlSuffix Default for LVR: sys-lvr-mrcpv1.cfg This is set within global parameter MediaServerSpec



media/recognizer

Default for TTS:

Media/synthesizer


Specifies the URL suffix to use when connecting to the media server. It indicates if this channel is going to be used for LVR or TTS.


Some vendors provide the ability to change this value in a configuration file that is read by the Media Server during startup. When this is the case, ensure that the values set in the vendor configuration file and the system configuration file (sys-lvr-mrcpv1.cfg or sys-extts-mrcpv1.cfg) match.

Otherwise, behavior is unpredictable.

GrammarSpec sys-lvr-mrcpv1.cfg

Specifies information about a static grammar, such as GrammarName, GrammarURI, Language and is defined in the Section GlobalParameters.

A sample GrammarSpec for the built-in grammar digits follows:

GrammarSpec „(GrammarID: digits GrammarURI : “builtin:grammar/digits‟ Language: "en-US" )‟

mrcpv1.<parameter> sys-lvr-mrcpv1.cfg


or

application

MRCPv1 parameters can be set in both section GlobalParameters and section Label from configuration files or from the application.

However:

If set in the configuration file, then allocation of the resource may fail if value is invalid or if parameter name is misspelled.

If set from application, then Recognition or Speak can fail and a forcefree may result due to an invalid parameter



name or an invalid value.

For additional information about MRCPv1 parameters, see “MRCPv1 parameters”

mrcpv1.Speech-

Language <lang>

Default:

Valid language

sys-lvr-mrcpv1.cfg


or application

This parameter must be set explicitly for LVR and TTS resources. It can be set in the configuration file or from the application, before recognition or speak request.

Synthesizer parameter: Specifies the default language of the speech data.

Recognizer parameter: Specifies the language of recognition grammar data within a session or request, if it is not specified within the data.

Example:

mrcpv1.Speech-Language en-US.


mrcpv1.Voice-Gender <gender>

Default: None

Range:

male

female

neutral

sys-lvr-mrcpv1.cfg


or

application

Defines voice of the speaker for speech synthesis.

Example: mrcpv1.Voice-Gender female


ContentType sys-lvr-mrcpv1.cfg


or

application

Specifies the type of input text sent to the resource for TTS (plain text or SSML) and to indicate the grammar type for LVR.

This parameter must be explicitly set for TTS either in the configuration file or from the application.

Recognition resources:



Each grammar that is loaded must specify a value for ContentType. Most, if not all, grammars are of the XML type and are set as follows:

ContentType "application/ grammar+xml"

Synthesis resources:

Synthesis resources can synthesize either plain text or SSML formatted text. The application informs the resource about which type of text to expect by setting the ContentType parameter. The value of this parameter must match the type of input text sent to the synthesizer.

Values can be set as follows:

Plain text: text/plain

SSML text: application/synthesis+ssml

Label sys-lvr-mrcpv1.cfg


The maximum length of the label name is 128 characters.

Specifies a pool name and the context for a recognition or text to speech resource.

A label named Empty can be used for allocating a resource without grammars (LVR) loaded during the allocation.

An example of Label definitions follow:

*

Section Label

Label digits

GrammarList digits

*

Section Label



Label date

GrammarList <grammar>

*

Section Label

Label VoiceFemale

<params value>

.

.

*

GrammarList sys-lvr-mrcpv1.cfg

Specifies a list of grammars defined within a Section Label to indicate the grammars associated with that label.

The following label associates the grammar digits with the label name digits.

*

Section Label

Label digits

GrammarList digits

*

Each grammar specified in the GrammarList must be defined using a GrammarSpec entry.


Chapter 5. Special Subjects

Special subjects

This chapter documents special subjects that relate to Loquendo Speech Server 7.0 resource processing but are beyond the scope of the other chapters in this document.

Topic Goto

say-as tag “say-as tag”

lexicon “Lexicons”

Commonly used Ports on Media Server Node “Commonly used ports on the Media Server node”

say-as tag

The Speech Synthesis Markup Language (SSML) say-as tag is designed to activates a reading style specified by a mnemonic (e.g. address, email).

While the W3C SSML 1.0 Recommendation specifies the say-as element and its semantics with the interpret-as, format, and detail attributes.

Loquendo TTS 7.8 supports the say-as syntax of the December 2002 SSML.

For a full listing of supported say-as tags see the Loquendo TTS User‟s Guide found in the directory path:

C:\Program Files\Loquendo\LTTS7\doc

Lexicons

Use the lexicon to specify special pronunciations for words or character strings and to substitute the original text strings with

Words that you want spoken to the caller

Words or character strings that are not in the existing sound bank

For example, if the Source Text string is IBM and you set the Destination Text to International Business Machines, the synthesizer speaks the name International Business Machine to the caller each time the text to be synthesized contains the text string IBM.

Create and edit the lexicon

Loquendo TTS support two format of lexicon files: the Loquendo Format(LEX), or the W3C Pronunciation Lexicon Specification (PLS) version 1.0 (see http://www.w3.org/TR/pronunciation-lexicon/). You need to use

http://www.w3.org/TR/pronunciation-lexicon/

the Loquendo TTS Lexicon Manager tool to write and modify the files in both formats. Loquendo Lexicon manager produces lexicons in text format.

Create the lexicon file in Loquendo (.lex) format

1. Open TTS Director tool:

Start->All Programs->Loquendo->Loquendo TTS7 ->Loquendo TTS7 Director

2. Open TTS lexicon manager tool from TTS7 Director tool:

Tools->Loquendo TTS Lexicon Manager

3. Create lexicon file from Lexicon Manager:

File->new->select "Loquendo Lexicon File"

Click "Add Section" icon (down arrow sign) from tool bar

Modify the Languages field for the languages you need to use, if you don't modify this field, the lexicon can be used for all languages.

Click on "Add Row" icon (plus sign) from tool bar

Enter Original Text field

Enter Substitute Text field

4. Click "Error Check" icon (check sign) to verify.

5. Right click Untitled -> save as -> filename.lex.

Sample lexicon file in .lex format

<?xml version="1.0" encoding="UTF-8"?>

<loqlexicon version="1.2">

<section case="insensitive">

"ibm" = "International Business Machine"



</section>

</loqlexicon>

Create the lexicon file in W3C Pronunciation Lexicon Specification (.pls) format

1. Open TTS Director tool:

Start->All Programs->Loquendo->Loquendo TTS7->Loquendo TTS7 Director


2. Open TTS lexicon manager tool from TTS7 Director tool:

Tools->Loquendo TTS Lexicon Manager

3. Create lexicon file from Lexicon Manager:

File->new->select "Pronunciation Lexicon Specification 1.0(PLS)”

Add the following content to field 3 on right panel

<lexeme>

<grapheme>IBM</grapheme>

<alias>International Business Machine</alias>

</lexeme>

4. Click "Error Check" icon (check sign) to verify.

5. Right click Untitled -> save as -> filename.lpls.

Sample lexicon file in .pls format

<?xml version="1.0" encoding="UTF-8"?>

<lexicon version="1.0" xmlns="http://www.w3.org/2005/01/pronunciation- lexicon"

alphabet="ipa" xml:lang="en-US">

<lexeme>

<grapheme>IBM</grapheme>

<alias>International Business Machine</alias>

</lexeme>

</lexicon>

Using the lexicon

The following information focuses on lexicons on the Loquendo Speech Server (LSS).

A User Lexicon can be loaded in the <num> position in the Lexicon Array (see User Control of TTS Pronunciation of Loquendo User‟s Guide). Any position can be chosen (although it is suggested that consecutive positions are used, starting from 0). If the specified position is already taken, the old lexicon will be substituted with the new one. The Lexicon Array will be searched starting from its last position. A loaded lexicon can be unloaded by referring to its <num> position in the Lexicon Array. You can load up to 32 lexicons (from index 0 to index 31). The following format shows how to load/unload lexicon file.

\lexicon(load=<num>,<lexicon filename>)

\lexicon(unload=<num>)

When you use an HTTP server, you must add the following two entries to your MIME table to associate the lexicon extension with the MIME type.


application/pls+xml pls

application/lex lex

For local file access, the following file extensions are correctly mapped on the box:

.pls, lex.

Three sample lexicon to use within a VXML application follows:

load lexicon locally:

<prompt>

First, The acronym I B M should be spoken as \lexicon(load=0,c:/lex/ibm.lex)

IBM.

</prompt>

load lexicon using HTTP server:

<prompt>

\lexicon(load=1,http://47.185.25.154/ibm.lex) Second, speak I B M as IBM.

</prompt>

load lexicon using SSML tag <lexicon>

<prompt>

<lexicon uri="file:c:/lex/ibm.lex"/> Third, speak I B M as IBM.

</prompt>

For more information on lexicon, see Loquendo TTS User‟s Guide provided by Loquendo.

Style Control

Activates one of the available alternative reading styles. Styles are text files that can be created by the user in order to modify the TTS behavior by setting reading parameters and activating User Lexicons. The file extension is .ycf.

Make sure the following requirements are satisfied when you using style control.

use text editor to create .ycf file

style filename path must be written with '/' instead of with '\'

style filename extension '.ycf' must be omitted in style activation

lexicon referenced in style file must be expressed with its full path. If you use filename only, it will be searched in Loquendo TTS data path (which defaults to C:/Program Files/Loquendo/LTTS7/data)

sample ibmSample.ycf


"lexicon" = "c:/lex/ibm.lex"

"SpellPunctuation" = "YES"

VXML application Example:

<prompt> \style=c:/lex/ibmSample IBM, \style=general IBM. </prompt>

The above vxml application text will be spoken as "International Business Machine comma IBM"

Note: The default lexicon has an higher priority over the one referenced in style, so if you use more lexicons defining the same word, the default lexicon transliteration will be used.

Reference to Loquendo TTS User‟s Guide for more details about style control.

Other User Control

Loquendo TTS allows the user to control some aspects of the TTS reading, such as the language in which the text will be pronounced, the voice, its speaking rate, its loudness, the interpretation of digits, the stress prominence of a word or its pronunciation.

The general syntax of the Loquendo TTS User Controls is the following:

<Marked-up text> ::= [<text-portion 1>] <Control Sequence> [<text-portion 2>]

<Control Sequence> ::= <Control> [<Control Sequence>] <white space>

<Control> ::= \<control tag> [<parameters>]

<white space> ::= <SPACE>|<TAB>|<RETURN>|<NEWLINE>|<FORMFEED>

<control tag> ::= <string of characters>> ["="]

<parameters> ::= ({[<control tag>]<value>}) | <value> [{,<value>}]

<value> ::= <string of characters> | <number> | <filename>

<filename> ::= [<path>] <name>

<path> ::= [<disk>:/]{<name>/}

<name> ::= <string of characters>

Examples:

This is \speed=70\pitch=30 a marked up text for \spell=yes LTTS.

Here \audio(play=C:/audio/hello.wav) You got your hello.

This is \audio(play=http://47.185.25.154/hello.wav) a test.

\voice=Dave Now I am using Dave as the voice, Sound good.

For more information on user control, see Loquendo TTS User‟s Guide provided by Loquendo.


TTS User Control in Peripro Applications

If you use TTS control sequence in Peripro applications, make sue to add the backslash. The following examples show the two different ways of doing it.

"You will hear \\sayas=SMS lol"

"You will hear \5Csayas=SMS lol"

Note: The Hex value of "\" is 5C so you can send it as "\<HEX value>"

MultiSpacePause User Control

By default, multiple spaces or tabs in a text generate a pause. If you set this parameter to "FALSE", no pause is generated.

MultiSpacePause configuration parameter cannot be dynamically changed and it will not work when used directly in the text. You can only set MultiSpacePause in the Loquendo TTS registry section according to your needs.

Registry setting only works with plain text multiple spaces or tabs. With VXML application, multiple spaces are collapsed into a single space therefore MultiSpacePause parameter will always be treated as FALSE and you are not going to hear pause even you set MultiSpacePause to TRUE.

The default value for MultiSpacePause parameter is TRUE. If you need to set it to FALSE, you need to set it in registry and restart Loquendo server.

The sample registry file MultiSpacePause.FALSE.reg for the parameter MultiSpacePause is listed below:

REGEDIT4

[HKEY_LOCAL_MACHINE\SOFTWARE\Loquendo\LTTS7\default.session] "MultiSpacePause"="FALSE"

Loquendo will update their TTS user manual to specify the registry exclusive use only for this parameter.

Commonly used ports on the Media Server node

In the interest of best practices for a secure network environment, typically, only those ports required for system operations are left open. All ports that are not required for system operations can be closed.

The following table represent a list of commonly used ports on the Media Server node. These ports must remain open.

Port Use

554 MRCPv1 RTSP Port

10000-10512 Ports reserved for RTP for data transmission between the MRCPv1 Client and MRCPv1 Media Server.


Language Modeling Recognition Object (LM RO)

The Language Modeling Recognition Objects (LM ROs) can be used in the way described below.

The MRCP server manages the LM ROs as permanently compiled objects. The ROs must be compiled off-line using the LASR off-line tool SATCA(Speech Assistant Toolkit Console Application). This tool is available if you installed the LASR SDK.

The compiled RO will be in the subfolder which is the definition of Name in header file. Please do not rename the subfolders, take them as consistent objects.

Note that the name of LM ROs must be unique and must begin with underscore „_‟ and LM ROs must be copied into the folder %LOQ_HOME%/ASRrp/rp_permanent/

In order to use LM ROs, the client has to specify „builtin:ro/_LMROname#turnName‟ in a RECOGNIZE uri-list.

Where:

„_LMRO_name‟ is the RO name (that begins with „_‟)

„turnName‟ is the turn that must be specified; if it is not present, the MRCP Server will return an error. Default turnName is „_‟.

The following example is for language model without semantics and using the default turn name for travel. You are going to need the following to create LM RO:

dictionary(.gra file) that is generally expanded with information that permits grouping words into classes

corpus(.dbt file) of sentences where, if possible, the sentences are annotated with the label of the turn in which the sentence was acquired.

header file for compiling LM RO

Step1: Create dictionary file(s) by grouping all possible words that are equivalent from the syntax and semantics. The number of words for each output dictionary has been limited to 4095. If your application requires more words please contact the Loquendo Technical Assistance.

Example:

cities.gra

Washington

Miami

Indianpolis

Atlanta


Confirmation.gra

yes

no

sure

certainly

day.gra

morning

tomorrow

afternoon

today

tonight

evening

hour.gra

one

two

three

four

five

six

seven

eight

nine

ten

eleven

twelve


quarter

half

twenty

thirty

fourty

fifty

other.gra

from

to

at

in

the

o'clock

past

destination

starting

Step2: Create corpus by combining words into set of sentences/phases

Example:

corpus.dbt

from Washington to Miami

at ten to nine

in the morning

yes

no

yes sure


tomorrow

at six o'clock

at half past seven

destination Washington

starting from Miami

Step3: Create header file which are the concatenation of all the sub-dictionaries supplied and the classification of the dictionary words. This file is used to compile LM RO.

Example:

lm.hdr

Type: LANGUAGE_MODELING

Language: en-us

Name: _LMRO

CompVocab: other.gra

CompVocab: cities.gra

ClsVocab: CITIES

CompVocab: confirmation.gra

ClsVocab: CONFIRMATION

CompVocab: hour.gra

ClsVocab: HOUR

CompVocab: day.gra

ClsVocab: DAY

VocabAutoCls: AUTO

Corpus: corpus.dbt

Note: Filler words (other.gra) do not have any corresponding class. Words without the name of an associated class form a class that contains only the word itself. By setting the AUTO to VocabAutoCls, you can request an additional automatic regrouping of the dictionary words. Otherwise, the classification remains unaltered. The default value is NONE.


Step4: LM compilation has to be done on the server where Loquendo ASR and SDK are installed. To compile LM RO, use the following command:

loqasrsatca -a lm.hdr

A folder called _LMRO will be generated, don't change the name of the folder.

Step5: Copy the folder _LMRO to %LOQ_HOME%\ASRrp\rp_permanent

Step6: In application, use the following format to load compiled _LMRO as builtin grammar:

<grammar src="builtin:ro/_LMRO#_"/>

Note: You can refer to corpus.dbt for spoken utterance/sentences for testing.

For more details, please refer to "Language Modeling recognition objects" section of MRCPv1 Server Specification document and Loquendo ASR7.8 – SATCA User‟s Manual 7.8.0

Builtin Phone Grammar

Loquendo‟s phone builtin grammar does not allow in any way to specify the word "extension". So if you try to apply phone number with extension and using Loquendo‟s builtin phone grammar Loquendo will only recognize the first 10 digit phone number without extension.

Loquendo will take into account of this observation for further releases of ASR language packs. In the meanwhile, you can take Loquendo‟s source builtin phone grammar under %LASR_INSTALL_PATH%\conf\languages\en-us\built-in\source and make modification in order to extend its coverage to all the utterances you need. Then you have to use the modified grammar as a source grammar not as a builtin grammar.


Chapter 6. Install Software

Overview

This chapter provides information about installing the Loquendo software on the Loquendo Speech Server node and installing the Avaya SeftService software on the Avaya Speech Server node. You must follow all instructions in described order to complete a successful installation. The software includes:

on Loquendo Speech Server node:

TTS installation

Engine

Remote API

SDK

Languages

Voice

ASR installation

Engine

SDK

Languages package

LSS installation

Speech server suite

License installation

License Manager Tool

on Avaya Speech Server node:

mps3.5 base package

mps3.5 patch bundle 3

You must restart the LSS Media Server node and Avaya Speech Server node after installing the software.


Introduction

The Loquendo Speech Server, Loquendo Recognizer, and Loquendo synthesizer reside and run on a Media Server node, separate from the Avaya Speech Server node. Use the information in this chapter to install the Loquendo vendor software on the Media Server node and MRCPv1 client software on the Avaya Speech Server node.

The Loquendo vendor software must be installed on a node dedicated to processing the MRCPv1 vendor Media Server software. Loquendo does not support Loquendo software residing on the Avaya Speech Server node, where the MRCPv1 client resides.

Installation time

The Avaya implementation of speech-based transaction processing with Loquendo Speech Server 7.0 resources requires you to install software distributed by Loquendo on each Media Server node and software distributed by Avaya on each Speech Server node.

On each Loquendo Speech Server 7.0 Media Server node, allow approximately 1 hour to install the Loquendo software. The amount of time depends on several factors that include:

The number of languages/voices you are installing.

The CPU power of the Media Server node.

Whether you are performing the install from a remote site (speed of network connection) or from a console connected to the Media Server node.

On each Avaya Speech Server node, allow 15-20 minutes depending on the configurations or options that you install.

Installation prerequisites

Avaya recommends the following requirement guidelines for installing software on the Loquendo Speech Server 7.0 Media Server node. Comply with the following prerequisites before installing software on Media Server node.

Requirements

Verify that the hardware on which the software is going to be installed meets the requirements as specified by Avaya. These requirements include the following.

Windows 2003 and Service Pack 2.

IBM x3550 or HP G5 quad core or higher.

Minimum of 4 GB RAM for the recognition resource or the Synthesis resource.

5 GB Free Disk Space.

Static IP address.


No antivirus software. Antivirus software impacts to performance issues.

No firewall.

Obtain all required licenses.

Backup any existing files you want to preserve.

Satisfy disk space requirements. Refer to the Technical Annex Documentation distributed by Loquendo for information about the disk space the vendor software requires.

Terminate all applications and close all programs on the node before you install software.

Stop Web services such as Internet Information Service (ISS) before you install software.

Ensure that you know the ports that need to be configured for the vendor software before the installation to prevent any port conflicts.

Activate Remote Desktop Connection (RDC) for remote support.

Install the Loquendo software.

Administrator logon

You must log on to the Media Server node as administrator to install and uninstall software. Changes to the administrator password after installation do not affect the behavior of the Loquendo software.

Loquendo Speech Server Installation

Locate the drive where the latest version of Loquendo software resides and unzip the file. Use the following procedure and follow the exact order as described below to install the Loquendo server software on the Media Server node.

Loquendo TTS 7.8 Installation

Install TTS engine

1. Go to the following installation directory

Loquendo_TTS_7-Win32_Engine_Full_Distribution_7.8.6

2. Double click on Loquendo_TTS_7-Win32_Engine_Full_Distribution_7.8.6.exe


3. Click ok to continue.

4. Click Next on Welcome window.


5. Select I accept the license agreement, then click Next.

6. Enter Multimedia Applications as Full Name

7. Enter Avaya as Organization

8. Select Anyone who uses this computer, then click Next


9. Browse to destination path if you don't want to use the default path which is C:\Program Files\Loquendo\LTTS7, click Next.


10. Click Next to start installation

11. Click Finish when it is done.

Install TTS Remote API

Skip TTS Remote API installation steps if you didn't purchase Loquendo TTS SDK package. This package is only needed to develop and debug applications.

1. Go to directory

Loquendo_TTS_7-Win32_Remote_API_Distribution_7.9.3

2. Double click the Loquendo_TTS_7-Win32_Remote_API_Distribution_7.9.3.exe file.

3. Click Next on Welcome window

License Agreement window will popup,

4. Select I accept the license agreement then click on Next

Installation options window will popup,

5. Select Full installation then click on Next


6. Click No.

User Information window will popup,




Destination Folder window will popup,

10. Click Next (destination folder will be the same as TTS engine folder which is C:\Program Files\Loquendo\LTTS7 and then click Next.

Ready to Install the Application window will popup

11. Click Next.

12. Click Finish when it's done.

Install TTS SDK (including TTS Director)

Skip TTS SDK installation steps if you didn't purchase Loquendo TTS SDK package. This package is only needed to develop and debug applications.

1. Go to directory

Loqudido_TTS_7-Win32_SDK_Distribution_7.10.1

2. Double click on

Loqudido_TTS_7-Win32_SDK_Distribution_7.10.1.exe

3. Click ok on popup window stating "RemoteAPI Full installation detected"




5. Select I accept the license agreement then click on Next.


6. Enter Multimedia Applications as Full Name.

7. Enter Avaya as Organization.



9. Click Next (destination folder will be the same as TTS engine folder which is: C:\Program Files\Loquendo\LTTS7, then click Next


10. Click Next


Install TTS Language(s) models

1. Go to directory

Loquendo_TTS_7-Win32_English_Distribution_7.8.0

2. Double click on Loquendo_TTS_7-Win32_English_Distribution_7.8.0.exe









8. Select destination folder where you want to install the language pack. Default is C:\Program Files\Loquendo\LTTS7, then click Next.


9. Click Next


Install TTS Voice(s)


1. Go to directory

Loquendo_TTS_7-Win32_Susan_Telephony_Distribution_7.7.1

2. Double click on

Loquendo_TTS_7-Win32_Susan_Telephony_Distribution_7.7.1.exe









8. Select destination folder where you want to install the language pack. Default is C:\Program Files\Loquendo\LTTS7, then click Next.


9. Click Next.


Note: If you want to install additional TTS voice after license already installed, you have to regenerate the license with the same PIK after the new voice was installed.

If installation failed, log file will be generated under c:\LTTS_7-<module>.log where <module>=EngineFull, English, SDK, etc.

Loquendo ASR 7.8 Installation

Install ASR engine

1. Go to Loquendo_ASR_7.8-Win32_Engine_Distribution_7.8.2

2. Double click setup.exe


3. Click ok on above popup window.




User Information window will popup.



8. Select Anyone who uses this computer, then click Next.

Destination Folder window will popup.

9. Select destination folder where you want to install the ASR engine. Default is C:\Program Files\Loquendo\LASR, then click Next.

Ready to Install the Application window will popup.

10. Click Next.


Install ASR SDK

Skip ASR SDK installation steps if you did not purchase Loquendo ASR SDK package. This package is only needed to develop and debug applications.

1. Go to directory

Loquendo_ASR_7.8-Win32_SDK_Distribution_7.8.3

2. Double click setup.exe



License Agreement window will popup.








9. Click Next.


Install SATCA package

Skip this section if you have installed the Loquendo ASR SDK package.

1. Go to directory

Loquendo_ASR_7.8-Win32_SATCA_Distribution_7.8.2

2. Follow the instructions in ReadMe.txt

Install ASR Language models

1. Go to directory

Loquendo_ASR_7[1].8-Win32_American_English_Distribution_7.8.0

2. Double click setup.exe.











9. Click Next.

10. Click Yes on above popup window.

11. Click OK on above popup window.


Note: After the installation of new Language Pack Distributions you have to run the Loquendo ASR configuration utility in order to enable the installed language.

Microsoft SNMP service installation and configuration

For the management of the Loquendo Speech Suite through the SNMP MIBs, it‟s necessary to install and configure the SNMP service.

Installation SNMP(if not installed)

Start->Control Panel->Add/Remove Programs->click Add/Remove Windows Components button->select Microsoft Management and Monitoring Tools->click Details-> select Simple Network Management Protocol

Configure SNMP service

Start->run->type services.msc->double click on SNMP Service on Service list->select Security tab->add the community name LoquendoAdmin->select Accept SNMP packet from any host->ok

Configure SNMP trap sender

Start->run->type services.msc->double click on SNMP Service on Service list->select traps tab->add the community name LoquendoAdmin->add the IP address of server where SNMP TRAP Receiver is installed (enter 127.0.0.1 if local) ->ok


Loquendo Speech Server 7.0 Installation

Install Speech Server Suite

1. Go to directory

Loquendo_Speech_Suite_7.0-Win32_Distribution_7.0.17_isoContents.

2. Double click Setup.exe


License Agreement window will popup.


5. On Destination Folders window select destination folder for the binaries (binary folder) and for the data (logs, configuration files and so on) folder, then click Next.

Default binary folder is C:\Program Files\Loquendo\Suite.

Default data folder is: C:\Document and Settings\Administrator\Application Data\Loquendo\Platform


6. On Select Features window:

a. Select MRCPv1 Server for Platform.

b. Select RTSP for LoadBalancer.

c. Select Management Console and click Next.


7. Click Next.

8. Click Yes to restart system

A detailed file of the setup process is always generated in c:\LSSuite.log


Loquendo License Manager Installation

Run the License manager Tool to generate license request file.

1. Run the License Manager Tool on the target Server where Loquendo Suite is installed and generate your license request file.

2. Go to License Manager directory.

3. Double click LoquendoLicenseManager.exe.

4. Enter Product Installation key (P.I.K).

5. Enter your email address.

6. Click I need to obtain or renew a license for this computer tab.

7. Click save button to Save file LoquendoLIcenseRequest.txt to specified directory.


Obtain license connect to Loquendo Customer Service Area

1. Go to http://www.loquendo.com/customerarea.

2. Enter your Username.

3. Select your PIK and then click the Licensing button at the bottom.

The following Licensing Tool window popup.

4. Browse directory to select LoquendoLicenseRequest.txt as File.

5. Select SUITE as the License type form the drop down list.

6. Click the Load button to automatically insert your data to Licensing text box or copy all information in the LoquendoLicenseRequest.txt from field "Name" and paste into the text area of the Licensing page.

7. Move the mouse cursor outside the text area and select Get License.

Download the license

The tool generates your license; click Click Here under Download license and save it. License file name is in the format of: PIK_#{#}.#.#_serverName(serverIP)_SUITE_RunMe.exe_

http://www.loquendo.com/customerarea


Run the license on the server where Loquendo suite is installed

1. Double click on license file just downloaded.

2. Browse to select the directory where extract Loquendo license.

Default is C:\Documents and Settings\Administrator\Local Settings\Temp\1.

3. Click Extract and Deploy Licenses.

4. Click ok.

5. Click ok.

6. Click ok.


7. Click ok.

8. Restart Loquendo Server.

Note: The description above refers to a first time licensing procedure. However, if you have to re-new the license of the MRCP server and/or Loquendo speech technology resources like ASR or TTS, you will have to do the following additional step:

Start Menu->Programs->Loquendo->Loquendo MRCP Server 7.0 ->Setup-> MRCPv1Configurator

9. Restart, if prompted for.

Loquendo Patches Installation

Loquendo_ASR_7.8-Win32_Engine_Distribution_7.8.2-Patch_12

1. Stop "Loquendo Management Context" from service tool

2. Backup following 2 folders:

“bin” folder under "C:\Program Files\Loquendo\LASR”

“conf” folder under %LASR_INSTALL_PATH%.

3. Expand the bin.zip file into C:\Program Files\Loquendo\LASR\bin.

4. Expand the conf.zip file into %LASR_INSTALL_PATH%\conf.

5. Start "Loquendo Management Context" from service tool.

Loquendo_Speech_Suite_7.0-Win32_Engine_Distribution_7.0.17-Patch3

1. Go to directory: LSS7.0.17-Patch3.

2. Run the install.vbs.

Post Installation

1. If you used the default data folder path during LSS installation, make sure C:\Documents and

Settings\Administrator\Application Data\Loquendo\Platform directory are not hidden. To

display hidden files and folders, do following:

Start->Control Panel->select Folder Options.->View tab->under Hidden files and folders,


2. Click Show hidden files and folders.

In order to run Loquendo ASR and TTS the following environment variables have to be defined. They should be set during vendor installation

PATH should include the following:

C:\ProgramFiles\Loquendo\LASR\bin

C:\ProgramFiles\Loquendo\LTTS7\bin

C:\ProgramFiles\Loquendo\Platform\lib

LASR_INSTALL_PATH should be defined as: C:\Program Files\Loquendo\LASR.

Loquendo Software Reinstallation

If you have older version of Loquendo software already installed on the machine, please remove older version in the following order before installing the new version.

LSS, ASR language, ASR SDK, ASR engine, TTS voices, TTS language, TTS SDK, TTS remote API, TTS engine.

The order for installation is opposite.

There is no need for relicensing because the old license will continue to work.

Since you have done a re-installation, you also have to run the following.

Start Menu->Programs->Loquendo->Loquendo MRCP Server 7.0 ->Setup-> MRCPv1Configurator.

Avaya Speech Server Installation

Use the following procedure to install the MRCPv1 client software on the Avaya Speech Server node.

Avaya SelfService 3.5 base package installation

1. Double click Avaya_SelfService_3.5.2.1.exe.


2. Select I accept license agreement, then select Next

3. Select Speech Server MRCPv1 including MRCPv1 TTS, MRCPv1LVR and Internet Audio Server Resource, then select Next


4. Enter TTS component number (comma separated) and click Next.

5. Enter LVR component number(comma separated), then click Next


6. Enter audio server component number and click Next.

7. Enter Loquendo speech server IP, server name and port number, then click Next

Note: default port number for Loquendo Speech Server is 554.

Repeat above step for the rest of the LVR and TTS component.


8. When the component info confirmation window comes up, after information verification, click Next to confirm.

9. Click Finish when it‟s done and restart the computer

Avaya SelfService 3.5 patch bundle 3 installation

1. Double click on Avaya_SelfService_3.5.Patch_Bundle_3.exe.

2. Accept license agreement and click Next.


3. Click Finish when it‟s done.

4. Restart computer.


Chapter 7. Uninstall Software

Uninstalling the Loquendo Software on the Media Server node

Use the following procedure to uninstall the Loquendo server software on the Media Server node.

Uninstall Loquendo Speech Suite 7.0

Choose Add/Remove Programs from Start->Settings->Control Panel

Select Loquendo Speech Suite 7.0 and click Remove button and from the modify dialog choose the remove button to uninstall the product.

Uninstall ASR 7.8

To complete remove Loquendo ASR for your computer, simply execute the standard Windows “Add/Remove Programs” procedure in the Control Panel. Please remove in the following order:

ASR languages

ASR SDK

ASR Engine

Uninstall TTS 7.8

To complete remove Loquendo TTS for your computer, simply execute the standard Windows “Add/Remove Programs” procedure in the Control Panel. Please remove in the following order:

TTS voices

TTS languages

TTS SDK

TTS Remote API

TTS Engine

Uninstalling the Avaya SelfService Software on the Avaya Speech Server node

Use the following procedure to uninstall the MRCPv1 client software on the Avaya Speech Server node.


To complete remove Avaya SelfService for your computer, simply execute the standard Windows “Add/Remove Programs” procedure in the Control Panel. Please remove in the following order:

Avaya SelfService 3.5 patch bundle3

Avaya SelfService 3.5 base package


Chapter 8. Known Issues

Loading .pls lexicon file

Problem:

Loading lexicon(.pls) file from application doesn‟t work

Loading lexicon(.pls) file from Management Console doesn‟t work

Workaround:

Use .lex lexicon file.

Note: According to Loquendo Engineering this will be fixed in the next release (probably available in 4th quarter of 2010).

Occasional Drop of Beginning of the First Syllable of the First Word in TTS

Problem:

Sometimes caller doesn‟t hear the first syllable of the first word very clearly.

Workaround:

Add control \pause at the beginning of the text.

Example:

<prompt>

\pause This is perfect.

</prompt>

Vendor-specific parameter com.loquendo.beep is not supported

Problem:

Vendor-specific parameter com.loquendo.beep is not supported by Avaya MPS platform.

Workaround:

Application can play pre-recorded beep using MMF or Wav file

Note: Loquendo requires ASR and TTS resources for a call must share the same RTSP session-ID in order for this parameter to work. While Avaya's MPS MRCPv1 client implementation does not allow for such an


operation because Avaya's TTS and ASR are two independent and separate resources where an input resource ASR and an output resource TTS are treated independently so the ASR and TTS sessions will always be negotiated separately with the server.

Built-in Phone Grammar Doesn’t Support Phone Number With Extension in Voice Mode

Problem:

Loquendo‟s built-in phone grammar doesn‟t support phone number with extension in voice mode.

Workaround:

Take Loquendo‟s source built-in phone grammar under %LASR_INSTALL_PATH%\conf\languages\en-us\built-in\source and make modification in order to extend its coverage to all the utterances needed.

Use the modified grammar as source grammar instead of a built-in grammar.

Note:

Loquendo is looking in to this issue and may fix it in the future releases of ASR language packs.

Phone number with extension in DTMF mode works fine. Use star key (“*”) as “extension”.

MultiSpacePause configuration parameter

Problem:

MultiSpacePause configuration parameter cannot be dynamically changed and does not work when used directly in the text.

Plain Text Example: “\@MultiSpacePause=FALSE There is no pause here and here also"

TTS ignores the MultiSpacePause command at the beginning of this string. You will still hear 2 pauses, before and after the first "here“ word.

Workaround:

MPS Developer Applications only - According to application needs, you can only set MultiSpacePause to TRUE/FALSE in the Loquendo TTS registry section. (see sample screenshot shown as below)


Note:

Loquendo will be updating their Loquendo‟s user manual to specify the registry exclusive use only for MultiSpacePause parameter.

Registry setting doesn‟t apply to VXML application. With VXML application, multiple spaces are collapsed into a single space therefore MultiSpacePause parameter will always be treated as FALSE and caller will not hear pause even if MultiSpacePause is set to TRUE.


Chapter 9. Troubleshooting

Troubleshooting

This chapter addresses the topic of troubleshooting issues involved with speech processing and the LSS 7.8 recognition and 7.8 TTS synthesis resources.

Troubleshooting information

You can obtain information about trouble shooting issues from vendor logging, Avaya Speech Server logging and MPS Application Processor logging.

Vendor logging

The Loquendo Speech Server provides for troubleshooting on the Media Server. Vendor log is disabled by default, please enable vendor log ONLY for diagnostic purpose. Follow the steps below to collect vendor logging.

Open the Loquendo Management Console

Start->All Programs->Loquendo->Loquendo Speech Suite 7.0 ->Management Console

Change Basic Configuration

Configuration->Basic and set the both "logLevel" and "apLogLevel" keys to "hardDebug (6)"

If it is TTS debugging, change Advanced Configuration

Configuration->Advanced Section -> MRCPv1Server->textToSpeech:

set lttsEnableLogging to enable(1)

set lttsEnableDump to enable (1)

If it is ASR debugging, change Advanced Configuration

Configuration->Advanced Section -> MRCPv1Server->speechRecognition

set lasrEnableLogging to enable(1)

set lasrEnableDump to enable (1)

Stop the ManagementContext service from service tool

Delete the log files contained in the folder "%LOQ_HOME%\logs" (except for the installer folder, that contains the installation log files)

Delete the audiodump files contained in the folder "%LOQ_HOME%\audioDump"


Start the Loquendo ManagementContext service from service tool

Collect InfoCollector file

Management Console->support->Loquendo Info Collector LoquendoInfoCollector_DATE_TIME.zip file will be placed in folder %HOMEPATH%

Enable a network analyzer (Ethereal/Wireshark ) on the server side and client side depends on vendor requirement.

Collect LogCollector files

Management Console->support->Loquendo Log Collector

This Log Collector tool will include the following

step1: change the configuration

Note: MRCPv1 client (rcm) will restart when server change configurations, you

can either wait for rcm comes up before next step or you can stop Avaya

selfservice before step1 and start it after step 1.

step2: run your test then click "collect data after test"

step3: restore configuration

step4: close the program

The Loquendo Log Collector will generate the following 3 compressed archives and they will be placed in folder %HOMEPATH%

LogC_Log_Export_DATE_TIME.zip

LogC_Service_Log_DATE_TIME.zip

LogC_Audio-Dump_DATE_TIME.zip

zip the following:

the "%LOQ_HOME%\logs" folder

the "%LOQ_HOME%\audioDump" folder

the grammar(s) used (if vendor requires)

the following files under directory %HOMEPATH%

LoquendoInfoCollector_DATE_TIME.zip

LogC_Log_Export_DATE_TIME.zip

LogC_Service_Log_DATE_TIME.zip

LogC_Audio-Dump_DATE_TIME.zip


the associated Ethereal/Wireshark dump

By default,

"%LOQ_HOME% = C:\Documents and Settings\Administrator\ApplicationData\Loquendo\Platform

%HOMEPATH% = C:\Documents and Settings\Administrator

For additional information about vendor logging, see the documentation provided by Loquendo.

Avaya logging

Avaya provides information to use for troubleshooting in the form of alarms, trace logging and generic call logging. For information about these sources of information and troubleshooting on the Avaya Speech Server node, see MPS Speech Server 6.5 Reference Guide (NN44100-131).

Troubleshooting issues

Use the following table to obtain troubleshooting information about specific issues.

Troubleshooting issues

Problem Possible cause and solution

System does not come up Check installation steps on both Loquendo and Avaya Speech Server node.

Check to determine if the Loquendo Speech Server node can be pinged from the Avaya Speech Server node.

Check to determine if the Loquendo Speech Server is up and running on the node.

Check the configuration files on the Avaya Speech Server node and ensure that the information about the Loquendo Speech Server is correct and that all other parameter information and formatting is correct.

For additional information about the Speech Server node, see the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

Verify that no port conflicts exist on either the Loquendo Speech node or the Avaya Speech Server node.

For information about ports in use on the:

LSS Media Server Node, see “Commonly used ports on the Media Server node”

Avaya Speech Server Node, see the MPS Speech Server 6.5 Reference Guide (NN44100-131).


TTS Under runs and audio play

An underrun event occurs when the TTS server cannot provide voice data fast enough to ensure that the caller hears continuous audio. In this case, the caller may hear gaps in speech prompts.

Information about underrun events are logged in alarms and display in reports.

For alarms that report underrun events, check the %OSCARHOME%/common/log/info.oscar.<comp#>.log on the Avaya Speech Server node.

The following alarm indicates that an underrun condition occurred.

Fri Mar 02 07:10:35 <rcm> 22400 Line 14 Severity 1 Comp #oscar.51973/hp197 sl> - [UnderrunTimer] in [CHAN_OUTPUT_IN_PROGRESS]= NOT OK = no:expired 7 totbytes recd=6560 mustHaveBytes=7000

See the MPS Speech Server 6.5 Reference Guide (NN44100-131) for alarm information.

The RCM MRCPv1 Play Statistics report displays information about underrun events.

See the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-131) for report information.

Possible Cause/Fix: The LSS Media Server is overloaded or under provisioned. Check the LSS Media Server to determine if:

It is provisioned correctly.

It is configured with adequate RAM.

The advanced parameters configured correctly.

See “Table 2: Advanced Configuration” about underrun.

It is sized correctly.

The CPU is not constantly running at a high rate of utilization.

Trace logging turned on. See the documentation provided by Loquendo for information about turning on and off trace or audio logging. See “Media Server Node requirement guidelines”

Recognizer does not generate a valid result (no match or forcefree condition is generated)

Check for overloaded engines on the Media Server node (forcefree).

Investigate using gclogs (GCL) by logging audio.

GCL logging is configured in the rcm.cfg file in component on the Speech Server node. See “rcm.cfg file”.

For information about Generic Call Logging on the Speech Server node,


see the MPS Speech Server 6.5 reference Guide (NN44100-131)

Turn on audio logging on the Media Server node.

For information about logging information on the Media Server node, see document provided by Loquendo.

Check to determine if audio is loud enough.

Allocation Failures Check to determine if the label name or the pool name exists in PMGR pool list. Label and pool names are defined in the sys-lvr-mrcpv1.cfg file. See “sys-[lvr|extts]-mrcpv1.cfg file”

For information about the Pool Manager (PMGR) process on the Speech Server node, see the MPS Speech Server 6.5 Reference Guide (NN44100-131).

Check the connections between MPS Application Processor and the Avaya Speech Server.

For information about the:

Hardware connections between nodes in the MPS network, see the Media Processing Server 500 Hardware Installation and Maintenance Guide (NN44100-302) or the Media Processing Server 1000 Hardware Installation and Maintenance Guide (NN44100-301).

Architecture of the MPS Application Processor node and the Speech Server node, see the MPS Speech Server 6.5 Reference Guide (NN44100-131).

Check the connection between Avaya Speech Server and the LSS Media Server. See “Node architecture”.

Check to determine if RCM is up and running on the Avaya Speech Server node, after you checked that the three previous solutions are not causing this problem.

For information about the Resource Control Manager (RCM) process on the Speech Server node, see the MPS Speech Server 6.5 Reference Guide.

Check to determine if the Loquendo Management Context is up and running on the Loquendo Media Server node.

Check to determine if the connection to the DCC board exists from Avaya Speech Server by pinging the DCC IP address from the Avaya Speech Server. For information about the:

Hardware connections between nodes in the MPS network, see the Media Processing Server 500 Hardware Installation and Maintenance Guide or the Media Processing Server 1000 Hardware Installation and Maintenance Guide.

DCC-3000 (Digital Communications Controller), see the MPS


Speech Server 6.5 Reference Guide.

TTS speak results in output failure

Check to ensure that ContentType is set correctly.

ContentType can be set from the application or from the sys-extts-mrcpv1.cfg file.

See “sys-[lvr|extts]-mrcpv1.cfg file”.

Check that the SSML input string is formatted correctly. See “Speech synthesis support”.

Check that the gender and voice configured for the SPEAK request is loaded on the Media Server node.

The gender and voice is set with the Label parameter.

See "sys-[lvr|extts]-mrcpv1.cfg file”

Application receives a forcefree condition and SOFT_RESET alarm is generated

Check to determine if the connection between the LSS Media Server and the Avaya Speech Server exists or if the connection is broken. See “Node architecture”

For information about the hardware connections between nodes in the MPS network, see the Media Processing Server 500 Hardware Installation and Maintenance Guide (NN44100-302) or the Media Processing Server 1000 Hardware Installation and Maintenance Guide (NN44100-301).

For information about specific alarms, see the MPS 3.0 Speech Server 6.0.1 MRCPv1 Resource Guide (NN44100-132).

Check to determine if the connection to the DCC board exists from Avaya Speech Server by pinging the DCC IP address from the Avaya Speech Server. For information about the:

Hardware connections between nodes in the MPS network, see the Media Processing Server 500 Hardware Installation and Maintenance Guide (NN44100-302) or the Media Processing Server 1000 Hardware Installation and Maintenance Guide (NN44100-301).

DCC-3000 (Digital Communications Controller), see the MPS Speech Server 6.5 Reference Guide (NN44100-131).

Check to determine if the grammar or TTS input string required for recognition or speak request resides at an accessible URI.

Check to determine that the grammar being loaded is a valid grammar or the string being sent for synthesis is a valid string.

Check to determine that the language being tested (used) is actually loaded (installed) on the LSS Media Server.