Bonita is available in different languages

Bonita is officially released in various languages but is open to more translations from the Community.

Languages available by default

The following languages are officially supported:

  • English (US)

  • French

  • Spanish (Latin America)

  • Japanese

  • Brazilian Portuguese

Officially supported language means that:

  • Translation is performed by Bonitasoft or trusted partners

  • The following Bonita components are translated: Studio, UI Designer and Bonita Applications

Language detection mechanism

Since Bonita 7.11.0, when a user accesses a page of Bonita Applications, the language used to display the page is detected using the following priority order:

  1. locale parameter value in the URL if it is present (E.g.: ?locale=pt_BR)

  2. BOS_Locale cookie value

  3. Web browser preferred language (first locale sent in the request header Accept-Language)

  4. English if none of the previous ones are set and/or supported

When a language different from the one already set in the BOS_Locale cookie is passed in the URL (locale parameter), then the cookie value is reset with this new language. This can be used to force the default language if needed (by simply providing a link to Bonita Applications with the locale parameter).

Select a language in a Bonita application

To select another language, if the application uses the default Bonita layout:

  1. Click on the username or icon in the top right corner of the application header

  2. In the modal window, go to the language section and select a language from the drop-down list

  3. Click on the "Apply" button

  4. Close the modal window

Select language

Select a language in a Custom Application

If the application uses the default Bonita layout, the header is the same as a Bonita Application, so the procedure is the same.
If the layout has been customized, users need to refer to the internally documented procedure.

Add a new language

This part is a legacy way to add a new language and will be reworked in the future.
Instructions below assume that the language you want to add is already available in the Community translation project. If translation is not available see Translate Bonita Runtime for instruction about how to collaborate to a new or ongoing translation.

Instructions below explain how to add a language to the Bonita Runtime. Steps below involve using content created by Bonitasoft community and therefore not officially supported.

Download the language files

  1. Go to Bonita translation project.

  2. Select the language you are interested in.

  3. Make sure you click on the "Toggle Hidden Files" button Toggle hidden files button to see already fully translated files.

  4. Browse the file tree to 2023.1/bonita-web/portal folder.

  5. For each file in the folder: open it and in the File menu click on Download. Each .po/.pot file has a language indicator and a locale indicator. For example, the files for the Brazilian Portuguese language end with pt_BR.po.

  6. For Subscription editions, you also need to get the files from 2023.1/bonita-web-sp/portal folder.

Install the files and configure java

  1. Create a new folder depending on the situation:

    • [TOMCAT_HOME]/server/i18n/

    • [STUDIO_HOME]/workspace/tomcat/server/i18n/

  2. Copy all the .po/.pot files into the new folder just created.

  3. Declare a new JVM property org.bonitasoft.i18n.folder and set the value to the full path to i18n folder:

    • Tomcat on Windows, edit the [TOMCAT_HOME]\setup\tomcat-templates\setenv.bat file: "-Dorg.bonitasoft.i18n.folder=C:\path_to_i18n_folder"

    • Tomcat on Linux, edit the [TOMCAT_HOME]/setup/tomcat-templates/ file: -Dorg.bonitasoft.i18n.folder="/path_to_i18n_folder"

    • Tomcat embedded in Bonita Studio edit the appropriate .ini file and use the following syntax: -Dtomcat.extra.params="-Dorg.bonitasoft.i18n.folder=C:\path\to_i18n_folder"

      • Windows 64bit: [STUDIO_HOME]/BonitaStudioSubscription64.ini

      • Linux 64bit: [STUDIO_HOME]/BonitaStudioSubscription64-linux.ini

      • etc.

  4. Restart your application server (or Click on Server in the Bonita Studio menu bar, click on Restart Web Server).

  5. Check that the new language is listed in the available languages of the Bonita layout.

Translate Bonita Runtime

  1. Go to Bonita translation project hosted on Crowdin and check if the language you want to contribute to is already listed. If it’s not, please request it by submitting an issue on our community issue tracker.

If the language you want to contribute to is already listed:

  1. If you don’t already have one, create a Crowdin account.

  2. On the Bonita translation project page click on the language you want to translate.

  3. At the top of the page, click on the "Join" button.

  4. Wait for us to validate your request to join the project.

  5. Navigate to the .po/.pot files in the portal folder (see information in the Add a new language section above).

  6. Click on a file to begin the translation. You can then use the filter missing translation to only display the strings to be translated.