Lookup Lists

Overview

A Lookup List is an account-wide list that you can upload from an Excel or CSV file. Unlike Global Lists, Lookup Lists are not constrained by required column types (Name, Value, Filter Key, and Score), and you can customize your columns as needed.

Lookup Lists can be used to embed drop-down selection lists in your forms. You can have users choose from lists of inventory, equipment, vehicle fleets, customers, and more to streamline data entry.

 

Lookup Lists can also be used to auto-populate data from your uploaded Excel or CSV file to other fields in your form based on what a user selects from the list. For example, if a user selects a name from a drop-down list of customers, that customer's details (e.g., account number, shipping address) could also appear on the form automatically. To do this, see our step-by-step guide on Lookup Mapping. 

 

How to Add a Lookup List

To add a Lookup List to your form:

1. In the Form Builder, select Lookup List from the Add Fields menu on the left.
2. In the Lookup List Settings menu on the right, add an existing list or create a new file.
3. Select View/Update List to view your list and make configurations:
   • The Name value is required and is used to populate the lookup list on the form.
   • The Value column will be used to populate the lookup field on the report.
   • By default, the Name column and the Value column are the same.
   • To make more advanced configurations, select Advanced.

In the example below, the user would select from the product names when selecting an option from this field.

Configuration

Setting	Description
Field Label	The label displayed for the field. This is usually displayed at the top left corner above the field.
Field Key	A Key used to reference the field in submission data. The key is also used to reference the field in rules and calculations.
Hint Text	The text that is displayed if the field has no value set, e.g. "Please enter a value"
Field Filter Key	A referenced Field Key of another field that will filter the Values based on the Values - Filter Key.
Memory Field	If a previous form containing the same Field Key has a value set, its value will be pre-populated for this field when the form is first opened.
Allow Multi-Selection	More than one value can be created and submitted in the form submission.
Rules	Rules that perform actions on fields or sections within the form. The actions can include hide, show, enable, disable, showSection and hideSection. Rules are executed on field value changes and when the form is opened. May also include a JavaScript snippet, for example: if ($lookuplistpicker_1$ > 23) { hide(); } else { show(); } (Please see the Introduction to Rules Document for more information)
Required	Sets the field to have required input. You will not be able to submit the form until this field has valid input.
Enabled	If not set the field will be visible but cannot be edited or set to accept new input.
Hide Question	Hides the Field Label.
Hidden	If enabled the field and all labels are not visible.
Exclude From Reports	If checked, the field will be excluded from HTML and PDF reports and will also be excluded from Excel and CSV exports.
Geo Location	Capture the current latitude and longitude when the acknowledgment button is clicked.
Time Stamp	Capture the current date and time when the acknowledgment button is clicked.
Alert Type	Choose a theme to change the background and font colors of the field cell as displayed in the apps.
Lookup List	(Required) The selected Lookup List from the available Lookup Lists setup on the Account.
Name	(Required) Map the column from your chosen Lookup List that will be used when the list is displayed.
Value	Map the column from your chosen Lookup List that will be stored as the value when the form is submitted.
Filter Key	Map the column from your chosen Lookup List that will be used when the Field Filter Key is set.
Score	Map the column from your chosen Lookup List that will be used for any calculations requiring numeric data.

Result Data

Data Type	Domain of Values	Example JSON
String Array	N/A	{ "lookuplistpicker_1": ["abc"] }