View the ‘How to use Multi-Language Management’ video within REDCap by navigating the MLM page found under ‘applications’ on the left hand project menu
Initial Considerations
The Multi-Language Management app (MLM) allows one to translate an entire project into various languages. This includes data entry forms, surveys, alerts, error notices, etc. REDCap does not perform the translations for you, but provides a streamlined framework. Settings configured at the project level speed the process of translation as opposed to configuring each and every field variable.
To enable the MLM, one must have Design & Set Up user rights. When accessed from the left navigation panel, one can define multiple languages in the project. Once configured the project language configuration can be copied to another project which has similar set up and field variables. The MLM allows you to convert languages in surveys, data entry instrument, alerts, and elsewhere throughout the project. You can activate any given language for a data entry or survey instrument. For example, a pre-survey instrument can have German / Spanish languages and a data entry form have no language translation enabled.
The MLM supports the e-consent framework. You are able to translate all the command language and everything you see as part of the e-Consents framework. Also, if you e-consent using the framework, the pdf consent form stored in the file repository will be in the language in which the participant took the survey. This will be beneficial for CFR Part 11 compliance for e-consent which requires it to be in the same language in which they consented.
The Process
Create project per normal process (define forms, create fields, events, etc.) The last step is to set up languages.
Click on MLM in Left Navigation panel
Click on Add new language
Define Language ID code in lower case by iporting from REDCap system files (button is located in lower left corner of dialogue box.
ALWAYS define English (en) first so that it will be the default.
ALWAYS add all languages using ‘Import from file or system’
Click on import from file or system
c. Before selecting your language be sure to review your translation selections:
Note: If you do not wish for your user interface items to be translated then you MUST de-select the translation of user interface items.
If you do not see your language listed by clicking the dropdown arrow, please create a REDCap support ticket and indicate what language you would like access to
d. Use dropdown to view from available system language files within REDCap to select your language.
Selecting foreign languages in this manor will expedite some of the system translation necessary for project set up (eg error messages, warnings)
5. Click ‘Import’
Your page should look like this where English is the first language listed and is identified as the default language
The vertical yellow line on the left indicates current changes are not yet saved. Click Save changes
6. A participant's preferred language can be designated based upon a field you have created in your project. This can be set manually through data entry or via MLM Action tags
When setting up a participant's preferred language, ensure the choices are labelled as the language code and not a numerical value:
7. Under the "Active Column" click the radio button to activate each language. Click the RTL radio button if the language should be read right to left (like Arabic)
8. Click Forms/Surveys tab to identify which instruments will be translated
Remember to save your work along the way!
9. Click on Language to translate (eg Spanish) and then the Translate pencil adjacent the instrument you wish to translate
10. Translate each field on the screen.
a. If the field is not to be translated (eg you wish some fields to remain in the default language, simple click the box next to the field variable name
b. Click and copy text from copy icon to an internet translation app. ( Use DeepL Translator or Google translate) or type in the translation if you are bilingual
12. After you translate the field, a green icon indicates it is done.
a. If you do not need to translate the field you can click the check box next to the field variable name
b. You can use the Rich text editor to enhance your text (e.g. bold, italicize, center text)
Remember to save your work! (as shown in step 5)
13. Note that you can translate all or only selected fields from your Survey Settings
14. Continue translating all forms and surveys per the above steps
15. Color codes:
Yellow button means current changes not saved yet. Short cut to save (Control S)
Green implies translated
Red is not translated
16. The code book is presented in English (the primary project language). It does indicate if the instrument has been translated. The code book example below shows the survey is translated to Spanish
18. Click through tabs to translate each of the topic areas (e.g. Forms/surveys, Alerts, )
19. NOTE: When translating Alerts, ensure on the English page that you set language source for each alert.
This is important because it drives the language for the alert.
It's also important who is triggering the alert if you've got that alert set to "user's" (person with REDCap access) or "survey respondent's" active language",
It will use the user's active language if a user triggers the alert, but will use the survey respondent's active language if the participant triggers it
20. MLM Action Tags
Be sure to review and utilized the Action Tags developed for the MLM application. Each one begins with the word @Language. Action tags can be specific to surveys or forms
How Participants Use / What the User Sees
When the survey is distributed, the user has the option to select what language they wish to use either as a button or in the upper right corner.
It is possible to toggle back to another language by clicking on the globe icon in the upper right and the language options re-appear
Additional Considerations
Translations are done at an instrument level, not field level. Take attestations into consideration when building your e-consent. Do you want the staff to participate in English or the alternate language? You may need 2 separate instruments. Or do not translate some of the fields in the form
How Matrix fields look
Note: By default, user selection of a language via the language widget in a survey will be prioritized over the language preference question selection. To remedy this potential conflict, you can add the action tags LANGUAGE-SET and LANGUAGE-CURRENT-SURVEY to the language preference field.
Please refer to the MLM FAQs Knowledge Article for additional information.