Custom locales

eazyBI for Jira eazyBI for Confluence Private eazyBI

Download and Enable the Language

1. In eazyBI Advanced Settings add the code to download the specified language and enable it for language options:

   [locales]
   translators = ['admin_username']
   translator_locales = ['es']

   1. Replace 'admin_username' with the username of eazyBI admin or Jira admin. This user will have the option to download the language.

   2. Replace 'es' with the language code, you are translating. Use a comma-separated list to add other languages if needed. 

2. As an eazyBI admin, click on the user profile icon in the top-right corner (the avatar) and choose "Download custom locales". eazyBI will automatically download and install all available locales listed in advanced settings translator_locales. Some languages are almost finished and missing terms will be replaced with English terms.

3. Any user can select/change the interface language from the top-right profile menu by choosing Languages > "[New Language]". User interface language describes how to list available languages and set the default language. 

4. If you do not find language among the listed, reach out to eazyBI Support for guidance on creating your private localization.
   
   

   Language code	Language
   de	German localization. Available by default.
   en	English localization. Available by default.
   es	Spanish localization.
   fr	French localization. Available by default.
   lt	Lithuanian localization.
   lv	Latvian localization. Available by default.
   pt-BR	Brasilian portugease localization.
   ru	Russian localization.
   zh-CN	Chinese simplified localization.

Add a custom locale to a Jira instance

If you would like to add a custom locale, for example, change the display name for Time dimension members, you can create your own customized locale and upload it to the Jira Data Center on Private eazyBI.

1. Create a directory JIRA_HOME/data/eazybi/custom/locales. In this directory, create a new locale file in YAML format.
   For example, to modify the date for Time dimension members, you may use the following content.

   example.yml

   en:
     locales:
       xx: "US Time"
   
   xx:
     cubes:
       dimensions:
         Time:
           caption: "Time"
           all_member_caption: "All Time"
           Year:
             caption: "Year"
             member_format: "%Y"
           Quarter:
             caption: "Quarter"
             member_format: "Q%{key} %Y"
           Month:
             caption: "Month"
             member_format: "%Y/%m"
           Day:
             caption: "Day"
             member_format: "%m/%d/%Y"
           Weekly:
             caption: "Weekly"
             all_member_caption: "All Time (weekly)"
             Year:
               caption: "Year"
               member_format: "%Y"
             Week:
               caption: "Week"
               member_format: "W%{key}, %Y/%m/%d"
             Day:
               caption: "Day"
               member_format: "%Y/%m/%d"
           Fiscal:
             all_member_caption: "All Fiscal periods"
             caption: "Fiscal"
             Year:
               caption: "Year"
               member_format: "FF%{key}" 
             Quarter:
               caption: "Quarter"
               member_format: "FF%{parent_key} Q%{key}" 
             Month:
               caption: "Month"
               member_format: "FF%Y/%m"
             Day:
               caption: "Day"
               member_format: "%m/%d/%Y" 
           "2 Weeks":
             caption: "Bi-Weekly"
             all_member_caption: "All Time (bi-weekly)"
             Year:
               caption: "Year"
               member_format: "%Y"
           "2 Weeks":
             caption: "Weeks"
             member_format: "W%{key}, %Y/%m/%d"
             Day:
               caption: "Day"
               member_format: "%Y/%m/%d"
   
     date:
       formats:
         default: "%Y-%m-%d"
         long: "%B %d, %Y"
         short: "%b %d %Y"
         month_year: "%B %Y"
         month_year_short: "%b %Y"
         month_day_short: "%b %d"
     time:
       formats:
         default: "%a, %d %b %Y %H:%M:%S %z"
         long: "%B %d, %Y %H:%M:%S"
         short: "%b %d %Y %H:%M:%S"
   
     number:
       format:
         delimiter: ","
         precision: 2
         separator: "."
         significant: false
         strip_insignificant_zeros: false

2. When creating new or edition existing locale file make sure:
   1. YAML format is indentation sensitive. Do not break the indentation hierarchy as then a file will fail to load.
   2. When specifying member_format then you can use the placeholders as described in Ruby strftime documentation http://apidock.com/ruby/DateTime/strftime
   3. You can name the file as you want but keep the file extension as .yml – all localization files with yml extension from JIRA_HOME/data/eazybi/locales will be loaded.
      
      

3. In eazyBI advanced settings, specify the locale name, which matches the file content (en: locales: xx:)

   [locales]
   default_locale = "en"
   available_locales = ["en", "xx"]

   We do not recommend changing existing default locale (en).
   
   

4. If you have Jira and eazyBI already running then disable and then enable eazyBI app from Jira administration / Manage Add-ons to ensure that the localisation file is loaded.

After these steps, you should be able to select the localization from the top right user menu drop-down. Please see also the advanced settings page how to change the default locale.