Feedback

  • Contents
 

VoiceXML Interpreter Server Configuration

The VoiceXML Interpreter Server gets its configuration parameters from a number of different sources.

Windows Registry

The Windows Registry contains configuration values that are set when the VoiceXML Interpreter is installed.

The values shown in the following table can be found under the key:

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Interactive Intelligence\VoiceXML\vxiserver

Value

Description

ConfigFile

A file containing user configurable configuration information.

WebConfigLoginName

The login name to use when entering the web configuration pages. The login name is not encrypted by the install, but it is encrypted if modified via the web configuration pages.

WebConfigLoginPassword

The login password to use when entering the web configuration pages. The login password is not encrypted by the install, but it is encrypted if modified via the web configuration pages.

WebConfigServerPort

The port used when entering the web configuration pages.

Configuration file

The configuration file (specified in the ConfigFile registry value) contains a number of configuration parameters, shown in the table below. While you can adjust the parameters by editing the file, we recommended that you use the VoiceXML Interpreter Server Web Configuration Interface to change these parameters.

Parameter

Description

cacheCleanupInterval

The number of seconds the Interpreter Server waits before deleting a locally cached VXML resource.The minimum that can be specified is 15 seconds and the maximum is 120 seconds. The default value (30 seconds) can remain unchanged.

cachepath

The directory used to store cached VXML resources. The default value can remain unchanged.

recMaxTimeSecs

The maximum time of a recording in seconds. This default value can remain unchanged.

recoValueSlotName

The element name to use for the value slot in returned NLSML recognition results. If none is specified, the default name is “value.”

ttsMRCP

Setting this parameter to true tells the VoiceXML Interpreter that the TTS engine supports the MRCP protocol. If the TTS engine does not support MRCP, set this parameter to false. The default setting is false.

ttsSSML

By default, this parameter is set to true since the default SAPI engine can support SSML and the MRCP servers must support SSML. When set to true, this parameter tells the VoiceXML Interpreter that the TTS engine supports SSML text handling. If the TTS engine does not support SSML, set this parameter to false.

vxiConfigFile

Path to the VoiceXML library configuration file. The default value can remain unchanged.

Optional parameters

There are four optional parameters, shown in the table below, that are not included in the default configuration file, but you can add them if you discover that they are necessary.

Parameters

Description

defaultGrammarMimeType

This parameter can be used to specify the default grammar type to use if no type is specified for a grammar.

ignoreGrammarFileMimeType

Setting this parameter to true tells the VoiceXML Interpreter to ignore a grammar file’s MimeType when determining a grammar file’s grammar type. If this parameter is set to false, then the grammar file’s MimeType is used as the grammar type.

keepRecoSession

When a VoiceXML session ends, VoiceXML calls RecoRelease. This means the ASR session is immediately closed and any additional ASR will require a new session.The assumption is that no further ASR will occur when the VoiceXML session ends, but that's not necessarily true if handlers will perform additional ASR work, or another VoiceXML session is created for additional processing.

Setting this parameter to true tells the VoiceXML Interpreter to keep the Recognition session alive when a VoiceXML session ends. The Reco session will have to be released outside of the VoiceXML Interpreter.

grammarCaching

Setting this parameter to true instructs the VoiceXML interpreter to cache grammar files. Setting the parameter to false instructs the VoiceXML interpreter to NOT cache grammar files. If this parameter is not set, the default is true.

To add any of the optional parameters to the VoiceXML Interpreter Server, you must do so by editing the configuration file. Once you add an optional parameter to the configuration file and restart the VoiceXML Interpreter Server, the optional parameter will be accessible from the VoiceXML Interpreter Server Web Configuration Interface. If you must adjust an optional parameter at a later time, we recommend that you use the VoiceXML Interpreter Server Web Configuration Interface to do so.

I3runvxml.cfg file

The I3runvxml.cfg file is a configuration file for the BladewareVXML library used by the Genesys PureConnect VoiceXML Interpreter. We recommend leaving the settings in this file in their default state.

Some of the settings in this file include:

  • Cache settings

  • ECMAScript settings

  • BladewareVXML logging settings

  • The location of the VoiceXML defaults XML

I3defaults.xml file

The I3defaults.xml file contains some VoiceXML script defaults. The default values for a number of properties are set and some default error handlers are defined. This document is loaded before every document requested by the user for interpretation.