The language used in NetHelpDesk for Key terms, field names and on the web interface can be customised. This can allow the names of key entities to be changed to something more appropriate for your organisation, and to allow the application to be translated into other languages entirely.
In order to use this feature and for this guide to be relevant, the following criteria will need to be met.
A. Your NetHelpDesk instance will need to be on version 10.98 or later.
i. To check this, go to N > Help > About NetHelpDesk.
ii. To upgrade, go to N > Help > Show Release Details.
B. You will need to have the NetHelpDesk Web Portal configured for use. If you have not done this already, a guide to setting this up can be found at www.nethelpdesk.com/guides/installweb/.
Here are a few terms which are commonly used in this guide and in the application:
Language Pack – This is the phrase given to a Language in NHD. Each pack contains a name, a flag and a set of translations.
Translation – When a phrase is customised in a Language Pack.
Custom Translation – A custom string used in customised content that can be translated.
Language Code – A unique identifier for the Language Pack, eg. EN-UK for English (United Kingdom)
Language information and settings in NetHelpDesk are stored in a Language Pack.
NetHelpDesk comes with our own pre-configured Language Packs, which will be installed into your instance of NetHelpDesk whenever a database upgrade takes place. In addition to this, you can customise our language packs to change the terminology, and create your own language packs. If a phrase has been customised, it will not be updated automatically again in future.
The default Language Packs is English (United Kingdom).
Every term that can be customised has a default value called the System Value. If a phrase in the currently selected language has no translation, then it will use the translation for the Default Language. If the phrase in the Default Language has no translation, then it will use the System value.
Language packs can be imported from a Language Pack file, and they can be exported. If a Language Packs translations are incomplete, or incorrect, or you have a new Language Pack that isn’t available by default, feel free to Export pack and send it to us, and we will support it. Click Contact in the main menu.
The Language settings can be found within N > Setup > Main Configuration > Language.
Here you will see a screen which lists the currently installed Language Packs, and has settings for Language.
A This table shows the currently installed language packs. The Language column shows the name of the Language, and the code column is its unique identifier. Double clicking on a Language Pack will allow you to customise it. NetHelpDesk comes with a number of Language Packs already installed.
B. The “Active” setting determines whether the Language Pack is in use when using Multiple Languages (5)
C. The “Default” column shows the current Default Language. Ticking another language will change the default language. Note that after changing the default language users may need to log out and back in for the changes to take effect.
D. Click this button to create a new custom Language Pack.
E. If enabled, this setting enables language selection on the Web Portal, otherwise just the default language will be used.
F. Configure Custom Translations. (Covered in Section 6)
Double clicking on a Language Pack in the grid in 4.1.A will open the Edit Language Pack screen.
A. This is the Full name of the Language Pack
B. This is the Language Code, which is a unique identifier. It can only been edited when creating a new Language Pack
C. This is the flag to represent the Language Pack, and is shown when selecting a Language on the Web Portal. Double-clicking here will allow you add or change the Flag. The flag is saved in the NetHelpDesk\Web\Images\Languages folder so must be accessible from the application. If it is not then pasting the image in this folder will also work. The image should be 24 x 24 pixels and must be in PNG format.
D. The Active setting – See 4.1.B.
E. This will take you to the edit translations screen – see below.
F. This will allow you to load a Language Pack from a file. The Codes of the selected Language Pack in the file structure and the current Language Pack must match if it is an existing Language Pack.
G. Export Language Pack to file. This can be used to send your customisations to us to support in future releases.
H. Delete the Language pack – can only be done for custom Language Packs.
Selecting the View/Edit Translations button will take you to a screen where you can edit the translations for the currently selected Language Pack.
A. Each tab represents a different group of Translations. See below (* represents that the group of translations is custom only - these will not be populated by default for system language packs).
Key Terms – Core (commonly used) terms.
Field Labels – the labels for all request related fields
Custom Field Labels* – The labels for Custom Fields
Field Hints* – The hints for request related fields
Custom Field Hints* – The hints for Custom Fields
Miscellaneous Terms – Terms which are used throughout the applications.
Phrases – Words and Phrases used mainly on the web portal.
Custom Translation* – Your own translations.
B. (Read-only) A list of the phrases you are translating. If no translation is entered in 3, then whatever is in here will be used for the selected Language Pack. Hover over the row to see a Hint.
C. The Translations for the language pack. Enter the Translation for the corresponding phrase from 2. Note that after changing or adding a translation users may need to log out and back in for some translations to take effect.
D. Where $# appears, it is using another translation to form this one. In this example $#Request Types will be Ticket Types.
If “Use multiple Languages” is enabled (4.1) (5) then End users and Technicians will be given the option to select their Language on the web portal. This can be done in a number of ways.
The log in screen for Users and Technicians will now show a drop-down containing all active languages. The Language that is selected will be used upon logging in.
After logging in the language selection will be saved as a cookie for use in the future.
Once logged in, it is possible to show a nav bar option for language selection. The flag of the currently selected language will show, and when hovered over it will show a dropdown to change language.
This can added to the loggedin.html and loggedintech.html files (if it does not appear already) by adding $NAVBARLANGUAGESELECTOR to the navbar html.
Adding a parameter to the link can also change the language.
Add the parameter “lang” with the value as the language code of the desired language.
In this example, English (US) will be loaded.
There are a few more settings that can enrich your utilisation of this feature.
When adding a new language pack, you will be asked if you want to base this is off of another Language Pack. Doing so will link the new Language pack to the template.
This means that whenever a phrase is updated on the Template, it will also update the Linked Language Packs as long as that phrase hasn’t been customised in the Linked Language Pack.
For example, the system English (US) pack is linked to the English (UK) pack. Whenever a translation is added to English (UK), it will be added to English (US).
Custom Translations are an advanced setting to add additional translatable content to the web portal. They work by setting up a string to be translated and the web portal searches for this string with “$#” in front of it. If it found it will be converted to the currently selected languages translation.
To add/edit/delete a custom translation, select option 6 from 4.1.
A. This is the string to translate. In this example, wherever $#customtranslation1 appears, it will be translated.
B. The Hint for the translation.
C. The default value if no translations are entered for the currently selected language.
Now on the translations page, on the custom translations tab, the new custom translation will show.
Now we can add the translation variable to wherever we want it. In this example it will be added to the bottom of the loggedin.html page.
Should you have any questions regarding any steps in this guide, please speak with the NetHelpDesk Support Team.
NetHelpDesk is available on a range of devices with industry-leading functionality available throughout.