Custom locales

On this page:

Lokalise User

At first, you'll need to get an access to Lokalise where additional eazyBI locales are maintained. If you are interested in maintaining an additional eazyBI user interface language then please contact eazyBI support.

Translate

1) Log-into lokalise.co with your email address (access granted by eazyBI on request)
2) Click on the "eazyBI" project name, or on the language name to start translating.

* Please make sure not to delete any variables like %{email} etc.

Download and Enable the Language

1) In eazyBI Advanced Settings add the following code:

[locales]
translators = ['admin']
translator_locales = ['pt-BR']

* Replace 'pt-BR' with the language code you are translating (List of language codes).
This will enable eazyBI administrators to download and set the specified language for eazyBI. (Use comma separated list to add other languages, if needed)


2) As an eazyBI admin:

  1. Click on the user profile icon in the top-right corner (the avatar)
  2. choose "Download localizations"

eazyBI will automatically download and install all available locales listed in advanced settings.


3) Select/change the interface language from the top-right profile menu by choosing Languages > "[New Language]". 

Add a custom locale to a Jira instance

If you would like to add a custom locale to another eazyBI instance then starting from eazyBI 4.2.0 you can use the Download custom locales link as described above.

Another option is to create your own customised locale and upload to the Jira server.

  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 date for Time dimension members, you may use 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"
    
      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"
  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 - all localization files 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.