Guest

Cisco Unified Communications Manager (CallManager)

Using the Cisco Unified CallManager Locale Installer with Cisco Unified CallManager 4.3(1)

  • Viewing Options

  • PDF (233.5 KB)
  • Feedback
Using the Cisco Unified CallManager Locale Installer with Cisco Unified CallManager 4.3(1)

Table Of Contents

Using the Cisco Unified CallManager Locale Installer with Cisco Unified CallManager 4.3(1)

Purpose of the Document

Contents

Introduction

Supported Cisco Unified Communications Products

Integration Considerations

Installing the Cisco Unified CallManager Locale Installer

Troubleshooting

Error Messages

Caveats

Obtaining the Release Notes for the Cisco Unified CallManager Locale Installer

Obtaining Documentation, Obtaining Support, and Security Guidelines

Cisco Product Security Overview


Using the Cisco Unified CallManager Locale Installer with Cisco Unified CallManager 4.3(1)


Purpose of the Document

Intended for the system administrator, this document provides installation procedures for the Cisco Unified CallManager Locale Installer, which is used with Cisco Unified CallManager and other Cisco IP telephony products that support languages other than English (United States) and network tones/cadences and annunciator prompts for countries other than the United States. This document also provides a description of user and network locales, integration/migration considerations, preinstallation tasks, and an overview of how the locale installer works.

Contents

Introduction

Supported Cisco Unified Communications Products

Integration Considerations

Installing the Cisco Unified CallManager Locale Installer

Troubleshooting

Error Messages

Caveats

Obtaining the Release Notes for the Cisco Unified CallManager Locale Installer

Introduction

Cisco provides locale-specific versions of the Cisco Unified CallManager Locale Installer on www.cisco.com. Installed by the system administrator, the locale installer allows the user to view/receive the chosen translated text or tones, if applicable, when a user works with supported interfaces.

Defining User Locales

User locale files provide translated text and voice prompts, if available, for phone displays, user applications, and user web pages in the locale that the user chooses. User locales are country-specific and are therefore packaged with a matching network locale.

Defining Network Locales

Network locale files provide country-specific phone tones and gateway tones, if available.

Cisco combines multiple network locales in a single locale installer.

Defining Combined Locales

The Cisco Unified CallManager Locale Installer combines user locales and network locales in a single web-downloaded file, when applicable.


Note The Cisco Media Convergence Server (MCS) or Cisco-approved, customer-provided server can support multiple locales. Installing multiple locale installers ensures that the user can choose from a multitude of locales.

Changes do not take effect until you reboot every server in the cluster. Cisco strongly recommends that you do not reboot the servers until you have installed all locales on all servers in the cluster. Minimize call-processing interruptions by rebooting the servers after regular business hours.


Supported Cisco Unified Communications Products

Cisco Unified CallManager Locale Installers exist for the following Cisco IP telephony products, as indicated in Table 1.

Table 1 Supported Cisco Unified Communications Products 

Product
Type of Locale Installers Supported
Notes

Cisco Unified IP Phone 7941G, 7961G, 7941G-GE, 7961G-GE, 7970G, 7971G-GE, 7911G, and 7906G

User for the phone LCD

Network for the phone tones

In Cisco Unified CallManager User Options, the user can choose the user locale that will display on the phone.1

To configure the phone tone, the administrator browses to a server that runs Cisco Unified CallManager Administration and chooses the network locale from the Phone Configuration window.

Tip The Cisco Unified IP Phone 7941G, 7961G, 7941G-GE, 7961G-GE, 7970G, 7971G-GE, 7911G, and 7906G support Unicode UTF-8.

Cisco Unified IP Phone 7940G and 7960G

User for the phone LCD

Network for the phone tones

In Cisco Unified CallManager User Options, the user can choose the user locale that will display on the phone.1

To configure the phone tone, the administrator browses to a server that runs Cisco Unified CallManager Administration and chooses the network locale from the Phone Configuration window.

Tip The Cisco Unified IP Phone 7960G and 7940G support ISO8859-1, ISO8859-2, Windows-1251, and Windows-1253.

Cisco Unified IP Phone 7905G and 7912G

User for the phone LCD

Network for the phone tones

In Cisco Unified CallManager User Options, the user can choose the user locale that will display on the phone.1

