Cisco Cisco Customer Voice Portal 8.0(1) Developer's Guide

Page of 122
local_hotlink – This tag is used for local hotlink configurations. The 
name
 attribute defines
the local hotlink’s name and must be unique within the element configuration.
The child 
<speech>
 tag indicates whether the inline or external speech grammar was set
for this hotlink. The 
<external>
 tag should contain the URI to the external speech
grammar. The 
<inline_component>
 tags encapsulate each utterance that activates the
hotlink.
The child 
<keypad>
 tag indicates whether the inline or external DTMF grammar was set
for this hotlink. The 
<external>
 tag should contain the URI to the external DTMF
grammar. The 
<inline_component>
 tags encapsulate each DTMF entry that activates
the hotlink.
The optional child 
<throw_event>
 tag is used if this hotlink throws an event.
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 from this point onwards for this call. The 
<language>
 tag content
is formatted according to the specification for using languages in VoiceXML (for example,
en-US). The 
<encoding>
 tag content is formatted according to the specification for encoding
XML pages (for example, UTF-8).
invalidate_session – This tag, if included in the XML, will prompt VXML Server to invalidate
the call session it retains in memory, call the end of call class or URI (if defined), and free
up the VXML Server port utilized by the call. The session is invalidated only after the
execution method of the dynamic configuration is completed. This tag is rarely used and
would be needed in a few circumstances where some external process takes the call away
from VXML Server such as when using a CTI system to transfer the call to an agent.
Substitution XML Format
The DTD for element configuration XML documents contain a tag 
<substitute>
 that is used
to define substitution. Substitution is the process of constructing a value from a combination of
Programming Guide for Cisco Unified CVP VXML Server and Cisco Unified Call Studio Release 8.0(1)
42
Chapter 6: Dynamic Element Configurations
Using the XML API