Initial Considerations
This tool is useful for projects who have participants that follow different workflows, as it allows you to grant access to instrument(s) at the record level when/if condition(s) are met. The logic is very similar to branching logic, except rather than applying logic at the field level, the logic is applied at a records instrument level.
Form Display logic impacts view of and accessibility of instrument(s) within the Record Status Dashboard, Record Home Page, and Record Instrument List on the left-hand menu when in a participant record. When the condition is not met, said instrume(s) appear greyed-out.
When a condition is NOT met for a given record, the instrument cannot be accessed within the user interface: (click on the image(s) below to expand)
Record Status Dashboard
Record Home Page
Record Instrument List
Important notes:
Form Display Logic is merely a ‘display’ function, which means this feature does NOT block end-users from taking survey(s) that are greyed out from selection in the user interface.
If you are using the Form Display Logic feature and the ‘Survey Queue’ function, be sure to read the additional considerations provided at the end of this page!
Form Display Logic does not impact data imports as this feature only operates in the data entry user interface to enable/disable the display of instruments.
You may define as many conditions as you want. A form may be selected in multiple conditions, but if so, please note that the form will be enabled if at least one of the conditions is met.
Simple example:
Let’s say you wish for a specific instrument to be accesible to 1 user group, and a second unique instrument to be accesible to user group 2. In this example, the project has 3 instruments:
'Study Intro' where the participant is assigned to a group field (1 or 2)
‘Treatment Survey’ should only be accessible to participants assigned to group 1
‘Control Survey’ should only be accessible to participants assigned group 2
To accomplish this you would…
a) Select the form(s) for user group 1 > insert logic, (see condition 1 below)
b)Select the form(s) for user group 2 > insert logic specific for group 2, (see condition 2 below)
c) Save
Now when reviewing the Record Status Dashboard you’ll see…
Records 1 & 2 which are assigned to group 1, have access to ‘Treatment Survey’, but do NOT have access to ‘Control Survey'
Records 3 & 4 which are assigned to group 2, have access to ‘Control Survey’, but NOT ‘Treatment Survey'
Record 5 has all forms available, as this record has not been assigned to a group, thus no conditions are able to be applied.
The Process
Navigate to your 'Online Designer' page
Click ‘Form Display Logic’
Create your condition(s)
Select one or more instrument(s) you wish to apply access logic to. The logic you create controls when said instrument is accessible.
If working with a longitudinal project:
Ensure your conditional logic includes the fields [event name] within the logic
Ensure you select the specific event(s) instruments you wish to apply logic to.
You will have the option to select unique event(s) or [all events]. Typically, [all events] is not used as form display logic is utilized to create unique conditions at specific timepoints, rather than across all timepoints.
Click ‘Save’
Understand the optional Form Display Logic settings available for use, this is very important if you are also using ‘Survey Queue’ functionality:
Review, Test, and Update Form Display Logic as needed
Additional Considerations
Survey Queue + Form Display logic notes:
If your Survey Queue is setup in a way which contradicts your Form display logic, Survey Queue functionality takes precedence over Form Display Logic, as Form Display logic is only a display function for project users.
Example) The below example uses the ‘simple example’ use case listed above
Although record 13 indicates they are in group 1, the survey queue indicates that all records should complete the pre & post survey, so when the first survey is sent to a participant, they will be provided both surveys for completion, even though your user interface has this greyed out:
Survey Queue Setup:
Participant’s Survey Queue view:
Internal, Project user view / Result:
If implementing ‘Form Display Logic’ in a Production project which has already collected data, be sure to review the ‘Optional Settings' and enable as needed for your projects specific needs. Examples below :
Keep forms enabled if they contain data: this selection will ensure internal project user can access instruments that have already collected data, that would normally be greyed out and restricted from display/access.
Hide forms that are disabled: this does the opposite of the above