4600 Series IP Telephone Scripts and Application Files

The files necessary to operate the 4600 Series IP Telephones are available on the Avaya web site at: http://www.avaya.com/support.

Two files on the TFTP Server are essential, other files will be needed when the Avaya IP Telephones need to be upgraded. The essential files are:

• An upgrade script file, which tells the IP telephone whether it needs to upgrade software. The Avaya IP Telephones attempt to read this file every time they reset. The upgrade script file is also used to point to the settings file. There are separate upgrade script files for the 4630 telephones.
• The settings file contains the option settings that enable many of the options you will need to customize the Avaya IP Telephones for your enterprise. You can use one settings file for all of your Avaya IP Telephones.

In addition to the upgrade script and settings files you need the latest binary code used in the Avaya IP Telephones.

These files are available from the Avaya website, thereby allowing you to upgrade to new software releases and new functionality without having to replace IP telephones. In general, all these files, plus other useful information such as a ReadMe file, information about infrared capabilities, and a template for the settings file, are contained in a self-extracting executable file (in both zipped and unzipped format) you can download to your TFTP server. Application files for all current 4600 Series IP Telephones (including the 4630/4630SW as of Release 2.0), and an upgrade script file, are bundled together in that self-extracting executable file. See Choosing the Right Application File and Upgrade Script File for more information.

The Avaya-provided upgrade script files, and the binaries included in the zip files, are designed to upgrade the Avaya IP Telephones. You should not need to modify them. It is essential that all of the binary files be together on the TFTP server. When downloading a new release onto a TFTP file server with an existing release already on it, we recommend that you:

• Stop the TFTP server.
• Back up all the current TFTP directories.
• Copy your 46xxsettings.txt file to a backup location.
• Remove all of the files in the download directory. This will ensure you do not have an inappropriate binary or configuration file on the server.
• Download the self-extracting executable file (or zip file if you prefer).
• Extract all of the files. When extracting the 4630 files, be sure to allow the directories to be created.
• Copy your 46xxsettings.txt file back into the download directory.
• Check the Readme files for release-specific information.
• Modify the 46xxsettings.txt file as desired.
• Restart the TFTP Server.
• Reset your Avaya IP Telephones.

You can download a default upgrade script file, sometimes called merely the “script file,” from
http://www.avaya.com/support. This file is sufficient to allow the telephone to use default settings for customer-definable options, although of course these settings can also be changed with DHCP or in some cases, from the telephone’s dialpad itself. However, you might want to open the default file and administer the options to add useful functionality to your Avaya IP Telephones. This file must reside in the same directory as the upgrade script file, and must be called 46xxsettings.scr or 46xxsettings.txt. The Avaya IP Telephones can operate without this file.

The settings file may include any of the five types of statements, one per line:

• Comments, which are statements with a “#” character in the first column.
• Tags, which are comments that have exactly one space character after the initial #, followed by a text string with no spaces.
• Goto commands, of the form GOTO tag, which cause the telephone to continue interpretation of the settings file at the next line after a # tag statement. If no such statement exists, the rest of the settings file is ignored.
• Conditionals, of the form IF $name SEQ string GOTO tag, which cause the GOTO command to be processed if the value of name is a case-insensitive equivalent to string. If no such name exists, the entire conditional is ignored.
• SET commands, of the form SET parameter_name value, where invalid values cause the specified value to be ignored for the associated parameter_name (so the default or previously administered value is retained). All values should be text strings, even if the value itself is numeric, a dotted decimal IP address, etc.

  NOTE:

  All data should be enclosed in quotation marks for proper interpretation.

The Avaya-provided upgrade script file includes lines that tell the telephone to GET 46xxsettings.scr and 46xxsettings.txt. These lines cause the telephone to use TFTP to attempt to download the file specified in the GET command. If the file is successfully obtained, its contents are interpreted as an additional script file - that is how your settings are changed from the default settings. If the file cannot be obtained, the telephone continues processing the upgrade script file (so if you do not have a 46xxsettings.scr file, the telephone will look for a 46xxsettings.txt file). If the settings file is successfully obtained but does not include any setting changes (which is the case when you initially download the script file template from the Avaya Support website, before you make any changes), the telephone stops using TFTP (and hence, does not go back to the upgrade script file).

You can change the name of the settings file, if desired, as long as you also edit the corresponding GET command in the upgrade script file. In general, however, you are encouraged not to alter the Avaya-provided upgrade script file; if Avaya changes the upgrade script file in the future, any changes you have made will be lost. You are strongly encouraged to use the 46xxsettings file to manage your customization instead.

For more details on customizing your settings file, see Contents of the TFTP Settings File.