Cisco Cisco Unified Customer Voice Portal 10.5(1)

Page of 406
2-32
Cisco Customer Voice Portal (CVP) Release 3.0(0) Configuration and Administration Guide
Chapter 2      Using NAM/ICM with the CVP IVR Solution
CVP Micro-Applications
Get Digits and Digit Entry Completion
The CVP tests GD digit entry input against several conditions to determine whether digit entry is 
complete. The CVP considers digit entry to be complete if the caller enters any of the following:
The maximum allowable number of digits (when terminator key is not used).
The maximum number of digits, excluding a terminator key (when terminator key is used).
Less than the maximum number of digits, followed by the terminator key.
Less than the maximum number of digits and exceeding the inter-digit timeout.
Nothing and reaching the no entry timeout.
Caution
It is important that you set up your NAM/ICM script to test for all the scenarios mentioned below. 
If digit-entry input is complete
After digit-entry input is complete, the CVP validates the digit string to determine if it is >= (greater 
than or equal to) the minimum length and <= (less than or equal to) the maximum length. 
Note
In variable-length data entry, the Maximum Field Length value does not accommodate the termination 
key. For example, if a GD micro-application is configured to accept a password that is between 6 and 12 
digits long and digit-entry completion is indicated through a termination key (or a timeout), the 
Minimum Field Length setting should be 6, the Maximum Field Length setting should be 12, and the 
DTMF Termination Key should be defined as a single character.
Before passing the result back to the Application Server, the Voice Browser would discard the 
termination key (that is, only the password digits will be included in the CED returned to ICM software). 
In this example, if the 13th digit is entered without reaching the interdigit timeout and the 13th digit is 
not
 the terminator key, a NOMATCH event (same as inter-digit timeout) occurs to clear the CED buffer 
on the Voice Browser.
After validating the digit string, the CVP does the following:
If the string is valid, the CVP stores the digit string (not including the terminator key) in the 
Call.CallerEnteredDigits variable, exits the node through the Checkmark (success) branch, and 
returns control to ICM software. 
If the string is not valid, the CVP considers it an invalid entry and does the following:
If the Number of Invalid Entry Tries value has not been reached, the CVP plays an error message 
and re-plays the original prompt.
If the Number of Invalid Entry Tries value has been reached, the CVP stores the last-entered 
digit string in the Call.CallerEnteredDigits variable, exits the node through the X (failure) 
branch, sets the user.microapp.error_code ECC variable to 16 (Reached Maximum Invalid 
Tries), and returns control to ICM software.