Custom fields allow you to capture data that may not be covered by your standard fields. Using this feature gate authors can add and configure additional fields into their gates and store the response data in generic fields in the receiving data platform.
This guide explains how to work with custom fields in Formulayt for both regular users and administrators.
Understanding custom fields
Custom fields are enabled at the Form Type level by the Formulayt administrator. They will also determined how many custom fields can be created, where they will appear in the form and where they map to in the receiving data platform.
Adding custom fields
Custom fields provide a useful solution for one-off data capture requirements. If you find yourself repeatedly using the same custom field, work with your administrator to add it to your form templates as a standard field.
How to add a custom field to your form
Follow these steps to add a custom field:
When editing or creating a gate
Open the form tab
Locate the Custom fields options (typically at the bottom)
If your selected Form Type supports Custom Fields you should see something similar to this...
Configuration options
When configuring a custom field, you have access to these options:
Field type - Choose from Text, Long text, Picklist, Checkbox, Radio input group or Hidden field
Question text - Define the label or field prompt displayed to users
Field options - Configure dropdown values (for picklist fields)
Field value - Set predetermined values for hidden fields
This field is required - Toggle whether the field is mandatory
Picklist configuration
For dropdown fields, enter each option on a new line. To separate display text from values, use the pipe separator:
value|displaytext
value|displaytext
value|displaytext
Administrator settings
For administrators configuring custom field availability:
Navigate to Setup / Fields
Create a new field
Select "Custom fields" from the Field Type dropdown
Select the number custom fields that gate authors can create
Note: Only one Custom fields field can be created with Formulayt
Field naming templates
Each custom field creates two data points: one for the question text and one for the user's response. The {n} placeholder in your naming templates determines the field number. You can configure the naming convention to your needs, but you must include {n} within your convention.
Example using templates:
Label template: $customField{n}Label
Value template: $customField{n}ValueThis creates:
$customField1Label $customField1Value
$customField2Label $customField2Value
$customField3Label $customField3Value
Once you have determined your custom fields naming convention you must ensure that your receiving data platform has the fields setup ready to receive the data. In the example above, 6 fields should be created in order to receive the questions and answer from any custom fields created in gates.