Subform form control

A form control that lets a form user enter a subform.

Configure the Subform form control

To configure the Subform control, do the procedure in this topic.

Video

Examples

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add a Subform control:
      1. On the eForm Builder screen, in the Toolbox, open the Common Controls tab.
      2. On the Common Controls tab, drag a Subform form control onto your eForm.
    • Change a Subform control:
      1. On your eForm, click the control, and click Edit .

Procedure

  1. Complete the settings on the configuration screens. You can use the Process Data screen to specify a variable.

    For more information, refer to Use Process Variables to Configure an Activity or a Form Control.

General

Specifies the basic configuration for your form control.

Screen



Fields

Field Name Definition

Label

Function:
Specifies the text label that shows on your form for the control.
Accepted Values:
One line of text that can have spaces.
Default Value:
Different for different controls.
Example:
Refer to:

Internal Name

Function:
Specifies a unique, technical name for your control.
Accepted Values:
One line of text with no spaces.
Default Value:
Different for different controls.
Example:
Refer to:

Help Text

Function:
A description for your control.
Accepted Values:
More than one line of text.
Default Value:
None

Help Text Display

Function:
Specifies if the field shows the text in Help Text field when the form user puts the mouse on the label or field.
Accepted Values:
  • None - Does not show the help text.
  • Hover On Label - Shows the help text when you put your mouse on the label.
  • Hover On Field - Shows the help text when you put your mouse on the field.
  • Hover On Both - Shows the help text when you put your mouse on the label and Field.
Default Value:
None

Configure

Configures advanced settings for your form control.



Fields

Field Name Definition

Show Label

Function:
Specifies if the form panel shows a label at the top.
Accepted Values:
  • Deselected - Shows no label at the top.
  • Selected - Shows label at the top.
Default Value:
Selected

Display Style

Function:
Specifies if the form control shows the values in rows or columns.
Accepted Values:
  • Rows - Shows the form controls of the subform as columns in rows.
  • Columns - Shows the form controls of the subform as columns.
  • Summary Columns - Shows a summary of the form controls in the subform as columns. You can not use summary columns in a child subform within a group of nested subforms.
Default Value:
Rows
Example:
Refer to:

Repeatable

Function:
Specifies if the form control values can repeat.
Accepted Values:
  • Deselected - The form control values do not repeat.
  • Selected - The form control values repeat.
Default Value:
Deselected

Expandable

Function:
Specifies if the process participant can expand the form control values.
To Open this Field:
  1. In the Display Style field, select Rows.
Accepted Values:
  • Deselected - The participant can not expand the form control values.
  • Selected - The participant can expand the form control values.
Default Value:
Deselected

Expand By Default

Function:
Specifies if the form control values are expanded by default.
To Open this Field:
  1. Select Expandable.
Accepted Values:
  • Deselected - The form control values are expanded by default.
  • Selected - The form control values are expanded by default.
Default Value:
Selected

Choose Summary Fields

Function:
Specifies the form controls to include and make it editable in the summary column in the subform.
To Open this Field:
In the Display Style field, select Summary Columns.

Choose Fields To Exclude In Column Layout

Function:
Specifies the form controls to hide in the subform.
To Open this Field:
In the Display Style field, select Columns.

List Options

Function:
Specifies the data source to get the options in the list.
To Open this Field:
  1. Select Repeatable.
Accepted Values:
  • None
  • Inline List - Completes the list with the values specified in the form control.
  • Lookup List - Completes the list with the values from an external data source.
Default Value:
None

Name

Function:
Specifies the name of the option shown in the drop-down list.
To Open this Field:
  1. In the List Options field, select Inline List.
Accepted Values:
One line of text that can have spaces.
Default Value:
Option 1

Value

Function:
Specifies the value of the name option that shows in the list.
To Open this Field:
  1. In the List Options field, select Inline List.
Accepted Values:
One line of text that can have spaces.
Default Value:
Option 1

Choose a Default Option

Function:
Specifies the name option shown to the form user as default in the drop-down list.
To Open this Field:
  1. In the Select List Type field, select Inline List.
Accepted Values:
  • Selected - The selected option is the default list name.
  • Deselected - The option is not the default list name.
Default Value:
Deselected

