Name (Label)

Type

Req'd

Single Setting Value

Substitution Allowed

Default

Notes

noinput_timeout

(Noinput Timeout)

string

Yes

true

true

5s

The maximum time allowed for silence or no keypress before a noinput event is thrown. Possible values are standard time designations including both a non-negative number and a time unit, for example, 3s (for seconds) or 3000ms (for milliseconds). Default = 5s.

max_noinput_count

(Max NoInput Count)

int ≥ 0

Yes

true

true

3

The maximum number of noinput events allowed during input capture. 0 = infinite noinputs allowed.

max_nomatch_count

(Max NoMatch Count)

int ≥ 0

Yes

true

true

3

The maximum number of nomatch events allowed during input capture. 0 = infinite nomatches allowed.

confidence_level

(Confidence Level)

decimal (0.0 to 1.0)

Yes

true

true

0.40

The confidence level threshold to use.

modal

(Disable Hotlinks)

boolean

Yes

true

true

false

Whether or not to temporarily disable all hotlink grammars (global or local) and universal grammars. If set to true, only the grammars of the current X_Option_Menu element will be enabled for the duration of the element. Otherwise all active grammars will be enabled.

optionX_dtmf

(Option X DTMF)

Character (0-9, #, *)

No

true

true

None

This setting defines the DTMF grammar that can be used to select the menu optionX. The valid format is a string separated with a semi-colon specifying two values in this order:

1. The language context in which the current input should be included in the menu grammar (optional). If omitted the language used will be the same as the page-scoped language.

2. The dtmf keypress or keypresses that is included in the menu DTMF grammar (required)

Sample configurations values are:

• en-US;1

• 1

Additional optionX_dtmf settings may be used to define multiple dtmf keypresses corresponding to the same return value.

optionX_voice

(Option X Voice)

string

No

true

true

None

This setting defines the voice grammar that can be used to select the menu optionX. Each configuration of this setting specifies an option for the grammar. The valid format is a string separated with semi-colons specifying three values in this order:

1. The language context in which the current input should be included in the menu grammar (optional). If omitted the language used will be the same as the page-scoped language.

2. exact or approximate (optional) for the accept attribute value, where if exact, the spoken utterance must match the expected value exactly; and where if approximate, the spoken utterance may match one of several words

3. The voice keyword or keywords (required) that is included in the menu voice grammar.

If one of the optional parameters is defined, two semi-colons must be used, even if the other parameter is not used. Sample configuration values are:

• en-US;exact;news report

• ;approximate;news report

• fr-FR;;news report

• news report

Additional optionX_voice settings may be used to define multiple matching voice keywords corresponding to the same return value.

optionX_value

(Option X Value)

string

Yes

false

true

None

The value to be stored in the element data value for this voice element when the caller selects optionX.

Where X is 2 – 10 as applicable.

Some voice browsers may not support menu options using * or #.

Name

Type

Notes

value

string

The value associated with the keyword or DTMF keypress inputted by the caller is stored in this variable.

value_confidence

float

This is the confidence value of the matched utterance.

Name

Notes

max_nomatch

The maximum number of nomatch events has occurred. If the max_nomatch_count is 0, this exit state will never occur.

max_noinput

The maximum number of noinput events has occurred. If the max_noinput_count is 0, this exit state will never occur.

optionX

The utterance or DTMF entry matched optionX.

Where X is 2 – 10 as applicable.

Studio Element Folder Name

Class Name

Menu

com.audium.server.voiceElement.menu.MFoundationXOptionMenu