Date

The Date voice element captures a date input from the caller. The date can be entered using DTMF input (in the YYYYMMDD format). It can also be spoken in natural language including a month, day and year. The captured value will be stored in element data as a fixed-length date string in the YYYYMMDD format. If the year is not specified in the input, YYYY is stored as "????". And if the month or the day is not specified, MM and DD will be stored as "??".

Settings

Name (Label)

Type

Req'd

Single Setting Value

Substitution Allowed

Default

Notes

inputmode

(Input Mode)

string enum

Yes

true

false

both

The type of entry allowed for input. Possible values are: voice | dtmf | both.

Noinput_timeout

(Noinput Timeout)

string

Yes

true

true

5s

The maximum time length 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.

collect_max_noinput_count

(Date Max NoInput Count)

int ≥ 0

Yes

true

true

3

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

collect_max_nomatch_count

(Date Max NoMatch Count)

int ≥ 0

Yes

true

false

3

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

collect_confidence_level (Date Confidence Level)

decimal (0.0 – 1.0)

Yes

true

true

0.40

The confidence level threshold to use during date capture.

modal (Disable Hotlinks)

boolean

Yes

true

true

false

If set to true, only the grammars of the current Date element will be enabled for the duration of the element. Otherwise all active grammars will be enabled.

secure_logging

(Secure Logging)

boolean

Yes

true

true

false

If set to true, user DTMF input for the element is considered secure and the attributes utterance, interpretation, value, nbestUtteranceX and nbestInterpretationX are masked in VXML server logs. The format used to render secure element attributes is to add a _secureLogging suffix. For example nbestUtterance1_secureLogging,*****.

maxnbest

(Maxnbest)

int ≥ 1

Yes

true

true

1

The maximum number of speech recognition results that can be generated per voice input.

Refer to the following Element Data table for information about nbestUtteranceX and nbestInterpretationX.

Element Data

Name

Type

Notes

value

string

The date stored in the YYYYMMDD format.

value_confidence

float

This is the confidence value of the captured date utterance. When n-best recognition is enabled, this stores the confidence score of the top hypothesis in the n-best list.

nbestLength

int ≥ 1

This stores the number of n-best hypotheses generated by the speech engine.

nbestUtterance1

nbestUtterance2

nbestUtteranceX

string

This set of element data stores the captured n-best utterances. While the maximum number of nbestUtteranceX values is equal to the maxnbest setting value, the actual number of these values available is determined by speech recognition at runtime, where nbestUtterance1 holds the utterance of the top hypothesis in the n-best list and nbestUtteranceX holds the utterance of the last hypothesis.

nbestInterpretation1

nbestInterpretation2

nbestInterpretationX

string

This set of element data stores the interpretations of captured n-best utterances. While the maximum number of nbestInterpretationX values is equal to the maxnbest setting value, the actual number of these values available is determined by speech recognition at runtime, where nbestInterpretation1 holds the interpretation of the top hypothesis in the n-best list and nbestInterpretationX holds the interpretation of the last hypothesis.

nbestConfidence1

nbestConfidence2

nbestConfidenceX

float

This set of element data stores the confidence scores of captured n-best utterances. While the maximum number of nbestConfidenceX values is equal to the maxnbest setting value, the actual number of these values available is determined by speech recognition at runtime, where nbestConfidence1 holds the confidence score of the top hypothesis in the n-best list and nbestConfidenceX holds the confidence score of the last hypothesis.

nbestInputmode1

nbestInputmode2

nbestInputmodeX

string

This set of element data stores the input modes of captured n-best utterances.

Exit States

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.

done

The data capture was completed.

Audio Groups

Date Capture

Name (Label)

Req'd

Max 1

Notes

collect_initial_audio_group

(Date Initial)

Yes

Yes

Played when the voice element first begins.

collect_noinput_audio_group

(Date NoInput)

No

No

Played when a noinput event occurs during date input. The noinput event count corresponds to the audio group count.

collect_nomatch_audio_group

(Date NoMatch)

No

No

Played when a nomatch event occurs during date input. The nomatch event count corresponds to the audio group count.

collect_help_audio_group

(Date Help)

No

No

Played when a help event occurs during date input. The help event count corresponds to the audio group count. If not specified, a help event is treated as nomatch.

End

Name (Label)

Req'd

Max1

Notes

done_audio_group (Done)

No

Yes

Played after the date capture is completed. If not specified, no audio will be played.

Folder and Class Information

Studio Element Folder Name

Class Name

Date & Time

com.audium.server.voiceElement.date.MBasicDate

Events

Name (Label)

Notes

Event Type

You can select Java Exception, VXML Event, or Hotlink as event handler for this element.