Delete

Function:
Deletes the selected row.
To Open this Field:
  1. In the Select List Type field, select Inline List.

Add Option

Function:
Adds more rows.

You can drag the rows to change the order.

To Open this Field:
  1. In the Select List Type field, select Inline List.

Lookup Source

Function:
Specifies the name of your data lookup source.
To Open this Field:
  1. In the List Options field, select Lookup List.
Accepted Values:
A valid lookup source
Default Value:
None

Add Lookup

Opens this Screen:
Select Data Source Type screen
To Open this Field:
  1. In the Select List Type field, select Lookup List.
Function of this Screen:
Specifies the data source where the form control will do the lookup procedure.

Allow Add

Function:
Specifies if the form user can add new records.
Accepted Values:
  • Selected - Lets the form user add new records.
  • Deselected - Does not let the form user add new records.
Default Value:
Selected

Allow Delete

Function:
Specifies if the form user can delete records.
Accepted Values:
  • Selected - Lets the form user delete records.
  • Deselected - Does not let the form user delete records.
Default Value:
Selected

Allow Copy

Function:
Specifies if the form user can copy records.
To Open this Field:
  1. Select Repeatable.
Accepted Values:
  • Selected - Lets the form user copy records.
  • Deselected - Does not let the form user copy records.
Default Value:
Selected

Confirm Deletion

Function:
Specifies if the form user must confirm before he deletes the record.
To Open this Field:
  1. Select Repeatable.
Accepted Values:
  • Selected - The form user must confirm before he deletes the record.
  • Deselected - The form user does not confirm before he deletes the record.
Default Value:
Selected

Show Row Number

Function:
Specifies if the row numbers show on the subform.
To Open this Field:
  1. Select Repeatable.
Accepted Values:
  • Selected - The row numbers show.
  • Deselected - The row numbers do not show.
Default Value:
Deselected

Read-Only History

Function:
Specifies if the participant can change the form data history.
To Open this Field:
  1. Select Repeatable.
Accepted Values:
  • Selected - The participant can not change the form data history.
  • Deselected - The participant can change the form data history.
Default Value:
Deselected

Minimum Occurrences

Function:
Specifies the minimum number of times a record shows on a subform.
To Open this Field:
  1. Select Repeatable.
Accepted Values:
An integer up to 999.
Default Value:
1

Maximum Occurrences

Function:
Specifies the maximum number of times a record shows on a subform.
To Open this Field:
  1. Select Repeatable.
Accepted Values:
An integer up to 9999999.
Default Value:
5
Example:
Refer to:

Default Occurrences

Function:
Specifies if the default number of times a record shows on the subform.
To Open this Field:
  1. Select Repeatable.
Accepted Values:
An integer up to 999.
Default Value:
1
Example:
Refer to:

Page Results

Function:
Specifies if the results show on more than one page.
To Open this Field:
  1. Select Repeatable.
Accepted Values:
  • Yes - The results show on more than one page.
  • No - The results do not show on more than one page.
Default Value:
No

Number Of Records Per Page

Function:
Specifies the number of records per page.
To Open this Field:
  1. In the Page Results field, select Yes.
Accepted Values:
An integer.
Default Value:
5

Show Action Buttons As Image

Function:
Specifies if the action buttons use images or text labels.
To Open this Field:
  1. Select Repeatable.
Accepted Values:
  • Selected - The action buttons use images.
  • Deselected - The action buttons use text labels.
Default Value:
Selected

Add Button Text

Function:
Specifies the text to show on the Add button.
To Open this Field:
  1. Deselect Show Action Buttons As Image field.
Accepted Values:
One line of text.
Default Value:
Add Record

Copy Button Text

Function:
Specifies the text to show on the Copy button.
To Open this Field:
  1. Deselect Show Action Buttons As Image.
Accepted Values:
One line of text.
Default Value:
Copy Record

Delete Button Text

Function:
Specifies the text to show on the Delete button.
To Open this Field:
  1. Deselect Show Action Buttons As Image.
Accepted Values:
One line of text that can have spaces.
Default Value:
Delete Record

Mobile Display Style

