How to develop a JDBC Form Load Binder

In this tutorial, we will following the guideline of developing a plugin to develop our JDBC Form Load Binder plugin. Please also refer to the very first tutorial How to develop a Bean Shell Hash Variable and also a JDBC related plugin How to develop a JDBC Options Binder for more details steps.

1. What is the problem?

For integration purpose, we would like to load our form data from a different database table instead of Joget form data table.

2. What is your idea to solve the problem?

Joget Workflow has provided a plugin type called Form Load Binder Plugin. We will develop one to support JDBC connection and custom query to load form data.

3. What is the input needed for your plugin?

To develop a JDBC Load binder, we will need the JDBC connection setting and also the custom query to populate the form data based on primary key or foreign key (for Grid).

1. Datasource: Using custom datasource or Joget default datasource
2. Custom JDBC Driver: The JDBC driver for custom datasource
3. Custom JDBC URL: The JDBC connection URL for custom datasource
4. Custom JDBC Username: The username for custom datasource
5. Custom JDBC Password: The password for custom datasource
6. SQL Query: The query to populate form data. 
   

The query should also support a syntax to inject the primary key (For Form/Section) or foreign key (For Grid element)

Example:

1. SELECT * from app_fd_sample where id = ?

4. What is the output and expected outcome of your plugin?

All retrieved columns are auto mapped to the fields with column name equal to field id. 

5. Is there any resources/API that can be reuse?

We can refer to the implementation of other available Form Load Binder plugins. Joget default datasource can be retrieve with AppUtil.getApplicationContext().getBean("setupDataSource").

6. Prepare your development environment

- Home
  - joget
    - plugins
    - jw-community
      -5.0.0

cd joget/plugins/
~/joget/jw-community/5.0.0/wflow-plugin-archetype/create-plugin.sh org.joget.tutorial jdbc_load_binder 5.0.0

Define value for property 'version':  1.0-SNAPSHOT: : 5.0.0
[INFO] Using property: package = org.joget.tutorial
Confirm properties configuration:
groupId: org.joget.tutorial
artifactId: jdbc_load_binder
version: 5.0.0
package: org.joget.tutorial
Y: : y

7. Just code it!

a. Extending the abstract class of a plugin type

Create a "JdbcLoadBinder" class under "org.joget.tutorial" package. Then, extend the class with org.joget.apps.form.model.FormBinder abstract class.

To make it work as a Form Load Binder, we will need to implement org.joget.apps.form.model.FormLoadBinder interface. Then, we need to implement org.joget.apps.form.model.FormLoadElementBinder interface to make this plugin show as a selection in load binder select box and implement org.joget.apps.form.model.FormLoadMultiRowElementBinder interface to list it under the load binder select box of grid element. 

 Please refer to Form Load Binder Plugin.

b. Implement all the abstract methods

As usual, we have to implement all the abstract methods. We will using AppPluginUtil.getMessage method to support i18n and using constant variable MESSAGE_PATH for message resource bundle directory.

package org.joget.tutorial;
 
import org.joget.apps.app.service.AppPluginUtil;
import org.joget.apps.app.service.AppUtil;
import org.joget.apps.form.model.Element;
import org.joget.apps.form.model.FormBinder;
import org.joget.apps.form.model.FormData;
import org.joget.apps.form.model.FormLoadBinder;
import org.joget.apps.form.model.FormLoadElementBinder;
import org.joget.apps.form.model.FormLoadMultiRowElementBinder;
import org.joget.apps.form.model.FormRowSet;
 
public class JdbcLoadBinder extends FormBinder implements FormLoadBinder, FormLoadElementBinder, FormLoadMultiRowElementBinder {
    
    private final static String MESSAGE_PATH = "messages/JdbcLoadBinder";
    
    public String getName() {
        return "JDBC Load Binder";
    }
 
    public String getVersion() {
        return "5.0.0";
    }
    
    public String getClassName() {
        return getClass().getName();
    }
 
    public String getLabel() {
        //support i18n
        return AppPluginUtil.getMessage("org.joget.tutorial.JdbcLoadBinder.pluginLabel", getClassName(), MESSAGE_PATH);
    }
    
    public String getDescription() {
        //support i18n
        return AppPluginUtil.getMessage("org.joget.tutorial.JdbcLoadBinder.pluginDesc", getClassName(), MESSAGE_PATH);
    }
 
    public String getPropertyOptions() {
        return AppUtil.readPluginResource(getClassName(), "/properties/jdbcLoadBinder.json", null, true, MESSAGE_PATH);
    }
 
    public FormRowSet load(Element element, String primaryKey, FormData formData) {
        throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
    }
}