Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

The Grid enables one to capture structured and related data.

Get Started

The easiest way to see how the Grid works are to use the existing built-in App Expenses Claims. Here are the steps:

  1. Start the Joget Server and open the App Center.

  2. Log in as admin and click on the pencil icon on the Expenses Claim to open the App Composer. (see Figure 1)


    Figure 1

  3. Under Form Builder column, click on Expense Claim Resubmit (see Figure 2)


    Figure 2

  4. Click anywhere on the Grid element on the canvas under Approval Comment(s) section to access the Property Editor.

  5. Click on UI & Validation, uncheck the Readonly checkbox and click Apply Changes (see Figure 3).


    Figure 3

  6. Click on Preview to open up the Preview tab, click on Click to edit to enter values and click on Add Row link to add more rows.

Grid Properties

Configure Grid

Figure 4: Configure Grid Properties

NameDescription
Options

Column definition and column label.

The column name is defined in the Field ID column whereas the corresponding label is defined in the label column.

Field ID

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

Please see Form Element for more information about defining the ID and list of reserved IDs.

LabelElement Label to be displayed to the end-user.

UI & Validation

Figure 5 : Configure Grid - UI & Validation

NameDescription
Readonly

Determines if the element is editable.

Validator

Attach a Validator plugin to validate the input value. Please see Form Validator.

Info
titleWhen will validation takes place?

Validation will take place whenever a form is submitted except when it is submitted as "Save as Draft".

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 MessageError message to be shown when row requirements set above is not met.

Data

NameDescription
 Load Data From

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 another form.

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

Data Binder - Multirow Form Binder

NameDescription
FormForm to store to or load from
Foreign KeyForeign Key for records lookup.