Data Grid form control

A form control that lets a form user view, change, or delete the data in a table.


Data Grid form control

Configure the Data Grid form control

To configure the Data Grid Data Grid icon control, do the procedure in this topic.

Video: Common Configuration Settings in eForm Controls

How to Start

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

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 the Data Grid form control.

Figure: General tab

General tab

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.

Figure: Configure tab

Configure tab

Fields

Field Name Definition

Mandatory

Function:
Specifies if the field is mandatory.
Accepted Values:
  • Deselected - The field is not mandatory.
  • Selected - The field is mandatory.
Default Value:
Deselected
Example:
Refer to:

Mandatory Field Validation Message

Function:
Specifies the message to show if the form user does not enter data in a mandatory form control.
Accepted Values:
More than one line of text that can contain letters, numbers, spaces, and special characters.
Default Value:
Enter the ${L}

${L} is a process data variable that shows the label for a form control.

Select List Type

Function:
Specifies the data source to get the options in the list.
Accepted Values:
Default Value:
Inline List
Example:
Refer to:

Header

Function:
Specifies the heading for the column.
To Open this Field:
  1. On the Configure tab, in the Select List Type field, select Inline List.
Accepted Values:
One line of text that can have spaces.
Default Value:
Column 1

Internal Name

Function:
Specifies a unique, technical name for your header.
To Open this Field:
  1. On the Configure tab, in the Select List Type field, select Inline List.
Accepted Values:
One line of text with no spaces.
Default Value:
Column1

Data Type

Function:
Specifies the data type for the column.
To Open this Field:
  1. On the Configure tab, in the Select List Type field, select Inline List.
Accepted Values:
  • string
  • number
  • boolean
  • datetime
  • enum

Format

Function:
Specifies the date and time format that the form control shows.
To Open this Field:
  1. On the Configure tab, in the Select List Type field, select Inline List.
  2. In the Data Type field, select datetime.
Accepted Values:
  • yyyy/MM/dd hh:mm:ss - Shows the date in the format year/Month/day hour:minute:second.
  • yyyy/MM/dd - Shows the date in the format year/Month/day.
  • yyyy-MM-dd hh:mm:ss - Shows the date in the format year-Month-day hour:minute:second.
  • yyyy-MM-dd - Shows the date in the format year-Month-day.
  • MM/dd/yyyy hh:mm:ss - Shows the date in the format Month/day/year hour:minute:second.
  • MM/dd/yyyy - Shows the date in the format Month/day/year.
  • dd-MM-yyyy hh:mm:ss - Shows the date in the format day-Month-year hour:minute:second.
  • dd-MM-yyyy - Shows the date in the format day-Month-year.
  • dd MMM yyyy hh:mm:ss - Shows the date in the format day Month year hour:minute:second.
  • dd MMM yyyy - Shows the date in the format day Month year.
  • MMM dd yyyy hh:mm:ss - Shows the date in the format Month day year hour:minute:second.
  • MMM dd yyyy - Shows the date in the format Month day year.
Default Value:
None
Example:
  • 09/21/1978
  • 1978/09/21
Limitations:

This field is available in these releases:

Width (%)

Function:
Specifies width of the column in proportion to the area of your form control.
To Open this Field:
  1. On the Configure tab, in the Select List Type field, select Inline List.
Accepted Values:
An integer that represents a percentage.
Default Value:
None

Mandatory

Function:
Specifies if the column is mandatory.
To Open this Field:
  1. On the Configure tab, in the Select List Type field, select Inline List.
Accepted Values:
  • Deselected - The column is not mandatory.
  • Selected - The column is mandatory.
Default Value:
Deselected

Visible

Function:
Specifies to show or hide the columns on the form.
To Open this Field:
  1. On the Configure tab, in the Select List Type field, select Inline List.
Accepted Values:
  • Selected - Shows the column on the form.
  • Deselected - Hides the column on the form.
Default Value:
Selected
Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.

Visible in Mobile

Function:
Specifies if the form field shows on a mobile device.
To Open this Field:
  1. On the Configure tab, in the Select List Type field, select Inline List.
Accepted Values:
  • Selected - The form field shows on a mobile device.
  • Deselected - The form field does not show on a mobile device.
Default Value:
Deselected
Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 2 or higher.

Groupable

Function:
Specifies whether to group the column based on a column header at runtime.

The form user can drag a column header to group.

To Open this Field:
  1. On the Configure tab, in the Select List Type field, select Inline List.
Accepted Values:
  • Selected - Groups the column based on a column header selected at runtime.
  • Deselected - Runtime grouping is disabled.
Default Value:
Deselected
Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 2 or higher.

Delete Delete icon

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

Add Column

Function:
Adds more rows.

Lookup Source

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

Add Lookup Add Lookup icon

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.

Auto Generate Lookup Columns

Function:
Specifies if the form control completes the header and columns using information from your data source.
To Open this Field:
  1. In the Select List Type field, select Lookup List.
