Voice Portal application parameters affecting the UUI data

When you add an application to Voice Portal using the VPMS web interface, the following parameters in the Advanced Parameters group on the Add Application page affect the contents of the SIP UUI data:

Parameter

Description

Generate UCID

The Universal Call Identifier (UCID) is an Avaya-proprietary call identifier used to help correlate call records between different systems. If the application passes a UCID to Voice Portal, Voice Portal always uses that UCID regardless of the setting in this field. If, however, the application does not pass a UCID, the Voice Portal MPP server can generate one for the call.

The options are:

  • Yes: If the application does not pass a UCID to Voice Portal, the MPP server generates a UCID. For blind and supervised transfers using the <redirect> CCXML tag, the MPP uses the same UCID as the call being transferred. Otherwise, it generates a new UCID.

  • No: The MPP does not generate a UCID.

Operation Mode

The SIP header for each call can contain User-to-User Interface (UUI) information that the switch can either pass on as a single block or attempt to parse so that the information can be acted on. This field determines how Voice Portal treats the UUI data.

The options are:

  • Service Provider: Voice 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: Voice 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 described in User-to-User Interface (UUI) data passed in SIP headers.

Transport UCID in Shared Mode

If Operation Mode is set to Shared UUI and Generate UCID is set to Yes, this field determines whether Voice Portal encodes a Voice Portal-generated UCID and adds it to the UUI data for all outbound calls.

The default is No, which means that a UCID is only passed as part of the UUI information if that UCID was passed to Voice Portal by the application.

Maximum UUI Length

The maximum length of the UUI data that can be passed in the SIP header. If this length is exceeded and Voice Portal generated a UCID for the call, the UCID is removed from the UUI data. If the result still exceeds this value, or if the UCID was passed to Voice Portal by the application, Voice Portal does not send any UUI data. Instead, it leaves the entire field blank because it has no way to determine what can be left out.