To configure the phone tone, the administrator browses to a server that runs Cisco Unified CallManager Administration and chooses the network locale from the Phone Configuration window.

Tip The Cisco Unified IP Phone 7905G and 7912G support ISO8859-1, BIG5 (Traditional Chinese), GB2312 (Simplified Chinese), and EUC-KR (Korean).

Cisco Unified Wireless IP Phone 7920

User for the phone LCD

Note The Cisco Unified Wireless IP Phone 7920 does not support network locales; United States of America tones are hard-coded.

In Cisco Unified CallManager User Options, the user can choose the user locale that will display on the phone.1

Tip The Cisco Unified Wireless IP Phone 7920 supports ISO8859-1, ISO8859-2, Windows-1251, and Windows-1253.

Cisco Unified Wireless IP Phone 7921

User for the phone LCD

Network for the phone tones

In Cisco Unified CallManager User Options, the user can choose the user locale that will display on the phone.1

Tip The Cisco Unified Wireless IP Phone 7921 supports Unicode.

Cisco Quality Reporting Tool

User

In Cisco Unified CallManager User Options, the user chooses the locale that will display on the phone.1

Cisco CallBack

User

In Cisco Unified CallManager User Options, the user chooses the locale that will display on the phone.1

Cisco WebDialer

User

In Cisco Unified CallManager User Options, the user chooses the locale that will display on the phone.1

Cisco Extension Mobility

User

In Cisco Unified CallManager User Options, the user chooses the locale that will display on the phone.1

Gateway Tones

Network

Network locales do not exist for some gateway
devices.2

Gateways tones in the locale installer override versions that exist in the database.

To configure the gateway tone, the administrator browses to a server that runs Cisco Unified CallManager Administration and chooses the Network Locale from the Gateway Configuration window.

Cisco Unified CallManager Auto-Registered Phone Tool

User locales that provide localized voice prompts

After you install the locales on the server, you do not need to reboot the Cisco Customer Response Solutions (CRS) server.

If voice prompts appear in English_United_States after the installation of the locale installer, see the "Troubleshooting" section.

Cisco Unified CallManager User Options

User

From these pages, the user can choose the locale that displays on the web pages.

Cisco Unified CallManager Administration User Configuration

User

See the "Troubleshooting" section for caveats about these pages.

Cisco Unified CallManager Attendant Console

User

The attendant chooses the locale from the attendant console login window. A message displays if the locale does not exist on the Cisco Unified CallManager server. The attendant console defaults to English if the locale does not exist.

After you upgrade the servers to Cisco Unified CallManager 4.3(1), you must reinstall the attendant console plug-in on the attendant console PC. Only Cisco Unified CallManager Attendant Console and later releases work with the locale installer.

Cisco Unified CallManager Assistant (console GUI)

User

Before you install the locale installer, close all sessions of Manager and Assistant clients.

Be aware that the Manager may want to use a different locale than the Assistant uses.

You choose the locale in the Cisco Unified CallManager Administration User Configuration window.

For more information on how to set the locale, refer to the Cisco Unified CallManager Administration Guide.

Cisco Unified CallManager CDR Analysis and Reporting (CAR)

User locales provide localized versions of end-user reports and the end-user graphical user interface (GUI).

CAR only supports the English character set, also known as ISO-Latin1 or ISO-8859-1; for example, United States and Western European languages.

To configure the user locale for the CAR user, the administrator browses into a server that runs Cisco Unified CallManager Administration and chooses the User Locale from the User Configuration window.

If the administrator does not configure the user locale for the CAR user, the CAR user can choose the locale in Cisco Unified CallManager User Options. The CAR user clicks the link, Change the Locale for the device profile(s) and these web pages, and then chooses the locale.

When the user browses into the server to view reports and the GUI in locales other than English_United_States, the user must enter a user name and password that has the appropriate privileges (not administrative privileges).

Annunciator Tones and Announcements

User and network

Annunciator Tones and Announcements automatically support localization after you install the locale installer and configure the locale settings for the Cisco Unified IP Phone or, if applicable, the device pool. For more information on Annunciator, refer to the Cisco Unified CallManager System Guide.

1 The administrator may choose the user locale in the Phone Configuration window of Cisco Unified CallManager Administration. When the phone resets, the most recent selection by the administrator or user determines which locale displays on the phone; no order of precedence exists for the selection.

