Cisco Cisco Customer Voice Portal 8.0(1) User Guide

Insert Element Outputs

Just like any element, VoiceXML insert elements can create element and session data, set the
UID of the user to associate with the call, send custom logging events, and can return one of a
set of exit states. Like voice elements, insert elements can have internal logging of caller activity
and have global hotlinks and hotevents activated while the caller is visiting the Insert element.
All of these actions involve variable data set within the Insert element and returned to VXML
Server. These are crucial in order to properly integrate with the rest of the elements in the
application.

Each of the return arguments is listed below:

•

audium_exit_state – The exit state of this VoiceXML insert element. The value of this
variable must be exactly as chosen in the Builder for Call Studio when defining the insert
element.

•

element_log_[VARNAME] / element_nolog_[VARNAME] – These create new element
data for this VoiceXML insert element whose name is VARNAME and which either sends
a logging event to log the element data value or not, respectively. The data type will be
assumed to be a string. The variable name cannot include spaces.

•

session_[VARNAME] – This creates a new session variable whose name is VARNAME.
The data type is assumed to be a string. The variable name cannot include spaces. If the
variable name already exists, the old value will be replaced with this one. If the old data type
was not a string, the new data type will be a string.

•

custom_[NAME] – This sends a custom logging event whose contents is the action named
NAME and the value of the variable being the description.

•

set_uid – This associates the UID passed to the call.

•

audium_hotlink, audium_hotevent, audium_error, audium_action – These four Unified
CVP variables are created in the root document and must be passed along in the return

. The content of each deals with the occurrence of any global hotlinks, hotevents,

errors, or actions (for example, a hang-up) while in this insert element. Since the subdialog
has its own context and root document, this data has to be explicitly passed for any of these
events to be recognized by VXML Server. The developer should not alter the contents of
these variables.

•

audium_vxmlLog – This variable contains the raw content for an interaction logging event.
Adding to the interaction log is not required - the 

 variable can be passed

empty. In order for VXML Server to parse the interaction data correctly, a special format is
required for the content of the 

 variable. This format is defined below.

The format for interaction logging is:

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

Where: ACTION is the name of the action.

The following bullets list the possible action names and the corresponding contents of VALUE:

User Guide for Cisco Unified CVP VXML Server and Cisco Unified Call Studio Release 8.0(1)