Introduction

  1. You need to know how to edit XMLs to define skip logic.

  2. Skip logic can be configured only via XML import.

  3. Skip logic is retained even if the form is edited and saved via UI (enhanced in v6.2).

The syntax for skip logic in custom forms has been updated in version 11. To provide better clarity and to allow the use of additional object fields such as participant and visit, the new syntax is now similar to a JSON-based dictionary.

Below are the example of code to display fields when specimen belongs to Class “Cell“.
Old syntax:

$extendedObj.specimenClass = "Cell

New syntax:

specimen.specimenClass == "Cell"

Examples:

If the field is marked as ‘Required,’ meaning it is mandatory for data entry, adding the showWhen condition will override this 'Required’ setting.

Use Case 1: Show Form field based on the Specimen Class.

Added the ShowWhen condition in form XML to show field based on Specimen Class.

image-20240620-122928.png

Show form field “Media“ only when specimen class == “Cell“:

image-20240620-124052.png

When Specimen Class is not “Cell” then form field “Media“ is not shown:

image-20240620-124345.png

Use Case 2: Show the Form field based on the value of another form field.

<showWhen><![CDATA[field_name == "value"]]></showWhen>

Show a field ‘Legal Guardian', if the participant is ‘Age Below 18' is selected as 'Yes’

image-20241113-134000.png

Data-Entry page when ‘Age Below 18' is selected as 'No’

image-20241113-135248.png

Data-Entry page when ‘Age Below 18' is selected as 'No’

image-20241113-135335.png

Use Case 3: Show a Custom field based on the value of another custom field.
note

For participant custom field use = cpr.participant.extensionDetail.attrsMap.variableName
For Visit custom field use = visit.extensionDetail.attrsMap.variableName

For Specimen custom field use = specimen.extensionDetail.attrsMap.variableName

For participant custom field use = cpr.participant.extensionDetail.attrsMap.variableName
For Visit custom field use = visit.extensionDetail.attrsMap.variableName

For Specimen custom field use = specimen.extensionDetail.attrsMap.variableName

Added the ShowWhen condition in form XML to show field based on another custom field value.

image-20240620-132912.png

Show custom field “Branch Form field1“ only when custom field “Show visit Form“ value = y.

image-20240620-133301.png

When custom field “Show visit Form“ value = n then custom field “Branch Form field1“ is not shown:

image-20240620-133450.png

Use Case 4: Display the fields when the multi-select field includes one or more values.

Requirement: Display the fields consent_provided_via and consented_by when the multi-select field contact_outcome includes one or both of the following values:

  1. "Patient Consented"

  2. "Sent Consent"

The fields should be visible if: contact_outcome contains either "Patient Consented" OR "Sent Consent", OR both.

Syntax:

<showWhen><![CDATA[contact_outcome && (contact_outcome.indexOf('Patient Consented') >= 0 || contact_outcome.indexOf('Sent Consent') >= 0)]]></showWhen>

XML file:

Screenshots:

When no value is selected for contact_outcome field:

image-20250127-080645.png

When one value is selected for contact_outcome field:

image-20250127-080714.pngimage-20250127-080734.png

When more than one value is selected for contact_outcome field:

image-20250127-080802.png