Guideline for developing a plugin

There following questions and steps are to help you plan and develop a plugin to fulfill a custom requirement.

1. What is the problem?

Example 1: Download a PDF version of a form when click on a button in a list.

Example 2: Provide a Gantt Chart view of your collected form data. 

Example 3: Hash variable is convenient in use, but it does not provide the ability to do condition checking.

2. How to solve the problem?

Example 1: Develop a Datalist Action plugin to display a button for generate form PDF.

Example 2: Develop a Userview Menu plugin that can be used to display form data as Gantt Chart.

Example 3: Develop a Hash Variable plugin that can do Bean Shell scripting.

3. What is the input needed for your plugin?

Example 1: To develop a PDF Download Datalist Action plugin, we can consider providing the following as input.

1. 1. Form ID : The form that will be used to generate the PDF file.

      แบบฟอร์ม: แบบฟอร์มที่จะใช้ในการสร้างไฟล์ PDF

   2. Record ID : Use the id of the datalist row or a column value to load the record.

      ID เรคคอร์ด: ใช้ id ของแถวดาต้าลิสต์หรือค่าคอลัมน์เพื่อโหลดเรคคอร์ด

   3. File Name : File name of the the generated PDF file.

      ชื่อไฟล์: ชื่อไฟล์ของไฟล์ PDF ที่สร้างขึ้น

   4. Formatting options : Options to format and customise the PDF output. 

      ตัวเลือกการจัดรูปแบบ: ตัวเลือกในการจัดรูปแบบและปรับแต่งเอาต์พุต PDF

Example 2: To develop an Gantt Chat Userview Menu plugin, we can consider providing the following as input.

1. 1. Datalist Binder : We can reuse datalist binder in our plugin to retrieve the data needed by the Gantt Chart.

      ดาต้าลิสต์ Binder: เราสามารถใช้ดาต้าลิสต์ Binder ในปลั๊กอินของเราเพื่อดึงข้อมูลที่ต้องการโดยแผนภูมิแกนต์

   2. Mapping : A field to map the columns that will be returned from the datalist binder to the data needed by the Gantt Chart.

      การแมป: ฟิลด์เพื่อแมปคอลัมน์ที่จะส่งคืนจากตัวยึดข้อมูลไปยังข้อมูลที่ต้องการโดยแผนภูมิแกนต์

   3. Styling : Options to style the Gantt Chart.

      จัดแต่ง: ตัวเลือกเพื่อจัดสไตล์แผนภูมิแกนต์

Example 3: Hash Variable plugin does not provide interface for user to configure, but to develop a Bean Shell Hash Variable plugin, we need somewhere to put our Bean Shell script. We can reuse the Environment Variable to store our scripts. So the Hash Variable syntax will be a prefix with environment variable key.

E.g. #beanshell.EnvironmentVariableKey#

But, this may not be enough. We may need some other way to pass in some variable too. We can consider using a URL query parameters syntax to pass in our variables because it is easier to parse later on.

E.g. #beanshell.EnvironmentVariableKey[name=Joget&email=info@joget.org&message={form.sample.message?url}]#

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

Example 1: When PDF Download Datalist Action is used as a datalist row action or column action, a normal user will see a link to download the PDF file in every rows of a datalist. Once the link is clicked, a PDF will be prompted to be downloaded.

When the plugin is used as a whole datalist action, a zip file containing all the generated PDF of every selected rows will be prompted to be downloaded.

Example 2: A normal user can see a Gantt Chart when a menu using the Gantt Chart Userview Menu plugin is clicked. User may navigate or interact with the Gantt Chart. 

Example 3: The Bean Shell Hash Variable plugin is for the admin user. Once it is used, the Hash Variable will be replaced by the output return from the Bean Shell interpreter.

5. Are there any resources/API that can be reused?

You may need to check out the document of Utility & Service Methods, JSON API, Javascript API and Bean Shell Programming Guide as well. These documents may contains some methods/examples that may help you in the development.

Example 1: To develop the PDF Download Datalist Action plugin, we can reuse the methods in FormPdfUtil to generate a form as PDF. We can also refer to the source code of the Datalist Form Data Delete Action plugin as well. Other than that, we can refer to the Export Form Email Tool on what kind of plugin properties options we can provide in the plugin as the Export Form Email Tool are using the methods in FormPdfUtil as well.

Example 2: To develop a Gantt Chart Userview Menu plugin, we can refer to the source code of all the Userview Menu plugin. From there, we can have a better understanding on how to make a template for a plugin using FreeMaker syntax. 

