Show TOC

Background documentationDescription of the Entity Fields Locate this document in the navigation structure

 

Entity

Tab

Field

Values

Field Description

Speak

Type

Audio

Plays an audio file specified in the File Name field. If the file is missing, it plays the text in the Text field using TTS.

Break

Adds a pause for the time specified.

SpeakAs

Plays the value specified in the Value field as per the SpeakAs Type selected in the SpeakAs Type drop-down list.

Text

Plays the text specified using TTS.

File Name

Specifies the file to be played.

Text

Specifies the text to be played by TTS.

Target

prompts

prompts_speakas

recordings

Folder from which the audio files specified are accessed.

Condition

Condition to be satisfied before playing the specified text or the audio file.

Description

A short description of the speak element

Barge-in

Default

True

False

(The default value is true).

If Barge-in is True then the caller can interrupt the system at any point during the execution of the Speak entity.

If Barge-in is False then the caller cannot interrupt the system at any point during the execution of the Speak entity.

Listen

Prompt / Reprompt

Type

Audio

Plays an audio file specified in the File Name field. If the file is missing, it plays the text in the Text field using TTS.

Break

Adds a pause for the time specified.

SpeakAs

Plays the value specified in the Value field as per the SpeakAs Type selected in the SpeakAs Type drop-down list.

Text

Plays the text specified using TTS.

File Name

Specifies the file to be played.

Text

Specifies the text to be played by TTS.

Target

prompts

prompts_speakas

recordings

Folder from which the audio files specified re accessed.

Condition

Condition to be satisfied before playing the specified text or the audio file.

Description

A short description of the speak element.

Barge-in

Default

True

False

(The default value is true).

If Barge-in is True then the caller can interrupt the system at any point during the execution of the Speak entity.

If Barge-in is False then the caller cannot interrupt the system at any point during the execution of the Speak entity.

Input

Grammar Type

Boolean

Currency

Date

Digits

External

List of choices

Number

Phone

Time

Type of input that a caller can enter or speak.

Result Variable

A variable in the dataStore that stores the user input.

Input Mode

Voice

Instructs the caller to speak the input using the telephone mouth piece.

DTMF

Instructs the caller to enter the input using the telephone keypad.

Voice+DTMF

Instructs the caller to either speak the input using the telephone mouth piece or enter the input using the telephone keypad.

Minimum

Minimum number of digits that the caller can enter or speak.

Maximum

Maximum number of digits that the caller can enter or speak.

Choices Items: DTMF Key

Value to be entered by the caller using the telephone keypad.

Choices Items: Value

Value that corresponds to the DTMF input or the speech input.

Choices Items: Description

A short description for the choices items.

Choices Items: Utterance in <language>

Choice of speech entries that a caller can speak in a specific language.

Grammar: Mode

Voice

Specifies the mode of input from the caller to be spoken using the telephone mouth piece

DTMF

Specifies the mode of input from the caller to be entered using the telephone keypad.

Grammar: Filename

Name of the file that contains the grammar defined for caller input.

Grammar: Resource Target

Specifies the folder to access the grammar definition from.

Grammar: Description

A short description of the grammar.

Result: Result (grammar slot)

Specifies value to a field name in a grammar file.

Result: Variable

Specifies a variable in the dataStore where you can store the result.

Result: Description

A short description for the result of input.

Events

Inherit from Parent?

If the checkbox is selected, you can use the events defined at the higher level (parent).

Event Name

listen.noinput 1(Reprompt)

listen.noinput 2(Reprompt)

listen.noinput 3(Reprompt)

listen.noinput 4(Exit)

listen.nomatch 2(Reprompt)

listen.nomatch 3(Reprompt)

listen.nomatch 4(Exit)

listen.maxspeechtimeout 1(Reprompt)

listen.maxspeechtimeout 2(Reprompt)

listen.maxspeechtimeout 3(Reprompt)

listen.maxspeechtimeout 4(Exit)

listen.help 1(Reprompt)

error.data (Event)

error.data.fatal (Event)

error.internal (Event)

error.mediaplatform (Event)

_fatal_error_exit_1 (Event)

Name of the event that is triggered because of the system or user action.

Occurrence Count

1-9

Specifies the count of the event occurred. For example, a nomatch event can occur for the first, second , third or fourth time.

Continuation

Reprompt

Return

