Extending TIBCO EBX® internationalization

Last published : Aug 10, 2026
Related information

Overview of the native EBX® localization

By default, the EBX® built-in user interface is provided in English (en-US) and French (fr-FR).
Localization consists of a formatting policy and a set of message files (resource bundle):
  • For English, localization is provided by a formatting policy and a set of message files with no locale defined,
  • For French, localization is provided by a formatting policy and a set of message files with locale set to "fr".
EBX® provides an option to add locales in order to extend the localization of the user interface and to internationalize the documentation of data models and associated services.

Language packs software

Language packs for TIBCO EBX® and its addons are available from TIBCO eDelivery according to the EBX® release. A language pack can also contain the online help, please see the TIB_ebx-lp_<version>_readme.txt file for more information.
Note:
On each release, there is a certain delay between the GA and the availability of the corresponding pack; in this case, the previous pack can be deployed (but may not cover all messages).

Extending EBX® user interface localization

EBX® supports the localization of its user interface into any compatible language and region.
Note:
Currently, Latin & Cyrillic characters are supported. Locales that use other character sets may be usable, but are not supported.

Adding a new locale

In order to add a new locale, the following steps must be followed:
  • Declare the new locale in the EBX® main configuration file. For example:
    ebx.locales.available=en-US, fr-FR, xx
    • The first locale is always considered the default.
    • The built-in locales, en-US and fr-FR, can be removed if required.
    See Configuring EBX® localization.
  • Package the following files in a jar file (sample name: ebx-lp_<version>_languagepack-xx.jar):
    • A formatting policy file, named com.orchestranetworks.i18n.frontEndFormattingPolicy_xx.xml,
    • A set of localized message files (*\_xx.mxml) in a resource bundle.
    Note:
    The files must be ending with ".mxml".
    A complete template set of files is available here.
  • Deploy the jar file in the EBX® class-path it must be accessible from the ebx.jar class-loader.

Localized resources resolution

Since version 5.7.0, localized resources are resolved on a locale-proximity base, with the following lookup mechanism:
  • resourceName + "\_" + language + "\_" + country + "\_" + variant + ".mxml"
  • resourceName + "\_" + language + "\_" + country + ".mxml"
  • resourceName + "\_" + language + ".mxml"
  • resourceName + ".mxml"
Note:
The resolution is done at the localized message level. It is therefore possible to define one or more files for a locale that only includes messages for which specific localization is required.

Known limitations

Non extendable materials

Localization of the following cannot be extended:
  • EBX® HTML editor and viewer.