Example 3: To develop Bean Shell Hash Variable plugin, we can refer to the source code of all the Hash Variable plugin and Bean Shell plugin. Especially, we can refer to Environment Variable Hash Variable plugin on how to retrieve environment variable using a variable key. We can also refer to Bean Shell Tool or Bean Shell Form Binder plugin on what to execute the script with Bean Shell interpreter.

6. Prepare your development environment

a. You will need to have the Joget Open Source ready and built. We will use the "wflow-plugin-archetype" module to generate a maven project for our plugin.

b. Generate a maven project.

The project file generated will be placed at the directory specified in the command prompt, eg: running the command in "C:\" will place the project file in the root of C drive.

To get the correct jogetDependencyVersion in order to build a proper project file with correct dependencies, check the file name specified in the ".m2" folder under directory of, eg:

C:\Users\(your computer name)\.m2\repository\org\joget\wflow-core\"5.0.11"

- Run the following for Window 

                 - Sample Screenshot in Window:

"C:\Joget Source Code\wflow-plugin-archetype\create-plugin.bat" packageName pluginFolderName jogetDependencyVersion

- Run the following for Linux or Mac

/joget_src/wflow-plugin-archetype/create-plugin.sh packageName pluginFolderName jogetDependencyVersion

- Sample Screenshot in Mac:                                                                                                                                        
 

c. Open/Import the maven project with your favorite IDE. Joget team recommends NetBeans IDE.  

7. Just code it!

a. Extending the abstract class of a plugin type

Refer to the document of the plugin type listed in Plugin Types. Find the abstract class and interface that need to be extended and implemented by your plugin.

Example: To develop a Userview Menu plugin, the plugin class need to extends the org.joget.apps.userview.model.UserviewMenu abstract class.

b. Implement all the abstract methods

A plugin will have to implements the abstract method of Plugin Base Abstract Class and Interface and also the abstract method of the individual abstract class and interface for the plugin type. 

Example: To develop a Userview Menu plugin, the following methods have to be implemented by the plugin. Please refer to the plugin documents for the details of each methods.

• getCategory
• getClassName
• getDecoratedMenu
• getDescription
• getIcon
• getLabel
• getName
• getPropertyOptions
• getRenderPage
• getVersion
• isHomePageSupported

c. Manage the dependency libraries of your plugin

The generated plugin folder by "wflow-plugin-archetype" module is a maven project. So, we will using the Dependency Mechanism provided by Maven.

d. Make your plugin internationalization (i18n) ready

To make the plugin i18n ready, we need to create a message resource bundle property file for the plugin.

• Create a property file with the plugin class name in "[Plugin project directory]/src/main/resources/message" directory. 
  

  Example: For a plugin named "GanttChartMenu", we need to create a "GanttChartMenu.properties" file under "[Plugin project directory]/src/main/resources/message" directory. 

  Sample content for GanttChartMenu.properties file

  ในการทำให้ปลั๊กอิน i18n พร้อมใช้งานเราจำเป็นต้องสร้างไฟล์คุณสมบัติบันเดิลทรัพยากรข้อความสำหรับปลั๊กอิน

  • สร้างไฟล์คุณสมบัติที่มีชื่อคลาสปลั๊กอินในไดเรกทอรี "[ไดเรกทอรีโครงการปลั๊กอิน] / src / main / resources / message"

            ตัวอย่าง: สำหรับปลั๊กอินชื่อ "GanttChartMenu" เราต้องสร้างไฟล์ "GanttChartMenu.properties" ภายใต้ไดเรกทอรี "[ไดเรกทอรีโครงการปลั๊กอิน] / src / main / resources / ข้อความ"

            เนื้อหาตัวอย่าง สำหรับไฟล์ GanttChartMenu.properties

  org.joget.sample.GanttChartMenu.pluginLabel=Gantt Chart
  org.joget.sample.GanttChartMenu.pluginDesc=To display form data in Gantt Chart layout
  userview.ganttChart.label.title=Title
  userview.ganttChart.label.week=Week

• Use getMessage(String key, String pluginName, String translationPath) of PluginManager or AppPluginUtil to retrieve i18n label.
  

  Example: Use the getMessage method in getLabel and getDescription methods to return i18n label and description.

  ใช้ getMessage (คีย์ String, String pluginName, String translationPath) ของ PluginManager หรือ AppPluginUtil เพื่อดึงข้อมูลฉลาก i18n

      ตัวอย่าง: ใช้เมธอด getMessage ใน getLabel และเมธอด getDescription เพื่อส่งคืนเลเบล i18n และคำอธิบาย

  public String getLabel() {
      return AppPluginUtil.getMessage("org.joget.sample.GanttChartMenu.pluginLabel", getClassName(), "message/GanttChartMenu");
  }
  public String getDescription() {
      return AppPluginUtil.getMessage("org.joget.sample.GanttChartMenu.pluginDesc", getClassName(), "message/GanttChartMenu");
  }

