Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
borderColorgreenpurple
borderWidth1
titleBGColor#ddffcc#ddccff
borderStylesolid
titleDefinitionNew Feature

New feature added in Joget DX :

  • Do not load subform in the background when it is collapsed or hidden option 


Table of Contents

Introduction

English
AJAX SubFormAJAX Sub Form gives you the flexibility of dynamically loading a Subform by attaching a listener to other another form field.

Unlike the generic Sub Form element found in the community edition, AJAX Sub Form gives you the flexibility of dynamically populating a Subform as the value it watches changes.

 
Info
titleData to load by the AJAX Subform

The target's form Load Binder will be executed to fetch record matched from the properties defined in AJAX Subform.

Panel
borderColorpurple
borderWidth1
titleBGColor#ddccff
borderStylesolid
titleNew Feature

New feature added in Joget DX Enterprise and Professional Edition:

  • Do not load subform in background when it is collapsed or hidden 

Image Removed

Figure 1: Screenshot highlighting AJAX Subform in Form Builder

Image Removed

Figure 2: Screenshot highlighting AJAX Subform in Form Builder Preview

Image Removed

Figure 3: AJAX Subform Properties

.

The Advanced Grid is only available on Professional and Enterprise Edition.

Get Started

The easiest way to see how the AJAX Subform works is to create a new app. Here are the steps:

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

  2. Log in as admin and click on the Design New App button. (see Figure 1)

    Image Added
    Figure 1

  3. Fill up the App Details as follows and click Save (see Figure 2):
      1. App ID: ajaxSubform
      2. App Name: AJAX Subform

    Image Added
    Figure 2

  4. You will be directed to the Design App. Click on the Create New Form button and fill up the Form Details as follows (see Figure 3):
    1. Form ID: formA
    2. Form Name: Form A
    3. Table Name: as_a

    Image Added
    Figure 3

  5. Click on Save and you will be directed to the  Form Builder.

  6. Drag and drop a Text Field element on to the canvas.

  7. Hover the mouse over the Text Field element on the canvas and click on Edit to open up the Edit Text Field properties.

  8. Fill up the Edit Text Field  properties as follows and click on OK (see Figure 4):
    1. ID: name
    2. Label: Name

    Image Added
    Figure 4

  9. Click on Save on the Form Builder.

  10. Click on Generate App, select Generate CRUD and click OK (see Figure 5)

  11. Once the App Generator is complete, click on the link to launch the userview.

  12. Click on New button and Save at least 2 records of data (see Figure 5)

    Image Added
    Figure 5

  13. Head back to the Design App.

  14. Click on the Create New Form button and fill up the Form Details as follows (see Figure 6):
    1. ID: formB
    2. Form Name: Form B
    3. Table Name: as_b

    Image Added
    Figure 6

  15. Click on Save and you will be directed to the  Form Builder. 

  16. Drag and drop a Select Box element on to the canvas.

  17. Hover the mouse over the Select Box element on the canvas and click on Edit to open up the Edit Select Box properties.

  18. Fill up the Edit Select Box properties as follows and click on Next (see Figure 7):
    1. ID: field1
    2. Label: Choose record from Form A
    3. Choose Options Binder: Default Form Options Binder

  19. Fill up the following details in the Select Form and click OK (see Figure 7):
    1. Form: Form A
    2. Label Column: name

    Image Added
    Figure 7

  20. Drag and drop an AJAX Subform element on to the canvas.

  21. Hover the mouse over the AJAX Subform element on the canvas and click on Edit to open up the Edit AJAX Subform properties.

  22. Fill up the Edit AJAX Subform properties as follows and click on Next (see Figure 8):
    1. Form: Form A


  23. Tick the first three checkboxes and click Next (see Figure 8)

  24. Fill up the Edit AJAX Subform properties as follows and click on OK (see Figure 8):
    1. Parent Field to keep Subform ID: field1

    Image Added
    Figure 8

  25. Click on Preview and select between the records in the Select Box to see the Subform dynamically loads the appropriate record.

How to use AJAX Subform

Widget Connector
width700
urlhttps://www.youtube.com/watch?v=arYXY7TDOtA
height550

AJAX Subform Properties

Edit AJAX Subform 

Image Added

NameDescription
ID

Element ID (By declaring as "view_existing_claim", a corresponding database table column "c_view_existing_claim" 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.
Form

Target Form to be loaded.

Info
titleUsage of Hash Variable

The use of Hash Variables inside the target form is permissible but may be limited due to the nature of how the form is loaded.

Example 1: One can use #requestParam.primaryKey# to access the record ID.

Example 2: One can use #form.tableName.fieldId[{requestParam.primaryKey}]# to access field value of the given record ID.


UI

Image Removed

General

Image AddedFigure 4: AJAX Subform Properties - UI

NameDescription
Reload Sub Form SubForm when Parent Field value change?

Dynamically reload the subform when parent field value changes.

Info

Parent Field value here refers to the

Parent Field to keep Subform ID setting in the next tab.
Readonly

Determines if the element is editable.

Display field as Label when readonlyread-only?

Displays the value of the element as plain text when an element is set to "Readonly".

Display without frame?
Decorator option. Removes default styling applied to SubForm when checked.
Collapsible?
Make the AJAX Subform collapsible.



Collapsible Setting

Image Added

7
NameDescription

Collapsible?

Make the AJAX Subform collapsible.

Label when expanded

Label when expanded

Label when collapsed

Label when collapsed

Expanded by default?

Expanded by default option.

Hide when no value?

To hide the AJAX Subform when there's no data to be loaded.

Do not load subform in background when it is collapsed or hidden

To not load the subform when it is collapsed or hidden.

Info
titleNew Feature

Newly introduced in Joget DX

...

...


Data & Binder

Data Linkage

Image Added

NameDescription
Parent Field to keep Subform ID
The ID of the field in the parent form to store the Sub Form SubForm table's primary key. Sub Form SubForm data will be loaded based on the record ID retrieved from this field.
Subform Field to keep Parent ID

The ID of the field in the Sub Form SubForm form to store the parent table's primary key.

Store Binder 

By default, the Workflow Form Binder plugin is used for loading and storage of form data in the AJAX Subform, you may override it with other plugins.

Info
titleImportant

The target form's Store Binder will not be executed. The Store Binder selected in this property will be executed instead.

See the list of available Form Binder.




Binder

Image Added


NameDescription
Store Binder 

By default, the Workflow Form Binder plugin is used for loading and storage of form data in the AJAX Subform, you may override it with other plugins.

Info
titleImportant

The target form's Store Binder will not be executed. The Store Binder selected in this property will be executed instead.

See a list of available Form Binder.



Related Video Tutorials

Widget Connector
urlhttps://www.youtube.com/watch?v=TXh_5_Wh26Y&feature=youtu.be


Download Demo App

Download the demo app with examples on using Ajax Subform with two options: 'JDBC SQL query' and ' Workflow Form Binder':