PreviousNextIndex

System Variables > System Variable Fields and Properties
 
System Variable Fields and Properties

The following table lists and describes the fields and properties for the system variables.

System Variable Fields and Properties 

Variable

Associated Fields

Descriptions/Comments

date - This variable gets data on the current date from the system.

 

audio

Returns the current date.

This field is specifically designed and optimized to be used in an audio variable. Therefore, to use this field, you must have the localization bundle and standard phrases installed. See Audio Variable.

When you use this field in a prompt, you can specify additional properties that govern how the information is presented to the caller. See Audio Field Properties.

 

dayofmonth

Returns the number of the current day. For example, if the current date is May 23, this field returns the value 23.

 

dayofweek

Returns the name of the current day of the week, for example, Tuesday.

 

dayinweeknum

Returns the number of the day in the week, where Sunday is 0 and Saturday is 6.

 

dayofweeknum

Returns the current day of the week as an integer, for example, Sunday is 1 ... Saturday is 7.

 

dayofyear

Returns the number of the current day in the year. For example, if the current date is May 23, in a non-leap year, this field returns the value 143.

 

month

Returns the name of the current month, for example, May.

 

monthinyear

Returns the number of the current month in the year. For example, if the current month is May, this field returns the value 05.

 

year

Returns the current year, for example, 2005.

ddLastException - This variable is automatically updated when a Java exception is caught using the Catch (Exception) item. The ddLastException fields will have data that is extracted from the Java exception that was caught.

 

errorcode

The error code associated with the exception, if provided. Currently only SQLExceptions provide error codes and the error codes are JDBC vendor specific.

 

message

The exception message. Contains information about why the exception was thrown.

 

object

The exception Java Object. This is stored so a developer can access the Java Exception object if necessary.

 

stacktrace

The stack trace of the exception stored in a string form.

 

type

The type of exception. The type is the fully qualified name of the exception class. For example, "java.io.FileNotFoundException", or "java.lang.NullPointerException".

redirectinfo - This variable gets data from the session connection redirect variable. This variable is an array representing the connection redirection paths.

 

presentationinfo

Returns the value of the pi (presentation information) property for the session.connection.redirect variable for each element of the array.

 

screeninginfo

Returns the value of the si (screening information) property for the session.connection.redirect variable for each element of the array.

 

uri

Returns the value of the uri property for the session.connection.redirect variable for each element of the array.

session - This variable takes the values for its fields from the call session information generated at run time.

 

aai

Returns the value of the session variable session.connection.aai. This variable contains application-to-application information that is passed during connection setup.

 

ani

Returns the ANI, or the number that the caller is calling from.

 

calltag

Returns a string, which contains the following elements:

  • Host name - Name of the Avaya IR system from which the call session data was obtained
  • Channel number - Number of the IR system port where the call was received
  • Date and time the IR system received the call

For example, a typical return value for this field might be something like:

  • IR11 15 Wed Aug 3 11:51:54 2005

Note: This field is specific to Avaya IR 1.3 systems.

 

channel

Returns the number of the port on which the call resides.

 

currentlanguage

Returns the current default language as defined by the application.

 

dnis

Returns the DNIS, or the number that the caller dialed.

 

exitReason

These fields are placed into the SDR (Session Data Record) on voice portal and eventually loaded into IQ for reporting. It is up to the application developer to set these values and they may change depending on the application flow.

For example, if the application catched connection.disconnect, they might set the exitReason to "caller hungup" or if the application exited normally before exiting the exitReason might be set to "transaction complete". Or these variables may be used to track how far a caller proceeded through a flow before hanging up.

These variables will be generated into all uses of the VXML <exit/> tag namelist attribute as:

  • "_avayaExitReason"
  • "_avayaExitInfo1"
  • "_avayaExitInfo2"

By default the value of the exitReason will be set to "" and exitInfo1 and exitInfo2 will be set to "".

CCXML will receive these values in the dialog.exit event. It is up to the CCXML application to handle these values so they eventually make it to IQ or other appropriate destination.

