Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager, Release 9.1(1)
Multilingual support configuration for IM and Presence
Download this chapter
Multilingual support configuration for IM and PresenceMultilingual support configuration for IM and Presence
Download the complete book
Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager, Release 9.1(1)Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager, Release 9.1(1) (PDF - 6 MB)
 Feedback

Multilingual support configuration for IM and Presence

If you want to expand your IM and Presence deployment to support multiple languages, you must configure Cisco Unified Communications Manager and IM and Presence to support the user locales that you require. There is no limit to the number of supported languages.

Install Locale installer on Cisco Unified Communications Manager

User locale files provide translated text for user applications and user web pages in the locale that the user chooses. User locales are country-specific. Use the following procedure to install locales on the server. Optionally, you can follow the software upgrade procedure to install locale files from either a local or a remote source.

Before You Begin
  • Install Cisco Unified Communications Manager on every server in the cluster before you install the Cisco Unified Communications Manager Locale Installer.
  • If you want to use a locale other than English, you must install the appropriate language installers on both Cisco Unified Communications Manager and on IM and Presence. Ensure the locale installer is installed on every server in the cluster (install on the Publisher server before the Subscriber servers).
  • User locales should not be set until all appropriate locale installers are loaded on both systems. Users may experience problems if they inadvertently set their user locale after the locale installer is loaded on Cisco Unified Communications Manager but before the locale installer is loaded on IM and Presence. If issues are reported, we recommend that you notify each user to sign into Cisco Unified Communications Manager user options pages and change their locale from the current setting to English and then back again to the appropriate language. You can also use the BAT tool to synchronize user locales to the appropriate language.
  • You must restart the servers 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.
