Input Types- Lookups
Platform URL | https://[enterprise].cvtr.io/v2/forms |
---|---|
API Endpoints | Not Applicable |
Epic | |
Document status | REVIEWED |
Document owner | @Danny Hannah @Adam Carter |
Technical writers | @Amish Ladhu |
Related Content |
Feature Overview
This page describes the different lookup input types available in Forms.
AddressLookup (Provided by: T2A)
AddressLookupGlobal (Provided by: Google)
EmailLookup (Provided by: Briteverify)
InternationalCompanyAddressLookup (Provided by: Dun & Bradstreet)
TelephoneLookup (Provided by: Data8)
TelephoneLookupInternational (Provided by: Informatica)
TelephoneLookupInternational2 (Provided by: Twillio)
1. Address Lookup
This lookup allows the user to search for a UK postcode, which once selected will automatically populate 4 address lines and a postcode field.
Field settings:
Field Name | Required | Notes |
Name | Prepopulated with postcodeLookup | |
Label | Prepopulated with Postcode Lookup. | |
Placeholder | Preselected with No. If changed to Yes, the Address fields and postcode field will have a placeholder (configured via the field settings). | |
CSS Class | Add a CSS class to allow more targeted CSS styling. |
Changing input label/placeholder values:
In the field ‘settings’ dialog, under the ‘input_descriptions’ tree, there will be a key/value item for each input where the value can be changed and will be reflected in the input label and placeholder.
Changing input required:
In the field ‘settings’ dialog, under the ‘input_required’ tree, there will be a key/value item for each input where the value can be changed to either true or false.
True: When completing the form and no value is added to the input, clicking the submit button will trigger the validation message and the form cannot be completed until this input has been populated.
False: When completing the form, this input does not require a value for the form to be completed.
Changing required messages:
In the field ‘settings’ dialog, under the ‘input_required_messages’ tree, there will be a key/value item for each input where the message shown when a required field has not been completed can be changed.
Lookup example:
2. AddressLookupGlobal
This lookup allows the user to search a global address, which once selected will automatically populate 4 address lines, a country field and a postcode field.
Field settings:
Field Name | Required | Notes |
Name | Prepopulated with addressLookupGlobal | |
Label | Prepopulated with Address Lookup Global. | |
Placeholder | Preselected with No. If changed to Yes, the Address fields and postcode field will have a placeholder (configured via the field settings). | |
CSS Class | Add a CSS class to allow more targeted CSS styling. |
Changing input label/placeholder values:
In the field ‘settings’ dialog, under the ‘input_descriptions’ tree, there will be a key/value item for each input where the value can be changed and will be reflected in the input label and placeholder.
Changing input required:
In the field ‘settings’ dialog, under the ‘input_required’ tree, there will be a key/value item for each input where the value can be changed to either true or false.
True: When completing the form and no value is added to the input, clicking the submit button will trigger the validation message and the form cannot be completed until this input has been populated.
False: When completing the form, this input does not require a value for the form to be completed.
Changing required messages:
In the field ‘settings’ dialog, under the ‘input_required_messages’ tree, there will be a key/value item for each input where the message shown when a required field has not been completed can be changed.
Lookup example:
3. EmailLookup
This lookup allows the user to identify valid email addresses.
Field settings:
Field Name | Required | Notes |
Name | Prepopulated with email | |
Required | Determine if the input has to be completed before the form can be submitted | |
Label | Prepopulated with Email | |
Placeholder | Add a placeholder within the input to provide a hint as to how to complete the field | |
CSS Class | Add a CSS class to allow more targeted CSS styling |
Lookup example:
If the email provided is invalid, a cross icon will show in the input which informs the user that the email is not valid. If the email provided is valid, a tick icon will show in the input.
4. InternationalCompanyAddressLookup
This lookup allows the user to search for a company based in a specific country, which once selected, will automatically populate (if available) 2 address fields, city, country, postcode, phone and website.
Field settings:
Field Name | Required | Notes |
Name | Prepopulated with company | |
Label | Prepopulated with Company Lookup | |
Placeholder | Preselected with No. If changed to Yes, the Address fields and postcode field will have a placeholder (configured via the field settings). | |
CSS Class | Add a CSS class to allow more targeted CSS styling. |
Changing input label/placeholder values:
In the field ‘settings’ dialog, under the ‘input_descriptions’ tree, there will be a key/value item for each input where the value can be changed and will be reflected in the input label and placeholder.
Changing input required:
In the field ‘settings’ dialog, under the ‘input_required’ tree, there will be a key/value item for each input where the value can be changed to either true or false.
True: When completing the form and no value is added to the input, clicking the submit button will trigger the validation message and the form cannot be completed until this input has been populated.
False: When completing the form, this input does not require a value for the form to be completed.
Changing required messages:
In the field ‘settings’ dialog, under the ‘input_required_messages’ tree, there will be a key/value item for each input where the message shown when a required field has not been completed can be changed.
Lookup example:
5. TelephoneLookup
6. TelephoneLookupInternational
7. TelephoneLookupInternational2
These lookups allow the user to identify valid mobile telephone numbers. There are 3 different types because different providers supply the service, and some customers may want to use one service over another.
Field settings:
Telephone Lookup:
TelephoneLookupInternational:
TelephoneLookupInternational2:
Field Name | Required | Notes |
Name | Prepopulated with telephone (cannot be changed if ‘TelephoneLookup’ is selected) | |
Required | Determine if the input has to be completed before the form can be submitted | |
Label | Prepopulated with Telephone | |
Placeholder | Add a placeholder within the input to provide a hint as to how to complete the field | |
CSS Class | Add a CSS class to allow more targeted CSS styling |
Lookup example:
If the telephone provided is invalid, a cross icon will show in the input which informs the user that the mobile telephone number is not valid. If the mobile telephone number provided is valid, a tick icon will show in the input.
Summary
Functionality | User Story | |
---|---|---|
1 | AddressLookup (Provided by: T2A) | Allows the user to search for a UK postcode, which once selected will automatically populate 4 address lines and a postcode field. |
2 | AddressLookupGlobal (Provided by: Google) | Allows the user to search for a global address, which once selected will automatically populate 4 address lines, a country field and a postcode field. |
3 | EmailLookup (Provided by: Briteverify) | This lookup allows the user to identify valid email addresses. |
4 | InternationalCompanyAddressLookup (Provided by: Dun & Bradstreet) | Allows the user to search for a company based in a specific country, which once selected will automatically populate (if available) 2 address fields, city, country, postcode, phone and website. |
5 | TelephoneLookup (Provided by: Data8) | Allows the user to identify valid mobile telephone numbers. |
6 | TelephoneLookupInternational (Provided by: Informatica) | Allows the user to identify valid mobile telephone numbers. |
7 | TelephoneLookupInternational2 (Provided by: Twillio) | Allows the user to identify valid mobile telephone numbers. |
User Permissions
Admin users, agency users and creative managers have access to global forms.