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

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) 

 

 

 

31

 

   

– 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 string, int, float, 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). 

   

– 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. 

   

– 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. 

   

– This tag is used to change the default audio path from this point onwards 

for this call. 

   

– This tag is used to change the maintainer e-mail address from this point 

onwards for this call. 

   

– 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. 

   

– 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 (e.g. “en-US”). 
The 

<encoding>

 tag content is formatted according to the specification for encoding XML 

pages (e.g. “UTF-8”). 

   

– This tag, if included in the XML, will prompt Unified CVP VoiceXML 

Server to invalidate the call session it retains in memory, call the end of call class or URI (if 
defined), and free up the VoiceXML 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 the VoiceXML Server such as when using a CTI system to transfer 
the call to an agent. 

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 
static and dynamic content. It is used as a way for a developer to use dynamic content in an 
element configuration without having to resort to a dynamic configuration. Substitution can be 
used throughout an element’s configuration such as settings, audio, VoiceXML properties, etc. 
See the VoiceXML Server User Guide for Cisco Unified Customer Voice Portal for more on 
substitution.