<field>

A field specifies an input item to be gathered from the user. You MUST specify a grammar within your field.

Attributes

Name	Data type	Description
name	String	The form item variable in the dialog scope that will hold the result. The name must be unique among form items in the form.
cond	String	An expression that must evaluate to true after conversion to Boolean in order for the form item to be visited. The form item can also be visited if the attribute is not specified.
expr	String	The initial value of the form item variable. Default is ECMAScript undefined. If initialized to a value, then the form item will not be visited unless the form item variable is cleared.
type	String	The type of field, i.e., the name of a built-in grammar type. See Built-In Grammars for more info.
slot	String	The name of the grammar slot used to populate the variable (if it is absent, it defaults to the variable name). This attribute is useful in the case where the grammar format being used has a mechanism for returning sets of slot/value pairs and the slot names differ from the form item variable names.
modal	Boolean	(defaults to false) If this is false, all active grammars are turned on while collecting this field. If this is true, then only the field's grammars are enabled: all others are temporarily disabled.

Name

Data type

Description

name

String

The form item variable in the dialog scope that will hold the result. The name must be unique among form items in the form.

cond

String

An expression that must evaluate to true after conversion to Boolean in order for the form item to be visited. The form item can also be visited if the attribute is not specified.

expr

String

The initial value of the form item variable. Default is ECMAScript undefined.

If initialized to a value, then the form item will not be visited unless the form item variable is cleared.

type

String

The type of field, i.e., the name of a built-in grammar type. See Built-In Grammars for more info.

slot

String

The name of the grammar slot used to populate the variable (if it is absent, it defaults to the variable name).

This attribute is useful in the case where the grammar format being used has a mechanism for returning sets of slot/value pairs and the slot names differ from the form item variable names.

modal

Boolean

(defaults to false) If this is false, all active grammars are turned on while collecting this field. If this is true, then only the field's grammars are enabled: all others are temporarily disabled.

Notes

Four useable shadow variables are returned: name$.utterance, name$.interpretation, name$.inputmode, and name$.confidence. Plum DEV includes support for the standard application variables, by default the platform will attempt to fetch the 5-best matches to an utterance. The n-best results are available the application.lastresult$[i] variable. For more information about the standard application variables see Application and Standard Variables.

Example

<?xml version="1.0"?>
<vxml version="2.0">
  <form>
    <!-- See section 2.3 for the list of available built-in grammars. -->
    <field name="myfield" type="digits?length=7">
      <prompt>
        Say or enter seven digits.
      </prompt>
      <filled>
        You entered <value expr="myfield"/>.
      </filled>
    </field>
  </form>
</vxml>

The output of the above script would be:

Computer: Say or enter seven digits. Human: Five five five one two one two. Computer: You entered five million five hundred fifty-one thousand two hundred twelve.

Child Tags

Parent Tags

<form>

Previous<exit>Next<filled>

Last updated 11 months ago