How Multi-Language Translation Files Work

With the Multi-Language feature, you can create a single form and provide it to your field users in multiple languages. It’s simple to set up a Multi-Language FormClosed A Multi-Language Form is a form that’s set up with different translations so that field users can choose their preferred language. Translated content includes page and section names, question text, help text, and other form content. and an associated output Document. Simply download Excel files that contain the strings to translate, add translations, upload the files, and activate the languages. This topic describes the structure of the translation files and best practices for working with translation files.

Available as an add-on to the Advanced and Enterprise tiers:

Essentials
Advanced +Add-on
Enterprise +Add-on

Contents

Content that you can translate

You can set up translations for:

Info:The topic Translated Multi-Language Content Across the Platform describes how TrueContext displays Multi-Language translations in Forms and Documents. It also explains how the Mobile App and Web Portal display translated content.

Translation file details

To set up a Multi-Language form and document, you only need to upload translation files for the form. The document displays the translated form content as submitted. If you want to show translated document details, however, you must upload document translation files.

This section describes how to work with translation files for the content that’s built into a form or document.

Info:The topic Data Source Translations describes how to set up and use translations in a Data Source.

How to get a translation file

When you add a language or change the content, you download an Excel file that contains the content to translate. The following example shows how to download a translation file for a Multi-Language Form.

"Languages" settings, which include a "Download" button to use when you add a language or make changes to the form.

Keys and values in the translation files

The Excel translation file for each language contains a set of keys and values that are based on the Source LanguageClosed The term Source Language refers to the language that you use when you build a Multi-Language Form or Document. Translation files contain text strings in the source language and another column for the string translations that you add.. The keys identify the translatable strings in the Multi-Language Form or Document. The values are the actual text strings that were configured by the Form or Document Designer. These are the strings that you must provide translations for.

Note:On the Mobile App and in output documents, any string that doesn’t have an associated translation is displayed in the source language.

The following illustration describes the keys and values in the translation files for a Multi-Language Form.

Excel file that shows the following columns: key_name, en_US (source language used by the Form Designer to build the form), es (language added by the Form Designer), changes_occurred (to indicate when a source string changed after file upload), and comments (for messages to your translator).

The following illustration describes the keys and values in the translation files for a Multi-Language Document.

Excel file that shows the following columns: key_name, en_US (source language used by the Form Designer to build the form), es (language added by the Form Designer), changes_occurred (to indicate when a source string changed after file upload), and comments (for messages to your translator).

Note:To upload the translation files successfully, you must keep all five column headings exactly the same as in the downloaded file.

Guidelines for translated strings

Tip:Keep in mind that the translations in the Excel file apply only to the information displayed on the Mobile App and in output documents. These translations do not display in the Web Portal.

Unique IDs in the form translation file keys

The key_name column identifies elements of your form by their Unique IDs.

Tip:The Form Builder supplies a default Unique IDClosed A Unique ID refers to the specific identifier of a question, form page, form section, or Data Destination. Unique IDs are used as reference points when pulling data for conditional logic, Analytics projects, Data Destinations, and Documents. when you add a page, section, question, answer exception, or other element to the form. We recommend that you change these to IDs that will help you easily identify these elements in the translation files. The following example shows how a translation file displays the unique IDs in the key_name column.

key_name column that shows the UniqueIDs "Site Information", "Job Information", and "Inspection Date" for a page, section, and question.

You can sort and filter the Excel file based on the Unique IDs. This is useful when you need to:

Upload the translations and activate the language

Once all of the translated strings have been added to the Excel file, you can upload the file and activate the language.

Tip:The uploaded file name doesn’t have to match the downloaded file name. You might want to name the file so that it’s easy to identify.

Note:To upload the translation files successfully, you must keep all five column headings exactly the same as in the downloaded file.

  • For a Multi-Language Form, activate the language and save the form. You might want to attach a Multi-Language Document.

    Result: The system creates a new form version. The Mobile App treats translations as form dependencies and downloads new versions as part of the reconcile process. The language is now available for selection.

  • For a Multi-Language Document, activate the language and update the document. Link the document to a Multi-Language Form.

    Result: The document renders in different languages depending on your form setup.

    Even if you don’t upload or activate a language, the system has translations for most of the document. Only static text in the document details renders in the Source Language.