...
What You Can Translate
When you need to deploy a PhixFlow application across sites in different countries, you can configure PhixFlow to use the locale to translate the application interface.
Translatable strings are set up using the translate() function?. You can use this function on:
- Labels and Static Text in forms, buttons, tab headers and other areas
- Grid Column Headings including groupings
- Menu Items in grid headers
You cannot configure translation on:
...
some text in the application to be displayed in a different language.
| Translatable PhixFlow property containing the source text | Where the text appears in the application |
|---|---|
Menu → Name | The menu name appears an option in a menu.* |
| Menu item → Name | The menu item name appears as a sub-menu option.* |
| Action → Basic Settings → Display Name | Exception - see below. |
| Layout component (any) → Description → Tooltip | For any layout component, when the user hovers their mouse pointer over the component, PhixFlow displays the tooltip text. |
| Layout component for static text → Display Text | Static text appears:
|
| Stream view attribute → Grid Settings → Label or if there is no label → Basic settings → Name | This text appears in a layout or dashboard that displays data:
|
| An expression defined with the translate() function, for example: Action → Basic settings → In Progress Message | The expression appears as a message, which notifies the user of the progress or completion of an action. |
- Known issue: when a user first logs into the application . However, when the page is reloadedthe menus are translated. If the user subsequently reloads the application, the menu options will revert to the source language.
- Action Display Names which are displayed in the tooltips for an attribute action on a grid.
- Data in grids or forms, including any dynamic text that displays values from data.
PhixFlow cannot translate:
- PhixFlow messages.
- Stream attributes in analysis models.
- The data in the stream.
- Layout component dynamic text, because this displays data from the stream.
- Grid view → Basic Settings → Name. This appears as the title of the grid when it appears in a layout or dashboard.
- In a grid view → attribute action → tooltip: if this includes the action display name, it is not translated.
- Number formats. Error messages generated by PhixFlow.
What PhixFlow Does to Translate Text
Translation works as follows:
- You have defined strings The user opens your application
- PhixFlow checks the user's locale.
- For the source text in any translatable fields in the application as translatable, using the translate() function.
- The user accesses a data view, dashboard or layout that contains a translatable string.
- PhixFlow checks the user locale to identify the language the user requires.
- PhixFlow looks in the translation table and displays a translation of the label if it finds:
- a string that exactly matches the translatable string
- in the language the user requires.
| Tip |
|---|
Remember, everything (except users) needs to be created within the application's repository. |
...
- interface, PhixFlow checks in the translation table.
- PhixFlow finds entry code text that exactly matches the text in the interface.
- PhixFlow matches the user's locale language to one of the translation cells.
- PhixFlow displays the translation text for that language instead of the source text.
PhixFlow displays the source text if it cannot find any translation. This may be because:
- no translation text is defined
- the language is not present in the translation table
- the exactly matching text is not present as an entry code
- no translation table has been set up for the application.
How to Configure Translation
Set up Languages and Locales
PhixFlow is supplied with a set of languages. These populate the drop-down lists in locales and in the translation table. If you have administration privileges, you can add more languages in the repository. You cannot add languages to applications.
| Tip |
|---|
You may intend to move an application to different PhixFlow instances. For example it is common to design and configure applications in a development instance. When it is complete the application is moved (exported/imported) to a production instance. Any languages and locales that you want to use in the |
If the language you need is not already listed in the Translation table, add the language to the Full Repository. You cannot set up specific languages for the application.
...