Exporting Languages into Excel for Translation

To translate multiple types of Configuration Items (e.g. Forms, List Views, Menus), please follow the process below.

  • To translate just Forms (field labels, validation messages, tooltips etc.), you can use the GUI which is part of the Form Designer. More details here.
  • To translate Questionnaire Templates, you can use the GUI in the Questionnaire Templates form. More details here.
  • To translate Walkthrough Templates, you can use the GUI in the Walkthrough Designer form. More details here.

The first step for the actual translation process is to export the translation file (Excel format). This export process is always done in language "pairs" - one language is the Source for the translation; the other is the Target language.

Export Localisation by Menu

Export Localisation by Menu is an interface that lets administrators export translation keys by workspace menu.

Administrators can choose source and target languages, optionally auto translate untranslated entries, and either export the entire menu or specific menus within the full workspace menu hierarchy.

The export localisation by menu has a menu crawler which crawls through the menus and will export all related items such as the list views, forms, components, fields and all elements for the related subforms.

The menu names, system resources, my settings, questionnaire templates and walkthrough templates are automatically included with each export.

How It Works
  • From the menu, select Designer Menu path separator Languages Menu path separator Export Localisation by Menu
  • Select the Source Language and the Target Language(s).
  • Select a specific workspace menu from the workspace menu selection list OR select "Export All".
  • If the database has been previously translated and since that time new fields or items have been added, then select Export untranslated entries only. This will reduce the list to only show the items which need translating.
  • Auto Translate: This option uses the Google Translate API Key (defined in Global Settings) to automatically translate the entries. If a translation already exists, the system will skip the API call, and the exported file will simply include the existing published translation.
    Note: If an incorrect API key is entered or translations are not enabled for that API key, the "Translated Language" column will have blank entries.
  • Click on Run

The system will prepare the file in a background process. Once ready, the user will receive a Notification in the browser, and they can initiate the download by clicking on the Notification.

note_awesome

Multiple Target Languages

  • If you select more than one target language, the system generates a separate file for each language. Each file will appear as its own system notification.

Downloading Export Files

  • Clicking the notification will automatically download the corresponding file. This action also marks the notification as read, and it will no longer be visible after you reload or log back in.

Usage of Auto Translate and Export All

  • Auto Translate relies on the Google Translation API and can incur heavy usage when run frequently along with the "Export All" option. To avoid repeatedly triggering translations, always keep a copy of your translated files and import them into the system when ready.

Dashboards, Calendars and BI Parameters

  • Translations for Dashboards, Calendars and BI Parameters will need to be done from the "Export Localisation" interface.

note_awesome

Use of Google API for Translations

Translations utilising the Google API key will incur a usage-based cost and should only be performed when necessary.

Export Localisation

  • From the menu, select Designer Menu path separator Languages Menu path separator Export Localization
  • Select the Source Language, and the Translated Language.
  • If the database has been previously translated and since that time new fields or items have been added, then select Export untranslated entries only. This will reduce the list to only show the items which need translating.

note_awesome

"Untranslated" refers to items which have no associated translation for that language. If you have CHANGED for example the label in your Base Language, and you intend to reflect this change in other languages, then you will have to export ALL entries, because our system cannot detect CHANGES to labels.

  • Configuration Items

    The configuration items are labels/texts which have been configured via the Designer.

    • Forms, which will export the following Details:
      • Field Labels
      • Tool Tips
      • Items of all the lookups which are used in the Form
      • Validation Messages
      • Messages defined for "Set Value Actions" used in the Form

        NOTE:
        Forms can also be translated using the in-line translation feature within the Form Designer.
    • List Views, which will contain
      • The Name of the List View
      • The Name of each Column of the View
    • Tree Views
      • The Name of the View
    • Visualizations
      • Information in the left-hand panel when building the Visualization, such as the chart type, Measures and Groups
    • Dashboards
      • Name of the Dashboard
      • Label for each Pane on the Dashboard
      • Link Names
    • Calendars
      • Calendar Title
      • Month/Week/Day/List
      • Dates will be shown in the format of the user's locality
      • Left Hand Filter Panel and the statuses
    • Components
      • Component Name
      • Names of fields and Attributes
    • Menus
      • Menu Titles
    • BI Parameters
      • The BI Report Parameters (parameter field labels)
    • Questionnaires
      • All information in enabled questionnaire templates
      • Questionnaire Templates can also be translated via the GUI
    • Walkthroughs
      • All information in enabled Walkthrough templates
      • Walkthrough Templates can also be translated via the GUI

  • Static Items

    "Static" items cannot be manipulated via configuration.
    Static items are only changed by new software releases, for example when new functionality is being introduced.

    • System Resources
      These are the System Entries which need to be translated to give the "typical" End User a fully internationalized experience. Examples for these are:
      • Labels for ALL the buttons a User can click on, e.g. SAVE, CANCEL, LOGIN, LOGOUT etc.
      • System generated messages which inform the user about processes in the Web Application, for example
        - "User 'John.Smith' has logged in successfully", or
        - "An Email has been sent to ..."
      • Admin Forms for the End User, such as "My Preferences" or "My Password" forms.
      • System Validation Messages, as well as "common" information when a Validation is triggered: "Unfortunately we found an error. ..."
      • Labels for the Login Box.
    • My Settings
      Contains all the entries necessary for the My Profile page.

Note: Please refer to Visualizations-Advanced Options on how to translate Visualizations.

See Also

The Internationalization Process

Adding a new Language

Adding a Locality to your System

The Language Files, and the Translation Process

Importing Languages into the Database

Translating Forms

Translating Questionnaire Templates

Translating Walkthrough Templates

Internationalized Users