Permission Control

Introduction

Permission Control in Joget allows you to manage user access to various components within your Joget App. Here's an overview of the main components and permission plugins available:

Components where permission control can be applied

1. UI: Controls access to entire user interfaces.
2. UI Category: Manages access to specific UI categories within the UI Builder.
3. UI Menu: Regulates access to menus in the UI Builder.
4. Form: Manages permissions related to forms in the Form Builder.
5. Form Section: Controls access to sections within forms in the Form Builder.
6. List: Manages permissions related to lists in the List Builder.
7. Advanced Tools > Permission: Controls access to advanced tools and features.

Here are some examples of how permission settings can be configured within the different builders in Joget:

• Advanced Tools permission settings in Form Builder.
  
• Advanced Tools permission settings in List Builder.
  
• Advanced Tools permission settings in UI Builder.
  
• Permission Type configuration in UI Builder for UI.
  
• Permission Type configuration in UI Category in UI Builder for UI Category.
  
• Permission Type configuration in Form Builder for Form.
  
• Permission Type configuration in Form Section in Form Builder for Form Section
  

Video tutorial 

In this video tutorial, you will learn how to manage and configure basic permission controls in Joget. This tutorial covers the essential steps to set up user access permissions for various components within your Joget app, ensuring you can effectively control who can view and interact with different parts of your application.

List of permission plugins

Provides detailed information on various permission plugins available in Joget. These plugins allow for fine-grained control over who can access and interact with different components of a Joget app. Each plugin serves a specific purpose, from checking if a user is an admin to verifying if a user belongs to a particular department. Understanding and configuring these plugins ensures that the right users have the appropriate access levels, enhancing the security and functionality of your application.

Admin UI permission

Admin UI Permission checks if the user is logged in and belongs to the admin role before letting the user view the screen.

• Label: Is Admin
• Applicable for: 
  • UI
  • UI Builder > Advanced Tools
  • UI Category
  • Form
  • Form Builder > Advanced Tools
  • Form Section
  • List Builder > Advanced Tools
• Availability: Joget DX Enterprise

Anonymous UI permission

Anonymous UI Permission checks that no users are logged in before letting the user view the screen. This element helps display public information to users who are not logged in.

• Label: Is Anonymous
• Applicable for: 
  • UI
  • UI Builder > Advanced Tools
  • UI Category
  • Form
  • Form Builder > Advanced Tools
  • Form Section
  • List Builder > Advanced Tools
• Availability: Joget DX Enterprise.

Bean Shell permission

Bean Shell Permission allows key in custom Java codes to define the permission checking.

Fields to configure:

• Label: Bean Shell Script
• Applicable for: 
  • UI 
  • UI Builder > Advanced Tools
  • UI Category
  • Form
  • Form Builder > Advanced Tools
  • Form Section
  • List Builder > Advanced Tools
• Availability: Joget DX Community Edition and Joget DX Enterprise.

These two objects are available to ease your implementation when writing your code.

• user
• requestParams

Example:

System.out.println( user.getFirstName() ); //will print "Admin"<font></font>
System.out.println( requestParams.get("appId") ); //will print "hr_expense";<font></font>
 
if (user.getFirstName().equalsIgnoreCase("Admin")) {
    return true;
} else {
    return false;
}

Controlled by manage permission menu

Controlled By Manage Permission Menu is part of the Manage Permission Menu.

• Label: Controlled By Manage Permission Menu
• Applicable for: 
  • UI
  • UI Builder > Advanced Tools
  • UI Category
  • Form Builder > Advanced Tools
  • Form Section
  • List Builder > Advanced Tools
• Availability: Joget DX Enterprise.

Department permission

Department Permission checks if the user currently logged in belongs to the selected department before letting the user view the screen.

• Label: Department
• Applicable for: 
  • UI
  • UI Builder > Advanced Tools
  • UI Category
  • Form
  • Form Builder > Advanced Tools
  • Form Section
  • List Builder > Advanced Tools
• Availability: Joget DX Community Edition and Joget DX Enterprise.

Group permission

Group Permission checks if the user currently logged in belongs to the selected group before letting the user view the screen.

• Label: Group
• Applicable for: 
  • UI
  • UI Builder > Advanced Tools
  • UI Category
  • Form
  • Form Builder > Advanced Tools
  • Form Section
  • List Builder > Advanced Tools
• Availability: Joget DX Community Edition and Joget DX Enterprise.

Logged in user permission

Logged In User Permission checks if the user is logged in before letting the user view the screen.

• Label: Logged In User
• Comment: Comment displayed when the user has no permission to view the screen
• Applicable for: 
  • UI
  • UI Builder > Advanced Tools
  • UI Category
  • Form 
  • Form Builder > Advanced Tools
  • Form Section
  • List Builder > Advanced Tools
• Availability: Joget DX Community Edition and Joget DX Enterprise Edition.

Organization permission

Organization Permission checks if the user currently logged in belongs to the selected organization before letting the user view the screen.

• Label: Organization
• Applicable for: 
  • UI
  • UI Builder> Advanced Tools
  • UI Category
  • Form
  • Form > Advanced Tools
  • Form Section
  • List Builder > Advanced Tools
• Availability: Joget DX Community Edition and Joget DX Enterprise.

Sub level UI permission

Sub Level UI Permission checks if there is a UI Key value set before permitting the user to view the screen. This element is intended for UI which serves content that is dependent on the UI Key value.

• Label: Is Sub Level UI
• Applicable for: 
  • UI
  • UI Builder> Advanced Tools
  • UI Category
• Availability: Joget DX Enterprise Edition.

User permission

User Permission checks if the user currently logged in belongs to the selected username before letting the user view the screen.

• Label: User
• Applicable for: 
  • UI
  • UI Builder> Advanced Tools
  • UI Category
  • Form
  • Form Builder > Advanced Tools
  • Form Section
  • List Builder > Advanced Tools
• Availability: Joget DX Community Edition and Joget DX Enterprise Edition.