Configuring a Repeatable Field Group with "Add" Functionality

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 unnecessary 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

Result

1

Create a page first with a section labeled Primary Beneficiaries and one Field Group.

^{Adding a repeatable field group to a wizard}

Field

Value

2

Field Label

<h3>$index+1. Beneficiary</h3>
This is the label of the Field Group that will be visible to the user and includes numbering.

3

Name

PrimaryBeneficiaries
This is the name of the Field Group as it appears in the Page Tree and as it is referenced in JSON.

4

Meta field pattern

Beneficiary{{$index+1}}.
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.

5

Repeat

Selected

6

Number of repetitions

1
One group will be initially displayed to the user.

7

Allow adding

Selected
This will show Add and Remove (as an X icon) buttons to the user.

8

Add button label

Another Beneficiary
Label that will be used for the Add button.

9

Remove button label

Leave empty.
Only the X icon will be displayed.

10

Maximum repetitions

4
Maximum number of groups that the user may add.

11

Minimum repetitions

1
Minimum number of groups that must remain present.
Remove icon will be shown only next to those groups that are above this number.

12

Add several fields to the group:

Percentage of the share
Social Security Number
Full Name
Relation to the owner
Date of birth
Home Address

^{Adding fields to a repeatable Field Group}

Field Type

Settings

13

Single Text

Setting	Value
Field Label	Percentage of the share (%)
Meta Field Name	BeneficiaryPerc
Max Input Length	3
Size by content	Selected

14

Single Text

Setting	Value
Field Label	SSN/TIN
Meta Field Name	SocSecNumber
Max Input Length	10
Size by content	Selected

15

Single Text

Setting	Value
Field Label	First and last name or trust name
Meta Field Name	FullName
Max Input Length	150
Size by content	Selected

16

Single Selection

Setting	Value
Field Label	Leave empty
Meta Field Name	BeneRelation
Display Type	Radio List
Layout	Horizontal
Choices	Value = 1 Label = Spouse
Choices	Value = 2 Label = Nonspouse
Choices	Value = 3 Label = Trust
Size by content	Selected

17

Date and time

Setting	Value
Field Label	Date of birth or trust
Meta Field Name	DateOfBirth
Display Type	DateLocal
Size by content	Selected

18

Single Text

Setting	Value
Field Label	Address Line(s)
Meta Field Name	HomeAddrAllLines
New Line	Selected
Max Input Length	150
Size by content	Selected

19

Single Text

Setting	Value
Field Label	City
Meta Field Name	HomeAddrCity
Max Input Length	50
Size by content	Selected

20

Domain Single Selection

Setting	Value
Field Label	State
Meta Field Name	HomeAddrState
Data Attribute	100801
Display Attributes	100801
Domain	States
Display Type	Select
Size by content	Selected

21

Single Text

Setting	Value
Field Label	Zip Code
Meta Field Name	HomeAddrZip
Max Input Length	10
Size by content	Selected

22

Exit the Field Group editing mode by clicking on the page name in the Page Tree.

23

Click Apply button in the bottom of the screen to close the Widget Design Screen and apply changes. Then click Save button in the top of the Widget Details Screen to save these changes.

24

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}

25

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}