Plugin Template Pack

Introduction

The Plugin Template Pack is designed to streamline the management of repetitive plugin configurations within the same application. By centralizing these configurations, it simplifies future maintenance. Currently, the Plugin Template Pack supports the following plugin types:

• Datalist Column Formatter
• User View / Form Permission
• Process Tool
• Form Options Binder
• Form Validator

Future updates will support more plugin types. The plugin's source code is available in the open-source repository at Plugin Template Pack GitHub. JogetOSS is a community-led initiative for open-source software related to the Joget no-code/low-code platform, and contributions are welcome.

Plugin information

This plugin allows users to manage plugin configurations more efficiently by applying a standardized template across multiple instances of the same plugin within an application.

Get started

Where to get the plugin

You can download the Plugin Template Pack from the JogetOSS GitHub repository.

How to install

1. Click Download on this plugin screen (It will be a .jar file).
2. Go to your Joget localhost or server. In the Joget Console, go to Admin Bar > Systems Settings > Manage Plugins and click the Upload Plugins button.
3. Under Upload Plugin, select the plugin .jar file you downloaded and click Upload.
4. Depending on the plugin type, you can now view your new plugin in your form, List, or UI Builder.
5. Remember to uninstall the old plugin before uploading a new version.
6. The Joget Knowledge Base has more information on managing and developing plugins.

How to use it

1. Start the Joget server and open the App Center.
2. Log in as admin and click Design New App or select an existing app.
   
3. Fill in the App ID (in camel case) and App Name for a new app, then click Save.
   
4. Create a new form. Fill in the Form ID, Form Name, and Table Name. Save the form.
   
5. Add fields to the form, save it, and click the Generate App button.
   
6. Generate the app with CRUD and Datalist included.
   
7. After the app is generated, launch the UI Builder by clicking on the CRUD component.
   
8. Go to the User View menu in the UI Builder and add the Plugin Template Management component.
   
9. Leave the configuration of Plugin Template Management properties as default and save the User View Builder.

Configure plugin template management properties

Fields to configure:

• Label: Menu label to be displayed to the end-user. It is a Mandatory field.
• Menú ID: 

UI (List)

Fields to configure:

• Button Position: The position of buttons  in the userview:
  • Top Left
  • Top Right
  • Bottom Left
  • Bottom Right
  • Top Left & Bottom Left
  • Top Right & Bottom Right
• Selection Type: The type record selector in the userview:
• Multiple: Allow users to select multiple or all the records simultaneously.
• Single: Allow users to select only one record at a time.
• Selector Position: The position of the record selector in the userview:
  • Left
  • Right
  • Both Left & Right
  • No
• New Record Button Label: New record button label to be displayed to the end user.
  Default Value: New
• Edit Link Label: Edit Record Button Label to be displayed to the end user.
  Default Value: Edit
• Delete Button Label: Delete Record Button Label to be displayed to the end user.
  Default Value: Delete
• Custom Header: Custom Header in HTML.
• Custom Footer: Custom Footer in HTML.

UI (add)

Fields to configure:

• Cancel Button Label: Cancel Button Label to be displayed to the end-user.
  Default Value: Cancel
• Save Button Label: Save Button Label to be displayed to the end-user.
  Default Value: Save
• Custom Header: Custom Header in HTML.
• Custom Footer: Custom Footer in HTML

UI (edit)

Fields to configure:

• Back Button Label: Back Button Label to be displayed to the end-user.
  Default Value: Back
• Save Button Label: Save Button Label to be displayed to the end-user.
  Default Value: Edit
• Custom Header: Custom Header in HTML.
• Custom Footer: Custom Footer in HTML.

Expected outcome

After setting up the Plugin Template Pack, you will have a standardized user interface that allows easier management of plugin configurations across multiple instances. This streamlines future maintenance and updates.

• UI list
  
  

• UI (Add)
  
  
• UI (Edit)
  

Download plugin

• Plugin Template Pack