Click on the magnifying glass to the right. Starting typing a topic you wish to learn about

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 23 Next »

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

 Click here to expand...

  1. Create project per normal process (define forms, create fields, events, etc.)

  2. Click on MLM in Left Navigation panel under ‘applications’

  3. Click ‘Add new language’

  4. In the ‘Language ID’ box, add your desired Language ID

    1. It is recommended to use the ISO code, such as 'en' or 'en-US' for English, or 'es' for Spanish. Use only letters and hyphen. View list of ISO 639-1 language codes within the application as needed

    2. Enter your language ‘display’ name

    3. Click ‘Import from file or system’

  5. CRITICAL STEP!

    1. The default selections are NOT used as a best practice

      1. De-select to include the ‘translations of user interface items’

      2. Select import ‘from available system languages’

      3. Select your language from the drop down menu

        • If you do not see the desired language listed after clicking the dropdown arrow, create a REDCap support ticket indicating what language you wish to utilize

      4. Click ‘import’

  6. Your page should now look similar to the below where English is the first language listed and is identified as the default language

    1. The vertical yellow line on the left indicates current changes are not yet saved. Click Save changes

    2. Save changes frequently and often to avoid re-work!

  7. Select the participant's preferred language field

    1. If you don’t yet have a preferred language field save you changes thus far and go create you field following the below guidance:

      1. ensure the choices are labelled as the language code and not a numerical value:

        • example)

  8. Activate your language(s)

    1. Under the "Active Column" click the radio button to activate each language.

    2. Only click the RTL radio button if the  language should be read right to left (like Arabic)

  9. Enable items & translate using the Forms/Surveys tab

    1. Here you will toggle on which instruments will be used as ‘data entry’ and / or ‘survey’

      1. Select your first language and enabled accordingly

      2. Select you 2nd language and enable accordingly

        • Remember, you have to select the language at the top of this page that you wish to enable/translate

        • Remember to SAVE CHANGES frequently!

      3. Once data entry/surveys have been enabled, it’s time to translate!

    2. To begin translating items, select the desired language widget

    3. Select ‘translate’ under the fields column

      1. Translate each field on the screen

        • You can use the Rich text editor to enhance your text (e.g. bold, italicize, center text)

      2. After you translate the field, a green icon indicates it is done.

      3. If the field is not to be translated (eg you wish some fields to remain in the default language, click the box next to the field variable name

      4. Translate any/all desired survey settings

      5. Click through tabs to translate each of the topic areas (e.g. Forms/surveys, Alerts, etc.)

      6. If your projects utilizes ASI’s (automated Survey Invites) you must select each ASI’s Language source. Best practice is to select the ‘language preference field’ for the best results!

      7. Save Changes!

  10. NOTE: When translating Alerts, ensure you set language source for each alert.

    1. This drives the language for the alert.

      1. As a best practice, the participants language preference field should be used.

  11. Save changes and review your MLM setup for accuracy

    1. Shortcut to save is by using your keyboard buttons (Control + S)

  12. Test your project configuration in development mode for accuracy and adjust as needed

Additional Considerations

  • When performing testing of your MLM project, be sure to test using an ‘incognito window’!

    • Why? MLM saves ‘cookie’ values. When a participant selects their language using the widget instead of a preferred contact field, this selection is saved as a ‘cookie’ to whatever device is being used. The Cookie value then overrides the preferred language field by design for all surveys tested from said device, regardless of unique participant record being selected.

  • MLM action tags

    • Once the MLM is enabled, special action tags become available for use:

 Click here to expand...

@LANGUAGE-CURRENT-FORM

Allows you to capture the currently used language in projects where multilingual data is enabled on data entry forms. The @LANGUAGE-CURRENT-FORM action tag can be used on fields of type 'Text Box' (no validation), and 'Drop-down List', or 'Radio Buttons' (these need to have choices whose codes correspond to the IDs of the defined languages - e.g., 'en'). This action tag is only active on data entry forms and will always, when possible, set the field's value to the currently active language. However, it has no effect when viewing survey responses.

@LANGUAGE-CURRENT-SURVEY

Same as @LANUGAGE-CURRENT-FORM, but works only on survey pages. For multi-page surveys, @LANGUAGE-CURRENT-SURVEY needs to be used on a field of each page where capture of the language is relevant (e.g. for performing branching).

@LANGUAGE-FORCE

When used on a field, the data entry form or survey on which the field is located will be rendered in the specified language (which must have been set up using the Multi-Language Management feature). The format must follow the pattern @LANGUAGE-FORCE="???", in which the ID of the desired language should be inside single or double quotes - e.g., @LANGUAGE-FORCE="de". Piping is supported - e.g., @LANGUAGE-FORCE="[field_name]" (if the source field is a radio field, make sure to add the :value qualifier). When the language is forced successfully (i.e., it exists and is active), the language selector is hidden. This action tag is evaluated when the form or survey loads. Using this together with @LANGUAGE-CURRENT-FORM/SURVEY on the source field for @LANGUAGE-FORCE may be used to 'lock in' a user to their selected language.

@LANGUAGE-FORCE-FORM

Same as @LANGUAGE-FORCE, but the effect is limited to data entry forms (i.e. this does not affect surveys).

@LANGUAGE-FORCE-SURVEY

Same as @LANGUAGE-FORCE, but the effect is limited to surveys (i.e. this does not affect data entry forms).

@LANGUAGE-SET

When used on a Drop-down or Radio Button field only, this action tag will allow the field's value to control the currently shown language (in the same way as switching the language via the buttons at the top of the page).

  • 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


Please refer to the MLM FAQs Knowledge Article for additional information.



  • No labels