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

C

HAPTER 

3:

 

S

ESSION 

API

 

 

P

ROGRAMMING 

G

UIDE FOR 

C

ISCO 

U

NIFIED 

CVP

 

VXML

 

S

ERVER 

 

 

 

AND 

C

ISCO 

U

NIFIED 

C

ALL 

S

TUDIO 

R

ELEASE 

4.1(1) 

 

19 

o

 

. The Java class or URI to call when a call to the application starts. The 

class

 attribute lists the full class name of the Java class. The 

src

 attribute contains the 

URI to call. The two attributes are mutually exclusive. The attribute 

run_in_background

 

is “true” if the Java class or URI is to be accessed in a separate thread by VXML Server 
and “false” if the call is to wait for the action to complete. 

o

 

. The Java class or URI to call when a call to the application ends. The 

class

 

attribute lists the full class name of the Java class. The 

src

 attribute contains the URI to 

call. The two attributes are mutually exclusive. 

o

 

. The Java class(es) to call when the application is loaded or updated. The 

class

 attribute lists the full class name of the Java class. The tag can appear multiple 

times, denoting multiple classes to run at the start of an application. The classes will be 
run in the order in which they appear in the document. The 

error_cancels_deploy

 

attribute is set to “true” when an error in the class should cause the application loading to 
fail. 

o

 

. The Java class(es) to call when the application is taken down (either as a 

result of the application server shutting down or due to an update). The 

class

 attribute 

lists the full class name of the Java class. The tag can appear multiple times, denoting 
multiple classes to run at the end of an application. The classes will be run in the order in 
which they appear in the document. 

•

 

– This tag contains tags representing the additions made to the application’s root 

document. This tag will not appear if no language, encoding, properties or variables are 
added to the root document.  The possible additions are: 

o

 

– This tag can appear any number of times listing the VoiceXML 

properties to add to the root document. Typically most voice browsers will take a 
property set here as an indication that it apply to the entire application. The 

name

 attribute 

lists the name of the property and the tag itself encapsulates the value. 

o

 

– This tag can appear any number of times listing the VoiceXML variables 

to add to the root document. A variable set in the root document is available to all 
VoiceXML pages in the application. The 

name

 attribute lists the name of the variable and 

the tag itself encapsulates the value.

 

o

 

– This tag encapsulates a Javascript function to place in the application’s root 

document. Any number of these tags can appear to add multiple Javascript functions to 
the root document. 

•

 

– This tag contains one or more 

<logger_instance>

 tags defining the loggers that 

are to listen to the events for calls for this application. The name attribute defines the logger 
instance name (all logger instances must have unique names). The class attribute defines the 
full Java class name of the logger to use. The optional configuration tag points to a 
configuration file for the logger instance. When the optional attribute 
enforce_call_event_order is “true” VXML Server will ensure that the logger receive the 
logger events for a call in the order in which they occurred in the call.