GetData

Purpose

Use GetData to retrieve information provided by a caller when the caller must press more than one key on the telephone keypad to transmit the information.


A screen capture of the Action GetData window

Description

GetData retrieves the result of pressing a series of keys in a single step.

The last key pressed must be the key identified by the Enter Key system parameter in the Application Server Interface group. By default, this is the pound (#) key.

GetData receives the information and stores it in a temporary buffer. The contents of the buffer are then assigned to the Key Buffer parameter variable for use by other states. If GetData fails for some reason (for example, if the caller does not provide complete input, the GetData result is Input Too Short or Input Incomplete), GetData still copies the contents of the buffer to the Key Buffer parameter variable and clears the temporary buffer.

GetData causes an automatic fade out of any background music. You can override this by using the System : Music : Automatic fade before actions system variable (SV226).

Parameters

The parameters for GetData identify the variable to which the information received from the caller is assigned. They also define characteristics of the information and operating rules for the action.

Possible results

GetData can have one of the following results:

Succeeded
The caller entered information that matched all of the parameters. The information has been assigned to the specified variable.
Input Too Short
The number of characters (or the number) the caller entered was less than the Minimum parameter.
Input Too Long
The number of characters (or the number) the caller entered exceeded the Maximum parameter.
Input Incomplete
The caller did not press the pound key.
Timeout
The time defined by Timeout has elapsed and the caller has not entered the information.
Last Timeout
The application has repeated this GetData action for the number of times defined by the value of Timeouts Allowed.
Caller Hung Up
The caller has hung up.

ASCII syntax

When using an ASCII editor, code this action with these parameters in the following order:

  1. Key Buffer input, local or system variable
  2. Minimum
  3. Maximum
  4. Timeout
  5. Timeouts allowed

For example:

label: "Check Edges"
	GetData(loc2_n, 12, 25, 10, 5)
	  edge EDGE_GETD_LEN_OK:			 len_ok
	  edge EDGE_GETD_TOO_SHORT:		 too_short
	  edge EDGE_GETD_TOO_LONG: 		 too_long
	  edge EDGE_GETD_INCOMPLETE:		  incomplete
	  edge EDGE_TIMEOUT: 			   timeout
	  edge EDGE_LAST_TIMEOUT: 		  last_timeout
	  edge EDGE_HUP: 				   hup
	;

The parameters and edges are described above under "Parameters" and "Possible results". For more information, see Testing a state table using the debugger.