Secondary keywords

Enabled

Yes or No. Default is Yes. Optional.

AppClass

The name of the Java class to run the application. You must include the package name but not the “.class”. Case-sensitive. Mandatory.

# Minimal AppName entry
AppName=pizzas
  AppClass=mypackage.pizzas
;

For VoiceXML 2.1 applications, the AppClass is always com.ibm.wvr.vxml2.DTVoicelet2 as follows:

AppName=defapp
  Parameter=URI,http://www.myserver.com/applications/sorry.vxml
  AppClass=com.ibm.wvr.vxml2.DTVoicelet2
;

Note: The previous version of the Java and VoiceXML environment supported VoiceXML 1.0 applications with an AppClass of com.ibm.speech.vxml.DTVoicelet, but this is no longer supported. Configuration files that include these entries will fail to import. VoiceXML 1.0 applications must be updated to VoiceXML 2.1

Locale

This property does not apply to VoiceXML 2.1 applications. The application locale property allows a Java application to have a default locale that is different from the default locale of the voice response node. For example, you might want to run an English version, a French version, and a Spanish version of an application on the same voice response node. The application locale for each version determines the default language and country or region (and optionally a user-defined variant) of all voice segments and other media types in the application. Optional.

# Pizza-ordering application in U.S. English
AppName=pizzasEnglish
  AppClass=mypackage.pizzas
  Locale=en_US
;
# Pizza-ordering application in Canadian French
AppName=pizzasFrench
  AppClass=mypackage.pizzas
  Locale=fr_CA
;

Parameter

A parameter name and value to be passed to the application. The syntax is parametername,value. All parameter values are treated as strings. Specify this keyword once for each parameter-value pair. Optional.

# Application that has two parameters
AppName=banking
  AppClass=mypackage.banking
  Parameter=branch_id,0123
  Parameter=branch_name,Southampton
;

Use the Parameter keyword to specify the URI of a VoiceXML application as follows:

AppName=defapp
  Parameter=URI,http://www.myserver.com/applications/sorry.vxml
  AppClass=com.ibm.wvr.vxml2.DTVoicelet2
;

Note that an absolute URI containing the protocol (http in the above example) is mandatory for VoiceXML 2.1. URIs that include numeric IPv6 format addresses, must have the numeric part within [ ] brackets, for example:

http://[2002:914:fc12:195:0000:8a2e:0370:7334]/welcome.vxml

This applies to all protocols.

If a VoiceXML application is started from a CCXML document, the CCXML document specifies the VoiceXML document to be processed. In this case, the Parameter keyword must be used to set the DynamicURI parameter to yes. For example:

AppName=ccxmldialog1
  Parameter=DynamicURI=yes
  AppClass=com.ibm.wvr.vxml2.DTVoicelet2
;

If a VoiceXML 2.1 application does not use speech recognition or text-to-speech, you must include the DTMFONLY parameter in the AppName entry, and set it to true. For example:

AppName=defapp
  Parameter=URI,http://www.myserver.com/applications/sorry.vxml
  Parameter=DTMFONLY,true
  AppClass=com.ibm.wvr.vxml2.DTVoicelet2
;

Use the MAX_WAITERS parameter to restrict the number of instances of an application that can be waiting for a call at any one time. If you are running a large number of applications this can increase the efficiency of your system. This limit only applies if your application does not have a wait time specified. The limit applies to individual application nodes. For example to limit an application called 'demo' to three instances waiting for a call at any one time:

AppName=demo
  AppClass=com.abc.demo
  Parameter=MAX_WAITERS, 3
;

If there are, for example, 4 instances of the demo application running, the last instance must wait for one of the first three to leave the waitForCall state before it can wait for an incoming call.

RecoDefinition

Speech recognition definition (recotype,locale) to override a RecoDefinition for the same locale in the NodeName configuration entry. Optional.

TTSDefinition

Text-to-speech definition (TTStype,locale) to override a TTSDefinition for the same locale in the NodeName configuration entry. Optional.