2 Network locales exist for the following gateways: Cisco Catalyst 6500 Series, Cisco 7600 Series Communication Media Module, Cisco Catalyst 4224 Access Gateway Switch, Cisco Catalyst 4000 Series, Cisco Catalyst 6000 8 Port Voice E1 and Services Module, Cisco Catalyst 6000 8 Port Voice T1 and Services Module, Cisco Catalyst 6000 24 Port FXS Analog Interface Module, Cisco Catalyst 6000 24 Port FXO Analog Interface Module, Cisco Voice Gateway 200, Cisco 1880, Cisco 2610, Cisco 2611, Cisco 2612, Cisco 2620, Cisco 2613, Cisco 2621, Cisco 2650, Cisco 2651, Cisco 2620XM, Cisco 2621XM, Cisco 2650XM, Cisco 2651XM, Cisco 2610XM, Cisco 2611XM, Cisco 2691, Cisco 2801, Cisco 2811, Cisco 2812, Cisco 2851, Cisco 3640, Cisco 3640A, Cisco 3620, Cisco 3660, Cisco 3725, Cisco 3745, Cisco 3825, Cisco 3845, Cisco 1700, Cisco 1760, and Cisco 1751.


About Cisco Unified CallManager Java Telephony Application Programming Interface (JTAPI) and Cisco Unified CallManager Telephony Service Provider (TSP)

Cisco Unified CallManager JTAPI and Cisco Unified CallManager TSP do not require that you download the locale installer to obtain locales. The locales automatically exist in the application. When you install the application, you choose the locale in which you want to view the installation. If you want to use additional locales or upgrade current locales, you must obtain an updated version of the application and install the application again.

Integration Considerations

The Cisco Unified CallManager Locale Installer 4.3(1) supports Cisco Unified CallManager Release 4.3(1). For more integration and migration information, review Table 2.

Table 2 Integration Considerations 

Version of Cisco Unified Communications Application
Considerations
Cisco Unified CallManager

Upgrade from older version to 4.3(1)

All existing locales in Cisco Unified CallManager after Release 3.2 migrate when you upgrade to Cisco Unified CallManager Release 4.3(1). However, new phrases and voice prompts display only in English_United_States until you install the Cisco Unified CallManager Locale Installer(s) that is appropriate to this Cisco Unified CallManager version on every server in the cluster (install the locale installer on the Publisher server first, then install it on the Subscriber servers).

The end-user graphical user interface (GUI) for new Cisco IP telephony products displays in English_United_States until you download the locale installer on every server in the cluster and choose the locale through Cisco Unified CallManager Administration, if necessary. To determine whether you choose the locale through Cisco Unified CallManager Administration, refer to the product documentation.

Each installation of the locale installer overwrites the existing installation as though you installed it for the first time.

New installation of 4.3(1)

When you install Cisco Unified CallManager, only the English_United_States user and the network locale install on the servers in the cluster.

To obtain locales other than English_United_States, you must install the Cisco Unified CallManager Locale Installer on every server in the cluster (install the locale installer on the Publisher server first, then install it on the Subscriber servers).

See the "Troubleshooting" section when phrases and voice prompts display in English_United_States after the installation of the locale installer.

Cisco Customer Response Solutions (CRS)

Installation/Upgrade of any version of CRS 2.0 or 3.0

These versions serve as minimum requirements for installing the Cisco Unified CallManager Locale Installer on the CRS server.

Installation/Upgrade of CRS 4.0 or later

When the Locale Installer 4.3(1) detects an installation of CRS 4.0 or later, it stores the TAPS files in an AAR file. However, it does not automatically install them. You must upload these files by using CRS Application Administration. During the locale installer installation, a message displays with instructions on how to upload the TAPS files.


Installing the Cisco Unified CallManager Locale Installer


Caution You must install Cisco Unified CallManager 4.3(1) on every server in the cluster before you install the Cisco Unified CallManager Locale Installer. Ensure the locale installer is installed on every server in the cluster (install on the Publisher server before the Subscriber servers).


Caution You must reboot the server for the changes to take effect. After you complete all locale installation procedures, restart each server in the cluster. Updates do not occur in the system until you restart all servers in the cluster; services restart after the server reboots.

To minimize call-processing interruptions, do not reboot the servers during regular business hours.


Tip If you want to do so, you can install the Cisco Unified CallManager Locale Installer via Virtual Network Computing (VNC).

