Cisco Cisco Unified Customer Voice Portal 11.0(1) User Guide
C
HAPTER
2:
C
ISCO
CVP
V
OICE
XML
C
OMPONENTS IN
D
ETAIL
C
ISCO
CVP
V
OICE
XML
User Guide
with a URI. In this way, the CVP VoiceXML application sees an insert element as simply
another function to access.
another function to access.
The inputs and outputs are the means by which the insert element interfaces with the rest of the
system. Most of the important data available to CVP VoiceXML elements are sent as input to
each Insert element. Once the insert element is complete, the return information contains any
element or session data to create, log entries, the exit state of the insert element, and other data to
act upon.
system. Most of the important data available to CVP VoiceXML elements are sent as input to
each Insert element. Once the insert element is complete, the return information contains any
element or session data to create, log entries, the exit state of the insert element, and other data to
act upon.
Restrictions
The following restrictions apply to a VoiceXML insert element. An insert element conforming to
these restrictions will be assured full integration with the CVP VoiceXML application. These
restrictions will be clarified later.
these restrictions will be assured full integration with the CVP VoiceXML application. These
restrictions will be clarified later.
• The insert element cannot define its own root document, a root document generated by CVP
VoiceXML Server must be used.
• The variables to return to Server, including the exit state, must conform to a strict naming
convention.
• When using the <return> tag, CVP VoiceXML-specified arguments must be returned along
with the custom variables.
Inputs
As with any element in the application, an insert element would need to be able to access
information about the call such as element and session data, call data (such as the ANI), and even
information found in the user management database if the application is configured to use one.
Normally, this information is available in the Java or XML API. Since an insert element is
written in VoiceXML, this information must be made available for the insert element to use from
within the VoiceXML.
information about the call such as element and session data, call data (such as the ANI), and even
information found in the user management database if the application is configured to use one.
Normally, this information is available in the Java or XML API. Since an insert element is
written in VoiceXML, this information must be made available for the insert element to use from
within the VoiceXML.
Cisco CVP VoiceXML achieves this by creating VoiceXML variables in the root document
containing all the desired information. The variable names conform to a naming convention so
the Insert element developer can refer to them appropriately. This is one reason why Cisco CVP
VoiceXML requires the use of the Server-generated root document.
containing all the desired information. The variable names conform to a naming convention so
the Insert element developer can refer to them appropriately. This is one reason why Cisco CVP
VoiceXML requires the use of the Server-generated root document.
In order to cut down on the number of variables appearing in the root document, the application
designer is given the option of choosing which input groups are passed to the insert element.
Additionally, the designer can individually choose which element and session data to pass. By
minimizing the inputs to only the data required by the insert element, the overhead involved in
using an Insert element is minimized.
designer is given the option of choosing which input groups are passed to the insert element.
Additionally, the designer can individually choose which element and session data to pass. By
minimizing the inputs to only the data required by the insert element, the overhead involved in
using an Insert element is minimized.
Each input type is listed below:
©2000 - 2005 Audium Corporation. All Rights Reserved. 1/14/05
41