Field Embedding

Initial Considerations

Field Embedding is the ultimate way to customize surveys and data collection instruments to make them look exactly how you want. Field Embedding is a feature that allows you to reposition field elements on a survey page or data entry form so that they get embedded in a new location on that same page. Embedding fields gives users greater control over the look and feel of your instrument.

 The Process

Creating the fields

1. Enter REDCap project > Left Menu > Designer > Enter instrument of choice > “Add Field” at desired location

2. Create fields in Online Designer as you normally would one after the other

Embedding the fields for aesthetics

1. “Add field” at desired location for a field that will embed the other fields within it

   1. If you are combining embedded fields to view together – Field type: descriptive field (or header if section break is desired)

   2. If you are embedding a text field as an option on another field – Field type: radio or dropdown

   3. Tables are often a great resource to align embedded fields

   4. “Use the Rich Text Editor” to access formatting including tables

      

2. Place the REDCap variable name of the field you wish to embed inside braces/curly brackets - e.g., {first_name} - and place it in the Field Label, Field Note, Section Header, or Choice Label of another field on that same instrument.

   1. Example of a table of embedded text fields:

      

      The online designer looks like this ^

      

      The form then looks like this ^ where the first_name and last_name fields are not visible, except within the table as embedded fields

   2. Example of a radio field with an embedded text field for “other” option:

      

      The field editor field looks like this to build the radio field ^
      

      

      The online designer looks like this ^
      

      

      The form then looks like this ^

3. Adding the field icons: The usual icons pertaining to a field's Data History, Field Comments, and (if enabled) Missing Data Codes can be displayed on a data entry form (but not on a survey) next to the embedded field's new location by appending :icons to the variable name inside the braces/curly brackets - e.g., {last_name:icons}. The icons do not appear by default but only when the ':icons' signifier is attached.

4. For reference a video on the subject can be found here: Video on Field Embedding

What the User Sees

Users may place fields in a grid/table for a more compact user-friendly page, or they can position fields close together in a group if they are related.

The field's true field label will never actually be seen on the survey/instrument. It is recommended to add a Field Label even if the field is being embedded because the label will still be needed when viewing a report.

Additional Considerations

1. Field embedding will not work across instruments but ONLY on the current instrument/survey being viewed. If on a multi-page survey, then the embedded field must be on the same survey page as its host field.

2. The field must exist first before it can be embedded elsewhere.

3. A field cannot be embedded inside itself (i.e., in its own Field Label), and a field cannot be embedded in another field's Field Label or Field Note if that field is also embedded elsewhere.

4. Field embedding does NOT work in the REDCap Mobile App