You can use Microsoft Terminal Services (TS) to install the Cisco Unified CallManager Locale Installer if TS was installed during the Cisco Unified CallManager installation.


Procedure


Step 1 Verify that you installed Cisco Unified CallManager 4.3(1) on every server in the cluster.

Step 2 To download the locale installer executable from the Cisco website, click http://www.cisco.com/kobayashi/sw-center/telephony/callmgr/locale-installer.shtml and go to
Step 3.

Or, to install the locale installer from the Plugin window in Cisco Unified CallManager Administration, do the following steps:

a. Choose Start > Programs > Cisco Unified CallManager > Cisco Unified CallManager Administration.

b. Log in to Cisco Unified CallManager Administration by using the administrator account and password.

c. Choose Application > Install Plugins.

d. Click the icon that represents the Cisco Unified CallManager Locale Installer.

The Voice Products software window on the web displays.

Step 3 Click the version for Cisco Unified CallManager Locale Installer.

The locale installer window displays.

Step 4 To download the executable to the server, click the executable.

Step 5 After downloading the file, save the file to the hard drive.

Step 6 Note the location of the saved file.

Step 7 Double-click the file to begin the installation.

Step 8 After the flash screen displays, a welcome dialog gets presented, click Next to continue to the license agreement.

Step 9 Read and accept the license agreement. Click Next to display the Readme Notes dialog.

Step 10 The readme notes contain build-time information such as components and devices that are supported in the released build. The readme may be printed for reference. Examine and accept the readme notes then click Next to proceed to Setup Type dialog.

Step 11 Choosing the complete setup type will install the user and network locale, or in the case of the combined network locale, all country network locales will be installed. Choosing a custom setup type will allow you to select or deselect user or network locales as desired. Click Next to proceed to Start Copying Files dialog.

Step 12 Review the setup options and click Next to proceed to the Ready to Install the Program dialog.

Step 13 Click Install to start installation of chosen locale options.


Note Application of the combined network locale installer may take a while. The speed of installation depends on the performance of the server. It is estimated to take between two to ten minutes to complete the database update. Observe the progress bar and text above it to determine the status of installation.


Step 14 When installation is complete, a new dialog requests confirmation of a reboot. Should you wish to apply another locale installer, do so before rebooting the server in order to reduce downtime.

Step 15 Click Finish.

Step 16 The Setup dialog box displays. Do not click any buttons or press any keys.

When the dialog box automatically closes, you have completed the installation on the server.

Step 17 Install the Cisco Unified CallManager Locale Installer on every server in the cluster.


Tip Make sure that you install the same components on every server in the cluster.


Step 18 If you want to install other locales, perform Step 2 through Step 17 on every server in the cluster.

Step 19 After you complete all locale installation procedures, restart each server in the cluster.

Updates do not occur in the system until you restart all servers in the cluster; services restart after the server reboots.

Step 20 Verify that your users can choose the locale(s) for supported products.


Troubleshooting

Review the following troubleshooting tips in the "Error Messages" and "Caveats" sections.

Error Messages

The following error messages may display during the installation process.

This host is not a valid Cisco Unified CallManager or Customer Response Solutions server!

Cisco Unified Communications Locale Installer can only be applied to a Cisco Unified CallManager server or a Customer Response Solutions server. Please ensure that either of these applications are installed on the server before proceeding.

Insufficient space was determined.

Free-up space on drive C:\ before retrying.

The database is not ready, please ensure that the MSSQLSERVER service is running before retrying!

Start SQL Service and wait for the service to be in RUNNING state before retrying installation.

Cisco Unified CallManager publisher server name was returned empty!

Ensure that the subscriber server is a member of a valid cluster and that the locale installer was applied to the cluster's publisher first.

Cisco Unified CallManager local server name was returned empty!

Ensure that the local server's name is correctly configured in SQL Server before retrying installation.

This installer will not run on Cisco Unified CallManager versions lower than 3.3!

Please refer to the matching readme document, co-located with the locale installer on cisco.com for details of supported Cisco Unified CallManager versions.

File locked, it will be updated after reboot: <path-and-filename-of-locked-file>

An attempt to overwrite an existing file has been rejected because it is in use or locked by another application. The file has been flagged for installation after the server has been rebooted.

Cisco Unified CallManager Java classpath not found anywhere!