Continue

Transfer

Exit

Event

Specifies the type of response for an event occurred.

Speak Item

Speak element to be executed when an event occurs.

Description

A short description of the event.

Properties

Inherit from Parent?

If the checkbox is selected, you can use the properties defined at the higher level (parent).

Property Name

listen.completetimeout

listen.confidencelevel

listen.dtmf.interdigittimeout

listen.dtmf.termchar

listen.dtmf.termtimeout

listen.incompletetimeout

listen.inputmodes

listen.maxspeechtimeout

listen.speedvsaccuracy

listen.sensitivity

listen.speechtimeout

listen.universals

resource.audiofetchhint

resource.audiomaxage

resource.audiomaxstale

resource.documentfetchhint

resource.documentmaxage

resource.documentmaxstale

resource.fetchtimeout

resource.grammarfetchhint

resource.grammarmaxage

resource.grammarmaxstale

resource.fetchaudiodelay

resource.fetchaudiominimum

resource.fetchaudio

Defines the platform behavior.

Value

Value of the property selected.

Typical Range

Displays the default range of values.

Default

Displays the default values.

Jumpwords

Event Name

Event to be triggered when the caller enters or speaks a jumpword.

Type

Phrase

Defines jumpwords using phrase.

External

Defines jumpwords using grammars.

DTMF Keys

Value that a caller enters using a telephone keypad to trigger an event.

Description

A short description for the jumpword.

Voice Grammar

File name that contains grammar definitions for jumpwords that are to be spoken by the caller.

DTMF Grammar

File name that has grammar definitions for jumpwords that are to be entered by the caller.

Voice Phrase in <language>

Phrase to be spoken by the caller to trigger an event.

Route

Path

Name of the path.

Expression

Condition to be satisfied before following the path.

Note Note

Pre-populated expressions are always in the form of a string comparison. For e.g: =@NUM1=="66" User defined expressions are not in the form of a string comparison. For e.g: =@NUM1==66

End of the note.

Default

Path to be followed under default conditions.

Description

A short description for the path.

Target

Target element for a path from the Route element.

Record

Variable

Variable that stores the audio file of the caller's recording.

Audio Directory

Folder where the caller's recordings are stored.

Resource Target

Specifies the folder where the recordings are stored.

Beep Before

If you select the Beep Before checkbox, then the caller hears a beep before recording starts.

Key Press Terminates

If you select the Key Press Terminates checkbox, the caller can terminate the recording by pressing a key.

Silence Timeout

Time for which the system waits for a response. If the caller does not speak within this time, the recording action is terminated.

Max Length

Maximum time for which a caller can record.

Transfer

Protocol

Phone

Specifies that the call has to be transferred to another telephone number.

URL

Specifies that the call has to be transferred to another voice application.

Destination

If you have selected the protocol as Phone, enter the telephone number.

If you have selected the protocol as URL, enter the voice application URL.

Process

Action

Add row

Delete row

Clear table

Find row

Move to row

Revert row

Set variable

Get URL value

Set Language

An action that you can perform on a variable, a table or a row of data.

Condition

A condition that applies for an action.

Description

Specifies a short description for an action.

Variable

The variable to be used for an action.

Table

A dataStore table to be used for an action.

Expression

An expression to be evaluated for the specified action.

Direction

Specifies a direction in which the search has to be performed.

Position

Specifies the position a row pointer has to be placed.

Row

Number of the row in a table of records.

VoiceXML

Standby timeout

Specifies the time after which a dialog session is removed if there is no activity.

VoiceXML

VoiceXML compliant XML instructions.

Variable

A variable in the dataStore that stores the value of a VoiceXML variable.

VXML Variable

A variable declared in VoiceXML.

Log

Log type

  • BI: Allows you to log calls to the BI system

  • Media Platform: allows you to log the voice call data to the VoiceXML gateway

  • Java Server Logging: Allows you to log to the AS Java

Log content

Specifies the content to be logged.

Signal In

Event

Specifies the event that has to be captured.

Signal Out

Event

Specifies the event that has to be triggered.

<BAPI or Web Service> name

Runtime

Specifies the runtime to be used.

Note Note

For voice applications always choose voice.

End of the note.

Auto Commit

Commit the transactions.

Auto Convert

If true, then the BAPI converts the data from one unit of measurement to another unit of measurement.