com.avaya.jtapi.tsapi
Class UserEnteredCode

java.lang.Object
  com.avaya.jtapi.tsapi.ASN1
      com.avaya.jtapi.tsapi.ASNSequence
          com.avaya.jtapi.tsapi.LucentPrivateData
              com.avaya.jtapi.tsapi.UserEnteredCode

public final class UserEnteredCode

extends com.avaya.jtapi.tsapi.LucentPrivateData

Contains the code/digits that may have been entered by the caller through the DEFINITY G3 call prompting feature or the collected digits feature.

This information, when available, is obtained via the LucentCallInfo.getUserEnteredCode() method.

The following are necessary steps for setting up VDNs, simple vector steps and CallObservers in order for a client application to receive UECs from the switch.

Note: VDNs are represented through the ACDManagerAddress interface.

1. Administer a VDN and a vector on the G3 switch with collect digits step and route command to a second VDN. See Call Scenario 1 and 2 below.

   The purpose of this VDN is to collect UEC, but it will not report the UEC to the PBX driver, even if the VDN is observed. The route command must redirect the call to a second VDN. The first VDN doesn't have to be observed by any client application.

2. Administer a second VDN and vector to receive the redirected call from the first VDN.

   The purpose of this second VDN is to report the UEC to the PBX driver. Thus a CallObserver must be placed on the second VDN, using CallCenterAddress.addCallObserver with the remain flag set to true. This VDN should redirect the call to its destination. The destination can be a station extension, an ACD split, or another VDN.

   If you are implementing Adjunct Routing, you will be registering the application as a RouteCallback on that second VDN. You can obtain the UEC information when you receive a RouteCallback. The RouteCallback passes a Routing event that is an extension of a RouteSessionEvent. You will be able to obtain a RouteSession object by using the RouteSessionEvent.getRouteSession method. In our implementation the RouteSession object also implements the LucentCallInfo object. So if you cast the RouteSession object to a LucentCallInfo object you will be able to obtain the UEC information.

   If the destination is a station extension and there is a CallObserver on that Address, call events for that observer will contain the UEC collected by the first VDN.

   If the destination is an ACD split and there is a CallObserver on an agent station in the split, call events for that observer will contain the UEC collected by the first VDN.

   If the destination is a VDN, UEC is NOT delivered to observers of that VDN.

   If multiple UECs are collected by multiple VDNs in call processing, only the most recently collected UEC is reported.

Limitations

1. An observed VDN only reports the UEC it receives (UEC collected in a previous VDN). It will not report UEC it collects or UEC collected after the call is redirected from the VDN.

2. A CallObserver on a station receives only the UEC that is received by the VDN that redirects the call to the station, provided that the VDN is observed (see Call Scenario 2).

Call Scenario 1:

VDN 24101 is mapped to vector 1 and vector 1 has the following steps:

1. collect 16 digits after announcement extension 1000
2. route to 24102
3. stop

VDN 24102 is mapped to vector 2 and vector 2 has the following steps:

1. route to 24103
2. stop

   where 24103 is a station extension.

When a call arrives on VDN 24101, the caller will hear the announcement and the switch will wait for the caller to enter 16 digits. After the 16 digits are collected in time (if the collect digits step is timed out, next step is executed), the call is routed to VDN 24102. The VDN 24102 routes the call to station 24103.

A CallObserver on VDN 24101 will NOT receive UEC.

If there is a CallObserver on VDN 24102, the 16 digits collected by VDN 24101 will be reported to that observer. VDN 24101 observing is not required for VDN 24102 to receive UEC collected by VDN 24101.

If there are CallObservers on VDN 24102 and station 24103, the 16 digits collected by VDN 24101 will be reported to those observers.

Whether the station 24103 is observed or not, the 16 digits will NOT be reported to the VDN 24102 observer when call is delivered to station 24103.

Call Scenario 2:

VN 24201 is mapped to vector 11 and vector 11 has the following steps:

1. collect 10 digits after announcement extension 2000
2. route to 24202
3. stop

VDN 24202 is mapped to vector 12 and vector 12 has the following steps:

1. collect 16 digits after announcement extension 3000
2. route to 24203
3. stop

VDN 24203 is mapped to vector 13 and vector 13 has the following steps:

1. queue to main split 2 priority m
2. stop

   where split 2 is a vector controlled ACD split that has agent extensions 24301, 24302, 24303.

When a call arrives on VDN 24201, the caller will hear an announcement and the switch will wait for the caller to enter 10 digits. After the 10 digits are collected in time, the call is routed to VDN 24202. When the call arrives on VDN 24202, the caller will hear an announcement and the switch will wait for the caller to enter 16 digits. After the 16 digits are collected in time, the call is routed to VDN 24203. The VDN 24203 queues the call to ACD Split 2. If the agent at station 24301 is available, the call is sent to station 24301.

A CallObserver on VDN 24201 will NOT receive UEC.

If there is a CallObserver on VDN 24102, the 10 digits collected by VDN 24201 will be reported to that observer.

If there is a CallObserver on VDN 24203, the 16 digits collected by VDN 24202 will be reported to that observer. However, the 10 digits collected by VDN 24201 will NOT be reported to that observer. An observer receives only the most recent UEC.

If VDN 24202 and VDN 24203 and station 24301 are all observed, only the 16 digits collected by VDN 24202 will be reported to the station 24301 observer. A station observer will receive the UEC that is received by the VDN that redirects calls to the station.

NOTE: In order to receive the UEC at a station observer, the VDN that receives the UEC and redirects calls to the station must be observed. For example, if VDN 24203 is NOT observed by any client, an observer on station 24301 will NOT receive the 16 digits collected by VDN 24202.

See Also:

LucentCallInfo

Field Summary

static short	UE_ANY
static short	UE_CALL_PROMPTER
static short	UE_COLLECT
static short	UE_DATA_BASE_PROVIDED
static short	UE_ENTERED
static short	UE_LOGIN_DIGITS
static short	UE_TONE_DETECTOR

Method Summary

ACDManagerAddress	getCollectVDN() Returns the ACDManagerAddress of the VDN which collected the digits
java.lang.String	getDigits() Returns the collected digits
short	getIndicator() Returns UE_COLLECT or UE_ENTERED
short	getType() Returns the type of digits collected

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UE_ANY

public static final short UE_ANY

See Also:

Constant Field Values

UE_LOGIN_DIGITS

public static final short UE_LOGIN_DIGITS

See Also:

Constant Field Values

UE_CALL_PROMPTER

public static final short UE_CALL_PROMPTER

See Also:

Constant Field Values

UE_DATA_BASE_PROVIDED

public static final short UE_DATA_BASE_PROVIDED

See Also:

Constant Field Values

UE_TONE_DETECTOR

public static final short UE_TONE_DETECTOR

See Also:

Constant Field Values

UE_COLLECT

public static final short UE_COLLECT

See Also:

Constant Field Values

UE_ENTERED

public static final short UE_ENTERED

See Also:

Constant Field Values

Method Detail

getType

public short getType()

Returns the type of digits collected

getIndicator

public short getIndicator()

Returns UE_COLLECT or UE_ENTERED

getDigits

public java.lang.String getDigits()

Returns the collected digits

getCollectVDN

public ACDManagerAddress getCollectVDN()

Returns the ACDManagerAddress of the VDN which collected the digits