• Pass a translation file path to readPluginResource(String pluginName, String resourceUrl, Object[] arguments, boolean removeNewLines, String translationFileName) method of AppUtil to provide the plugin properties option with i18n label.  We can use "@@message.key@@" in the JSON of Plugin Properties Options.
  

  Example: For property options of a GanttChartMenu plugin, the following shows the sample code implementation of getPropertyOptions method and the GanttChartMenu.json file

  ผ่านไฟล์การแปลไปยัง readPluginResource (String pluginName, String resourceUrl, อาร์กิวเมนต์ [] บูลีน removeNewLines, String translationFileName) ของ AppUtil เพื่อจัดเตรียมตัวเลือกคุณสมบัติปลั๊กอินที่มีฉลาก i18n เราสามารถใช้ "@@ message.key @@" ในตัวเลือก Plugin Properties Options ของ JSON

      ตัวอย่าง: สำหรับตัวเลือกคุณสมบัติของปลั๊กอิน GanttChartMenu ข้อมูลต่อไปนี้แสดงการใช้งานโค้ดตัวอย่างของวิธีการ getPropertyOptions และไฟล์ GanttChartMenu.json

  public String getPropertyOptions() {
      return AppUtil.readPluginResource(getClassName(), "/properties/GanttChartMenu.json", null, true, "message/GanttChartMenu");
  }

  [{
      title : '@@userview.ganttChart.edit@@',
      properties : [{
          name : 'id',
          label : 'Id',
          type : 'hidden'
      },
      {
          name : 'customId',
          label : '@@userview.ganttChart.customId@@',
          type : 'textfield',
          regex_validation : '^[a-zA-Z0-9_]+$',
          validation_message : '@@userview.ganttChart.invalidId@@'
      },
      {
          name : 'label',
          label : '@@userview.ganttChart.label@@',
          type : 'textfield',
          required : 'True',
          value : '@@userview.ganttChart.label.value@@'
      }]
  }]

• Pass a translation file path to getPluginFreeMarkerTemplate(Map data, final String pluginName, final String templatePath, String translationPath) method of PluginManager whenever retrieving a HTML template. Once we passed a translation file path, we can use "@@message.key@@" in the freemarker template to retrieve i18n label.
  

  Example: For getRenderPage method of a GanttChartMenu plugin, the following show the sample code implementation of getRenderPage method and the "GanttChartMenu.ftl" FreeMarker template. 

  ไฟล์การแปลไปที่ getPluginFreeMarkerTemplate (ข้อมูลแผนที่ปลั๊กอิน String สุดท้ายชื่อแม่แบบ String สุดท้ายPath, String translationPath) วิธีการของ PluginManager เมื่อใดก็ตามที่เรียกแม่แบบ HTML เมื่อเราผ่านเส้นทางไฟล์แปลแล้วเราสามารถใช้ "@@ message.key @@" ในเทมเพลต freemarker เพื่อดึงฉลาก i18n

      ตัวอย่าง: สำหรับเมธอด getRenderPage ของปลั๊กอิน GanttChartMenu ต่อไปนี้จะแสดงการใช้งานโค้ดตัวอย่างของเมธอด getRenderPage และเท็มเพลต "GanttChartMenu.ftl" FreeMarker

      public String getRenderPage() {
          Map model = new HashMap();
          model.put("request", getRequestParameters());
          model.put("element", this);
          
          PluginManager pluginManager = (PluginManager)AppUtil.getApplicationContext().getBean("pluginManager");
          String content = pluginManager.getPluginFreeMarkerTemplate(model, getClasstName(), "/templates/GanttChartMenu.ftl", "message/GanttChartMenu");
          return content;
      }

  <div>
      <h1>@@userview.ganttChart.label.title@@ : ${element.properties.title!}</h1>
  </div>

• Postfix the plugin class name with an underscore and language code to create a message resource bundle property file for other language. 

Example: GanttChartMenu_zh_CN.properties

e. Register your plugin to the Felix Framework

In the start method of the activator class, add your plugin class to the "registrationList" variable.

public void start(BundleContext context) {
    registrationList = new ArrayList<ServiceRegistration>();

    //Register plugin here
    registrationList.add(context.registerService(MyPlugin.class.getName(), new MyPlugin(), null));
}

f. Build it and testing

Once you are done with all the steps above, you can build your project with your IDE using Maven. You can also run "mvn clean install" command in your project directory to build it. After building your project, a jar file is created under "target" folder in your plugin project folder. Upload the plugin jar to Manage Plugins to test your plugin.

Example: In NetBeans, right-click on the project name, then select "Clean and Build".

8. Take a step further, share it or sell it