Introduction
The userview Permission Menu allows you to configure category permissions for user-defined groups at run-time.
This feature eliminates the need for app designers to go into the userview builder to manually set the permission for every menu category.
Get Started
The easiest way to see how the Manage Permission menu works is to download the attached demo app, import, publish and run the app in your Joget platform:
- Manage permission menu basically allows you to configure the userview menu category permissions from the run time screens. In this example (Figure 1), there are four menu categories you can assign the view permission.
- The Configure button (Figure 2) will present you with the following permission options:
- Is Admin
- Is Anonymous
- Bean Shell Script
- Department
- Group
- Logged In User
- Organization
- Is Sub Level Userview
- User
- In Userview Builder, the Manage Permission menu property is shown in Figure 3 (More details are provided below).
- Each menu category permission property (Figure 4) is tagged as "Permission Type = Controlled By Manage Permission Menu" and given a "Permission Key" name. You then map the respective "Permission Key" names into the "Manage Permission > Permissions" grid (Figure 3).
Figure 1
Figure 2
Figure 3
Figure 4
Manage Permission Properties
Configure Manage Permission Menu
id: Menu element unique id. Userview will use this id in the URL for the menu if the Custom ID is empty.
Custom ID: Item link slug. Optional field (Figure 5)
Unique field
Value defined here must be unique to the rest of the Userview Menus as the first matching name will be called upon.
Label: Menu label. Mandatory field.
Page Title: Page title on Permission Menu page. You can use HTML tags, for example <b></b> to bold the title.
Permissions:
| Permission Key | Id to match against userview categories (Figure 4). |
| Permission Label | Permission list name (Figure 3). |
| Category | Optional Group label. Category to group similar permission labels under. |
Enable Refined Controls (Requires Admin User Role)?: Allows administrators to implement intricate user permission configurations per group.
Using LDAP / External Directory Manager?
If you are using external directory manager such as the LDAP Directory Manager, you must enable this option to use this Manage Permission menu.
Important Note
Once this feature is enabled, only users with administrative access can manage the permission.
As opposed to Figure 2, when configuring permission, you will be brought to the following screen for finer permission control.
Figure 5
Figure 6
Figure 7
Advanced
Name | Description |
|---|---|
| Custom Header | Custom Header in HTML to show (Figure 6). |
| Custom Footer | Custom Footer in HTML to show. |
Performance & Offline
Cache Settings
Name | Description |
|---|---|
| Scope | Caching options are (Figure 7):
|
| Duration (s) | Duration in seconds to cache content, defaults to 20 seconds if applicable. |
Read more at Performance Improvement with Userview Caching.
PWA Offline Settings
Note: PWA Offline support is dependent on the theme used.
Name | Description |
|---|---|
| Enable cache for offline support | Check this to enable caching for offline support, usually set for use on mobile browsers. |
Read Progressive Web Application (PWA) for more information.
How to use this permission plugin in a userview category
In the userview category that you wish to manage its permission via this plugin, edit the category's permission as shown in figure 4. After setting up the Permission Menu, remember to configure all the respective userview categories. Note that, multiple categories can use the same permission key. Setting up as such will grant multiple categories to a permission group.