The default VXML handlers provided by Voice Portal (formerly default.vxml) will need to be augmented and also look for the same values (as above, that is, "_avayaExit<type>" to be defined.

If doing so, place them in the namelist of any VXML  <exit/> tags. These values will be defined (generated) into every Dialog Designer generated VXML page. The default handlers catch exit cases where an error occurs and no handler is defined in the application to catch and handler the error. In addition, Dialog Designer will (try to, if feasible) generate a "default" connection.disconnect handler if the application does not provide one.

Voice Portal is responsible for documenting this so that non-Dialog Designer applications can utilize this mechanism, and to allow custom CCXML applications to take advantage of this feature. It is unknown what if any effect this will have on OSDM's. However, we can likely assume that if an application terminates in an OSDM no termination information will be logged. The above serves as the design for the standpoint of Dialog Designer and as a contract between Dialog Designer and Voice Portal.

 

exitInfo1

 

exitInfo2

 

lasterror

When an IC operation completes, error information is returned from the VOX in this variable.

If the operation succeeded, the lastError field will be empty.

In conjunction with the web parameter sage.ic.throwexceptions, the application can be disabled from throwing runtime exceptions for IC errors by setting this value to false. This requires that the developer always checks for a value in the lastError field, but provides the flexibility of doing so within the data node instead of their error handler.

Regardless of the value of sage.ic.throwexceptions, session.lastError will always be populated after an IC call.

 

protocolname

Returns the value of the session variable session.connection.protocol.name. This variable is the name of the connection protocol.

 

protocolversion

Returns the value of the session variable session.connection.protocol.version. This variable is the version of the connection protocol.

 

sessionid

Returns the session ID number assigned to the call.

 

sessionlabel

Contains any data you want to assign to it. This is the only field of the session variable to which you can assign a value. Assign the value using the Value field in the Avaya Properties view.

Note: This field is specific to Avaya Voice Portal. It was designed to be used as an application report filter.

 

sharedmode

Either shared or serviceprovider. If shared, then uui consists of fields of id and value, Example:

12, 01DR12345678; FA, 0001001C46E70028

The uui is then automatically unpacked so the id can value can be accessed

 

uui

Returns the contents of the uui (user-to-user information) variable field.

 

vpcalledextension

Returns the number of the station on the Voice Portal system

Note: This field is specific to Avaya Voice Portal. Its value is obtained from the Voice Portal Media Processing Platform (MPP).

 

vpconverseondata

Contains the DTMF digit data from an Avaya Call Center vector program. This data is used to initiate a session with the Dialog Designer application.

Note: This field is specific to Avaya Voice Portal. Its value is obtained from the Voice Portal Media Processing Platform (MPP). For more information about converse-on transactions, see your Voice Portal documentation.

 

vpcoveragereason

Returns the reason the call is being transferred to the Voice Portal system. Possible values include:

  • noanswer
  • busy

Note: This field is specific to Avaya Voice Portal. Its value is obtained from the Voice Portal Media Processing Platform (MPP).

 

vpcoveragetype

This field is reserved for future use.

Note: This field is specific to Avaya Voice Portal. Its value is obtained from the Voice Portal Media Processing Platform (MPP).

 

vprdnis

Returns the original number that the caller dialed, when the caller has been transferred or redirected. For example, if the caller dialed extension 1234, but the party at extension 1234 did not answer, the system might be set to automatically transfer the call to extension 9000. In this example, the dnis field would be set to 9000, and this field, the vprdnis field would be set to 1234.

Note: This field is specific to Avaya Voice Portal. Its value is obtained from the Voice Portal Media Processing Platform (MPP).

 

vpreporturl

Returns the URL of the Web service to which the system writes the application report data.

Note: This field is specific to Avaya Voice Portal. Its value is obtained from the Voice Portal Media Processing Platform (MPP).

time - This variable gets data on the current time from the system.

 

timezone

Returns the time zone in which the system is configured, as a number relative to "Zulu" or Greenwich Mean Time. For example, if the system taking the call is configured for Eastern Daylight Savings Time, then this field returns a value of -0400.

 

minute

Returns the current minute past the hour on the system clock. For example, if the current time is 5:32 p.m., this field returns 32.

 

audio

Returns the current time.

This field is specifically designed and optimized to be used in an audio variable. Therefore, to use this field, you must have the localization bundle and standard phrases installed. For more information about using audio variables, see Audio Variable.

When you use this field in a prompt, you can specify additional properties that govern how the information is presented to the caller. See Audio Field Properties.

 

millisecond

Returns the current millisecond of the system clock at the time the request is made.

 

hour

Returns the current hour of the system clock, in a 24-hour format. For example, if the current time is 5:32 p.m., this field returns 17.

 

second

Returns the current second of the minute past the hour on the system clock. For example, if the current time is 5:32:45 p.m., this field returns 45.



PreviousNextIndex

©2009, Avaya Inc. All rights reserved.