Accepted Values:
  • Selected - Completes the header and columns of the grid using data from your data source.
  • Deselected - Does not complete the header and columns of the grid.
Default Value:
Selected

Bound Column

Function:
Completes the column value using a specified field from your lookup source.
To Open this Field:
  1. In the Select List Type field, select Lookup List.
  2. Deselect Auto Generate Lookup Columns.
Accepted Values:
A column value from the list.
Default Value:
None

Format

Function:
Specifies the date format that the form control shows.
To Open this Field:
  1. In the Select List Type field, select Lookup List.
  2. Deselect Auto Generate Lookup Columns.
  3. In the Bound Column field, select any field that specifies the date value.
Accepted Values:
  • yyyy/MM/dd - Shows the date in the format year/Month/day.
  • yyyy-MM-dd - Shows the date in the format year-Month-day.
  • MM/dd/yyyy - Shows the date in the format Month/day/year.
  • dd-MM-yyyy - Shows the date in the format day-Month-year.
  • dd MMM yyyy - Shows the date in the format day Month year.
  • MMM dd yyyy - Shows the date in the format Month day year.
Default Value:
None
Example:
  • 09/21/1978
  • 1978/09/21
Limitations:

This field is available in these releases:

Configure Enum(Configure Enum icon

Opens this Screen:
Configure Option
To Open this Field:
  1. In the Select List Type field, select Lookup List.
  2. Deselect Auto Generate Lookup Columns.
Function of this Screen:
Configures the list of values for the columns.

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 Edit

Function:
Specifies if the form user can change values in the data grid.
Accepted Values:
  • Selected - Lets the form user change the values.
  • Deselected - Does not let the form user change the values.
Default Value:
Selected

Pop-up Edit

Function:
Specifies if the form user can change values in the data grid on an edit screen.
Accepted Values:
  • Selected - Lets the form user change values in the data grid in an edit screen.
  • Deselected - Does not let the form user change records in the data grid on an edit screen.
Default Value:
Deselected

DateTime Conversion

Function:
Specifies whether to change the date-time to ISO format.
Accepted Values:
  • Selected - The date-time value uses ISO format.
  • Deselected - The date-time value uses a specified, non-ISO format.
Default Value:
Deselected

Mandatory Column Validation Message

Function:
Specifies the message to show if the form user does not complete a mandatory column in the form.
Accepted Values:
More than one line of text that can contain letters, numbers, spaces, and special characters.
Default Value:
Please complete the mandatory columns for ${L}

${L} is a process data variable that shows the label for a form control.

Minimum Records Validation Message

Function:
Specifies the message to show if the form user does not enter a set minimum number of values in the form.
Accepted Values:
More than one line of text that can contain letters, numbers, spaces, and special characters.
Default Value:
Please enter minimum number of records for ${L}

${L} is a process data variable that shows the label for a form control.

Maximum Items

Function:
Specifies the maximum number of records the form user can enter in the form.
Accepted Values:
An integer.
Default Value:
10

Minimum Items

Function:
Specifies the minimum number of values for the form user to enter in the form.
Accepted Values:
An integer.
Default Value:
0

Appearance

Specifies the look and feel for your form control.

Figure: Appearance tab

Appearance tab

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

Apply Font Properties To Control

Function:
Specifies if the control gets the font properties from the properties set in the form settings.
Accepted Values:
  • Selected - The control gets the font properties from the properties set in the form settings.
  • Deselected - The control does not get the font properties from the properties set in the form settings.
Default Value:
Deselected

Label CSS Class

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

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

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 CSS icon 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.

Figure: Behavior tab

Behavior tab

Fields

Field Name Definition

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

Label Position

Function:
Specifies the position of the text label that shows on your form for the control.
Accepted Values:
  • Inherit - The position of the label is as specified in the form settings.
  • Left - Specifies that the position of the label is to the left of the container.
  • Top - Specifies that the position of the label is to the top of the container.
Default Value:
Inherit

Advanced

Specifies advanced settings for your form control.

Figure: Advanced tab

Advanced tab

Fields

Field Name Definition

Field ID

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

Maximum Height (px)

Function:
Specifies the maximum height for your control in pixels.
Accepted Values:
An integer less than 10000.
Default Value:
300

Export as CSV

Function:
Specifies if an Export as CSV button shows on the form control This button exports the data grid to a file in .csv format.
Accepted Values:
  • Deselected - The Export as CSV button is not shown.
  • Selected - The Export as CSV button is shown.
Default Value:
Deselected

Enable Filtering

Function:
Specifies whether to show the filter icon at runtime where the form user can specify a condition to filter the column.
Accepted Values:
  • Selected - Shows the filter icon at runtime to where the form user can specify a condition for the column filter.
  • Deselected - The user can not filter the column.
Default Value:
Deselected
Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 2 or higher.

Page Size

Function:
Specifies size of the field on your form.
Accepted Values:
An integer.
Default Value:
10

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