Form Grid

Definition

Form Grid extends the default functionalities of a typical grid element.

Unlike the generic grid element that only accepts standard text field for its inputs, the Enhanced Grid Form Element captures data by making reference to another form element.

Hence, one can take full advantage of what a typical form element has to offer, e.g., validation and formatting.

Figure 1: Screenshot of Form Grid in sample HR Expenses Claim app

Figure 2: Screenshot of Form Grid in sample HR Expenses Claim app - Add New Row

Figure 3: Form Grid Properties

Name

Description

ID

Element ID (By declaring as "entries", a corresponding database table column "c_entries" will be created)

Label

Element Label to be displayed to end user.

Form

Target form to reference to.

Columns

The columns defined here must be correspondent to the Form chosen above.

Name	Description
Value	Field ID of the form element to reference to the target form. Example: In "HR Expense Claim Entry" form, there are Form Elements with the ID "date", "category", "purpose", and "formattedAmount".
Label	Column Label.
Format Type	If you would like to format the returned value, you may make use of the format type. Default choice: Text. Available Format Types Text - formats the value as text HTML - outputs data as HTML Multiple lines text - maintains the spacing formatting for multiple lines text, such as TextArea. Decimal - formats as decimal. Number of decimals is expected in the "Format" field. Date - formats as date. Original Date and New Date formats are expected in the "Format" field. Format: (original format)\|(new format) Example of usage: Original value: 5/23/2012 Expected value: 2012/5/23 Format : M/d/y\|y/M/d Note: Please refer to Java SimpleDateFormat for date format. File - Show the value as a link to the attachment. Form Def ID is expected in the "Format" field. Expected Form Def ID Specify the Form Def ID that contains the actual File Upload form element. Image - Show the value as a thumbnail of the attachment. Form Def ID is expected in the "Format" field. Expected Form Def ID Specify the Form Def ID that contains the actual Image Upload / File Upload form element. Options - Show the label of multiple choice element given the value given. Form Def ID is expected in the "Format" field. Expected Form Def ID Specify the Form Def ID that contains the actual Select Box / Radio / Check Box form element.
Format	Depending on your chosen Format Type, additional argument may be entered here.
Width	Column width in characters. Sample 200px

Figure 4: Form Grid Properties - UI

Name	Description
Enable Sorting Feature	Determines if ordering of rows is to be enforced.
Field ID for Sorting	Field to keep the ordering sequence; must correspond with a field id in the target form.
Form Submit Button Label (Normal Mode)	Label of the Submit button in normal mode.
Form Submit Button Label (Readonly Mode)	Label of the Submit button in read-only mode.
Display field as Label when readonly?	Displays the value of the element as plain text when element is set to "Readonly".
Popup Dialog Height	Specifies the height, in characters. Sample 200px
Popup Dialog Width	Specifies the width, in characters. Sample 200px
Readonly	Determines if the element is editable.
Disable Add Feature	Determines if a new row can be added.
Disable Delete Feature	Determines if a row can be removed.
Delete confirmation message	Confirmation message when deleting a row.
Show Row Numbering?	Shows numbering on the grid.
Paging Size	Items to be displayed per page.

Figure 5: Form Grid Properties - Validation & Data Binder

Name	Description
Validator	Attach a Validator plugin to validate the input value. When will validation takes place? Validation will takes place whenever form is submitted except when it is submitted as "Save as Draft".
Unique Column	Column/Field ID to identify record ID.
Min Number of Row Validation (Integer)	Min Number of Row Validation (Integer)
Max Number of Row Validation (Integer)	Max Number of Row Validation (Integer)
Error Message	Error message to be shown when row requirements set above is not met.
Load Binder	Option by default. Grid data will be saved/loaded in JSON format in its defined database cell. In this example, Multirow Form Binder is used to load data from other form. See list of available Form Binder.
Store Binder	Option by default. Grid data will be saved/loaded in JSON format in its defined database cell. In this example, Multirow Form Binder is used to load data from other form. See list of available Form Binder.
Delete Associated Grid Data?	If the popup form has another form grid, this option will delete the inner grid data. Caution These 3 options: (Delete Associated Grid Data, Delete Associated Child Form Data, Delete Files), in combination, does apply to nested grid/child elements. These options traverses the entire form tree. Upon encountering a 'false' condition, it will move on to the next grid/child element. Example: Consider that the popup form has a form grid, form grid has a subform, subform has a file upload element with abc.pdf. If all options are checked, abc.pdf will be deleted. If all except "Delete Associated Child Form Data" is checked, abc.pdf will NOT be deleted.
Delete Associated Child Form Data?	If the popup form has a subform, this option will delete the subform data. Caution These 3 options: (Delete Associated Grid Data, Delete Associated Child Form Data, Delete Files), in combination, does apply to nested grid/child elements.
Delete Files?	If the popup form contains file upload element, this option will delete the actual uploaded file(s). Caution These 3 options: (Delete Associated Grid Data, Delete Associated Child Form Data, Delete Files), in combination, does apply to nested grid/child elements.
Abort Related Running Processes?	If there are process instances related to the deleted row, this options will abort those process instances.

Learning More

Download a tutorial app on Grids from Joget Workflow Marketplace to learn more.

Space shortcuts

Page tree