Skip to main content

Platform Control: Required

What does the Required control do to fields in your Journey interface?

Kate Gubbins avatar
Written by Kate Gubbins
Updated over 10 months ago

A Required field in your Journey will be a mandatory field that must be completed in order to satisfactorily complete the data capture of the Journey.

Generally, you will not be able to submit an application until you have completed all the Required (Mandatory) fields

A Required field in your Journey can be identified in two ways:

  • any fields that are not mandatory will have the notation (optional) in the field title eg:

  • when you try to leave the page/section, any mandatory fields that are not yet satisfied will be highlighted by a red border eg:

How to configure a field to be Required (Mandatory)

To make a field Required (Mandatory), you need to make sure you are in Draft mode in Platform, find the field you want to make Required, and scroll across to the Required Control:

The Required control gives you three options for managing if a field can be edited:

  • Required: Yes - this will mean that the field is MANDATORY (must be completed) in your journey

  • Required: No - this will mean that the field is OPTIONAL, (not required to be completed) in your journey

  • Required: Conditional - this will mean that the field is Mandatory (or Optional) in your journey only when specified conditions are met

You will note in Platform, some fields do not have a Required control at all (the control is blank). This will mean that the field is Optional (Not Required) by default.

Required on Condition

Required on Condition allows you to set a json expression to govern conditions that will set the mandatory/optional behaviour of the field.

As an example for setting conditional logic for the Required control, in the following screenshot, a number of the data capture fields for a Property Asset are set to be Required on condition:

As background,

  • where the Property Asset is NOT to be used as security for this application, the Lender does not require the fields capturing details for Title, Tenure and Holding.

  • However, where the Property Asset IS to be used as security for this application, the Lender does require the fields capturing details for Title, Tenure and Holding.

We are able to set this conditional logic to make these fields Required, only where the Property Asset has "To Be Used as Security" = YES

If you click on the condition, you are able to see this logic

  • where UseAsSecurity = YES, make required:

In the interface, where To Be Used as Security = No, these fields are not Required:

Whereas, where To Be Used as Security = Yes, these fields ARE conditionally Required:

Did this answer your question?