Video Screencast Help
Search Video Help Close Back
to help
New in the Rewards Catalog: Vouchers for "Symantec Technical Specialist" and "Symantec Certified Specialist" exams.

Localizing Helpdesk Configuration Parameters

Updated: 19 Jun 2007 | 3 comments
John Doyle's picture
0 0 Votes
Login to vote

Field labels and other text in Helpdesk Solution pages and dialogs can be displayed in different languages based on the local setting in the user's browser. The default language is English, and German, French, Spanish, Brazilian Portuguese, Japanese, Simplified Chinese, Russian, Dutch, Danish, Swedish, and Arabic are available. When users with different language settings log in to Helpdesk, the Helpdesk screens appear in the language specified in their browser.

Configuration parameters, such as the Status Code pull down list, queue names, Close Codes, and the like, can also be localized for each language through the use of a CustomStrings.xml file.

Note: Data that is entered into the Helpdesk by users, such as text written into the Comments field of a ticket, is not translated by the system. The data entered by users remain in the language it was entered in.

Localizing Helpdesk Configuration Parameters

To localize configuration strings into different languages, you copy the CustomStrings.xml file into sub-directories for each language using the correct culture names.

Note: Helpdesk uses en-US as its default language. You may want to keep your default custom strings file in US English so there will be no confusion in the browser setting. This technique is the same one that .NET uses and is nice because of the built-in fall back capabilities inherent in the system.

To localize Helpdesk configuration parameters

  1. Create a sub-directory under the custom directory for each language that you wish to support.
  2. Name them using the 2 or 4 letter culture codes.
    The culture names follow the RFC 1766 standard in the format "<languagecode2>-<country/regioncode2>", where <languagecode2> is a lowercase two-letter code derived from ISO 639-1 and <country/regioncode2> is an uppercase two-letter code derived from ISO 3166. For example, U.S. English is "en-US". For a complete list, see the CultureInfo class at http://msdn.microsoft.com.
  3. Copy the localized CustomStrings.xml files into each directory.
  4. Restart IIS.

How Helpdesk Finds the Language to Use

The system tries to find the best language fit possible. A Swiss German CustomStrings.xml should be in the "de-CH" directory. A Germany German CustomStrings.xml file should be in the "de" subdirectory. If the browser settings are set to Swiss German, the "de-CH" subdirectory will be searched first for a match for the string id, then the "de" subdirectory, then the custom directory, then the Helpdesk and AppWeaver resources. In this way, string ids not found in the country or regioncode file will next be searched for in the languagecode file, and, if not found there, searched for in the (default) CustomStrings.xml file in the custom directory and finally in the (localized) Helpdesk resource files.

Adding New Strings

When you create new strings in Helpdesk, you need to add them to a custom resource library and then create versions of this library for each library that you want to support.

For example, let's say you defined a new status called "At home".

To add the new "At home" string

  1. Create a file called CustomStrings.xml file in a folder called custom in the Heldesk\AeXHD folder.
  2. Add the following code to that file:
    <?xml version="1.0" encoding="utf-8" ?>
      <strings>
        <string id="At home">At home</string>
      </strings>
    
    
  3. Now, to add the Spanish version, create a folder called es in the custom folder.
  4. Copy the CustomStrings.xml file to the es folder and change it so that it reads:
    <?xml version="1.0" encoding="utf-8" ?>
      <strings>
        <string id="At home">En casa</string>
      </strings>
    
    

    You can do this for every language you wish to support.

  5. Finally add (or edit if you already have one) a custom.config file to the AeXHD folder which contains the following:
    <?xml version="1.0" encoding="utf-8" ?>
      <custom.configuration>
        <resourceLibs>
          <resourceLib file="CustomStrings.xml" path="~/custom/" appcache="yes"/>
        </resourceLibs>
      </custom.configuration>
    
    

Comments

David Falcon's picture
20
Jun
2007
0 Votes 0
Login to vote

Great article - also have question

hi john. great article. i have a question that adds to what you are doing. when setting up tco, is there a way to take into account local currency? for instance, entering pounds for countries that use pounds vs. dollars for countries that use dollars?

i know it's "far out there", but was just curious.

Lucke's picture
27
Jun
2007
0 Votes 0
Login to vote

Time zone

Hi John. It's great Article and helps me a lot.

I have different countries with different time zones, and this impacts on the SLA. Do you know if there is a way to configure different time zones depending on the browser languages

Thanks!!

Lucke

Steve Wayment's picture
30
Nov
2009
0 Votes 0
Login to vote

This doesn't seem to work for

This doesn't seem to work for me.  When I created an 'es' folder, the Spanish computer still seems to pick up the .xml file in the 'custom' folder instead of the one in the 'custom\es' folder.  I then moved the default .xml file from the 'custom' folder to 'custom\en'.  All English PCs are picking up the file in this location, but Spanish PCs end up showing the 'csid' labels instead of the actual text.  This means it's not looking in the 'es' folder.  But it's not looking in the 'en' folder either, which is partially correct.  I've tried changing the 'es' folder to 'es-MX' because the Spanish PC is using the Mexico language setting, but that didn't help.  The only thing I can think of is that the Spanish PC is using an English OS.  But all of the default Helpdesk strings are coming through in Spanish.  (ie. Ver instead of View.)  Any Ideas?