What is the problem? You have a custom requirement and you found that none of the built-in plugins provided by Joget Workflow nor plugins available in are able to fulfill your requirement. 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 used, but it does not provide the ability to do condition checking. How to solve the problem? Refer to the that supported by Joget Workflow, find the most appropriate plugin type that can help you to fulfill the custom requirement. Example 1: Develop a Datalist Action plugin to display a button for generate form PDF. Example 2: Develop an Userview Menu plugin that can use to display form data as Gantt Chart. Example 3: Develop a Hash Variable plugin that can do Bean Shell scripting. What is the input needed for your plugin? Look at it from the user's perspective; how are you going to use the plugin. Then, look at it from a developer's perspective; to make the plugin reusable in more use cases. You can refer to on what type of input field you can provide to your plugin user. Example 1: To develop a PDF Download Datalist Action plugin, we can consider providing the following as input. Example 2: To develop an Gantt Chat Userview Menu plugin, we can consider providing the following as input. 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 to store our scripts. So the Hash Variable syntax will be a prefix with environment variable key. 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. What is the output and expected outcome of your plugin? How and what a normal user Not the admin user who use the plugin to provide functionality will use and see your plugin result. 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. The Joget team will try their best to enrich the contents in the tutorials section. You may need to check out the document of , , and as well. Example 1: To develop the PDF Download Datalist Action plugin, we can reuse the methods in to generate a form as PDF. We can also refer to the of the Datalist Form Data Delete Action plugin as well. Other than that, we can refer to the 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 of all the Userview Menu plugin. From there, we can have a better understanding on how to make a template for a plugin using syntax. Example 3: To develop Bean Shell Hash Variable plugin, we can refer to the 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. Prepare your development environment a. You will need to have the ready and built. Generate a maven project. Open the maven project with your favour IDE. Extending the abstract class of a plugin type Refer to the document of the plugin type listed in. Find the abstract class and interface that need to be extended and implemented by your plugin. Example: To develop a , the plugin class need to extends the org. Implement all the abstract methods A plugin will have to implements the abstract method of and also the abstract method of the individual abstract class and interface for the plugin type. Example: To develop a , the following methods have to be implemented by the plugin. Please refer to the plugin documents for the details of each methods. So, we will using the provided by. 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. Sample content for GanttChartMenu. Example: For property options of a GanttChartMenu plugin, the following shows the sample code implementation of getPropertyOptions method and the GanttChartMenu. The class is used to register your plugin class to the. You do not need to do this if your plugin is not an. Build it and testing Once you are done with all the steps above, you can build your project with your IDE using Maven. Upload the plugin jar to to test your plugin. Take a step further, share it or sell it You have completed a very useful plugin. Don't just keep it to yourself, share or sell your plugin in the or even better, you can write a tutorial in our Knowledge Base to share your effort with others. To share or sell your plugin, please send an email to info joget.
