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

Page of 98
C
HAPTER 
6:
 
D
YNAMIC 
E
LEMENT 
C
ONFIGURATIONS
 
 
V
OICE
XML
 
P
ROGRAMMING 
G
UIDE 
 
 
 
FOR 
C
ISCO 
U
NIFIED 
C
USTOMER 
V
OICE 
P
ORTAL 
R
ELEASE 
4.0(1) 
 
 
 
 
28
 
   
error 
– This tag reports to Unified CVP VoiceXML Server that an error occurred while 
executing the dynamic configuration. The VoiceXML Server will then throw an exception 
whose message is contained in the 
<error>
 tag. This allows the XML API to throw 
exceptions just as the Java API does. 
   
setting 
– This tag holds an element setting, the name appearing in the 
name
 attribute and the 
value of the setting contained within the 
<setting>
 tag. It is repeated for each setting 
included in the base configuration. No 
<setting>
 tags appear if the base configuration 
contains no settings or the element itself defines no settings. 
   
substitute 
– This tag holds information on substitution. Substitution is typically used in static 
configurations and since static and dynamic configuration XML documents share the same 
DTDs, it appears here. Substitution would not normally be used with dynamic 
configurations. The substitution tag contents are fully described in the section entitled 
“Substitution XML format” at the end of this chapter. 
   
new_data 
– This tag holds the element and session data this dynamic element configuration is 
to create. Any number of 
<set_element> 
and 
<set_session>
 tags can appear, one for each 
element and session data variable to be created. The 
log
 attribute of 
<set_element>
 sets 
whether the value of the variable is stored in the activity log. The optional 
type
 attribute is 
used to specify the data type of the variable and can be stringintfloat, or boolean. The 
create
 attribute found in both tags determines when the variable is created, before the 
element is entered (before_enter), or after the element exits (after_exit). 
   
set_uid 
– This tag is used to associate the call with a UID in the user management system. 
The content of the tag should be the integer UID. 
   
log 
–This tag is used to trigger logger events when this dynamic configuration is executed. 
Any number of  
<custom>
 tags can appear, denoting the triggering of a custom event. The 
name
 attribute holds the name of the data, and the 
<custom>
 tag encapsulates the value. Any 
number of 
<warning>
 tags can appear, denoting the triggering of a warning event. The 
<warning>
 tag encapsulates the warning message. 
   
set_default_path 
– This tag is used to change the default audio path from this point onwards 
for this call. 
   
set_maintainer 
– This tag is used to change the maintainer e-mail address from this point 
onwards for this call. 
   
set_timeout 
– This tag allows the timeout length set for this session to be changed. The 
contents of the tab must be an integer representing the number of minutes in the timeout. 
   
set_main_doc_content 
– This tag allows the encoding and language settings for the 
application to be changed for this call. The 
<language>
 tag content is formatted according to 
the specification for using languages in VoiceXML (e.g. “en-US”). The 
<encoding>
 tag 
content is formatted according to the specification for encoding XML pages (e.g. “UTF-8”).