Page History

We need to always have our Joget Workflow Source Code ready and builded by following this guideline. 

The following tutorial is prepared with a Macbook Pro and Joget Source Code version 5.0.0. Please refer to 如何开发插件 for other platform command.

Let say our folder directory is as follows. 

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

The "plugins" directory is the folder we will create and store all our plugins and the "jw-community" directory is where the Joget Workflow Source code stored.

Run the following command to create a maven project in "plugins" directory.

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

Then, the shell script will ask us to key in a version for your plugin and ask us for confirmation before generate the maven project.

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

We should get "BUILD SUCCESS" message shown in our terminal and a "jdbc_load_binder" folder created in "plugins" folder.

Open the maven project with your favour IDE. I will be using NetBeans.  

我们需要始终准备好Joget Workflow Source Code，并按照这个指导方针建立起来  。 

以下教程是使用Macbook Pro和Joget源代码5.0.0版编写的。 其他平台命令请参考  如何开发插件。

假设我们的文件夹目录如下所示。 

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

“plugins”目录是我们要创建和存储我们所有插件的文件夹，“jw-community”目录是Joget Workflow源代码存储的地方。

运行以下命令在“plugins”目录下创建一个maven项目。

然后，shell脚本将要求我们为您的插件输入一个版本，并在生成maven项目之前要求我们确认。

我们应该“使成功”，在我们的终端和“插件”文件夹中创建一个“jdbc_load_binder”文件夹中显示的信息。

用你喜欢的IDE打开maven项目。我将使用  NetBeans。  

package org.joget.tutorial;
 Element;
import org.joget.apps.form.model.FormBinder;
import org.joget.apps.form.model.FormData;
import org.joget.apps.appform.servicemodel.AppPluginUtilFormLoadBinder;
import org.joget.apps.appform.servicemodel.AppUtilFormLoadElementBinder;
import org.joget.apps.form.model.ElementFormLoadMultiRowElementBinder;
import org.joget.apps.form.model.FormBinderFormRowSet;
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 
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.
    }
}

Then, we have to do a UI for admin user to provide inputs for our plugin. In getPropertyOptions method, we already specify our 插件属性选项与配置 definition file is locate at "/properties/jdbcLoadBinder.json". Let us create a directory "resources/properties" under "jdbc_然后，我们必须为管理员用户提供一个UI来为我们的插件提供输入。在getPropertyOptions方法中，我们已经指定了我们的  插件属性选项和配置  定义文件位于“/properties/jdbcLoadBinder.json”。让我们在“jdbc_load_binder / src / main”目录下创建一个目录“resources / main" directory. After create the directory, create a file named "jdbcLoadBinder.json" in the "properties" folder.

In the properties definition options file, we will need to provide options as below. Please note that we can use "@@message.key@@" syntax to support i18n in our properties options.

properties”。创建目录后，在“properties”文件夹中创建一个名为“jdbcLoadBinder.json”的文件。

在属性定义选项文件中，我们需要提供如下的选项。请注意，我们可以在我们的属性选项中使用“@@ message.key @@”语法来支持i18n。

Same as 与JDBC Options Binder, we will need to add a test connection button for custom JDBC setting. Please refer to 如何开发一个JDBC选项绑定器 on the Web Service 插件 implementation.

Once we done the properties option to collect input and the web service to test the connection, we can work on the main method of the plugin which is load method.

相同  ，我们需要添加一个测试连接按钮来进行自定义的JDBC设置。请参阅  如何开发一个JDBC选项绑定器上的  Web服务插件实现。

一旦我们完成了收集输入的属性选项和Web服务来测试连接，我们可以在插件的主要方法，这是加载方法。

C。管理你的插件的依赖库

我们的插件使用dbcp，javax

c. Manage the dependency libraries of your plugin

Our plugin is using dbcp, javax.servlet.http.HttpServletRequest and javaxHttpServletRequest和javax.servlet.http.HttpServletResponse class, so we will need to add jsp-api and commons-dbcp library to our POM file.

HttpServletResponse类，所以我们需要将jsp-api和commons-dbcp库添加到我们的POM文件中。

d。让你的插件国际化（i18n）准备就绪

我们在getLabel和getDescription方法中使用i18n消息密钥。我们还在我们的属性选项定义中使用了i18n消息密钥。所以，我们需要为我们的插件创建一个消息资源包属性文件。

在“jdbc_load_binder / src / main”目录下创建目录“resources / messages”。然后，在该文件夹中创建一个“JdbcLoadBinder.properties”文件。在属性文件中，让我们添加所有的消息键和它的标签如下。

d. Make your plugin internationalization (i18n) ready

We are using i18n message key in getLabel and getDescription method. We also used i18n message key in our properties options definition as well. So, we will need to create a message resource bundle properties file for our plugin.

Create directory "resources/messages" under "jdbc_load_binder/src/main" directory. Then, create a "JdbcLoadBinder.properties" file in the folder. In the properties file, let add all the message keys and its label as below.

e. Register your plugin to Felix Framework

We will have to register our plugin class in Activator class (Auto generated in the same class package) to tell Felix Framework that this is a plugin.

    public void start(BundleContext context) {
        registrationList = new ArrayList<ServiceRegistration>();
        //Register plugin here
        registrationList.add(context.registerService(JdbcLoadBinder.class.getName(), new JdbcLoadBinder(), null));
    } 

f. Build it and testing

Let build our plugin. Once the building process is done, we will found a "jdbc_load_binder-5.0.0.jar" file is created under "jdbc_load_binder/target" directory.

Then, let upload the plugin jar to Manage Plugins. After upload the jar file, double check the plugin is uploaded and activated correctly.

Image Removed

Let create a form to load firstName, lastName and email from dir_user table based on username to test the load binder.

Image Removed

Then, configure the load binder of the form to use JDBC Binder with the following query.

 select * from dir_user where username = ?

Image Removed

Image Removed

Let create an userview and drag a Form Menu element to display our form. Then, publish it and test our form with an "id" parameter.

Image Removed

Next, let add a grid element and test with the following query.

select * from dir_group g 
join dir_user_group ug on ug.groupId = g.id
where ug.userId = ?

Image Removed

Image Removed

Let check our result again.

Image Removed

e. 注册你的插件Felix框架

我们将不得不在Activator类（在同一个类包中自动生成）中注册我们的插件类，以告诉Felix框架这是一个插件。

f. 建设和测试

让我们建立我们的插件。一旦构建过程完成，我们将在“jdbc_load_binder / target”目录下创建一个“jdbc_load_binder-5.0.0.jar”文件。

然后，让插件jar上传到  管理插件。上传jar文件后，仔细检查插件是否正确上传和激活。

Image Added

让我们创建一个表单，根据用户名从dir_user表中加载firstName，lastName和email，以测试加载联编程序。

Image Added

然后，将表单的加载联编程序配置为使用JDBC联编程序和以下查询。

Image Added

Image Added

让我们创建一个用户视图并拖动一个表单菜单元素来显示我们的表单。然后，发布它并用“id”参数测试我们的表单。

Image Added

接下来，让我们添加一个网格元素，并使用以下查询进行测试。

Image Added

Image Added

再次检查我们的结果。

Image Added