Click on Images to Expand Them
It is possible to set up a Field Group to be repeated several times, as well as added or removed by the end-user. This is useful in cases when the user must enter several options of the same data, such as previous residency addresses, employment history, education history, phone numbers, several dependents, several account owners, and so on. Even you only have one field that needs to be repeated in this way, you must enclose it in a Field Group.
Repeatable Field Groups must use an index counter within the Meta field name pattern to distinguish between the groups. An index counter can be used in the visualized parts of the field group as well, for example, in the Field Label at the top of Field Group, or in Custom Content that is displayed at the bottom of the group below all grouped fields.
By changing different Repeat settings of a Field Group you can set:
the number of times that the group is initially displayed (Number of repetitions)
whether the user can add more repeated versions of the group with the Add button (Allow adding)
how many additional groups the user may add to the list (Maximum repetitions)
when the user deletes unnecessarily repeated groups, how many of them must remain (Minimum repetitions)
In the example below, the wizard will have a Primary Beneficiaries section, where several beneficiaries can be added, but no less than one and no more than four.
Step 1: Create a Page
Adding a repeatable field group to a wizard
Field | Value | Details |
---|---|---|
Field Label |
| This is the label of the Field Group that will be visible to the user and includes numbering. |
Name |
| This is the name of the Field Group as it appears in the Page Tree and as it is referenced in JSON. |
Meta field pattern |
| This is the prefix that will be added to Meta Field Names of fields contained in the group. Each added field group will have a new number, e.g. Beneficiary1., Beneficiary2., Beneficiary3., etc. |
Repeat | Selected | |
Number of repetitions | 1 | One group will be initially displayed to the user. |
Allow adding | Selected | This will show Add and Remove (as an X icon) buttons to the user. |
Add button label | Another Beneficiary | The label that will be used for the Add button. |
Remove button label | Leave empty. | Only the X icon will be displayed. |
Maximum repetitions | 4 | The maximum number of groups that the user may add. |
Minimum repetitions | 1 | The minimum number of groups that must remain present. Remove icon will be shown only next to those groups that are above this number. |
Step 2: Add Fields to the Group
Adding fields to a repeatable Field Group
Percentage of the Share | ||
---|---|---|
Field Type | Setting | Value |
Single Text | Field Label | Percentage of the share (%) |
Meta Field Name | BeneficiaryPerc | |
Max Input Length | 3 | |
Size by content | Selected |
Social Security Number | ||
---|---|---|
Field Type | Setting | Value |
Single Text | Field Label | SSN/TIN |
Meta Field Name | SocSecNumber | |
Max Input Length | 10 | |
Size by content | Selected |
Full Name | ||
---|---|---|
Field Type | Setting | Value |
Single Text | Field Label | First and Last Name or Trust Name |
Meta Field Name | FullName | |
Max Input Length | 150 | |
Size by content | Selected |
Relation to the owner | ||
---|---|---|
Field Type | Setting | Value |
Single Selection | Field Label | Leave empty |
Meta Field Name | BeneRelation | |
Display Type | Radio List | |
Choices | Value = 1 | |
Choices | Value = 2 | |
Choices | Value = 3 | |
Size by content | Selected |
Date of birth | ||
---|---|---|
Field Type | Setting | Value |
Date and Time | Field Label | Date of birth or trust |
Meta Field Name | DateOfBirth | |
Display Type | DateLocal | |
Size by content | Selected |
Home Address | ||
---|---|---|
Field Type | Setting | Value |
Single Text | Field Label | Address Line(s) |
Meta Field Name | HomeAddrAllLines | |
New Line | Selected | |
Max Input Length | 150 | |
Size by content | Selected | |
Single Text | Field Label | City |
Meta Field Name | HomeAddrCity | |
Max Input Length | 50 | |
Size by content | Selected | |
Domain Single Selection | Field Label | State |
Meta Field Name | HomeAddrState | |
Data Attribute: | 100801 | |
Display Attributes: | 100801 | |
Domain: | States | |
Display Type: | Select | |
Size by content | Selected | |
Single Text | Field Label | Zip Code |
Meta Field Name | HomeAddrZip | |
Max Input Length | 10 | |
Size by content | Selected |
Step 3: Apply Changes
Step 4: Test the Widget
Test the widget by opening it. There should be one instance of the Primary Beneficiaries field group visible.
A wizard with a repeatable field group
Click Another Beneficiary at the bottom of the screen. An entry for a second beneficiary appears. You may add up to four entries. If necessary, you can delete either one of the entries, by clicking on the X.
A wizard with an added repeatable field group