The media player (Genesys: MCP; Cisco: Gateway) launches a VXML project by using a URL, and some parameters are passed in this URL. (In many cases you can see these parameters in your Voice IVR logs.)

Since VXML Connector is a media player, it needs to pass these same parameters. In addition, VXML Connector passes some URL parameters that are specific and can be consumed by the VXML Server. For example, JACADA_IS_VISUAL_IVR=Yes indicates to the IVR that the session is running in Visual IVR mode and not Voice IVR mode.

In the Cisco and Genesys environments, passing parameters in the URL automatically creates these variables in the Session object. In Avaya, the variables to be used need to be created.


VXML Specific Variables 

Variables specific to VXML are listed and described in the following table.

JACADA_INTERACTION_UNIQUE_ID The unique identifier for the Interaction instance (read only).
This number, which is different on each run
of the VIVR VXML Connector, can be used
to identify the specific Interaction run by a user.
JACADA_IS_VISUAL_IVR This read-only flag indicates whether the
current session is a Visual IVR session
) or a Voice session type (
server. This variable is used when invoking
REST services from the Avaya
Orchestration Designer.
JACADA_USER_DATA_SIMPLE This variable holds data appended to the URL used to launch VIVR VXML Connector, in the VIVRParam parameter. For example, a customer's account number can be
appended to the URL:
new&window Title=<WindowTitle>&appkey=webclientappkey&
accountId=vivr&VIVRParam =12345


Passing Session Data in the URL

Occasionally it is useful to pass specific data in the URL that does not come from the VIVRParam parameter. This is accomplished by modifying the sessionScript of the ProjectConfiguration.xml, using JavaScript. 

To pass session data, assign a variable named sessionUriParam. The following example shows how to set a session Id and pass it into the VXML server in the URL:

Var sessionId = ‘1234567890’;
var sessionUriParam = 'SESSIONID=' + sessionId;