Plugin Template - Forms Validator

Introduction

The Form Validator plugin helps ensure that form fields comply with specific validation rules, such as making fields mandatory. This plugin enhances the user experience by enforcing validation logic directly within the form, streamlining data collection and preventing errors.

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. Launch the Plugin Template Demo app and go to the Plugin Template Management Page.
  2. Click on the New button to create a new Plugin Template.
  3. Fill in the Plugin Template Management Page.
  4. For the Plugin field, select any one of the formatters under Form Validator.
  5. To make the form fields mandatory, select the Basic plugin.
  6. Click the Configure Plugin button. Ensure the Mandatory property is checked.
  7. Click Submit to save the configuration, then click Save to store the Plugin Template.
  8. Enter the Design View of the Plugin Template Form.
  9. Select one of the fields you want to validate and click the edit icon.
  10. In the field's Advanced Options, go to Edit Text Field.
  11. For the Validator property, choose Plugin Template - Validator.
  12. In the Validator (Plugin Template - Validator) section, select the template you created and click OK.
  13. Repeat Steps 11 and 12 for any additional fields that need to be mandatory.
  14. Save the form.
  15. Launch the app and go to the Plugin Template Form page. The fields configured with the validator will have an asterisk (*) indicating that they are mandatory fields.

Expected outcome

Once the Form Validator plugin is set up, the form fields you configured as mandatory will be marked with an asterisk (*). Users will not be able to submit the form without filling in these required fields, improving the quality and completeness of data collected.

Download plugin

Created by Julieth Last modified by Aadrian on Nov 19, 2024