Introduction
English |
---|
The List Grid is best described similar to a Form Grid, but with the capability to add new records from a List instead. The Advanced Grid is only available on Professional and Enterprise Edition. |
Get Started
The easiest way to see how the List Grid works is to create a new app. Here are the steps:
- Start the Joget Server and open the App Center.
- Log in as admin and click on the Design New App button. (see Figure 1)
Image Removed
Image Added
Figure 1
- Fill Select Create A Blank App and fill up the App Details as follows and click Save (see Figure 2):
- App ID: listgrid
- App Name: List Grid
Image Modified
Figure 2
- You will be directed to the Design App Composer. Click on the Create New Form button and fill up the Form Details as follows (see Figure 3):
- Form ID: formA
- Form Name: Form A
- Table Name: lg_a
Figure 3
- Click on Save and you will be directed to the Form Builder.
- Drag and drop a Text Field element on to the canvas.
- Click on the Text Field element on the canvas to open up the Configure Text Field properties.
- Fill up the Configure Text Field properties as follows and click on OK (see Figure 4):
- ID: name
- Label: Name
Figure 4
- Click Apply Changes and Change and Save the changes on the Form Builder.
- Click on Generate App, select Generate CRUD and click OK Generate (see Figure 5).
- Once the App Generator is complete, click on the link to launch the UI.
- Click on New button and Save at least 2 records of data (see Figure 5).
Figure 5
- Head back to the Design App Composer.
- Click on the Create New Form button and fill up the Form Details as follows:
- ID: formB
- Form Name: Form B
- Table Name: lg_b
- Click on Save and you will be directed to the Form Builder.
- Drag and drop a List Grid element on to the canvas.
- Click on the List Grid element to open up the Configure List Grid properties.
- Fill up the Configure List Grid properties as follows and click on Next (see Figure 6):
- List: List - Form A
Columns:
Figure 6
- Click on Preview , click on the plus sign on the List Grid and it will open up a popup list displaying the data you recently entered in step 12. Tick any number of rows and click Submit button. The name of the data selected will be displayed in the List Grid.
...
Name | Description |
---|
Validator | Attach a Validator plugin to validate the input value. Info |
---|
title | When will validation takes place? |
---|
| Validation will take place whenever a form is submitted except when it is submitted as "Save as Draft". |
Available options: |
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. |
Data BinderStore
Name | Description |
---|
Load Data From | Load Data From allows you to customize the method for data retrieval to populate the list grid in the form. |
Save Data To | Save Data To allows you to customize the method on how the list grid row records are saved to. This option is empty by default. An empty binder Data Store means that the list grid records will be saved/loaded as a JSON format in the parent form & database table. See the list of available Form BindersData Stores. The recommended binder Data Store to use is the Multirow Form BinderData Store so that each record is saved into a child database table via a subform definition. The binder Data Store will update the foreign key "parent id" into each child record to point to the parent database table. |
...
Name | Description |
---|
Delete Associated Grid Data? | If the popup form has a grid element(s), this option will delete the inner grid data. Panel |
---|
borderColor | #ffa700 |
---|
borderWidth | 1 |
---|
titleBGColor | #ffdb99 |
---|
borderStyle | solid |
---|
title | 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 traverse 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 ONE of the options is checked, abc.pdf will NOT be deleted. |
|
Delete Associated Child Form Data? | If the popup form has a child element(s), this option will delete the child data. Panel |
---|
borderColor | #ffa700 |
---|
borderWidth | 1 |
---|
titleBGColor | #ffdb99 |
---|
borderStyle | solid |
---|
title | 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 a file upload element, this option will delete the actual uploaded file(s). Panel |
---|
borderColor | #ffa700 |
---|
borderWidth | 1 |
---|
titleBGColor | #ffdb99 |
---|
borderStyle | solid |
---|
title | 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, these options will abort those process instances. |
Panel |
---|
borderColor | purple |
---|
bgColor | white |
---|
titleColor | black |
---|
borderWidth | 1 |
---|
titleBGColor | #ddccff |
---|
borderStyle | solid |
---|
title | New feature |
---|
|
New feature in Joget DX 8 version 8.1 onwards
Bulk Deletion- List Grid now accepts the action to bulk delete rows of data (temporary deletion). Denoted by a simple check box, users can select the records they want, or select the check box on the header to select al the rows.
- Select/Deselect row(s) using the checkbox, and click on the trash icon above the table to delete row(s) of table.
Image Added
|
Advanced
Name | Description |
---|
URL Request Parameters for List | Refine the target Data List selections by defining the filter criteria here. Name | Description |
---|
Parameter | Target Data List filter parameter name | Field ID | Current form element field ID | Default Value | Default Value for the search parameter |
|
...