User-to-User Interface (UUI) data passed in SIP headers

Last Updated : Dec 06, 2012 |
Prolog information
Metadata
Keywords:
When you add an application to Experience Portal using the EPM web interface, you also specify how User-to-User Interface (UUI) information will be passed to the application if it uses a SIP connection using the Operation Mode field in the Advanced Parameters group on the Add Application page.
The options are:
  • Service Provider: Experience Portal passes the UUI data along as a single block to the application without making any attempt to interpret data.
    If you select this option, the application must handle the UUI data on its own.
  • Shared UUI: Experience Portal takes the UUI data and parses it into an array of IDs and their corresponding values. It then passes the application both the fully encoded UUI data and the parsed array with only the values still encoded..
    If you select this option, the UUI data must conform to the Avaya UUI specifications listed below.

UUI data format in CCXML applications

For a CCXML application, the UUI data is organized in a tree format. For example:
avaya.ucid = ‘####################’
avaya.uui.mode = "shared uui"
avaya.uui.shared[0].id = "FA"
avaya.uui.shared[0].value = "################"
avaya.uui.shared[1].id = "BG"
avaya.uui.shared[1].value = "################"
Each connection has its own tree associated with it, and the values for that connection can be accessed using the format session.connections['connection_number'].avaya.element_name.
For example, if you want to declare two variables called ucid and mode, and you wanted to set those variables to be equal to the corresponding values for connection 1234, you would specify:
<var name="ucid" expr="session.connections['1234'].avaya.ucid"/> 
<var name="mode" expr="session.connections['1234'].avaya.uui.mode"/>

UUI data format in VoiceXML applications

In VoiceXML, there is only one active call so the UUI information is organized into a similar tree format and placed into a session variable at the start of the dialog. The tree structure looks like this:
session.avaya.ucid
session.avaya.uui.mode
session.avaya.uui.shared[]
With the Shared UUI mode, you must send UUI/AAI data as name-value pairs in the following format:
<id0>,<value0>;<id1>,<value1>;<id2>,<value2>; ...
When you specify the name-value pairs:
  • Each name must be set to the hexadecimal encoded ID stored in the shared[] array.
  • Each value must be set to the encoded value stored in the shared[] array.
  • Each name in the pair must be separated from its value by a , (comma).
  • Each name-value pair must be separated from the next name-value pair by a ; (semi-colon).
For example, if you wanted to send a UCID using UUI/AAI, you might specify: aai = "FA,2901000246DEE275"