Java resource files required for updating Cisco Unified CallManager Assistant have not been found in known paths nor within the entire C:\ path. Please ensure that Cisco Unified CallManager has been completely and successfully installed before reapplying the locale installer.

Unable to determine current version of Java Runtime Environment from the Windows registry!

Please ensure that the appropriate JRE version is installed on the server for the current Cisco Unified CallManager version.

Unable to determine Java Runtime Environment home directory from the Windows registry!

Please ensure that the appropriate JRE version is installed on the server for the current Cisco Unified CallManager version.

Database-Related Error Messages

The following database-related error messages are accompanied by a brief reason description:

Highest Cisco Unified CallManager database name was returned empty!

An error occurred determining local server name!

An error occurred determining the highest Cisco Unified CallManager database name!

An error occurred determining the Cisco Unified CallManager publisher server name!

An error occurred determining Cisco Unified CallManager version!

An error occurred whilst applying user locale browser map language to database!

An error occurred whilst applying [user|network] component version to database!

An error occurred whilst adding [user|network] locale records to the database!

Caveats

See the following caveats and refer to the corresponding version of the Cisco Unified CallManager Locale Installer Readme for caveats that are specific to the Cisco Unified CallManager Locale Installer. To obtain the readme, click the following URL:

http://www.cisco.com/cgi-bin/tablebuild.pl/callmgr-locale-43


Caution Using non-English character sets with DC Directory, Netscape Directory, or Active Directory may cause directory database errors. Cisco Unified CallManager Release 4.0 only supports the English character set, also known as ISO-Latin1 or ISO-8859-1, Windows 1251-Cyrillic, and Windows 1253-Greek with any directory.

English_United_States phrases and voice prompts display after the installation completes.

This situation causes no problems in your cluster. You may not have the latest locale installer that is available on cisco.com. Furthermore, Cisco may choose to update the Cisco Unified CallManager database and not immediately update the Cisco Unified CallManager Locale Installer.

Attempt to install the locale installer on all servers again. If English_United_States phrases or voice prompts display, wait until an updated version of the locale installer displays on cisco.com. Download and install the updated version of the locale installer.


Note Cisco Unified CallManager Auto-Register Phone Tool voice prompts and Cisco Non-IOS gateway network tones do not fall back to English_United_States.


Cisco Unified CallManager only supports the English character set in the User area of Cisco Unified CallManager Administration.

After you download the locale installer, you can display field names in the User area of Cisco Unified CallManager Administration in your chosen language. However, Cisco Unified CallManager only supports the English character set, also known as ISO-Latin1 or ISO-8859-1, in the fields and in all user accounts and passwords that are needed to access these windows. If a user enters data that is not in the English character set, a dialog box displays and states that the user must enter data from the English character set.

You can choose different phone and gateway tones for the system.

If you choose to use different network locales, make sure that you choose a network locale in the parameters or the device pool that is supported by all gateway and phone device types that use the locale installer.

A new locale installer exists.

You cannot install the new locale installer with any version of Cisco Unified CallManager other than Release 4.2(3), unless otherwise indicated in this document, the readme document, or the Cisco Unified CallManager Compatibility Matrix.

You cannot uninstall a locale or the Cisco Unified CallManager Locale Installer.

No option exists to modify, repair, or remove the locale or the locale installer. Running the locale installer multiple times results in a reinstallation of the locale, as if it is not already installed on the server.

You must reinstall the locale installer after you perform restoration procedures.

The Cisco Unified Communications Applications Server Restore Utility does not restore the locale installer. You must reinstall the locale installer after you restore Cisco Unified CallManager data.

Localization of Fast Dials and the Personal Address Book not supported.

Fast Dials and Personal Address Book text displays in English only.

Obtaining the Release Notes for the Cisco Unified CallManager Locale Installer

To obtain the release notes for the Cisco Unified CallManager Locale Installer, click the following URL:

http://www.cisco.com/en/US/products/sw/voicesw/ps556/prod_release_notes_list.html

Obtaining Documentation, Obtaining Support, and Security Guidelines

For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Cisco Product Security Overview

This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately.

A summary of U.S. laws governing Cisco cryptographic products may be found at: http://www.cisco.com/wwl/export/crypto/tool/stqrg.html. If you require further assistance please contact us by sending email to export@cisco.com.