Cisco Cisco Unified Customer Voice Portal 10.5(1) Developer's Guide

Page of 91
I
NTRODUCTION
 
 
C
ISCO 
CVP
 
V
OICE
XML
 
3.0 
 
 
Element Specifications 
 
 
 
Copyright 2001 - 2005 Audium Corporation.  All Rights Reserved. 1/14/05
 
13
 
Introduction 
Every element included with CVP VoiceXML Studio and Server must be configured before it can be used. This reference file contains 
a detailed specification for each of the CVP VoiceXML elements, listing all the options available in the configuration. The 
specifications must be followed, or the element may complain with an error message or behave erratically.  
Each element specification in this reference file presents information on some or all of the following five topics: 
• 
Overview. 
 Each specification starts with a brief description of the element’s behavior including what it does, how it reacts to 
various settings and audio groups, and other miscellaneous behavior. The information should help the developer decide whether to 
use these elements in an application or to rely on custom elements. 
• 
Settings.
  Settings contain information that affects how the element behaves. Each setting is described in this document using the 
following attributes: 
o
 
Type
:  The type of data accepted such as a boolean, integer, or enumeration. 
o
 
Required
:  This defines whether the setting is required to have a value if the setting is active (available to be configured in 
CVP VoiceXML Studio).  The definition of required in this case is that the setting must have an appropriate value for CVP 
VoiceXML Studio to validate the voice element configuration. In CVP VoiceXML Studio, all required settings are denoted by 
a red asterisk in front of the setting names. 
o
 
Single setting value
:  This defines whether the setting can have multiple values.  If set to true, then the setting may have only a 
single configuration value.  Multiple value settings are created in CVP VoiceXML Studio by right clicking on the setting and 
choosing the “add setting name” option. 
o
 
Substitution allowed
:  This setting attribute determines if the setting value can include substitution for dynamic configuration. 
In CVP VoiceXML Studio, any setting that allows substitution values will activate the substitution button located at the top 
right of the settings pane. 
o
 
Default
:  The initial value of an element setting when a new element is dragged to the workspace. 
• 
Element Data
.  Some elements capture data, and yield information that may be useful to other elements or for logging purposes. 
The variables created by each element are listed here. 
• 
Exit States
.  Each element may have one or more exit states that indicate the dialog status when the element execution has 
completed.  Exit states do not appear in an element configuration and cannot be changed.