Manage Permission Menu

Introduction

The Manage Permission Menu in Joget DX 8 allows you to configure category permissions for user-defined groups at runtime. This feature eliminates the need for app designers to go into the UI builder to set permissions for every menu category manually.

How does it work?

The easiest way to see how the Manage Permission menu works is to download the attached demo app, import, publish, and run the app on your Joget platform:

1. Manage permission menu allows you to configure the UI menu category permissions from the run time screens. In this example, there are four menu categories to which you can assign the view permission.
   

2. The Configure button will present you with the following permission options:

   • Is Admin
   • Is Anonymous
   • Bean Shell Script
   • Department
   • Group
   • Logged In User
   • Organization
   • Is Sub Level UI
   • User
     
3. In UI Builder, the Manage Permission menu property is shown provided below. 
   
4. Each menu category permission property 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.
   

Configure manage permission

To configure Manage Permission properties, in UI Builder, drag and drop the Manage Permission element onto the canvas and click on it.

When adding Manage Permission, you will see the following fields available for configuration:

• Label: This is the menu label displayed for the Manage Permission Menu. It's a mandatory field, and you can add Font Awesome Icons to your menu labels.
• Menu ID: Item link slug. Optional field.
  
  Unique field
  The value defined here must be unique to the rest of the UI Menus, as the first matching name will be called upon.
• Page Title: Specify the title for the Permission Menu page. You can use HTML tags for formatting, such as <b></b> for bold text.
• Permissions: Configure individual permissions for each category. Here's what you need to define:
  • Permission Key: An ID to match against UI categories.
  • Permission Label: Permission list name.
  • Category: Optional Group label. Category to group similar permission labels under.
• Enable Refined Controls (Requires Admin User Role)?: This option allows administrators to implement intricate user permission configurations per group.
  Note: 
  If you use an external directory manager such as the LDAP Directory Manager, you must enable this option to utilize the Manage Permission menu.
  Important: 
  Only users with administrative access can manage permission once this feature is enabled.

You will be brought to the following screen for finer permission control when configuring permission.

Advanced

The Advanced section in the Manage Permission Menu allows you to include custom HTML content for the menu's header and footer. This provides flexibility in tailoring the appearance and additional information shown in the Manage Permission interface.

Fields to Configure:

• Custom Header: Include custom HTML content for the header of the Manage Permission Menu.
• Custom Footer: Include custom HTML content for the footer of the Manage Permission Menu.

Performance & offline

The Performance & Offline Settings section allows you to configure caching and offline support for the Manage Permission Menu. Proper configuration in this section ensures efficient performance and availability of permission settings even in offline scenarios.

Cache settings

The Cache Settings in Joget define how the Manage Permission Menu data is cached to improve performance. 

Fields to Configure:

• Scope:
  Options include are: 
  
  • None: No caching.
  • Application: Cache content by application where all users will see the same content.
  • User: Cache by username.
• Duration (s): Duration in seconds to cache content, defaults to 20 seconds if applicable.

For more information, see Performance Improvement with UI Caching.

PWA offline settings

The PWA Offline Settings section enables caching for offline support. This is typically used for mobile browsers, ensuring that the Manage Permission Menu remains accessible even without an active internet connection—Configure settings to cache list actions and links for enhanced offline functionality.

Field to Configure:

• Enable cache for offline support: Enable caching for offline support. This is usually set for mobile browsers. See Progressive Web Application (PWA) documentation for more details.