Configure a New Language

   MaestroThe UI design product.  |   Form Builder |   21.11 This feature was updated in 21.11.

Maestro allows you to translate form's elements into different languages, including right to left languages.

To add a new language:

1. Open a form in the Maestro editor and click Translation.

   

   The Translation windows lists the following details:

   • Property Path -
   • Default Value -
   • Translated Value -
2. Click New Language to configure a new language.



3. Enter a language name in the Label field, for example, German.
4. Enter a language code, which is an identifier for the new language, in the Code field, for example, de.
5. Select the Is this a right to left language checkbox to add a right to left language, for example, Arabic.
6. Click OK to open a window displaying an additional column - Translated Value - which you can use when the German language is selected.



7. Enter translated values of the form's elements into the Translated Value column and click Save.
   Note

   You can use the search functionality to find the Property Path you want to translate. 

8. Click Edit Locale Details to update the name and locale code of the default language.



9. Click Delete to remove the translation for the new language.
   Note

   This option is shown only when a non-default language is selected.

10. Click Download to download the translation in the new language as a CSV file on your local PC.
    Note

    This option is shown only when a non-default language is selected.

11. Click Upload to upload the translation in the new language as a CSV file from your local PC.
    Note

    This option is shown only when a non-default language is selected.

To manage a language:

1. Open a form in the Maestro editor and click Translation on the Toolbar.



The window lists keys for objects within the form, in the Property Path column, that are mapped to labels based on the selected language, the Default Value. The window opens with the default language selected, for example, English.

Note

You are not able to edit the default language in the Translation window, as it is directly derived from the form's component properties.

Note

If you have a component selected when you click Translation, the list is scrolled to the selected Property Path. The scroll position remains as you switch between languages.

2. Select a language from the dropdown list to switch between multiple languages, if more than one language is configured.
3. Type a part of a key name, which are listed in the Property Path column, and click Search to list keys and values based on the search criteria.
4. Click Export to export form's translation as a CSV file.
   Note

   This option is shown only when a new language is added.

5. Click Import to import form's translation as a CSV file.
   Note

   This option is shown only when a new language is added.

Now, when you have set up the new language, you can configure the form with the Select Language component. The message is shown using a Form.showProgress call, for example, Form.showProgress("Loading..."). You can right click the string in the rule and turn it into a translatable key. For the save, cancel and submit calls you can change this value on the root form item and it would also be a translatable key.

Since Maestro 21.11, you have ability to specify the source of a translation CSV so that it can be stored externally to the form. A service or URL can be used to load the translation. This allows users to maintain their translations outside the form without republishing the form to push new translated texts.

You can use the Translation.fetch() function to load the translation for the specified language code. If the translation loads, the interface will refresh with the translation defined by the current locale. If the translation doesn't load, an error will appear in the JavaScript console. A simple way to implement it in a form is to add a button that calls Translation.fetch("myLanguageCode", false, "/web-plugin/resources/mynewCSC.csv").This translates the form based on a translation file that's at an external URL. In this example, it's in a portal resource on the Manager server, but it could be anywhere.

Next, learn how to mark for translation.