Procedure
    Step 1   Download the locale installer from www.cisco.com.
    Step 2   Click the version of the Cisco Unified Communications Manager Locale Installer.
    Step 3   Click Download to download the installer file to the server.
    Step 4   After downloading the file, save the file to the hard drive and note the location of the saved file.
    Step 5   Double-click the file to begin the installation.
    Step 6   Perform these actions to complete the installation:
    1. Read and accept the license agreement, and then click Next to display the Readme Notes window.
      Note   

      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.

    2. Examine and accept the readme notes, and then click Next. The Setup Type window appears.
    3. Select a custom setup type in the Setup Type window to allow you to select or deselect user locales as required, and then click Next.. The Start Copying Files window appears.
    4. Review the setup options, and then click Next.. The Ready to Install the Program window appears.
    1. Click Install to start the installation of the selected user locales.
      Note   

      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 7   When the installation is complete, a new dialog requests confirmation of a restart. Should you wish to apply another locale installer, repeat this procedure before restarting the server in order to reduce downtime.
    Step 8   Click Finish. The Setup dialog box displays. Do not click any buttons or press any keys.
    Step 9   When the Setup dialog box automatically closes, you have completed the installation on the server. Install the Cisco Unified Communications Manager Locale Installer on every server in the cluster.
    Step 10   After you complete all locale installation procedures, perform these actions:
    1. Run the following command on the CLI: run sql update enduser set cucm_cdrtime=0
    2. Restart the Sync Agent service in Cisco Unified Serviceability (select Tools > Service Activation).
    3. Restart each server in the cluster.
    Step 11   Verify that your users can select the locale(s) for supported products.

    Troubleshooting Tip

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

    What to Do Next

    Install Locale installer on IM and Presence

    Install Locale installer on IM and Presence

    Before You Begin
    • Install the Locale Installer on Cisco Unified Communications Manager. If you want to use a locale other than English, you must install the appropriate language installers on both Cisco Unified Communications Manager and on IM and Presence.
    • If your IM and Presence cluster has more than one node, make sure that the locale installer is installed on every server in the cluster (install on the Publisher server before the Subscriber servers).
    • User locales should not be set until all appropriate locale installers are loaded on both systems. Users may experience problems if they inadvertently set their user locale after the locale installer is loaded on Cisco Unified Communications Manager but before the locale installer is loaded on IM and Presence. If issues are reported, we recommend that you notify each user to sign into Cisco Unified Communications Manager user options pages and change their locale from the current setting to English and then back again to the appropriate language. You can also use the BAT tool to synchronize user locales to the appropriate language.
    • You must restart 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.
    Procedure
      Step 1   Locate the IM and Presence locale installer.
      Step 2   Click the version of the IM and Presence Locale Installer that is appropriate for your working environment.
      Step 3   After downloading the file, save the file to the hard drive and note the location of the saved file.
      Step 4   Copy this file to a server that supports SFTP.
      Step 5   Sign into Cisco Unified IM and Presence Operating System Administration using the administrator account and password.
      Step 6   Select Software Upgrades > Install/Upgrade.
      Step 7   Select Remote File System as the software location source.
      Step 8   Enter the file location, for example /tmp, in the Directory field.
      Step 9   Enter the IM and Presence server name in the Server field.
      Step 10   Enter your username and password credentials in the User Name and User Password fields.
      Step 11   Select SFTP for the Transfer Protocol.
      Step 12   Click Next.
      Step 13   Select the IM and Presence locale installer from the list of search results.
      Step 14   Click Next to load the installer file and validate it.
      Step 15   After you complete the locale installation, restart each server in the cluster.
      Step 16   The default setting for installed locales is "English, United States”. While your IM and Presence server is restarting, change the language of your browser, if necessary, to match the locale of the installer that you have downloaded.
      Note   

      IM and Presence does not currently support Safari browser.

      If you use this browser:

      Internet Explorer

      Version 6.x

      1. Select Tools > Internet Options.
      2. Select the General tab.
      3. Click Languages.
      4. Use the Move Up button to move your preferred language to the top of the list.
      5. Click OK.
      If you use this browser:

      Mozilla Firefox

      Version 3.x

      1. Select Tools > Options.
      2. Select the Content tab.
      3. Click Choose in the Languages section of the window.
      4. Use the Move Up button to move your preferred language to the top of the list.
      5. Click OK.
      Step 17   Verify that your users can select the locale(s) for supported products.

      Troubleshooting Tip

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

      Related References

      Error messages

      See the following table for a description of the messages that can occur during Locale Installer activation. If an error occurs, you can view the messages in the installation log.

      Table 1 Locale Installer Messages and Descriptions

      Message

      Description

      [LOCALE] File not found: <language>_<country>_user_locale.csv, the user locale has not been added to the database.

      This error occurs when the system cannot locate the CSV file, which contains user locale information to add to the database, which indicates an error with the build process.

      [LOCALE] File not found: <country>_network_locale.csv, the network locale has not been added to the database.

      This error occurs when the system cannot locate the CSV file, which contains network locale information to add to the database This indicates an error with the build process.

      [LOCALE] CSV file installer installdb is not present or not executable

      You must ensure that an application called installdb is present. It reads information that a CSV file contains and applies it correctly to the target database. If this application is not found, it did not get installed with the Cisco Unified Communications application (very unlikely), has been deleted (more likely), or the server does not have a Cisco Unified Communications application, such as Cisco Unified Communications Manager or IM and Presence, installed (most likely). Installation of the locale will terminate because locales will not work without the correct records in the database.

      [LOCALE] Could not create
      /usr/local/cm/application_locale/cmservices/
      ipma/com/cisco/ipma/client/locales/maDialogs_
      <ll>_<CC>.properties.Checksum.

      [LOCALE] Could not create
      /usr/local/cm/application_locale/cmservices/
      ipma/com/cisco/ipma/client/locales/maMessages_
      <ll>_<CC>.properties.Checksum.

      [LOCALE] Could not create
      /usr/local/cm/application_locale/cmservices/
      ipma/com/cisco/ipma/client/locales/maGlobalUI_
      <ll>_<CC>.properties.Checksum.

      [LOCALE] Could not create
      /usr/local/cm/application_locale/cmservices/
      ipma/LocaleMasterVersion.txt.Checksum.

      These errors could occur when the system fails to
      create a checksum file, which an absent Java executable,
      /usr/local/thirdparty/java/j2sdk/jre/bin/java, an absent or damaged Java
      archive file, /usr/local/cm/jar/cmutil.jar, or an absent or damaged Java
      class, com.cisco.ccm.util.Zipper, causes. Even if these errors occur, the
      locale will continue to work correctly, with the exception of Cisco Unified
      Communications Manager Assistant, which can not detect a change in
      localized Cisco Unified Communications Manager Assistant
      files.

      [LOCALE] Could not find
      /usr/local/cm/application_locale/cmservices/
      ipma/LocaleMasterVersion.txt in order to
      update Unified CM Assistant locale information.

      This error occurs when the system does not find the file in the correct location, which is most likely due to an error in the build process.

      [LOCALE] Addition of <locale-installer-file-name> to the database has failed!

      This error occurs because the collective result of any failure that occurs when a locale is being installed causes it; it indicates a terminal condition.

      [LOCALE] Could not locate <locale-installer-file-name>

      The system will not migrate this locale during an upgrade.

      The downloaded locale installer file no longer resides in the download location. The platform may have moved or deleted it. This is noncritical error indicates that after the Cisco Unified Communications application has been upgraded, you need to either reapply the locale installer or download and apply a new locale installer.

      [LOCALE] Could not copy <locale-installer-file-name> to migratory path. This locale will not be migrated during an upgrade!

      You cannot copy the downloaded locale installer file to the migration path. This is noncritical error indicates that after the Cisco Unified Communications application has been upgraded, you need to either reapply the locale installer or download and apply a new locale installer.

      [LOCALE] DRS registration failed

      The locale installer could not register with the Disaster Recovery System. A backup or restore record will not include the locale installer. Record the installation log and contact Cisco TAC.

      [LOCALE] DRS unregistration failed

      The locale installer could not deregister from the Disaster Recovery System. A backup or restore record will not include the locale installer. Record the installation log and contact Cisco TAC.

      [LOCALE] Backup failed!

      The Disaster Recovery System could not create a tarball from the downloaded locale installer files. Re-apply the local installer before attempting to back up.

      Note   

      Manually reinstalling locales after a system restore achieves the same goal.

      [LOCALE] No COP files found in restored tarball!

      Corruption of backup files may prevent successful extraction of locale installer files.

      Note   

      Manual reapplication of the locale installer will restore the locale fully.

      [LOCALE] Failed to successfully reinstall COP files!

      Corruption of backup files may damage locale installer files.

      Note   

      Manual reapplication of the locale installer will restore the locale fully.

      [LOCALE] Failed to build script to reinstall COP files!

      The platform could not dynamically create the script used to reinstall locales.

      Note   

      Manual reapplication of the locale installer will restore the locale fully. Record the installation log and contact TAC.

      Localized applications

      IM and Presence applications support a variety of different languages. See the following table for a list of localized applications and the available languages.

      Table 2 List of Localized Applications and Supported Languages

      Interface

      Supported Languages

      End User Applications

      Cisco Unified CM IM and Presence User Options

      Arabic (Algeria, Bahrain, Egypt, Iraq, Jordan, Kuwait, Lebanon, Morocco, Oman, Qatar, Saudi Arabia, Tunisia, United Arab Emirates, Yemen)

      Bulgarian

      Catalan (Spain)

      Chinese (China, Hong Kong, Taiwan)

      Croatian

      Czech (Czech Republic)

      Danish (Denmark)

      Dutch (Netherlands)

      English

      Estonian (Estonia)

      Finnish (Finland)

      French (France)

      German (Germany)

      Greek (Greece)

      Hebrew (Israel)

      Hungarian (Hungary)

      Italian (Italy)

      Japanese (Japan)

      Korean (Korean Republic)

      Latvian (Latvia)

      Lithuanian (Lithuania)

      Norwegian (Norway)

      Polish (Poland)

      Portuguese (Brazil, Portugal)

      Romanian (Romania)

      Russian (Russian Federation)

      Serbian (Republics of Montenegro and Serbia)

      Slovak (Slovakia)

      Slovenian (Slovenia)

      Spanish (Columbia and Spain)

      Swedish (Sweden)

      Thai (Thailand)

      Turkish (Turkey)

      Administrative Applications

      Cisco Unified CM IM and Presence Administration

      Chinese (China), English, Japanese (Japan), Korean (Korean Republic)

      Cisco Unified IM and Presence Operating System

      Chinese (China), English, Japanese (Japan), Korean (Korean Republic)