Forms
Under the “Forms” item in the left-hand side menu, you can create forms. A form is used by the system to obtain information from the end-user. There are two types of forms in the system:
Identity form: The identity form is used to obtain items that can be used to pre-populate information about the end-user. An identity form holds information about your end-users which can be used to authenticate and authorize them through potential identity providers. When an already-created identity is tied to an end-user who is registering as a candidate, their candidacy presentation will then be prefilled with data taken from the identity form.
Candidate Form: The candidate form contains end-user information which can be used for the presentation of the candidate once all candidates are published. The information you create here can also be used to gather additional items that your organization may need to collect about candidacies, including acceptances of terms and conditions, email addresses, and so forth.
Recommendation Form: The recommendation form contains end-user information which can be used to gather information about the recommender. When a recommendation is visible, only the name of the recommender can be made visible. No other information regarding the recommender will be visible to other end-users.
Party Form: The party form is used when creating a party to obtain information about that party. A party form requires, as a minimum, a text field with a “title” purpose – read more on these below.
You can read more about how to create identity and candidate forms in the guide: Create a form.
These are the basic settings you must configure to create a new form.
Name: This is the internal name of the form, and it is only visible to backend users.
Candidates, Identities, Recommendations, or Parties: Here, you can select which resources the form defines the data structure for, candidates, identities, recommendations, and/or parties.
: The grey “+” button reveals a bar with several customizable form fields that can be added to the form,
. Read more about the different form fields below in section 1.1. Form fields.
Form fields are add-on fields that allow you to collect richer data about the end-users through forms. All fields are available for both candidate, recommendations and identity forms. Each field however requires additional set-up, as you will see below.
There are two ways to access and placements for the fields:
Click on the grey “+” button to add a new field at the end of the form;
Or click on the “+” button next to an already existing field, to add a new field just below that field.
See below all the form fields, their definitions, and the data they facilitate forms to collect:
Form field |
|
|
|---|---|---|
Check box | Adds a checkbox field |
|
Date | Adds a date field in dd/mm/yyyy format |
|
Date Time | Adds a date and time field. Displays the date as dd/mm/yyyy and time by hour and minutes |
|
Divider | Adds a space separator |
|
Image | Adds an image field. Note that there can only be one image field per form. | Allows end-users to upload one image. |
Information | Adds an open and editable text box that supports HTML. | In this field, you can write any piece of information you may want to share with your end-users. This field is not editable by the end-users. |
Link list | Adds link fields. A form can only support up to 10 links. | Allows end-users to provide links. |
Number | Adds a field that only supports numbers. |
|
Rich Text Area | Adds a textbox field with customizable features. | In this field, end-users can write longer texts with |
Select | Adds a dropdown menu with selectable options. |
|
Text | Adds a text field. |
|
Video | Adds a video field that supports URL links. | Allows end-users to provide links that lead to videos. |
Inside each of the previously mentioned form fields, there are extra fields that require setup. Some of these are particular only to some of the form fields - if not specified otherwise, the feature applies to all form fields.
See the additional features below:
Attribute name: This field corresponds to the unique internal name of the form field.
Purpose: This field dictates the type of treatment the information will receive. There are four types:
Generic: Generic information doesn't require any specific treatment.
Summary: Summary information will be used to summarize attributes of a resource where applicable.
Title: Title information will be used to represent a resource wherever applicable. Eg. a Candidate's title would be their name. This purpose is only applicable to Text and Select fields.
Subtitle: Subtitle information will be used to supplement the title of a resource where applicable. Eg. A candidate's subtitle could be their profession. This purpose is only applicable to Text and Select fields.
Required: When this feature is toggled on, the specific form field needs to be filled in.
Editable: When this feature is toggled on, the specific form field can be edited by end-users.
Public: When this feature is toggled on, answers to the specific form field will be publicly available and visible to all other end-users.
Label: This field corresponds to the label that will be displayed with the field to the end-user. It is placed just above the field in the frontend.
Help text: When “Help text” is toggled on, you will need to provide a text describing what is required in the specified form field.
Minimum length: This field specifies the minimum amount of characters that must be provided in the particular field. This feature is only applicable to Text and Rich Text Area fields.
Maximum length: This field specifies the maximum amount of characters that can be provided in the particular field. This feature is only applicable to Text and Rich Text Area fields.
Translatable: This feature sets whether the specific form field can be provided in more languages than the default one for the Candidacy site (read more here). When toggled on, new tabs corresponding to the different locales set for the Candidacy will appear in the form field.
This option is only applicable to Text and Rich Text Area fields.
Earliest: This feature specifies the earliest possible date (and time) that can be selected. This feature is only applicable to Date and Date Time fields.
Latest: This feature specifies the latest possible date (and time) that can be selected. This feature is only applicable to Date and Date Time fields.
Minimum amount: This field specifies the minimum amount of links that are required to complete the form. This feature is only applicable to Link fields.
Maximum amount: This field specifies the maximum amount of links that an end-user can add to the form. There can only be a maximum of 10 links per form. This feature is only applicable to Link fields.
Minimum value: This field specifies the minimum value that the form field allows. This feature is only applicable to Number fields.
Maximum value: This field specifies the maximum value that the form field allows. This feature is only applicable to Number fields.
Selectable options: Under “Selectable options”, it is possible to add different interactive options that will be displayed to the end-users in the format of a dropdown menu. This feature is only applicable to Select fields.
Allow unknown video hosts,
: this allows the field to be filled with potentially unsupported video hosts. Supported hosts are Vimeo and YouTube. This feature is only applicable to Video fields.