Customizing Application UI Labels

Pre-Requisite

To deploy customizations to the GridGuard application user interface, ensure that you are on GridGuard version 5.2.9 or higher. If you are on an earlier version, please contact SyferLock Support to obtain the patch to upgrade your server.

Edit appropriate message.properties file

GridGuard first looks in the file /opt/syferlock/gridserver/webapps/gridguard/WEB-INF/classes/i18n/messages.properties to find all the key values. It will then look in the file /etc/syferlock/gridserver/i18n/gridguard/messages_en.properties and if any values are found, will use those values to override the default values. So to change the labels, simply add the labels you want to change to the etc/syferlock/gridserver/i18n/gridguard/messages_en.properties file.

  • Log onto the GridGuard server through SSH as gridadmin
  • cd /etc/syferlock/gridserver/i18n/gridguard/
  • In this directory, you will find a file named 'messages_en.properties'. This file will initially be empty.
  • To override any string literal displayed in the user interface, first determine the key for the label from the file /opt/syferlock/gridserver/webapps/gridguard/WEB-INF/classes/i18n/messages.properties
  • Now, enter the new value in the file /etc/syferlock/gridserver/i18n/gridguard/messages_en.properties. For e.g., to override the value of the string 'Show Password/PIN Rules' string that is displayed during registration to say 'Show PIN Rules', add a string with the following value to the file /etc/syferlock/gridguard/i18n/gridguard/messages_en.properties password.showPasswordRules=Show PIN Rules
  • For internationalization support, simply add a new messages_[locale].properties file in the directory /etc/syferlock/gridguard/i18n/gridguard. For e.g., to add support for Spanish, add a file named message_es.properties, and for Portuguese (Brazil), add a file named messages_pt-BR.properies. When you are add support for a new language, you will need to override every value in the base message.properties file. When adding/modifying values try to keep the length of the string the same as before; this will help with alignment / display.
  • Note: Localization will be driven by the user browser settings. The application will attempt to match the browser setting to the appropriate messags_[locale].properties file. If one cannot be found, the system will default to English language settings.