Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 15 Current »

Platform URL

https://[enterprise].cvtr.io/v2/forms

API Endpoints

Not Applicable

Epic

GFR-50 - Getting issue details... STATUS

Document status

DRAFT

Document owner

Danny Hannah Adam Carter

Technical writers

Amish Ladhu

Related Content

https://convertr.atlassian.net/wiki/spaces/PF/pages/edit-v2/3058532652

šŸ  Feature Overview

This page describes the different lookup input types available in Forms.

  1. AddressLookup (Provided by: T2A)

  2. AddressLookupGlobal (Provided by: Google)

  3. EmailLookup (Provided by: Briteverify)

  4. InternationalCompanyAddressLookup (Provided by: Dun & Bradstreet)

  5. TelephoneLookup (Provided by: Data8)

  6. TelephoneLookupInternational (Provided by: Informatica)

  7. TelephoneLookupInternational2 (Provided by: Twillio)


1. Address Lookup

This lookup allows the user to search a UK postcode. which once selected will automatically populate 4 address lines and a postcode field.

Field settings:

Field Name

Required

Notes

Name

(tick)

Prepopulated with postcodeLookup

Label

(error)

Prepopulated with Postcode Lookup.

Placeholder

(error)

Preselected with No. If changed to Yes, the Address fields and postcode field will have a placeholder (configured via the field settings).

CSS Class

(error)

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:

Screen Recording 2023-06-06 at 10.32.32.mov

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

(tick)

Prepopulated with addressLookupGlobal

Label

(error)

Prepopulated with Address Lookup Global.

Placeholder

(error)

Preselected with No. If changed to Yes, the Address fields and postcode field will have a placeholder (configured via the field settings).

CSS Class

(error)

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:

Screen Recording 2023-06-06 at 11.09.39.mov

3. EmailLookup

This lookup allows the user to identify valid email addresses.

Field settings:

Field Name

Required

Notes

Name

(tick)

Prepopulated with email

Required

(error)

Determine if the input has to be completed before the form can be submitted

Label

(error)

Prepopulated with Email

Placeholder

(error)

Add a placeholder within the input to provide a hint as to how to complete the field

CSS Class

(error)

Add a CSS class to allow more targeted CSS styling

Lookup example:

Screen Recording 2023-06-06 at 14.29.36.mov

If the email provided in 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 ticket icon will show in the input.


4. InternationalCompanyAddressLookup

This lookup allows the user to search for a company based in a specific country which onces selected will automatically populate (if available) 2 address fields, city, country, postcode, phone and website.

Field settings:

Field Name

Required

Notes

Name

(tick)

Prepopulated with company

Label

(error)

Prepopulated with Company Lookup

Placeholder

(error)

Preselected with No. If changed to Yes, the Address fields and postcode field will have a placeholder (configured via the field settings).

CSS Class

(error)

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:

Screen Recording 2023-06-06 at 14.48.36.mov

5. TelephoneLookup
6. TelephoneLookupInternational
7. TelephoneLookupInternational2

These lookups allows the user to identify valid mobile telephone numbers. There are 3 different types because different providers supply the service and some customer may one to use one service over another.

Field settings:

Telephone Lookup:

TelephoneLookupInternational:

TelephoneLookupInternational2:

Field Name

Required

Notes

Name

(tick)

Prepopulated with telephone (cannot be changed if ā€˜TelephoneLookupā€™ is selected)

Required

(error)

Determine if the input has to be completed before the form can be submitted

Label

(error)

Prepopulated with Telephone

Placeholder

(error)

Add a placeholder within the input to provide a hint as to how to complete the field

CSS Class

(error)

Add a CSS class to allow more targeted CSS styling

Lookup example:

Screen Recording 2023-06-06 at 14.58.32.mov

If the telephone provided in 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 ticket icon will show in the input.


\uD83D\uDDD2 Summary

Functionality

User Story

1

AddressLookup (Provided by: T2A)

Allows the user to search 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 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 onces 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.

\uD83D\uDDD2Ā User Permissions

Admin users, agency users and creative managers have access to global forms.

Convertr User Matrix v.1.2

  • No labels