Cisco TCL Scripts for IOS Gateways

This document contains frequently asked questions that address the most common problem areas dealing with the Cisco Tool Command Language (TCL) Interactive Voice Response (IVR) scripting environment, which helps customers to meet their needs in script customization and new IVR script creation.

A. Neither. It should return "collect aborted" and stop collecting input. The message "collect fail" is returned if the digits entered do not match the patterns.

A. The card number is a combination of the entered account number and PIN number. When a user is prompted to enter a card number, the collected digits are passed through $info(digits). That field is split into two variables (account number and PIN number) and then passed to the RADIUS server for authorization.

A. No, lockScript is a Solaris binary. If you want to bypass having to use lockScript, and you are using Cisco IOS® Software Release12.0(7) T image, issue the test voip scripts command.This command turns off the signature mechanism. You have to run it again if you reboot the machine, so currently it cannot be used in a production environment.

if {regexp {^[0-9]$} $digits_collected First_digit} { ....

}

A. You need to enclose your regexp in brackets ([]).

if {[regexp {^[0-9$]} $digits_collected First_ digit]} {

.....

}

 

A. lockScript is a Solaris binary executable.

A. After making changes to your script, run the command line lockScript <user ID> your_script.tcl, which creates a new file your_script.1.1.1.tcl. Then load your script on the router. Use the following command to accomplish this:

lockScript <UID>./scripts (your script) 

A. No, they are the same.

A. The connectionId is unique to the gateway, so each gateway generates its own connectionId.

A. The Cisco TCL script file name needs to have a .tcl extension for both version 1 and version 2 infrastructure. The gateway reads the script and scans for the FSM command. If this command is found, then it uses version 2 infrastructure. For version 2.0 scripts there is a command to add to the script requiredversion majorversion.minorversion . This command verifies that the script is running with the correct version of TCL IVR application programming interface (API).

A. At this moment, Cisco does not have an immediate plan to provide more language support and prompts for the debit card application. It must be ensured that additional languages can be successfully and effectively supported through the Cisco TCL customized scripts, especially with the Clapton project. The feedback from Clapton customers will enable Cisco to assess the necessity to support additional languages.

A. Cisco TCL IVR infrastructure version number:

• 1.0 12.0(4) XH 1.0.x
• 1.1 12.0(7) T 1.1.x
• 2.0 (TBD) 2.0.x

A. The Network Time Protocol (NTP) time formats for Disconnect Time, Connect Time, and Setup Time are displayed as: %H:%M:%S.%k %Z %tw %tn %td %Y where:

• %H is hours (00 to 23)
• %M is minutes (00 to 59)
• %S is seconds (00 to 59)
• %k is milliseconds (000 to 999)
• %Z is the timezone string
• %tw is the day of week (Monday through Sunday)
• %TN is the month name (January through December)
• %td is the day of month (01 to 31)
• %Y is the year including century (for example,1998)

For example, the vendor-specific attribute (VSA) number 25 for Setup Time is "18:27:28.032 UTC Wed Dec 9 1998"

A. The alpha draft is the current version of the RADIUS Vendor-Specific Attributes Implementation Guide. There is no newer version than this.

A. All the vendor-specific attributes (VSAs) published in the document are supported in Cisco IOS® Software. The script, however, only supports credit-amount, credit-time, and returnCode for the prepaid application. That is because the billing system Cisco uses, MIND CTI, currently supports only these three VSAs.

DEC 14 19:05:51.734: RADIUS: Received from id 2 212.16.129.16:1645, Access-Accept, len 177
      DEC 14 19:05:51.734: Attribute 26 29 0000000968176833
      DEC 14 19:05:51.734: Attribute 26 37 00000009671F6833
      DEC 14 19:05:51.734: Attribute 26 31 000000096B196833
      DEC 14 19:05:51.734: Attribute 26 29 0000000966176833
      DEC 14 19:05:51.734: Attribute 26 31 0000000965196833
      DEC 14 19:05:51.734: RADIUS: saved authorization data for user 61953D5C at 61953 E84
      DEC 14 19:05:51.734: RADIUS: cisco AVPair ":h323-return-code = 51"
      DEC 14 19:05:51.734: RADIUS: cisco AVPair ":h323-redirect-number =384910" 
      DEC 14 19:05:51.734: RADIUS: cisco AVPair ":h323-preferred-lang = 1" 
      DEC 14 19:05:51.734: RADIUS: cisco AVPair ":h323-credit-time=2345" 
      DEC 14 19:05:51.734: RADIUS: cisco AVPair ":h323-credit-amount=6700"

