Submit a ticketCall us

WebinarWebinar: A checklist for planning your Network Performance Monitor (NPM) upgrade

Are you ready for your next upgrade? To help you plan smoothly, join this webcast to learn more about, SolarWinds® Orion® Installer, SolarWinds Upgrade Advisor, Upgrades Guides, Training Videos, and other resources available. We’ll share key upgrade planning considerations, lessons learned from customers with practical advice from SolarWinds Product Experts. We’ll also give practical tips to identify the estimated time needed and resources, how to prepare the business and IT staff for changes, ways to plan for required system changes, and more.

Register now.

Home > Success Center > Web Help Desk (WHD) > WHD - Knowledgebase Articles > Customize the Web Help Desk GUI language and labels

Customize the Web Help Desk GUI language and labels

 

Updated November 10, 2017

Overview

This article describes how to customize the Web Help Desk GUI language and labels.

Environment

All WHD versions

Steps

  1. Navigate to your Web Help Desk home directory.
    Apple® macOS®/Library/WebHelpDesk    
    Microsoft® Windows®:  \Program Files\WebHelpDesk    
    Linux:  /usr/local/webhelpdesk
  2. Navigate to /conf/labels and open the Labels.properties file in a text editor (such as Notepad++). 

    This is the default labels file that contains all default labels used by the application. Do not edit this file. View the contents and locate the labels you need to change.

  3. In the /labels directory, create a custom labels file named CustomLabels.properties.txt.

    This file will only include the labels you need to change. The application will use the default labels for any value not found in the CustomLabels.properties file.

  4. Copy the label entries you need to change from the Labels.properties file to the CustomLabels.properties.txt file. 
    For example, to change the label for Ticket to read Job, enter lbl.ticket=Job in the CustomLabels.properties.txt file. 

    If you cannot find the label in the Labels.properties file, you cannot modify the label.

  5. Rename the CustomLabels.properties.txt file to CustomLabels.properties, removing the .txt extension. 

Supporting additional languages

You can create additional CustomLabels.properties files for specific locales by prefixing .properties with a language and country code as specified by ISO 639 and 3166. For example, to define custom labels for Spanish clients, create a file named CustomLables_es.properties in the /labels directory and add your custom label definitions. 

To define label specifically for Mexican Spanish, name the file CustomLabels_es_MX.properties

Web Help Desk queries the files starting with the most specific match. For example, if a Spain client submits a request, the application will access the following files in order until it can define the label:

  • CustomLabels_es_ES.properties
  • CustomLabels_es.properties
  • CustomLabels.properties
  • Labels.properties

For complete listings of ISO 369 and 3166 language and country codes, see:

 

Oracle Java requires properties files to be in Latin-1 or escaped Unicode format, where Unicode characters are represented by Unicode escape sequences. You can use the native2ascii Java tool to convert native-encoded files to to this format. This tool is located at <WebHelpDesk>/bin/native2asciiAdditionally, UTF-8 encoding does not use Unicode escape sequences. Use the native2ascii tool convert UTF-8 encoded files. 

Java tool syntax

The native2ascii tool uses the following syntax: 

native2ascii -encoding "<encoding_name>" [input_file] [output_file]</encoding_name

For example, to convert a file encoded in Shift-JIS to escaped Unicode, execute the following command:

native2ascii -encoding "SJIS" CustomLabels_ja.properties.orig CustomLabels_ja.properties

See native2ascii - Native-to-ASCI Converter ascii on the Oracle website for a list of supported encoding and instructions on using the native2ascii tool. (© 2017 Oracle Corporation, available at http://www.oracle.com, obtained on November 11, 2017)

 

Disclaimer: Please note, any content posted herein is provided as a suggestion or recommendation to you for your internal use. This is not part of the SolarWinds software or documentation that you purchased from SolarWinds, and the information set forth herein may come from third parties. Your organization should internally review and assess to what extent, if any, such custom scripts or recommendations will be incorporated into your environment.  You elect to use third party content at your own risk, and you will be solely responsible for the incorporation of the same, if any.

 

Last modified

Tags

Classifications

Public