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

C

HAPTER 

9:

 

C

ONFIGURABLE 

E

LEMENTS

 

 

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) 

 

58 

Once a VoiceXML page is visited and the 

audium_vxmlLog

 variable is filled with content, it 

must be passed back to VXML Server for parsing to place in the activity log. This means that 
every submit back to VXML Server must include this variable as an argument. If the voice 
element uses the 

getSubmitURL()

 method to obtain the submit URL, 

audium_vxmlLog

 must be 

explicitly added to the argument list in order to log correctly. Another advantage of using the 

getSubmitVAction()

 methods are that they already add this variable to the submit. 

The convention used to for interaction logging appends the action name, description, and 
timestamp using the following format:  

“

|||ACTION$$$VALUE^^^ELAPSED

”  

where: 

•

 

ACTION is the name of the action. There are currently seven different actions that can be 
logged (the names are exactly as listed, all lowercase):  

o

 

This is used to indicate that the caller heard an audio group play. The value 

is the name of the audio group. 

o

 

 This is used to report how the caller entered their data, whether by voice or 

by DTMF keypresses. The value is stored in the inputmode VoiceXML shadow variable. 

o

 

 This is used to report the utterance as recorded by the speech recognition 

engine (available using a VoiceXML shadow variable). The value is the actual utterance. 

o

 

 This is used to report the interpretation as recorded by the speech 

recognition engine. The value is the actual interpretation. 

o

 

 This is used to report the confidence as recorded by the speech recognition 

engine (available using a VoiceXML shadow variable). The value is the confidence 
value. 

o

 

 This is used to indicate the caller entered the wrong information, incurring a 

nomatch event. The value is the count of the nomatch event. 

o

 

 This is used to indicate the caller entered nothing, incurring a noinput event. The 

value is the count of the noinput event. 

•

 

VALUE is the value (description) to put in the log. 

•

 

ELAPSED is the number of milliseconds since the VoiceXML page was entered. This is 
required in order to keep an accurate timestamp in the activity log. Luckily, the VXML 
Server-generated root document provides a Javascript function named 

application.getElapsedTime(START_TIME)

 that returns the number of milliseconds 

elapsed since the time specified in 

START_TIME

. A VoiceXML variable is declared in the root 

document that holds the time the VoiceXML page was entered and should be passed as input 
to this method. The variable name is 

audium_element_start_time_millisecs

, though just 

as with 

audium_vxmlLog

, a Java constant defined in 

VoiceElementBase

 named 

ELEMENT_START_TIME_MILLISECS

 should be used to refer to this variable

.