DEC 14 19:05:51.738: cid(2) ta_get_event returning authorized
      DEC 14 19:05:51.738: :/getVariable/
      DEC 14 19:05:51.738: :/puts/
      DEC 14 19:05:51.738: Event: authorized
      DEC 14 19:05:51.738: :/puts/
      DEC 14 19:05:51.738: ReturnCode: Uknown variable name
      DEC 14 19:05:51.738: :/getVariable/
      DEC 14 19:05:51.738: :/puts/
      DEC 14 19:05:51.738: RedirectNumber: Uknown variable name
      DEC 14 19:05:51.738: :/getVariable/
      DEC 14 19:05:51.738: :/puts/
      DEC 14 19:05:51.738: PrefLang: Uknown variable name
      DEC 14 19:05:51.738: :/getVariable/
      DEC 14 19:05:51.738: :/puts/
      DEC 14 19:05:51.738: CrediAmount: 6700
      DEC 14 19:05:51.738: :/getVariable/
      DEC 14 19:05:51.738: :/puts/
      DEC 14 19:05:51.738: CrediTime: 2345
      DEC 14 19:05:51.742: :[callID]
      DEC 14 19:05:51.742: :/puts/
      DEC 14 19:05:51.742: cid( 2) app running state select_language
      DEC 14 19:05:51.746: TA_PlayPromptCmd() 00:04:27.512

set ev [authorize $account $pin "" [ani] info]
      set returncode [getVariable radius returnCode] 
      puts "Event: $ev" 
      puts "ReturnCode: $returncode" 
      puts "RedirectNumber: [getVariable radius redirectNumber]"
      puts "PrefLang: [getVariable radius preferredLang]" 
      puts "CrediAmount: [getVariable radius creditAmount]" 
      puts "CrediTime: [getVariable radius creditTime]"

A. This is because there is an extra space between the attribute name and the = sign. For example, see the output below for the difference between credit-time and return-code:

DEC 14 19:05:51.734: RADIUS: cisco AVPair ":h323-return-code = 51"
      DEC 14 19:05:51.734: RADIUS: cisco AVPair ":h323-redirect-number = 384910"
      DEC 14 19:05:51.734: RADIUS: cisco AVPair ":h323-preferred-lang = 1"
      DEC 14 19:05:51.734: RADIUS: cisco AVPair ":h323-credit-time=2345"
      DEC 14 19:05:51.734: RADIUS: cisco AVPair ":h323-credit-amount=6700"

Follow the format exactly as with credit-time and credit-amount and remove the spaces.

1d10h: RADIUS: added cisco VSA 30 Len 24 "h323-disconnect-cause=10"
  ...
  1d10h: Attribute 26 32 000000091E1A6833
  1d10h: RADIUS: added cisco VSA 30 Len 24 "h323-disconnect-cause=10"
  d10h: Attribute 26 32 000000091E1A6833

A. No, it is not a bug. All of the H.323 vendor-specific attributes (VSAs) are of type string and coded in a "attribute=value" format. The upshot is that h323-disconnect-cause=10 is not sent as subattribute 30 value of 10, but subattribute 30, value of "h323-disconnect-cause=10". So the debug that you see is:

1d10h: Attribute 26 32 000000091E1A6833 ^^^^^^^---------- vendor 9 ^^------- subattribute 
   30 ^^----- length 26 ^^^^- "h3"

The entire string in the debugs is not printed, so only "h3" is seen from the whole "h323-disconnect-cause=10" string.

A. The zip file called TCLWare_1_1_0.zip contains the Cisco audio files. This resides on the FTP server at ftp/skynyrd. Logon as anonymous for your user ID and use your email address for the password. Try the FTPget command and be certain to set the transfer mode to binary. If you perform the FTP on a Solaris platform, issue the unzip command and not thegunzip command. WinZip works properly on a Microsoft Windows NT platform.

A. The clid_authen_collect script can be helpful in this situation. You will find this script and all the audio files on the Ftpeng server in /skynyrd/TCLware_1_1_0.zip. Use the FTP facility at ftpeng.cisco.com and logon as anonymous for your user ID and use your email address for the password. Go to the /skynyrd directory and you will find all above mentioned files. Try the FTPget command and be certain to set the transfer mode to binary. If you perform the FTP on a Solaris platform, use the unzip command and not the gunzip command. WinZip works properly on a Microsoft Windows NT platform.

A. The binary for lockScript Clapton Pilot Program has been placed on the FTP server at ftpeng.cisco.com. To obtain this binary, go to the /skynyrd and find the lockScript binary. Try the FTP get command and be certain to set the transfer mode to binary. If you perform the FTP on a Solaris platform, use the unzip command and not the gunzip command. WinZip works properly on a Microsoft Windows NT platform.