Platform URL | https://[enterprise].cvtr.io/v2/forms |
---|---|
API Endpoints | Not Applicable |
Epic | |
Document status | READY FOR REVIEW |
Document owner | |
Technical writers | |
Related Content | https://convertr.atlassian.net/wiki/spaces/PF/pages/edit-v2/3058532652 |
🏠 Feature Overview
This page describes the below standard input types available in Forms:
Title
First Name
Last Name
Password
Email
Telephone
HiddenInput
Optin
Title
This input type can be used on the form to accept the 'Title' of the lead. When selecting the Type as ‘Title’, the ‘Name’ and ‘Label’ fields are automatically populated and user can overwrite the same if required.
The following options are available under Title type by default:
Mr
Ms
Mrs
Miss
Dr
Rev
Clicking on the ‘Settings’ icon shown below opens a modal where user can add additional options for title.
Field Settings Modal
Adding additional options
Within the ‘Field Settings' modal, under the ‘Fields’ tab, additional options can be added to the title list in 2 ways
i. Users can enter data in the format: {"value":"value1","label":"label1"} and click on the ‘Import’ button
ii. Users can enter the label under ‘Label’ and value under ‘Value’ and click ‘Add’.
The values added as JSON and added via Add button will be shown in the listing table.
Users can remove options from the list using the '-' button available against each option.
Users can reorder options in the list using the '+' icon available against each option.
Once changes have been made, clicking on the ‘Save’ button will persist the changes to the Title field.
2. First Name
This input type can be used on the form to accept the ‘First Name’ of the lead. When selecting the Type as ‘First Name’, the ‘Name’ and ‘Label’ fields are automatically populated and user can overwrite the same if required.
3. Last Name
This input type can be used on the form to accept the ‘Last Name’ of the lead. When selecting the Type as ‘Last Name’, the ‘Name’ and ‘Label’ fields are automatically populated and user can overwrite the same if required.
4. Password
This input type can be used on the form to accept the ‘Password’. When selecting the Type as ‘Password’, the ‘Name’ field is automatically populated and user can overwrite the same if required. User must provide a ‘Label’ for the input type. The ‘Password’ field masks the input entered by the user as shown in the screenshot above.
5. Email
This input type can be used on the form to accept the ‘Email’ of the lead. When selecting the Type as ‘Email’, the ‘Name’ field is automatically populated and user can overwrite the same if required. User must provide a ‘Label’ for the input type.
6. Telephone
This input type can be used on the form to accept the ‘Telephone’ of the lead. When selecting the Type as ‘Telephone’, the ‘Name’ and ‘Label’ fields are automatically populated and user can overwrite the same if required.
The Telephone input has 2 parts:
a dropdown to select the Country Code; ‘United Kingdom’ is selected by default. User can select the country code from the dropdown.
text field to provide the telephone number
7. HiddenInput
This input type is for adding fields to the form, which should not be visible to the user.
User is not allowed to add a ‘HiddenInput’ as the first field on the form. An error message ‘Please start creating a form with inputs’ is shown.
The user must provide a ‘Name’ for the hidden input field. The fields ‘Required’, ‘Label’, ‘Placeholder’, and ‘CSS Class’ are disabled for this input type.
8. Opt in
This input type is used when we want the user to agree to the terms and conditions and to Opt in to receive emails, messages etc. When this input type is selected, the ‘Name’ and ‘Label’ fields are auto populated and the user can overwrite them. This input type can be marked as required but cannot have a placeholder.
By clicking on the ‘Settings’ icon and selecting the ‘Choices’ tab, the below modal opens, where the user can either import or manually add the list of options to be displayed for the user to opt in, on the form.
In the above image, Label is the name that will be displayed on the form as an opt in item and Value is the value that will be passed when the user selects the checkbox associated with an opt in option.
The values added via the settings modal can be seen on the form preview.
By clicking on the ‘Settings’ icon and selecting the ‘Options’ tab, the below modal opens, where the user can specify the terms & conditions and opt in choices, to be shown on the form.
E.g. In the below image:
‘terms’ is the Key that has an associated Value, which is the terms and conditions that will be displayed to the user, such as: ‘I accept that the data provided on this form will be processed, stored, and used in accordance with the terms set out in our privacy policy.' (link to the privacy policy can be provided within the 'Value’ field using html code.)
‘contact_choice’ is the Key that has an associated Value, ‘Preferred contact method:', below which the choices added/imported in the 'Choices’ tab will be displayed, such as: SMS, email, etc.
\uD83D\uDDD2 Summary
Functionality | User Story | |
---|---|---|
1 | Title | Allow users to add and edit the title of the lead, default values available are:
|
2 | First Name | Allow users to enter and edit the first name of the lead |
3 | Last Name | Allow users to enter and edit the last name of the lead |
4 | Password | Allow users to enter the password information |
5 | Allow users to enter and edit the email address of the lead | |
6 | Telephone | Allow users to enter and edit the telephone number of the lead |
7 | HiddenInput | Can be used to have fields, that should not be visible to the end user, on the form |
8 | Optin | Allow users to agree to the terms and conditions and to Opt in to receive emails, messages etc. |
\uD83D\uDDD2 User Permissions
Admin, agency users and creative managers have access to global forms.
Agency users can perform edit actions only if access is enabled at enterprise level.