Joget Workflow v6 Beta 4 Released

Check out the latest Joget Workflow v6 Beta for many new features and improvements in user experience (UX), app maintainability and performance.

Skip to end of metadata
Go to start of metadata
Definition

List Grid is best described as a Form Grid but with the capability to add in new records from a Data List.


Figure 1: Screenshot highlighting List Grid in Form Builder

Modified the form in http://localhost:8080/jw/web/console/app/crm/1/form/builder/crm_contact

Figure 2: Screenshot highlighting adding new records using List Grid in Form

Figure 3: Screenshot highlighting new records added in List Grid in Form

Figure 4: List Grid Properties

NameDescription
IDElement ID (By declaring as "account", a corresponding database table column "c_account" will be created)
LabelElement Label to be displayed to end user.
Data ListData List to display for selection.
Columns

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

NameDescription
Value

Field ID of the target form.

Example:

In "Account" form sourced in the Data List "Account Listing", there are Form Elements with the ID "id", and "accountName".

LabelColumn Label.
EditableYes/No
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
  • Date - formats as date. Original Date and New Date formats are expected in the "Format" field.
    Format: [KB:input format]|[KB:output 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.
  • Decimal - formats as decimal. Number of decimals is expected in the "Format" field.
  • File - Show the value as a link to the attachment. Form Def id is expected in the "Format" field.
  • Image - Show the value as a thumbnail of the attachment. Form Def id is expected in the "Format" field.
FormatDepending on your chosen Format Type, additional argument may be entered here.
Width

Column width in characters.

Sample

Figure 5: List Grid Properties - UI

NameDescription
Enable Sorting FeatureDetermines 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.
Insert Button Label
Insert Button Label
Form to Edit Row
After addition of row, user may edit the record row by opening it in the Form defined here.
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?
 
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?
Show additional column on the leftmost to denote numbering.
Popup Dialog Height

Height in character

Sample
Popup Dialog Width

Width in character

Sample

Figure 6: List Grid Properties - Validation & Data Binder

NameDescription
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 ColumnColumn/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.
Store Binder

Option by default. Grid data will be saved/loaded in JSON format in its defined database cell.

Figure 7: List Grid Properties - Advanced

NameDescription
URL Request Parameters for Datalist

Refine the target Data List selections by defining the filter criteria here.

NameDescription
ParameterTarget Data List filter parameter name
Field IDCurrent form element field ID
Default ValueDefault Value for the search parameter
  • No labels