Localization Support
Localization Support
Localization Support
This chapter describes the localization support in Cisco Unified Communications Manager Express
(Cisco Unified CME) for languages other than English and network tones and cadences not specific to the
United States.
• Information About Localization, on page 1
• Configure Localization Support on SCCP Phones, on page 5
• Configure Localization Support on SIP Phones, on page 19
• Configuration Examples for Localization, on page 28
• Configuration Examples for Locale Installer on SCCP Phones, on page 31
• Where to Go Next, on page 35
• Feature Information for Localization Support, on page 35
Note Some abbreviations such as BLF, SNR, and CME are not localized.
Prerequisites
• Cisco Unified CME 9.5 or later version
• Locale package version 9.5.2.6 is required
Localization Support
1
Localization Support
System-Defined Locales
Restriction All the localization enhancements are supported in Cisco Unified CME only. They are not supported in Cisco
Unified SRST. Table 1: Language Codes for User-Defined Locales, on page 2 shows the language codes
used in the filenames of locale files.
Language Language
Code
Canadian fr_CA
French
System-Defined Locales
Cisco Unified CME provides built-in, system-defined localization support for 12 languages including English
and 16 countries including the United States. Network locales specify country-specific tones and cadences;
user locales specify the language to use for text displays.
Configuring system-defined locales depends on the type of IP phone:
• Cisco Unified IP Phone 7905, 7912, 7940, and 7960—System-defined network locales and user locales
are preloaded into Cisco IOS software. No external files are required. Use the network-locale and
user-locale commands to set the locales for these phones.
• Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, 8941, 8945, and
Cisco IP Communicator—You must download locale files to support the system-defined locales and
store the files in flash memory, slot 0, or on an external TFTP server. See Install System-Defined Locales
for Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP
Communicator, on page 5.
• Cisco Unified 3905, 6941, 6945, 8961, 9951, and 9971 SIP IP Phones—You must download locale files
to support the system-defined locales and store the files in flash memory, slot 0, or on an external TFTP
server.
Note TFTP aliases for localization are not automatically created for Cisco Unified SIP IP phones in a Cisco Unified
CME system. For more information on how to manually create TFTP aliases, see Install System-Defined
Locales for Cisco Unified IP Phone 8961, 9951, and 9971, on page 19.
Note Cisco Unified CME 10.5 Release onwards, the System defined locales are deprecated and User-defined locales
are recommended.
Cisco Unified 3905 SIP IP Phones and Cisco Unified 6945, 8941, and 8945 SCCP IP Phones have support
for all locales up to Cisco Unified CME 8.8.
Localization Support
2
Localization Support
Localization Support for Cisco Unified SIP IP Phones
Note The locale files must be stored in the same location as the configuration files.
User-Defined Locales
The user-defined locale feature allows you to support network and user locales other than the system-defined
locales that are predefined in Cisco IOS software. For example, if your site has phones that must use the
language and tones for Traditional Chinese, which is not one of the system-defined choices, you must install
the locale files for Traditional Chinese.
In Cisco Unified CME 4.0 and later versions, you can download files to support a particular user and network
locale and store the files in flash memory, slot 0, or an external TFTP server. These files cannot be stored in
the system location. User-defined locales can be assigned to all phones or to individual phones.
User-defined language codes for user locales are based on ISO 639 codes, which are available at the Library
of Congress website at http://www.loc.gov/standards/iso639-2/. User-defined country codes for network
locales are based on ISO 3166 codes.
For configuration information, see Install User-Defined Locales, on page 9.
The following display items are localized by the dictionary file for Cisco Unified CME:
• Directory Service (Local Directory, Local Speed Dial, and Personal Speed Dial)
• Status Line
Localization Support
3
Localization Support
Multiple Locales
Display options configured through Cisco IOS commands are not localized and can only be displayed in
English. For example, this includes features such as:
• Caller ID
• Header Bar
• Phone Labels
• System Message
Multiple Locales
In Cisco Unified CME 8.6 and later versions, you can specify up to five user and network locales and apply
different locales to individual ephones or groups of ephones using ephone templates. For example, you can
specify French for phones A, B, and C; German for phones D, E, and F; and English for phones G, H, and I.
Only one user and network locale can be applied to each phone.
Each of the five user and network locales that you can define in a multilocale system is identified by a locale
tag. The locale identified by tag 0 is always the default locale, although you can define this default to be any
supported locale. For example, if you define user locale 0 to be JP (Japanese), the default user locale for all
phones is JP. If you do not specify a locale for tag 0, the default is US (United States).
To apply alternative locales to different phones, you must use per-phone configuration files to build individual
configuration files for each phone. The configuration files automatically use the default user-locale 0 and
network-locale 0. You can override these defaults for individual phones by configuring alternative locale
codes and then creating ephone-templates to assign the locales to individual ephones.
For configuration information, see Configure Multiple Locales on SCCP Phones, on page 15.
Note In Cisco Unified CME 4.3 and earlier versions, you do not include the file suffix for any phone type except
Cisco ATA and Cisco Unified IP Phone 7905 and 7912. For example:
Router(config-telephony)# load 7941 SCCP41.8-2-2SR2S
• Backward compatibility with the configuration method in Cisco Unified CME 7.0 and earlier versions.
Localization Support
4
Localization Support
Locale Installer for Cisco Unified SIP IP Phones
For configuration information, see Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions,
on page 12.
With the locale installer, you do not need to perform manual configuration. Instead, you copy the locale file
using the copy command in privileged EXEC configuration mode.
Note You must copy the locale file into the /its directory (flash:/its or slot0:/its) when you store the locale files on
the Cisco Unified CME router.
For example,
Router# copy tftp://12.1.1.100/CME-locale-de_DE-German-8.6.3.0.tar flash:/its
For configuration information, see Use the Locale Installer in Cisco Unified CME 9.0 and Later Versions, on
page 22.
Tip The locale installer simplifies the installation and configuration of system- and user-defined locales in
Cisco Unified CME 7.0(1) and later versions. To use the locale installer in Cisco Unified CME 7.0(1) and
later versions, see Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions, on page 12.
Localization Support
5
Localization Support
Install System-Defined Locales for Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP Communicator
Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale.
You must have an account on Cisco.com to access the Software Download Center. If you do not have an account or if
you have forgotten your username or password, click the appropriate button at the login dialog box and follow the
instructions that appear.
Step 2 Navigate to Downloads Home > Products > Unified Communications > Call Control > Mid-Market Call Control >
Cisco Unified Communications Manager Express > Unified Communications Manager Express Individual File
Set and select your version of Cisco Unified CME.
Step 3 Select the TAR file for the locale you want to install. Each TAR file contains locale files for a specific language and
country and uses the following naming convention: CME-locale-language_country-CMEversion
Example:
For example, CME-locale-de_DE-4.0.2-2.0 is German for Germany for Cisco Unified CME 4.0(2).
Step 4 Download the TAR file to a TFTP server that is accessible to the Cisco Unified CME router. Each file contains all the
firmware required for all phone types supported by that version of Cisco Unified CME.
Step 5 Use the archive tar command to extract the files to flash memory, slot 0, or an external TFTP server.
Example:
Router# archive tar /xtract source-urlflash:/file-url
Example:
For example, to extract the contents of CME-locale-de_DE-4.0.2-2.0.tar from TFTP server 192.168.1.1 to router flash
memory, use this command:
Router# archive tar /xtract tftp://192.168.1.1/cme-locale-de_DE-4.0.2-2.0.tar
flash:
Step 6 See Table 2: Phone-Type Codes for Locale JAR Files, on page 7 and Table 3: System-Defined User and Network
Locales, on page 7 for a description of the codes used in the filenames and the list of supported directory names.
Each phone type has a JAR file that uses the following naming convention:
language-phone-sccp.jar
Example:
Localization Support
6
Localization Support
Install System-Defined Locales for Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP Communicator
For example, de-td-sccp.jar is for German on the Cisco Unified IP Phone 7970.
Each TAR file also includes the file g3-tones.xml for country-specific network tones and cadences.
6921 rtl
6945 rtl
7906/7911 tc
7931 gp
7941/7961 mk
7970/7971 td
8941/8945 gh
CIPC ipc
English_United_Kingdom UK United_Kingdom
CA Canada
CA Canada
AT Austria
CH Switzerland
Localization Support
7
Localization Support
Install System-Defined Locales for Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP Communicator
Step 7 If you store the locale files in flash memory or slot 0 on the Cisco Unified CME router, create a TFTP alias for the user
locale (text displays) and network locale (tones) using this format:
Example:
Router(config)# tftp-server flash:/jar_filealias directory_name/td-sccp.jar
Step 8 If you store the locale files on an external TFTP server, create a directory under the TFTP root directory for each user
and network locale.
Use the appropriate directory name shown in Table 3: System-Defined User and Network Locales, on page 7 and
remove the two-letter language code from the JAR file name.
Example:
For example, the user-locale directory for German and the network-locale directory for Germany for the Cisco Unified
IP Phone 7970 are:
TFTP-Root/German_Germany/td-sccp.jar TFTP-Root/Germany/g3-tones.xml
Step 9 For Russian and Japanese, you must copy the UTF8 dictionary file into flash memory to use special phrases.
• Only flash memory can be used for these locales. Copy russian_tags_utf8_phrases for Russian;
Japanese_tags_utf8_phrases for Japanese.
• Use the user-locale jp and user-locale ru command to load the UTF8 phrases into Cisco Unified CME.
Step 10 Assign the locales to phones. To set a default locale for all phones, use the user-locale and network-locale commands
in telephony-service configuration mode.
Step 11 To support more than one user or network locale, see Configure Multiple Locales on SCCP Phones, on page 15.
Localization Support
8
Localization Support
Install User-Defined Locales
Step 12 Use the create cnf-files command to rebuild the configuration files.
Step 13 Use the reset command to reset the phones and see the localized displays.
Note From Cisco Unified CME 10.5 Release onwards, the System defined locales are deprecated and User-defined
locales are recommended. However, the older locale packages can be still used but some phrases may be
displayed in English.
Restriction • User-defined locales are not supported on the Cisco Unified IP Phone 7920 or 7936.
• User-defined locales are not supported if the configuration file location is “system:”.
• When you use the setup tool from the telephony-service setup command to provision phones, you can
only choose a default user locale and network locale and you are limited to selecting a locale code that
is supported in the system. You cannot use multiple locales or user-defined locales with the setup tool.
• When using a user-defined locale, the phone normally displays text using the user-defined fonts, except
for any strings that are interpreted by Cisco Unified CME, such as “Cisco/Personal Directory,” “Speed
Dial/Fast Dial,” and so forth.
Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale.
You must have an account on Cisco.com to access the Software Download Center. If you do not have an account or if
you have forgotten your username or password, click the appropriate button at the login dialog box and follow the
instructions that appear.
Step 2 Navigate to Downloads Home > Products > Unified Communications > Call Control > Mid-Market Call Control >
Cisco Unified Communications Manager Express > Unified Communications Manager Express Individual File
Set and select your version of Cisco Unified CME.
Step 3 Select the TAR file for the locale that you want to install. Each TAR file contains locale files for a specific language
and country and uses the following naming convention: CME-locale-language_country-CMEversion-fileversion.
Localization Support
9
Localization Support
Install User-Defined Locales
Example:
For example, CME-locale-zh_CN-4.0.3-2.0 is Traditional Chinese for China for Cisco Unified CME 4.0(3).
Step 4 Download the TAR file to a TFTP server that is accessible to the Cisco Unified CME router. Each file contains all the
firmware required for all phone types supported by that version of Cisco Unified CME.
Step 5 Use the archive tar command to extract the files to slot 0, flash memory, or an external TFTP server.
Example:
Router# archive tar /xtract source-urlflash:/file-url
For example, to extract the contents of CME-locale-zh_CN-4.0.3-2.0.tar from TFTP server 192.168.1.1 to router flash
memory, use this command:
Router# archive tar /xtract tftp://192.168.1.1/cme-locale-zh_CN-4.0.3-2.0.tar
flash:
Step 6 For Cisco Unified IP Phone 7905, 7912, 7940, or 7960, go to Step 11, on page 12. For Cisco Unified IP Phone 7911,
7941, 7961, 7970, or 7971, go to Step 7, on page 10.
Step 7 Each phone type has a JAR file that uses the following naming convention: language-type-sccp.jar
Example:
For example, zh-td-sccp.jar is Traditional Chinese for the Cisco Unified IP Phone 7970.
See Table 4: Phone-Type Codes for Locale Files, on page 10 and Table 5: Language Codes for User-Defined Locales,
on page 10 for a description of the codes used in the filenames.
6921 rtl
6945 rtl
7906/7911 tc
7931 gp
7941/7961 mk
7970/7971 td
8941/8945 gh
CIPC ipc
Bulgarian bg
Chinese zh3
Croation hr
Localization Support
10
Localization Support
Install User-Defined Locales
Czech Republic cs
Finnish fi
Greek el
Hungarian hu
Korean ko
Polish pl
Portugese (Brazil) pt
Romanian ro
Serbian sr
Slovakian sk
Slovenian sl
Turkish tr
3
For Cisco Unified IP Phone 7931, code for Chinese Simplified is chs; Chinese Traditional is cht.
Step 8 If you store the locale files in flash memory or slot 0 on the Cisco Unified CME router, create a TFTP alias using this
format:
Example:
Router(config)# tftp-server flash:/jar_filealias directory_name/td-sccp.jar
Remove the two-letter language code from the JAR filename and use one of five supported directory names with the
following convention:
user_define_number, where number is 1 to 5
For example, the alias for Chinese on the Cisco Unified IP Phone 7970 is:
Router(config)# tftp-server flash:/zh-td-sccp.jar alias user_define_1/td-sccp.jar
Note On Cisco 3800 series routers, you must include /its in the directory name (flash:/its or slot0:/its). For example,
the TFTP alias for Chinese for the Cisco Unified IP Phone 7970 is:
Router(config)# tftp-server flash:/its/zh-td-sccp.jar alias user_define_1/td-sccp.jar
Step 9 If you store the locale files on an external TFTP server, create a directory under the TFTP root directory for each locale.
Remove the two-letter language code from the JAR filename and use one of five supported directory names with the
following convention:
user_define_number, where number is 1 to 5
Example:
For example, for Chinese on the Cisco Unified IP Phone 7970, remove “zh” from the JAR filename and create the
“user_define_1” directory under TFTP-Root on the TFTP server:
Localization Support
11
Localization Support
Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions
TFTP-Root/user_define_1/td-sccp.jar
Step 12 Rename these files and copy them to flash memory, slot 0, or an external TFTP server. Rename the files using the
format user_define_number_filename where number is 1 to 5.
Example:
For example, use the following names if you are setting up the first user-locale:
user_define_1_7905-dictionary.xml
user_define_1_7905-font.xml
user_define_1_7905-kate.xml
user_define_1_7920-dictionary.xml
user_define_1_7960-dictionary.xml
user_define_1_7960-font.xml
user_define_1_7960-kate.xml
user_define_1_7960-tones.xml
user_define_1_SCCP-dictionary.utf-8.xml
user_define_1_SCCP-dictionary.xml
Step 13 Copy the language_tags_file and language_utf8_tags_file to the location of the other locale files (flash memory, slot
0, or TFTP server). Rename the files to user_define_number_tags_file and user_define_number_utf8_tags_file
respectively, wherenumber is 1 to 5 and matches the user-defined directory.
Step 14 Assign the locales to phones. See Configure Multiple Locales on SCCP Phones, on page 15.
Step 15 Use the create cnf-files command to rebuild the configuration files.
Step 16 Use the reset command to reset the phones and see the localized displays.
Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions
To install and configure locale files to use with SCCP phones in Cisco Unified CME, perform the following
steps.
Tip Cisco Unified CME 7.0(1) provides backward compatibility with the configuration method in
Cisco Unified CME 4.3/7.0 and earlier versions. To use the same procedures as you used with earlier versions
of Cisco Unified CME, see Install System-Defined Locales for Cisco Unified IP Phone 6921, 6945, 7906,
7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP Communicator, on page 5.
Localization Support
12
Localization Support
Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions
Restriction • When using an external TFTP server, you must manually create the user locale folders in the root directory.
This is a limitation of the TFTP server.
• Locale support is limited to phone firmware versions that are supported by Cisco Unified CME.
• User-defined locales are not supported on the Cisco Unified IP Phone 7920 or 7936.
• User-defined locales are not supported if the configuration file location is system.
• When you use the setup tool from the telephony-service setup command to provision phones, you can
only choose a default user locale and network locale, and you are limited to selecting a locale code that
is supported in the system. You cannot use multiple locales or user-defined locales with the setup tool.
• When using a user-defined locale, the phone normally displays text using the user-defined fonts, except
for any strings that are interpreted by Cisco Unified CME, such as “Cisco/Personal Directory,” and
“Speed Dial/Fast Dial.”
• If you install and configure a user-defined locale using country codes U1-U5 and then you install a new
locale using the same label, the phone retains the original language locale even after the phone is reset.
This is a limitation of the IP phone. To work around this limitation, you must configure the new package
using a different country code.
• Each user-defined country code (U1-U5) can be used for only one user-locale-tag at a time. For example:
Router(config-telephony)# user-locale 2 U2 load Finnish.pkg
Router(config-telephony)# user-locale 1 U2 load Chinese.pkg
LOCALE ERROR: User Defined Locale U2 already exists on locale index 2.
Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale.
You must have an account on Cisco.com to access the Software Download Center. If you do not have an account or have
forgotten your username or password, click the appropriate button at the login dialog box and follow the instructions that
appear.
Step 2 Navigate to Downloads Home > Products > Unified Communications > Call Control > Mid-Market Call Control >
Cisco Unified Communications Manager Express > Unified Communications Manager Express Individual File
Set and select your version of Cisco Unified CME.
Step 3 Select the TAR file for the locale you want to install. Each TAR file contains locale files for a specific language and
country and uses the following naming convention: CME-locale-language_country-CMEversion
Localization Support
13
Localization Support
Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions
Example:
For example, CME-locale-de_DE-7.0.1.0 is German for Germany for Cisco Unified CME 7.0(1).
Step 4 Download the TAR file to the location previously specified by the cnf-file location command. Each file contains all the
firmware required for all phone types supported by that version of Cisco Unified CME.
a) If the cnf-file location is flash memory: Copy the TAR file to the flash:/its directory.
b) If the cnf-file location is slot0: Copy the TAR file to the slot0:/its directory.
c) If the cnf-file location is tftp: Create a folder in the root directory of the TFTP server for each locale using the following
format and then copy the TAR file to the TFTP-Root folder. TFTP-Root/TAR-filename
Example:
For system-defined locales, use the locale folder name as shown in Table 6: System-Defined and User-Defined
Locales, on page 14. For example, create the folder for system-defined German as follows:
TFTP-Root/de_DE-7.0.1.0.tar
For up to five user-defined locales, use the User_Define_n folder name as shown in Table 6: System-Defined and
User-Defined Locales, on page 14. A user-defined locale is a language other than the system-defined locales that
are predefined in Cisco IOS software. For example, create the folder for user-defined locale Chinese (User_Define_1)
as follows:
TFTP-Root/CME-locale-zh_CN-7.0.1.0.tar
Note For a list of user-defined languages supported in Cisco Unified CME, see Cisco Unified CME Localization
Matrix.
English English_United_States US
English_United_Kingdom UK
CA
Danish Danish_Denmark DK
Dutch Dutch_Netherlands NL
French French_France FR
CA
German German_Germany DE
AT
CH
Italian Italian_Italy IT
Japanese4 Japanese_Japan JP
Norwegian Norwegian_Norway NO
Localization Support
14
Localization Support
Verify User-Defined Locales
Portuguese Portuguese_Portugal PT
Russian Russian_Russia RU
Spanish Spanish_Spain ES
Swedish Swedish_Sweden SE
Step 5 Use the user-locale [user-locale-tag] country-codeload TAR-filename command in telephony-service configuration
mode to extract the contents of the TAR file. For country codes, see Table 6: System-Defined and User-Defined Locales,
on page 14.
Example:
For example, to extract the contents of the CME-locale-zh_CN-7.0.1.0.tar file when U1 is the country code for user-defined
locale Chinese (User_Define_1), use this command:
Router (telephony-service)# user-locale U1 load CME-locale-zh_CN-7.0.1.0.tar
Step 6 Assign the locales to phones. See Configure Multiple Locales on SCCP Phones, on page 15.
Step 7 Use the create cnf-files command to rebuild the configuration files.
Step 8 Use the reset command to reset the phones and see the localized displays.
Restriction • Multiple user and network locales are not supported on the Cisco Unified IP Phone 7902G, 7910, 7910G,
or 7920, or the Cisco Unified IP Conference Stations 7935 and 7936.
• When you use the setup tool from the telephony-service setup command to provision phones, you can
only choose a default user locale and network locale and you must select a locale code that is predefined
in the system. You cannot use multiple or user-defined locales with the setup tool.
Localization Support
15
Localization Support
Configure Multiple Locales on SCCP Phones
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. user-locale [user-locale-tag] {[user-defined-code] country-code}
5. network-locale network-locale-tag [user-defined-code] country-code
6. create cnf-files
7. exit
8. ephone-template template-tag
9. user-locale user-locale-tag
10. network-locale network-locale-tag
11. exit
12. ephone phone-tag
13. ephone-template template-tag
14. exit
15. telephony-service
16. reset {all [time-interval]| cancel | mac-address mac-address | sequence-all}
17. end
DETAILED STEPS
Localization Support
16
Localization Support
Configure Multiple Locales on SCCP Phones
Step 5 network-locale network-locale-tag [user-defined-code] Specifies a country for tones and cadences.
country-code
• network-locale-tag—Assigns a locale identifier to
Example: the country code. Range is 0 to 4. Default: 0. This
Router(config-telephony)# network-locale 1 FR argument is required when defining some locale other
than the default (0).
• user-defined-code—(Optional) Assigns one of the
user-defined codes to the specified country code.
Valid codes are U1, U2,U3, U4, and U5.
• country-code—Type ? to display a list of
system-defined codes. Default: US (United States).
You can assign any valid ISO 3166 code to a
user-defined code (U1 to U5).
Step 6 create cnf-files Builds the required XML configuration files for IP phones.
Use this command after you update configuration file
Example:
parameters such as the user locale or network locale.
Router(config-telephony)# create cnf-files
Localization Support
17
Localization Support
Configure Multiple Locales on SCCP Phones
Step 16 reset {all [time-interval]| cancel | mac-address Performs a complete reboot of all phones or the specified
mac-address | sequence-all} phone, including contacting the DHCP and TFTP servers
for the latest configuration information.
Example:
Router(config-telephony)# reset all • all—All phones in the Cisco Unified CME system.
• time-interval—(Optional) Time interval, in seconds,
between each phone reset. Range is 0 to 60. Default
is 15.
• cancel—Interrupts a sequential reset cycle that was
started with a reset sequence-all command.
• mac-address mac-address—A specific phone.
• sequence-all—Resets all phones in strict
one-at-a-time order by waiting for one phone to
reregister before starting the reset for the next phone.
Localization Support
18
Localization Support
Verify Multiple Locales on SCCP Phones
Step 1 Use the show telephony-service tftp-bindings command to display a list of configuration files that are accessible to IP
phones using TFTP, including the dictionary, language, and tone configuration files.
Example:
Router(config)# show telephony-service tftp-bindings
tftp-server system:/its/SEPDEFAULT.cnf
tftp-server system:/its/SEPDEFAULT.cnf alias SEPDefault.cnf
tftp-server system:/its/XMLDefault.cnf.xml alias XMLDefault.cnf.xml
tftp-server system:/its/ATADefault.cnf.xml
tftp-server system:/its/XMLDefault7960.cnf.xml alias SEP00036B54BB15.cnf.xml
tftp-server system:/its/germany/7960-font.xml alias German_Germany/7960-font.xml
tftp-server system:/its/germany/7960-dictionary.xml alias German_Germany/7960-dictionary.xml
tftp-server system:/its/germany/7960-kate.xml alias German_Germany/7960-kate.xml
tftp-server system:/its/germany/SCCP-dictionary.xml alias German_Germany/SCCP-dictionary.xml
tftp-server system:/its/germany/7960-tones.xml alias Germany/7960-tones.xml
Step 2 Ensure that per-phone configuration files are defined with the cnf-file perphone command.
Step 3 Use the show telephony-service ephone-template command to check the user locale and network locale settings in each
ephone template.
Step 4 Use the show telephony-service ephone command to check that the correct templates are applied to phones.
Step 5 If the configuration file location is not TFTP, use the debug tftp events command to see which files Cisco Unified CME
is looking for and whether the files are found and opened correctly. There are usually three states (“looking for x file,”
“opened x file,” and “finished x file”). The file is found when all three states are displayed. For an external TFTP server
you can use the logs from the TFTP server.
Restriction Phone firmware, configuration files, and locale files must be in the same directory.
Localization Support
19
Localization Support
Install System-Defined Locales for Cisco Unified IP Phone 8961, 9951, and 9971
Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale.
You must have an account on Cisco.com to access the Software Download Center. If you do not have an account or if
you have forgotten your username or password, click the appropriate button at the login dialog box and follow the
instructions that appear.
Step 2 Navigate to Downloads Home > Products > Unified Communications > Call Control > Mid-Market Call Control >
Cisco Unified Communications Manager Express > Unified Communications Manager Express Individual File
Set and select your version of Cisco Unified CME.
Step 3 Select the TAR file for the locale you want to install. Each TAR file contains locale files for a specific language and
country and uses the following naming convention: CME-locale-language_country-CMEversion
Example:
For example, CME-locale-de_DE-8.6 is German for Germany for Cisco Unified CME 8.6.
Step 4 Download the TAR file to a TFTP server that is accessible to the Cisco Unified CME router. Each file contains all the
firmware required for all phone types supported by that version of Cisco Unified CME.
Step 5 Use the archive tar command to extract the files to flash memory, slot 0, or an external TFTP server.
Example:
Router# archive tar /xtract source-urlflash:/file-url
For example, to extract the contents of CME-locale-de_DE-8.6.tar from TFTP server 192.168.1.1 to router flash memory,
use this command:
Router# archive tar /xtract tftp://192.168.1.1/cme-locale-de_DE-8.6.tar flash:
Step 6 See Table 7: Phone-Type Codes for Locale JAR Files, on page 20 and Table 8: System-Defined User and Network
Locales , on page 21 for a description of the codes used in the filenames and the list of supported directory names.
Each phone type has a JAR file that uses the following naming convention:
language-phone-sip.jar
Example:
For example, de-gh-sip.jar is for German on the Cisco Unified IP Phone 8961.
Each TAR file also includes the file g4-tones.xml for country-specific network tones and cadences.
3905 cin
6941 rtl
6945 rtl
8961 gh
9951 gd
Localization Support
20
Localization Support
Install System-Defined Locales for Cisco Unified IP Phone 8961, 9951, and 9971
9971 gd
English_United_Kingdom UK United_Kingdom
GB United_Kingdom
CA Canada
AU Australia
CA Canada
AT Austria
CH Switzerland
Step 7 If you store the locale files in flash memory or slot 0 on the Cisco Unified CME router, create a TFTP alias for the user
locale (text displays) and network locale (tones) using this format:
Example:
Localization Support
21
Localization Support
Use the Locale Installer in Cisco Unified CME 9.0 and Later Versions
Use the appropriate directory name shown in Table 7: Phone-Type Codes for Locale JAR Files, on page 20 and remove
the two-letter language code from the JAR file name.
For example, the TFTP aliases for German and Germany for the Cisco Unified IP Phone 8961 are:
Router(config)# tftp-server flash:/de-gh-sip.jar alias German_Germany/
Router(config)# tftp-server flash:/g4-tones.xml alias Germany/g4-tones.xml
Step 8 If you store the locale files on an external TFTP server, create a directory under the TFTP root directory for each user
and network locale.
Use the appropriate directory name shown in Table 7: Phone-Type Codes for Locale JAR Files, on page 20 and remove
the two-letter language code from the JAR file name.
Example:
For example, the user-locale directory for German and the network-locale directory for Germany for the Cisco Unified
IP Phone 8961 are:
TFTP-Root/German_Germany/gh-sip.jar TFTP-Root/Germany/g4-tones.xml
Step 9 Assign the locales to the phones. To set a default locale for all phones, use the user-locale and network-locale commands
in voice register global configuration mode.
Step 10 To support more than one user or network locale, see Verify Multiple Locales on SIP Phones, on page 28.
Step 11 Use the create profile command to rebuild the configuration files.
Step 12 Use the reset command to reset the phones and see the localized displays.
Use the Locale Installer in Cisco Unified CME 9.0 and Later Versions
Restriction • When using an external TFTP server, you must manually create the user locale folders in the root directory.
This is a limitation of the TFTP server.
• Locale support is limited to phone firmware versions that are supported by Cisco Unified CME.
• User-defined locales are not supported if the configuration file location is “system:”.
• If you install and configure a user-defined locale using country codes U1-U5 and then you install a new
locale using the same label, the phone retains the original language locale even after the phone is reset.
This is a limitation of the IP phone. To work around this limitation, you must configure the new package
using a different country code.
• Each user-defined country code (U1-U5) can be used for only one user-locale-tag at a time. For example:
Localization Support
22
Localization Support
Use the Locale Installer in Cisco Unified CME 9.0 and Later Versions
Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale
You must have an account on Cisco.com to access the Software Download Center. If you do not have an account or have
forgotten your username or password, click the appropriate button at the login dialog box and follow the instructions that
appear.
Step 2 Navigate to Downloads Home > Products > Unified Communications > Call Control > Mid-Market Call Control >
Cisco Unified Communications Manager Express > Unified Communications Manager Express Individual File
Set and select your version of Cisco Unified CME.
Step 3 Select the TAR file for the locale you want to install. Each TAR file contains locale files for a specific language and
country and uses the following naming convention: CME-locale-language_country-CMEversion.tar
Example:
For example, CME-locale-de_DE-German-8.6.3.0.tar is German for Germany for Cisco Unified CME 9.0.
Step 4 Download the TAR file to the location previously specified by the cnf-file location command. Each file contains all the
firmware required for all phone types supported by that version of Cisco Unified CME.
With the locale installer, you do not need to perform manual configuration. Instead, you copy the locale file using the
copy command in privileged EXEC configuration mode.
Note You must copy the locale file into the /its directory (flash:/its or slot0:/its) when you store the locale files on
the Cisco Unified CME router.
a) If the cnf-file location is flash memory: Copy the TAR file to the flash:/its directory.
Example:
For example,
Router# copy tftp://12.1.1.100/CME-locale-de_DE-German-8.6.3.0.tar flash:/its
b) If the cnf-file location is slot0: Copy the TAR file to the slot0:/its directory.
c) If the cnf-file location is tftp: Create a folder in the root directory of the TFTP server for each locale using the following
format and then copy the TAR file to the TFTP-Root folder.
Example:
TFTP-Root/TAR-filename
For system-defined locales, use the locale folder name as shown in Table 9: System-Defined and User-Defined
Locales , on page 24. For example, create the folder for system-defined German as follows:
TFTP-Root/de_DE-8.6.3.0.tar
Localization Support
23
Localization Support
Use the Locale Installer in Cisco Unified CME 9.0 and Later Versions
For up to five user-defined locales, use the User_Define_n folder name as shown in Table 9: System-Defined and
User-Defined Locales , on page 24. A user-defined locale is a language other than the system-defined locales that
are predefined in Cisco IOS software. For example, create the folder for user-defined locale Chinese (User_Define_1)
as follows:
TFTP-Root/CME-locale-zh_CN-Chinese-8.6.3.0.tar
Note For a list of user-defined languages supported in Cisco Unified CME, see Cisco Unified CME Localization
Matrix.
English English_United_States US
English_United_Kingdom UK
CA
Danish Danish_Denmark DK
Dutch Dutch_Netherlands NL
French French_France FR
CA
German German_Germany DE
AT
CH
Italian Italian_Italy IT
Japanese Japanese_Japan JP
Norwegian Norwegian_Norway NO
Portuguese Portuguese_Portugal PT
Russian Russian_Russia RU
Spanish Spanish_Spain ES
Swedish Swedish_Sweden SE
Step 5 Use the user-locale [user-locale-tag] {[user-defined-code]country-code} [load TAR-filename] command in voice register
global configuration mode to extract the contents of the TAR file. For country codes, see Table 9: System-Defined and
User-Defined Locales , on page 24.
Localization Support
24
Localization Support
Configure Multiple Locales on SIP Phones
Note Use the complete filename, including the file suffix (.tar), when you configure the user-locale command for
all Cisco Unified SIP IP phone types.
Example:
For example, to extract the contents of the CME-locale-zh_CN-Chinese-8.6.3.0.tar file when U1 is the country code for
user-defined locale Chinese (User_Define_1), use this command:
Router(config-register-global)# user-locale U1 load CME-locale-zh_CN-Chinese-8.6.3.0.tar
Step 6 Assign the locales to the phones. See Configure Multiple Locales on SIP Phones, on page 25.
Step 7 Use the create profile command in voice register global configuration mode to generate the configuration profile files
required for Cisco Unified SIP IP phones.
Step 8 Use the reset command to reset the phones and see the localized displays.
Restriction • Multiple user and network locales are supported only on Cisco Unified IP Phone 8961, 9951, and 9971.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. user-locale [user-locale-tag] {[user-defined-code] country-code}
5. network-locale network-locale-tag [user-defined-code] country-code
6. create profile
7. exit
8. voice register template template-tag
9. user-locale user-locale-tag
10. network-locale network-locale-tag
11. exit
Localization Support
25
Localization Support
Configure Multiple Locales on SIP Phones
DETAILED STEPS
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Example:
Cisco Unified CME.
Router(config)#voice register global
Step 5 network-locale network-locale-tag [user-defined-code] Specifies a country for tones and cadences.
country-code
• network-locale-tag—Assigns a locale identifier to
Example: the country code. Range is 0 to 4. Default: 0. This
Router(config-register-global)# network-locale 1 argument is required when defining some locale other
FR than the default (0).
• country-code—Type ? to display a list of
system-defined codes. Default: US (United States).
You can assign any valid ISO 3166 code to a
user-defined code (U1 to U5).
Step 6 create profile Generates provisioning files required for SIP phones and
writes the file to the location specified with the tftp-path
Example:
command.
Router(config-register-global)# create profile
Localization Support
26
Localization Support
Configure Multiple Locales on SIP Phones
Step 8 voice register template template-tag Enters voice register template configuration mode to define
a template of common parameters for SIP phones in
Example:
Cisco Unified CME.
Router(config)voice register template 10
• Range— 1 to 10.
Step 12 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for a SIP phone.
Example:
Router(config)#voice register pool 5
Step 13 voice register template template-tag Enters voice register template configuration mode to define
a template of common parameters for SIP phones in
Example:
Cisco Unified CME.
Router(config)voice register template 10
• Range— 1 to 10.
Step 15 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Example:
Cisco Unified CME.
Router(config)#voice register global
Localization Support
27
Localization Support
Verify Multiple Locales on SIP Phones
Step 1 Use the show voice register tftp-bind command to display a list of configuration files that are accessible to IP phones
using TFTP, including the dictionary, language, and tone configuration files.
Example:
Router#sh voice register tftp-bind
tftp-server syncinfo.xml url system:/cme/sipphone/syncinfo.xml
tftp-server SIPDefault.cnf url system:/cme/sipphone/SIPDefault.cnf
tftp-server softkeyDefault_kpml.xml url system:/cme/sipphone/softkeyDefault_kpml
.xml
tftp-server softkeyDefault.xml url system:/cme/sipphone/softkeyDefault.xml
tftp-server softkey2_kpml.xml url system:/cme/sipphone/softkey2_kpml.xml
tftp-server softkey2.xml url system:/cme/sipphone/softkey2.xml
tftp-server featurePolicyDefault.xml url system:/cme/sipphone/featurePolicyDefau
lt.xml
tftp-server featurePolicy2.xml url system:/cme/sipphone/featurePolicy2.xml
tftp-server SEPACA016FDC1BD.cnf.xml url system:/cme/sipphone/SEPACA016FDC1BD.cnf
.xml
Step 2 Use the show voice register template all command to check the user locale and network locale settings in each ephone
template.
Step 3 Use the show voice register pool all command to check that the correct templates are applied to phones.
Step 4 If the configuration file location is not TFTP, use the debug tftp events command to see which files Cisco Unified CME
is looking for and whether the files are found and opened correctly. There are usually three states (“looking for x file,”
“opened x file,” and “finished x file”). The file is found when all three states are displayed. For an external TFTP server,
you can use the logs from the TFTP server.
Localization Support
28
Localization Support
Example for Configuring Multiple User and Network Locales
After using the previous commands to define Germany as the default user and network locale, use the following
commands to return the default value of 0 to US:
telephony service
no user-locale 0 DE
no network-locale 0 DE
Another way to define Germany as the default user and network locale is to use the following commands:
telephony service
cnf-file location flash:
cnf-file perphone
user-locale DE
network-locale DE
After using the previous commands, use the following commands to return the default to US:
telephony service
no user-locale DE
no network-locale DE
The following example defines three alternative locales: JP (Japan), FR (France), and ES (Spain). The default
is US for all phones that do not have an alternative applied using ephone templates. In this example, ephone
11 uses JP for its locales, ephone 12 uses FR, ephone 13 uses ES, and ephone 14 uses the default, US.
telephony-service
cnf-file location flash:
cnf-file perphone
create cnf-files
user-locale 1 JP
user-locale 2 FR
user-locale 3 ES
network-locale 1 JP
network-locale 2 FR
network-locale 3 ES
create cnf-files
ephone-template 1
user-locale 1
network-locale 1
ephone-template 2
user-locale 2
network-locale 2
ephone-template 3
user-locale 3
network-locale 3
ephone 11
button 1:25
ephone-template 1
ephone 12
button 1:26
ephone-template 2
ephone 13
button 1:27
ephone-template 3
ephone 14
button 1:28
Localization Support
29
Localization Support
Example for Configuring User-Defined Locales
ephone-template 2
user-locale 1
network-locale 1
ephone 11
button 1:25
ephone-template 2
ephone 12
button 1:26
Processing file:flash:/its/user_define_1_tags_file
Processing file:flash:/its/user_define_1_utf8_tags_file
Localization Support
30
Localization Support
Example for Configuring Swedish as the System-Defined Locale
Localization Support
31
Localization Support
User-Defined Locale is Default Language to be Applied to All Phones
Processing file:flash:/its/user_define_2_tags_file
Processing file:flash:/its/user_define_2_utf8_tags_file
Localization Support
32
Localization Support
Examples for Configuring Multiple User and Network Locales on SIP Phones
Processing file:flash:/its/user_define_2_tags_file
Processing file:flash:/its/user_define_2_utf8_tags_file
Router(config-telephony)# ephone-template 1
Router(config-ephone-template)# user-locale 2
Router(config-ephone-template)# ephone 1
Router(config-ephone)# ephone-template 1
The ephone template tag has been changed under this ephone, please restart or reset ephone
to take effect.
Router(config-ephone)# telephony-service
Router(config-telephony)# create cnf-files
Router(config-telephony)# ephone 1
Router(config-ephone)# reset
Examples for Configuring Multiple User and Network Locales on SIP Phones
The following example sets the default locale of 0 to Germany, which defines Germany as the default user
and network locale. Germany is used for all phones unless you apply a different locale to individual phones
using ephone templates.
voice register global
user-locale 0 DE
network-locale 0 DE
After using the previous commands to define Germany as the default user and network locale, use the following
commands to return the default value of 0 to US:
voice register global
no user-locale 0 DE
no network-locale 0 DE
Another way to define Germany as the default user and network locale is to use the following commands:
voice register global
user-locale DE
network-locale DE
After using the previous commands, use the following commands to return the default to US:
Localization Support
33
Localization Support
Example for Configuring Locale Installer on SIP Phones
Localization Support
34
Localization Support
Where to Go Next
Where to Go Next
Ephone Templates
For more information about ephone templates, see Templates.
Localization Enhancements for 10.5 Cisco Unified CME 10.5 provides support for additional
Cisco Unified SIP IP Phones languages.
Localization Enhancements for 9.0 Provides the following enhanced localization support
Cisco Unified SIP IP Phones for Cisco Unified SIP IP phones:
• Localization support for Cisco Unified 6941 and
6945 SIP IP Phones.
• Locale installer that supports a single procedure for
all Cisco Unified SIP IP phones.
Localization Enhancement 8.8 Adds localization support for Cisco Unified 3905 SIP
and Cisco Unified 6945, 8941, and 8945 SCCP IP
Phones.
Localization Support
35
Localization Support
Feature Information for Localization Support
Cisco Unified CME Usability 7.0(1) • Locale installer that supports a single procedure for
Enhancement all SCCP IP phones.
• Parses firmware-load text files and automatically
creates the required TFTP aliases for localization.
• Backward compatibility with the configuration
method in Cisco Unified CME 7.0 and earlier
versions.
Multiple Locales 4.0 Multiple user and network locales were introduced.
Localization Support
36