Function:
Specifies if the subform shows one form controls per row on a mobile device. Showing form controls in rows saves space on a small screen.
Accepted Values:
  • Inherit - Shows the form controls on the subform in the format you specify.
  • Rows - Shows one form control per row on the subform.
Default Value:
Inherit

Appearance

Specifies the look and feel for your form control.

Screen



Fields

Field Name Definition

Font Family

Function:
Specifies the font family of the input text and label.
Accepted Values:
A valid font name from the list.
Default Value:
Arial

Font Style

Function:
Specifies the style of the font for the input text and label.
Accepted Values:
  • Bold - Shows the input text and label in bold.
  • Underline - Shows the label underlined.
  • Italic - Shows the label in italic.
Default Value:
None

Foreground Color

Function:
Specifies the foreground color for your control.
Accepted Values:
A color value using a hex code, RGB code, or RGBA code.

You can enter a color code, or select a color from the palette.

Default Value:
#ff0000

Container CSS Class

Function:
Specifies a CSS class for the container of your control.
Accepted Values:
A valid CSS class.
Default Value:
None

If you specify your CSS on the top menu, the CSS is populated.

Example:
Refer to:

Font Size (px)

Function:
Specifies the size of the input text and label for your form control.
Accepted Values:
A valid positive integer.
Default Value:
12

Behavior

Specifies how the control shows on your form.



Fields

Field Name Definition

Enable

Function:
Specifies if the form user can change the value of a field.
Accepted Values:
  • Selected - The form user can change the value.
  • Deselected - The form user cannot change the value.
Default Value:
Selected

Visible

Function:
Specifies if the form user sees the field.
Accepted Values:
  • Selected - The form user sees the field.
  • Deselected - The form user does not see the field.
Default Value:
Selected

Advanced

Specifies advanced settings for your form control.



Fields

Field Name Definition

Field ID

Function:
Shows an ID of the control.
Accepted Values:
Read-only.
Default Value:
Different for different controls.

Sub Total

Function:
Shows the total number of rows.

This is not available for nested subforms.

To Open this Field:
  1. In the Configure tab, select Repeatable.

Sort Columns

Function:
Specifies the sort order for the columns.

Auto-Lookups To Exclude On Form Load Or Edit

Function:
Specifies the form controls to exclude from a lookup in the subform when the eForm loads in the browser, or the user changes the value in the form control.

Excluding Auto-Lookups is recommended in these conditions:

  • You do not want to overwrite user input when a form loads in the browser.
  • Under some conditions, such as Summary View, form controls open for editing in a pop-up screen. A user may input data in a form control, and then the control opens again in a pop-up, such as in Summary View. In this case, you may not want to execute the Auto-Lookup again because it will overwrite the user's input.

    There are some exceptions to this recommendation. For more information, refer to Limitations.

Limitations:
Excluding Auto-Lookups is not recommended for list or other form control whose options populate using an Auto-Lookup. If you exclude the Auto-Lookup, the values not populate. That includes a value the user has selected. This limitation applies on both form load and form control edit events.

This is an exception to the recommended case where the form control opens for editing in a pop-up screen.

To Open this Field:
On the Configure tab, in the Display Style field, select Summary Columns.

Export As CSV

Function:
Specifies to export the subform data in .csv format. For a nested subform, it may not be possible to give correctly formatted values.
Accepted Values:
  • Selected - The subform data is exported in .csv format.
  • Deselected - The subform data is not exported in .csv format.
Default Value:
Deselected

Data Security Settings

Function:
Specifies whether to store information from the field in the process schema, so the application can use it again, or to simply pass on the information after the form is submitted without storing the information. This option helps to protect sensitive user information.
Accepted Values:
  • Persist - Stores the data from the field in the process schema, so the application can use it again.
  • Do Not Persist - Does not store the data from the field in the process schema. This option provides greater security for sensitive user information.
Default Value:
Persist

Show In Tablet

Function:
Specifies if the form field shows on a tablet.
Accepted Values:
  • Selected - The form field shows on a tablet.
  • Deselected - The form field does not show on a tablet.
Default Value:
Selected

Show In Mobile

Function:
Specifies if the form field shows on a mobile device.
Accepted Values:
  • Selected - The form field shows on a mobile device.
  • Deselected - The form field does not show on a mobile device.
Default Value:
Selected