Appliance Error Messages

The appliance lets you specify a language for the error messages it sends to browsers. This section explains appliance error message support and provides instructions to modify error message text and create support for additional languages.

The appliance provides error messages to browsers through a set of language-specific directories, each of which contains two files.

When you select a language in the browser-based management tool, you are actually selecting one of these language-specific directories and the files it contains.

The two files the appliance uses are:

• ERRPAGE.CFG, which contains the text of all appliance error messages
• PXYERR.HTM, which is the HTML template file that applies a format to the applicable error text and other error information and is sent to the receiving browsers

The language-specific directories that contain these two files are located in \ETC\PROXY\DATA\ERRPAGE\NLS\LANGUAGE, where LANGUAGE is the English name of the language.

For example, the English files are stored in \ETC\PROXY\DATA\ERRPAGE\NLS\ENGLISH.

Other common appliance error message directories include:

\ETC\PROXY\DATA\ERRPAGE\NLS\GERMAN

\ETC\PROXY\DATA\ERRPAGE\NLS\SPANISH

\ETC\PROXY\DATA\ERRPAGE\NLS\PORTUGUESE

\ETC\PROXY\DATA\ERRPAGE\NLS\FRENCH

\ETC\PROXY\DATA\ERRPAGE\NLS\JAPANESE

You can specify the language for error page vending in Configure > Mini Web. For more information, see Mini Web Tab.

Checking the Language Directories on Your Appliance

To see a list of the directories on your appliance:

1. In the browser-based management tool, click Configure > Mini Web > the drop-down list.

Customizing the Appliance Error Template and Message Files

You can create error message support for additional languages and customize existing error message text and format.

Creating a New Language

1. Start FTP and log in as explained in Starting an FTP Session with the Appliance.

2. Enter the following:

   get /etc/proxy/data/errpage/nls/english/pxyerr.htm

   get /etc/proxy/data/errpage/nls/english/errpage.cfg

3. Modify the ERRPAGE.CFG file.

   There are explicit instructions in the file that clearly indicate which parts can be translated.

   You cannot delete or add error messages, nor can you change the number or order of the messages.

4. Modify the PXYERR.HTM file.

   Because this is an HTML file, you can customize it in a variety of ways. To interface with the appliance's message delivery mechanisms, you must ensure the following:

   • The keywords <PROXY_ADDRESS>, <ERROR_STATUS>, and <ERROR_DESCRIPTION> must be retained because they are dynamically replaced with the information that their names imply.
   • Graphics that you add should be put in the SYS:\ETC\PROXY\DATA directory. References to these graphics must use the <PROXY_ADDRESS> keyword as a starting reference point. See the usage of ALERTBAR.GIF in the PXYERR.HTM file.

5. Using FTP, create a new language directory in the path given in Appliance Error Messages.

6. Enter the following, where language is the new language directory you created:

   put pxyerr.htm /etc/proxy/data/errpage/nls/language/errpage.cfg

   put pxyerr.htm /etc/proxy/data/errpage/nls/language/pxyerr.htm

The new language is dynamically available in the browser-based management tool and from the command line. You do not need to restart the appliance.

Customizing the Error Message Text of an Existing Language

Referring to the procedure in Creating a New Language for details, complete the following basic steps:

1. Open the ERRPAGE.CFG file from an existing language-specific directory.

2. Modify the file.

   IMPORTANT:  There are limitations on what you can change in this file. See Creating a New Language for details.

3. Replace the file when modifications are completed.

Customizing the Error Message Format of an Existing Language

Refer to the procedure in Creating a New Language for details, then complete the following basic steps:

1. Open the PXYERR.HTM file from an existing language-specific directory.

2. Modify the file.

   IMPORTANT:  There are limitations on what you can change in this file. See Creating a New Language for details.

3. Replace the file when modifications are completed.