-- Free VoiceXML Resource by C.a.T.S. --

<www.vxml.co.za>

<training>

<voicexml tutorial>

The Script Element

With the script element, it is possible to specify a block containing scripting language code, which is analogous to the HTML 4 element. This element was enhanced with the advent of VXML version 2.1. The script element can make use of ECMA script.

An example of ECMA script follow:

    <script>
	function checkInput(valueCheck){
      		switch (valueCheck) {
      			case 1: playback = 1;
      				return playback;
      			case 2: playback = 2;
      				return playback;
				     }
      				       } 
	</script>

A routine that might make use of the script can be a prompt that invokes the script and then plays back the value which is returned.

The return value is <value expr="checkInput(i)"/>

A working example is given below where an expression within a prompt calls an ECMA Script routine within a form and returns a value which is played to the caller. This working example can be used as a starting point for custom solutions.

<form id="script_show">
	<block>
			<prompt>
				We are checking your order.
			</prompt>
			
			  <script>
			  var playback;
			  var valueCheck;
				function checkInput(valueCheck)
                       {
      				switch (valueCheck) 
                             {
      					case 1: playback = 'yes';
      						return playback;
      					case 2: playback = 'no';
      						return playback;
      					case 3: playback = 'maybe';
      						return playback;
      				}
      			}
			  </script>
			  <var name="i" expr="1"/>
				The return value is <value expr="checkInput(i)"/>
	</block>
</form>

A working example of a script that logs the date, start time, end time and call duration of a call will be compiled as follow.

Include the following script section at the very top of the application:

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE vxml PUBLIC "-//W3C//DTD VOICEXML 2.1 WVS//EN" "vxml21-0728.dtd">

<vxml version="2.1" xmlns="http://www.w3.org/2001/vxml" xml:lang="en-AU">	
	<property name="inputmodes" value="dtmf"/>

<!-- This script section captures the Date and the start time of the call -->
		<script> 
			var startDate = new Date();
  			var startTime = startDate.getTime();
  		</script>
<!-- The script section ends here  -->
	<form id="welcome">

The following section can be invoked when the call is terminated, to calculate the call duration and also log the results. It would be advisable to run this routine as a subdialog which is invoked once the application terminates, regardless of the termination point or method.

<script>
      var endDate = new Date();
      var endTime = endDate.getTime();
      var callDuration = endTime - startTime;
</script>

<block>
<log expr="'SubDialog return value is:' + '|' + endDate + '|' +
                      startTime + '|' + endTime + '|' + callDuration"/>
</block>

The log file entry looks like the example below. The log element contents can be manipulated to create a more elegant entry:

SubDialog return value is: |Thu Jul 10 12:47:19 GMT+0200 (CAT) 2008|1215686837532|1215686839703|2171

Herewith a VXML page with a few script routines which can be used to create applicable solutions.

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE vxml PUBLIC "-//W3C//DTD VOICEXML 2.1 WVS//EN" "vxml21-0728.dtd">

<vxml version="2.1" xmlns="http://www.w3.org/2001/vxml"
	xml:lang="en-AU">
	<meta name="GENERATOR" content="IBM WebSphere Voice Toolkit" />
	
	<var name="i" expr="1"/>
	<var name="j" expr="true"/>
	<var name="k" expr="'one'"/>
	<var name="l" expr="'two'"/>
	
  	<script>
  		var startDate = new Date();
  		var startTime = startDate.getTime();
  	</script>

<form>
	<block>
	<prompt>We are logging call duration here</prompt>
    	<script>
      		var endDate = new Date();
      		var endTime = endDate.getTime();
      		var callDuration = endTime - startTime;
      		var TestVariable = 123456;
      		var playback;
      		var valueCheck;
      		var val1;
      		var val2;
      		var status;
      		var arrayValue=new Array(2);
      		var first;
      		var second;
      		// Case function in ECMA Script
      			function checkInput(valueCheck){
      				switch (valueCheck) {
      					case 1: playback = 1;
      						return playback;
      					case 2: playback = 2;
      						return playback;
      					case 3: playback = 3;
      						return playback;
      					}
      			}
      		// If statement check in ECMA Script
      			function checkVars (val1, val2) {
      				if (val2 == 'true') 
      				{
      					if (val1 == '1')
      					{
      						status = "true";
      						return status;
      					}
      				}
      				else
      				{
      					status = "false";
      						return status;
      				}
      			}
      		//Array in ECMA Script
      			function checkArray	(first, second) {
      				arrayValue[0] = first;
      				arrayValue[1] = second;
      			return arrayValue;
      			}
    	</script>
      		<prompt>
      		<!-- 	The call duration is <value expr="callDuration"/> milliseconds<sentence/>
      				My test variable is <value expr="TestVariable"/><sentence/>
      				The date is <value expr="startDate"/>
      		 -->	
      			The return value is <value expr="checkInput(i)"/>
      			The values are <value expr="checkVars(i, j)"/>
      		</prompt>
      			<var name="arrayValue" expr="checkArray(k, l)"/>
      			<foreach item="count" array="arrayValue">
      				<prompt>
      					The counter is at <value expr="count"/>
      				</prompt>
      				
      			</foreach>
      			<log expr="'End Date:' + endDate"/>
      	</block>
  </form>
</vxml>

Now we can go to:
Scripts