Plugin Template - User view / Form Permission

Introduction

The Userview/Form Permission Plugin enables you to manage permissions for both Userviews and Forms in a Joget app. This guide provides step-by-step instructions on how to configure and apply the Permission Plugin Template to control access within your 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. Launch the Plugin Template Demo app and go to the Plugin Template Management Page.
  2. Click the New button to create a new template.
  3. Fill in the template details. Select a plugin under Permission Control or Form Permission in the Plugin field. For this example, select Is Admin.
  4. Click Configure Plugin (no properties need to be configured for this plugin). Then, click Submit and save the template by clicking Save.
Apply the permission plugin to userview
  1. The Permission Plugin Template can be applied at either the Userview level or the Userview Category level using the Permission Control feature.
  2. Apply the Permission at the Userview Level:
  3. Go to the Userview Builder, select Settings, navigate to Configure Layout > Theme (DX Progressive Theme) > Configure Permission.
  4. Choose Plugin Template - Permission for the Permission Type field.
  5. Select the template you created and save the Userview by clicking Save.
  6. Apply the Permission plugin template at the UI Category level.
  7. In the UI Builder, click the permission icon for a category.
  8. Choose Plugin Template - Permission for the Permission Type field.
  9. Select the template you created, click OK, and save the UI.
Note:
The Permission tab in the Advanced Tool ( Advanced Tools > Permission ) of the Userview Builder can utilize the Permission Plugin template created to provide the app designer with fine-grain control over managing the permissions of each individual element in the builder.
Apply the permission plugin to forms
  1. The Permission Plugin Template can be applied at both the Form level and the Form Section level using the Permission Control feature.
  2. Apply the Form Permission plugin template to the Form Level.
  3. In the Form Builder, select Settings, then go to Configure Form > Advanced.
  4. Choose Plugin Template - Permission for the Permission field.
  5. Select the template you created and save the form.
  6. Apply the Permission plugin template at the Form Section Level.
  7. In the Form Builder, click the Edit Section icon for a section, then navigate to Edit Section > Data Binder > Advanced Options.
  8. Choose Plugin Template - Permission for the Permission field.
  9. Select the template you created, click OK, and save the form.
Note:
The Permission tab in the Advanced Tool ( Advanced Tools > Permission ) of the Form Builder can utilize the Permission Plugin template created to provide the app designer with fine-grain control over managing the permissions of each individual element in the builder.

Download plugin

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